Console API clients (REST)
Console API (REST)
For all requests, include the access token in the Authorization header: authorization:Bearer ${TOKEN}.
A detailed API description can be found here via Swagger. With a valid access token, this offers an interactive API experience against your Camunda Platform 8 cluster.
Client credentials and scopes
To interact with Camunda Platform 8 programmatically without using the Camunda Platform 8 Console, create client credentials in the organization settings under the Console API tab.
Client credentials are created for an organization, and therefore can access all Camunda Platform 8 clusters of this organization.
Scopes define the access for client credentials. A client can have one or multiple of the following permissions:
A client can have one or multiple permissions from the following groups:
- Cluster: Manage your clusters.
- Zeebe Client: Manage API clients for your cluster.
- Web Modeler API (Beta): Interact with the Web Modeler API.
- IP Whitelist: Configure IP-Whitelist rules.
- Connector Secrets: Manage secrets of your clusters.
- Members: Manage members of your organization.
The full API description can be found here.
After client credentials are created, the Client Secret is only shown once. Save this Client Secret somewhere safe.
Access token
Once you have your client credentials, you can retrieve an access token using the following command:
curl --header "Content-Type: application/json" \
--request POST \
--data '{"grant_type":"client_credentials", "audience":"api.cloud.camunda.io", "client_id":"XXX", "client_secret":"YYY"}' \
https://login.cloud.camunda.io/oauth/token
Access tokens have a validity period found in the access token. After this time, a new access token must be requested.
Note that the auth service has built-in rate limiting. If too many token requests are executed in a short time, the client is blocked for a certain time. Since the access tokens have a certain validity period, they must be cached on the client side.