GET /v1/openapi.yaml
The API’s machine contract, served by the hub’s gateway: the routes under /v1, the two
credentials (x-api-key and x-project-id) with the routes each one opens, and the gateway’s EPX
codes with their HTTP statuses. The request and response bodies are the hub’s own, which the gateway
passes through unchanged. Generate your types from the served document rather than from a copy, and
watch info.version to notice a contract change.
Request
No path, query or body parameters, and no credential header.Response
The raw YAML document: no envelope, unlike every other route.Example
See also
- Authentication — the two credentials
- Errors — gateway codes — every
EPXcode - SDK:
client.api.callreaches any route by name - API overview — the contract version this reference describes