This documentation supports the 20.02 version of BMC CMDB.

To view an earlier version, select the version from the Product version menu.

General principles for using the REST API

The API follows the REST architectural style, so resources, HTTP verbs, and status codes are used. JSON is used for request and response bodies. The endpoints provided by the API are specified using the Swagger specification language.

The following principles are common to the endpoints provided by the BMC CMDB REST API.

Endpoint verbs

Where possible, endpoints use the following verbs consistently:

GETRetrieve a single resource, or collection of resources.
POSTCreate a new resource.


Update a resource, specifying the required target state of all fields. Any fields omitted are reset to default values or deleted, as appropriate for the endpoint.
PATCHUpdate a resource, specifying the required target state of some fields. Any omitted fields are not modified. To delete a field, set it to null .
DELETEDelete a resource.

Input encoding

When constructing the URL for an endpoint that contains a dynamic portion (either in the path or in the query string), ensure that you correctly encode the characters. For example: 

https://<host name>:<port number>/api/cmdb/v1.0/instances/
https://<host name>:<port number>/api/cmdb/v1.0/instances/{datasetId}/{namespace}/{className}

JSON format

JSON is used for both request and response bodies. If you are editing JSON request bodies manually, you must escape any reserved characters in your strings.

URLs in responses

Several POST endpoints create a new resource, which you can retrieve later using the REST API. In these cases, the response to the POST request contains a "uri" field, containing the URL of the newly created resource.

For example:

curl -X GET --header 'Accept: application/json' --header 'Authorization: 
<Your token>' 'https://<host name>:<port number>
https://<host name>:<port number>/api/cmdb/v1.0/instances

HTTP/1.1 200 OK
  "instances": [
      "instance_id": "OIGAA5V0HHE1FAOPM3MZOPM3MZALU9",
      "class_name_key": {
        "name": "BMC_ComputerSystem",
        "namespace": "BMC.CORE"
      "attributes": {
        "Name": "instances_CS1",
        "ShortDescription": "n/a"
      "_links": {
        "self": [
            "href": "https://<host name>:<port number>

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