API Versioning

The Cisco Business Dashboard API is versioned, with the version forming part of the method URL. In the event that non-backwards compatible changes to the API are introduced in a future release, the API version will be updated. When a new version of the API is introduced, the previous version will coexist for a time to allow a controlled migration for applications using the API.

The current version of the API is v2. API version v1 is a limited release version provided for backwards capability with selected products and is not to be used for new projects.

API Info

The API versions supported by a Dashboard instance can be determined using the api-info method. This method is itself unversioned, and can be accessed without authentication.

GET /api/api-info

{
    "min-supported-api-ver": "v1",
    "max-supported-api-ver": "v2"
}

Path-Based Versioning

The API version is included as part of the method path in the request URL:

GET https://dashboard.example.com/api/v2/nodes/
Accept: application/json

This is an example of a getNodes request using the v2 API.