Versioning
The /v1 contract
Section titled “The /v1 contract”The public API is versioned in the URL path:
https://api.atlasthq.com/api/public/v1/…Everything under /v1 shares one compatibility promise.
What we may change without a new version
Section titled “What we may change without a new version”These are considered backwards-compatible and can ship at any time, so build your integration to tolerate them:
- Adding new endpoints.
- Adding new fields to a response object.
- Adding new webhook event types.
- Adding new optional query parameters.
What counts as a breaking change
Section titled “What counts as a breaking change”A change that could break existing integrations — for example removing or
renaming a field, changing a field’s type, or changing authentication — will
not happen inside /v1. It would ship as a new version (/v2), and /v1
would continue to work during a documented migration window.
How changes are communicated
Section titled “How changes are communicated”- The reference is generated from the live API, so the Jobs API reference always reflects what’s currently deployed.
- Material changes are announced in the Atlast changelog.
Downloading the spec
Section titled “Downloading the spec”You can download the OpenAPI specification for this API and import it into Postman, Insomnia, or a code generator:
https://docs.atlasthq.com/openapi-public.json