Operations REST APIs

You can use Operations REST APIs to automate administrative actions.

The Swagger definition for the REST APIs is included with the product. If your installation includes a web server that hosts the Swagger UI, you can access the Swagger (also known as OpenAPI) definition for the REST APIs from a URL with the following format:

https://host_name:port_number/root/ops/explorer

Where host_name is the name of your web server, port_number is the port number that is used by the web server and root is the context root for the server. The root is bas. For example, localhost:9080/bas/ops/explorer.

You can also get the Swagger definition by using the following REST API call:

GET root/ops/docs

The call returns a JSON object that contains the Swagger definition.

Important: To prevent cross site request forgery attacks, REST API operations require that the HTTP header BPMCSRFToken is set with every request. For more information, see Preventing cross site request forgery.