REST API versioning
The REST API is versioned separately from TrueSight Network Automation. The following table lists the REST API version and the corresponding product version:
REST API version | Support introduced in product version | Deprecated in product version |
|---|---|---|
3.0 | 8.9.04 | |
2.1 | 8.9.03 | 8.9.04 |
2.0 | 8.9.02 | 8.9.03 |
1.0 | 8.9.01 | 8.9.02 |
Further versions of the API will be released with future product releases, resulting in multiple concurrent API versions supported by a given TrueSight Network Automation version. All versions but the latest are deprecated and might be removed in future releases.
To determine the versions of the API supported by a TrueSight Network Automation application server, use the GET api/about endpoint. This endpoint returns a list of API versions and product information, as shown in the following example:
"productName": "TrueSight Network Automation",
"component": "",
"version": "8.9.04",
"apiVersions": [
"v1.0 (deprecated)",
"v2.0 (deprecated)",
"v2.1 (deprecated)",
"v3.0]
}
Note that this endpoint does not perform any authentication checks, so it does not require a token to be passed and can also be accessed in a browser if required.
To see what features are available in each of the supported API versions, view the version-specific swagger schema file. Once you have determined an API version to use, include the version in the URL for every endpoint you call. Here are some example URLs for v3.0 of the API:
https://serverName:portNumber/bca-networks/api/v3.0/groups?filter.realm=Default
BMC recommends that you develop your scripts and programs against the latest available version of the API. Although older versions will continue to function properly, new features will be added only to the latest version. Data structures might or might not be compatible between different versions.