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
-
Before you run API commands, generate access tokens. For more information about the steps, see Generating access tokens.
-
Copy the following Swagger files and save them in yaml format:
-
The Managed services IaaS component provides support for defining connections to various clouds, templates that can be used to deploy stack instances.
-
Managed services: cam-service-composer-api
The Managed services service composer.
-
Managed services: cam-tenant-api
The Managed services tenant service provides a way to retrieve information about the tenant for the current user.
-
-
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.
-
Load the yaml files onto any swagger browser.