REST API on CloudBolt Documentation

Make your first request

Mon, 01 Jan 0001 00:00:00 +0000

These examples use curl, but the requests are the same regardless of the client. To browse the full list of endpoints, use the API console at /api-docs/v3/cmp/.

Get a token

Exchange your Cloud Management Platform (CMP) credentials for a token:

curl -X POST -H "Content-Type: application/json" \
  -d '{"username":"<username>","password":"<password>"}' \
  "https://<cmp-ip-or-hostname>/api/v3/cmp/apiToken/"

The response returns two tokens. token is the short-lived access token used in the requests below; refreshToken is the longer-lived one you exchange for a new access token when it expires. Keep the access token and your CMP address in shell variables:

Authentication

Mon, 01 Jan 0001 00:00:00 +0000

The API uses the same accounts and permissions as the rest of Cloud Management Platform (CMP): the roles and group permissions that apply in the web interface also apply to the API.

Prerequisites

An account you can log in to the web interface with. Every user has API access.

Get a bearer token

With curl

Replace cmp-ip-or-hostname, username, and password. Include domain only when logging in against a directory domain.

Conventions

Mon, 01 Jan 0001 00:00:00 +0000

These conventions apply across every endpoint. For the endpoint reference, use the API console built into CMP at /api-docs/v3/cmp/.

URLs and verbs

Paths follow a small number of patterns.

Path	What it addresses
`/{plural-noun}`	A collection of that type, such as `/api/v3/cmp/servers/`.
`/{plural-noun}/{id}`	A single item within a collection.
`/{single-noun}`	A singleton that exists without a collection. The current-user singleton is `/api/v3/cmp/user/`.
`/{plural-noun}/actions/{action}`	Functionality better expressed in RPC style than REST, such as `/resource-handlers/actions/sync-vms`.

Both collections and items are called resources. Collections are the more common of the two.