Skip to content

OpenAPI

The Upsign API is documented with an OpenAPI specification you can use to generate clients, validate requests, and explore endpoints.

Spec file

  • Bundled with this site: /openapi.yaml
  • Same file may be exposed by the API at GET /v2/openapi.yaml (no API key) when deployed with the latest server code.

Using the spec

  • Interactive docs: Use the API reference to browse operations and try requests.
  • Client generation: Use your preferred OpenAPI generator against the openapi.yaml file and the base URL for your environment.