List all workflow connections

GET

/api/admin/workflow/connections

const url = 'https://example.com/api/admin/workflow/connections';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/admin/workflow/connections \
  --header 'Authorization: Bearer <token>'

Retrieves all configured workflow connections

Authorizations

bearerAuth

Responses

200

List of workflow connections

application/json

object

count

required

Total number of connections

number

items

required

Array of workflow connections

Array<object>

object

required

Unique connection identifier

string

name

required

Human-readable connection name

string

baseUrl

required

Base URL of the workflow engine API

string format: uri

callbackBaseUrl

required

Base URL for CM Box callbacks

string format: uri

auth

required

object

type

required

Authentication type

string

Allowed values: bearer basic api_key none

token

Bearer token (for type: bearer)

string

username

Username (for type: basic)

string

password

Password (for type: basic)

string

apiKey

API key (for type: api_key)

string

headerName

Header name for API key (default: X-API-Key)

string

Example

{
  "items": [
    {
      "id": "camunda-prod",
      "name": "Camunda Production",
      "baseUrl": "https://camunda.example.com/api",
      "callbackBaseUrl": "https://cmbox.example.com",
      "auth": {
        "type": "bearer",
        "token": "secret-token",
        "username": "admin",
        "headerName": "X-API-Key"
      }
    }
  ]
}

500

Internal server error

application/json

object

error

required

Indicates an error occurred

boolean

message

required

Error message describing what went wrong

string

Example

{
  "error": true,
  "message": "Item not found"
}