Important

   

Starting version 8.9.03, BMC Network Automation is renamed to TrueSight Network Automation. This space contains information about BMC Network Automation 8.9.02 and previous versions. For TrueSight Network Automation 8.9.03 and later releases, see the TrueSight Network Automation documentation.

REST API versioning

The REST API is versioned separately from BMC Network Automation. The following table lists the REST API version and the corresponding product version:

REST API versionSupport introduced in product versionDeprecated in product version
2.18.9.03
2.08.9.028.9.03
1.08.9.018.9.02

Further versions of the API will be released with future product releases, resulting in multiple concurrent API versions supported by a given BMC 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 BMC Network Automation application server, use the GET api/about endpoint. This endpoint returns a list of API versions and product information, as follows:

{
  "productName": "BMC Network Automation",
  "component": "",
  "version": "8.9.02",
  "apiVersions": [
    "v1.0 (deprecated)",
    "v2.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 v2.0 of the API:

https://serverName:portNumber/bca-networks/api/v2.0/combo_groups
https://serverName:portNumber/bca-networks/api/v2.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.

Was this page helpful? Yes No Submitting... Thank you

Comments