Versioning

The Admin API uses URI versioning. For example, https://{{tenant-space}}.admin.api.scayle.cloud/api/admin/v1. The current version is v1. Whenever making a request to the Admin API, you have to specify the version inside the URI.

Backwards-Compatible Changes

When backwards-compatible changes are made to the Admin API, no new version is released. Backwards-compatible changes are defined as:

• Adding new API resources.
• Adding new optional request parameters.
• Adding new properties to responses.

Backwards-Incompatible Changes

When backwards-incompatible changes are made to the Admin API, a new version is released. Backwards-incompatible changes are defined as:

• Deleting existing API resources.
• Adding new required parameters to existing API methods.
• Removing properties from an existing API response.
• Changing data types of existing properties.

Release Notes

For details about updates to the Admin API, see the release notes.