Using BMC CMDB functions in an external application with the REST API

You can interact with and control BMC CMDB from a remote computer by using a script or program that uses REST API. 

By using the REST APIs, you can perform most tasks that you can currently perform through CMDB Portal or command-line utilities. For more information, see Endpoints in the REST API. Additionally, the Remote Procedure Call (RPC) API continue to be supported. 

The REST API follows the REST architectural style and uses resources, HTTP verbs, and status codes. JSON is used for request and response bodies. REST API follows the token based authentication that is supported by Remedy AR System. The REST API provides certain endpoints that are aligned with the Swagger specification language. 

Using the Swagger UI

REST API are aligned with Swagger specifications. You can generate the REST client using the Swagger tools. You can retrieve the Swagger specifications by using the following REST API link.

/api/v1.0/swagger.json

Alternately, you can also use the following Swagger URL.

https://<host name>:<port number>/cmdb/api/help.html

The Swagger UI enables you to explore and interact with all the endpoints in the REST API.