Qodex.ai

Administration API (REST)

Number of APIs: 20

🚀 Overview

The Camunda 8 Administration API (formerly Console API) provides:

  • A programmatic interface for managing Camunda clusters and API clients

  • Endpoints for various operations, including cluster backup, creation, and deletion, as well as client and member management

  • IP whitelisting and secret management

NOTE: A detailed API description can be found here via Swagger. With a valid access token, this offers an interactive API experience against your Camunda 8 cluster.

Take a closer look at Camunda's Administration API (REST) documentation.

💪 What do you need to make it work?

All requests to the Administration API require authentication.

This Qodex collection is configured to automatically handle the authentication process if:

  • You are using the SaaS offering of Camunda

  • You provide an API client ID and secret

If you're using a Self-Managed instance of Camunda, you may need to manually request an authentication token and include it in the headers of your requests.

1. Configure an API client

To interact with Camunda 8 programmatically without using Camunda Console, create client credentials in the organization settings under the Administration API tab.

Client credentials are created for an organization, and therefore can access all Camunda 8 clusters of this organization.

See the Camunda 8 Administration API documentation for available scopes and permissions.

After client credentials are created, the Client Secret is only shown once. Save this Client Secret somewhere safe.

2. Configure a Qodex environment

Enable the Camunda SaaS environment in Qodex. See the [Qodex documentation] on managing environments for more information.

Configure the Current value of the following variables in the environment:

  • authorizationServerUrl - The URL of the authorization server. For the SaaS offering, this is https://login.cloud.camunda.io/oauth/token.

  • administrationApiAudience - The audience associated with the API client. For the SaaS offering, this is api.cloud.camunda.io.

  • administrationApiBaseUrl - The base URL of the Camunda 8 Administration API. For the SaaS offering, this is https://api.cloud.camunda.io.

  • administrationApiClientId - The client ID of the API client you created in the Camunda 8 Console.

  • administrationApiClientSecret - The client secret of the API client you created in the Camunda 8 Console.

With these values configured, a pre-request script defined on the collection will automatically retrieve an access token before each request, and store it in the administrationApiBearerToken variable. If you forget to configure any of these variables, requests will show a failed test with an error message indicating the unconfigured variable.

If you prefer to manually manage the access token, configure its value in the administrationApiBearerToken variable.

The access token is automatically included in the headers of every request in the collection: Authorization: Bearer {{administrationApiBearerToken}}.

3. Make requests to the API

With the environment configured, you can now make requests to the Camunda 8 Administration API. The collection includes a variety of requests to manage clusters, clients, and secrets.

See the Camunda 8 documentation or the Swagger experience for more information on the available endpoints and their usage.

Common issues

No request made, 1/2 tests pass

If it appears no request was made, and the Test Results tab shows a failing test, there is likely misconfigured data. Common issues include:

  • No environment selected.

  • Unconfigured authorizationServerUrl, administrationApiAudience, administrationApiClientId, or administrationApiClientSecret variables.

  • Improperly formed access token.

Error message: There was an error in evaluating the Pre-request Script:Error: No data, empty input at 1:1 ^

Additional information can be found in the Qodex console. This error may indicate a problem with credentials, such as an invalid administrationApiClientId or administrationApiClientSecret.

403 Forbidden response

A 403 Forbidden response may indicate insufficient permissions for the API client. Ensure the client has the necessary scopes and permissions to perform the requested operation.

  1. Members-{email} - Delete member DELETE {{baseUrl}}/members/email

  2. Clusters - Get parameters GET {{baseUrl}}/clusters/parameters

  3. Clusters-{cluster Uuid}-Clients - Create client POST {{baseUrl}}/clusters/:clusterUuid/clients

  4. Clusters-{cluster Uuid}-Backups - Get backup GET {{baseUrl}}/clusters/:clusterUuid/backups

  5. Clusters - Create cluster POST {{baseUrl}}/clusters

  6. Members-{email} - Create member POST {{baseUrl}}/members/email

  7. Clusters-{cluster Uuid} - PATCH :clusteruuid PATCH {{baseUrl}}/clusters/clusters/:clusterUuid

  8. Clusters - Get clusters GET {{baseUrl}}/clusters

  9. Clusters-{cluster Uuid}-Clients - Get clients GET {{baseUrl}}/clusters/:clusterUuid/clients

  10. Clusters-{cluster Uuid}-Clients-{client Id} - Get client GET {{baseUrl}}/clusters/:clusterUuid/clients/:clientId