Versioning

The API version is the part of the path after /api. The current version is v1.

POST /api/v1/check

• The API URL on the Settings page of the console includes the version.
• The X-Api-Version header and data.apiVersion name the version that answered.
• A version name is lowercase. /api/V1/check gets 404 api_version_not_supported.

Old versions keep runningCopy Anchor Link

A new version gets a new path, such as /api/v2/check. After a new version comes out, the old version keeps running for at least 6 months. The Changelog lists each version.

A version that does not existCopy Anchor Link

A path with a version that does not exist gets 404 api_version_not_supported. The message names the versions that exist.

{
  "data": null,
  "code": "api_version_not_supported",
  "message": "API version v2 does not exist. Available versions: v1.",
  "errorId": "FMC01",
  "traceId": "req_01M6JY9Z6G06X4E6E81DQYJ4DG"
}

This response has no X-Api-Version header and no X-Region header.