API Specs

Export a published version

Returns a published version as a downloadable OpenAPI document. A published version is frozen, so the same call returns the same bytes forever, which makes it safe to generate clients from in a build.

get/api/projects/{projectId}/specs/{specId}/versions/{versionId}/export

Request

  • Base URL: https://api.routebase.dev
  • URL: https://api.routebase.dev/api/projects/{projectId}/specs/{specId}/versions/{versionId}/export
  • Auth: API key in header X-API-Key

Path parameters

ProjectIdstring uuid required

Public id of the project.

SpecIdstring uuid required

Public id of the API specification.

VersionIdstring uuid required

Public id of the specification version.

Query parameters

SpecFormatstring

Output format. Defaults to yaml.

Headers

X-RB-Regionstring
Example:us

Region of your organization. US organizations must send us; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.

Response

The specification document as a file.

string required

Changes

No recorded changes to this operation across all 1 revision of this API.