How to call the Multi-Cloud Orchestrator REST API

In addition to it's graphical user interface, Multi-Cloud Orchestrator is also accessible through a REST API, allowing programmatic interaction and automation.

Prerequisites

  • Have curl installed on your computer

Generate an API key

  1. Go to Settings > User details
  2. Press the Create API key button Create API key
  3. Extract the API credentials from the downloaded ZIP file

Example of using the REST API with Curl

  1. Make a REST API call using the API credentials downloaded in the previous step. For example list all existing templates:
curl --cacert ca_cert.pem --key private/cert.key --cert cert.crt https://clients.imco.na.cloud.im/v2/blueprint/templates
[
  {
    "resource_type": "template",
    "label_ids": [],
    "error_event_id": null,
    "id": "5fa18ff323145305115a6f82",
    "name": "Ubuntu 20.04",
    "generic_image_id": "5f9be04ff1dffe05262c8386",
    "error_message": null,
    "state": "ready"
  }
]

Delete your API key

  1. Go to Settings > User details
  2. Press the Delete current API key button Delete API key

Additional Resources