API Specs

Export the current state of a specification

Returns the working state of a specification as OpenAPI, which is the draft as it stands in the designer right now. To export something stable, export a published version instead.

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

Request

  • Base URL: https://api.routebase.dev
  • URL: https://api.routebase.dev/api/projects/{projectId}/specs/{specId}/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.

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.

string required

Changes

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