API reference

You can use REST APIs to integrate Managed services with your application.

About the task

The terms in the swagger files for your reference:

  • Stack is the API name for a deployed template instance.
  • Stackstate is a separate table that keeps a history of all the detailed states the stack has been in. When you do a stack/<stack_id>/retrieve, it includes the latest state.
  • Foreign key (fk) is the ID of that particular stackstate.

Procedure

  1. Before you run API commands, generate access tokens. For more information about the steps, see Generating access tokens.

  2. Copy the following Swagger files and save them in yaml format:

  3. Managed services API needs tenantId, IBM Cloud Pak for AIOps team (ace_orgGuid), and IBM Cloud Pak for AIOps namespace (cloudOE_spaceGuid) for authorization. For the procedure to get these values, see Prerequisites for using Managed services APIs topic.

  4. Load the yaml files onto any swagger browser.