Discover the current API version

Query version discovery endpoints to determine which API versions and specification versions are available.

Before you begin

A running automation orchestrator instance is accessible from your environment.
You have a valid access token.

Procedure

List the available API versions.
Send a GET request to the API root:
```
$ curl https://orchestrator_host/api \
  -H "Authorization: Bearer access_token"
```
The response includes the current version and all available version paths:
```
{
  "current_version": "/api/v1",
  "available_versions": {
    "v1": "/api/v1"
  }
}
```
When a new major version is introduced, current_version shifts to the new version. Both versions appear in available_versions while they serve traffic.
List the endpoints available in a specific API version.
Send a GET request to the version root:
```
$ curl https://orchestrator_host/api/v1 \
  -H "Authorization: Bearer access_token"
```
The response lists all resource endpoints available under this version.

Retrieve the full version details for a specific API version.

Send a GET request to the version endpoint:

$ curl https://orchestrator_host/api/v1/version \
  -H "Authorization: Bearer access_token"

{
  "api_version": "v1",
  "info_version": "1.4.0",
  "status": "current",
  "links": {
    "docs": "/api_docs/v1/docs",
    "redoc": "/api_docs/v1/redoc",
    "openapi": "/api_docs/v1/openapi.json"
  }
}

Check the info_version field against your client version.

A client built against version 1.5.0 connecting to a server running 1.3.0 can detect that 1.4.0+ endpoints are unavailable.

Results

Confirm the current_version field matches the API prefix you are using in your integration.
Confirm the status field is current and not deprecated.

Note:

The links field is null when an administrator has set APP_ENABLE_API_DOCS to false. API documentation endpoints are enabled by default. The status field reflects the version lifecycle state, such as current or deprecated.