API reference

You can use REST APIs to integrate Cloud Automation Manager 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:

   • Cloud Automation Manager: cam-iaas

     The Cloud Automation Manager iaas component provides support for defining connections to various clouds, templates that can be used to deploy stack instances.

   • Cloud Automation Manager: cam-service-composer-api

     The Cloud Automation Manager service composer.

   • Cloud Automation Manager: cam-tenant-api

     The Cloud Automation Manager tenant service provides a way to retrieve information about the tenant for the current user.

3. Cloud Automation Manager API needs tenantId, IBM Multicloud Manager team (ace_orgGuid), and IBM Multicloud Manager namespace (cloudOE_spaceGuid) for authorization. For the procedure to get these values, see Prerequisites for using Cloud Automation Manager APIs topic.
4. Load the yaml files onto any swagger browser.