Version scope
The major REST API version appears in the URL, currently /v1. Webhook payloads use an independent numeric schemaVersion. A new webhook schema will not silently reinterpret an existing schema version.
Effective August 1, 2026
Versioning and deprecation
A practical compatibility policy for production customer integrations. This policy supplements the Terms of Service and does not promise availability beyond an active supported service.
Compatible changes
The following changes may be released without a new major API version:
- New endpoints or optional request fields
- New response fields
- New enum values where the contract does not define a closed enum
- New webhook event types that an endpoint has not selected
- New optional webhook data fields
- Performance, security, and reliability improvements that preserve documented behavior
Clients must ignore response fields they do not recognize and handle unknown non-closed enum values safely.
Breaking changes
Removing an operation or field, changing a field type or meaning, making an optional field required, reducing a documented limit in a way that invalidates accepted requests, or changing authentication requirements is treated as breaking unless required immediately to address active abuse, fraud, legal obligations, or a material security risk.
Deprecation notice
For ordinary breaking changes, Uptime Basics intends to provide at least 12 months notice before removing a supported major API version or webhook schema. Notice will be published in the developer changelog and documentation. When customer contact is reasonably available and the affected integration can be identified, an account notification or email may also be used.
Deprecated HTTP operations may include Deprecation, Sunset, and Link headers when practical. The replacement path and final supported date will be documented.
A shorter period may be necessary for security vulnerabilities, abuse prevention, legal requirements, upstream provider shutdowns, or functionality already operating outside its documented contract.
Rate and plan limits
Allowances are part of the customer plan rather than the API major version. Current effective limits are available through /capabilities, /usage, response headers, and Account > Integrations. Commercial plan changes may alter future allowances with customer notice as required by the applicable agreement.
Developer support
Use Account > Support > API or integration for API, webhook, export, authentication, or SDK questions. Include the UTC time, operation, status code, and X-Request-Id. Never include a complete bearer token, signing secret, custom header value, password, or payment detail.