Class AdminApiClient

This class provides methods to interact with the Camunda Admin API.

Throws

An error that may occur during API operations.

Constructors

constructor

new AdminApiClient(
    options?: {
        config?: DeepPartial<
            {
                CAMUNDA_AUTH_STRATEGY: | "BASIC"
                | "OAUTH"
                | "BEARER"
                | "COOKIE"
                | "NONE";
                CAMUNDA_BASIC_AUTH_PASSWORD: undefined
                | string;
                CAMUNDA_BASIC_AUTH_USERNAME: undefined | string;
                CAMUNDA_CONSOLE_BASE_URL: undefined | string;
                CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
                CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
                CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
                CAMUNDA_COOKIE_AUTH_PASSWORD: string;
                CAMUNDA_COOKIE_AUTH_URL: string;
                CAMUNDA_COOKIE_AUTH_USERNAME: string;
                CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
                CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
                CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
                CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
                CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
                CAMUNDA_JOB_WORKER_MAX_BACKOFF_MS: number;
                CAMUNDA_LOG_LEVEL:
                    | "none"
                    | "error"
                    | "http"
                    | "info"
                    | "warn"
                    | "verbose"
                    | "debug"
                    | "silly";
                CAMUNDA_MODELER_BASE_URL: string;
                CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined
                | string;
                CAMUNDA_OAUTH_DISABLED: boolean;
                CAMUNDA_OAUTH_FAIL_ON_ERROR: boolean;
                CAMUNDA_OAUTH_TOKEN: undefined | string;
                CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
                CAMUNDA_OAUTH_URL: undefined | string;
                CAMUNDA_OPERATE_BASE_URL: string;
                CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
                CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
                CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
                CAMUNDA_SECURE_CONNECTION: undefined | boolean;
                CAMUNDA_SUPPORT_LOG_ENABLED: boolean;
                CAMUNDA_SUPPORT_LOG_FILE_PATH: undefined | string;
                CAMUNDA_TASKLIST_BASE_URL: string;
                CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
                CAMUNDA_TENANT_ID: string;
                CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
                CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
                CAMUNDA_TOKEN_SCOPE: undefined | string;
                CAMUNDA_ZEEBE_OAUTH_AUDIENCE: undefined | string;
                ZEEBE_ADDRESS: undefined | string;
                ZEEBE_CLIENT_ID: undefined | string;
                ZEEBE_CLIENT_SECRET: undefined | string;
                ZEEBE_GRPC_ADDRESS: undefined | string;
                ZEEBE_REST_ADDRESS: string;
                ZEEBE_TOKEN_AUDIENCE: string;
                zeebeGrpcSettings: {
                    GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                    GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                    GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                    GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | 1000;
                    GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                    GRPC_KEEPALIVE_TIME_MS: number;
                    GRPC_KEEPALIVE_TIMEOUT_MS: number;
                    GRPC_MAX_RECONNECT_BACKOFF_MS: string | 10000;
                    GRPC_MIN_RECONNECT_BACKOFF_MS: string | 5000;
                    ZEEBE_CLIENT_LOG_LEVEL: "NONE" | "DEBUG" | "INFO" | "ERROR";
                    ZEEBE_CLIENT_LOG_TYPE: "JSON" | "SIMPLE";
                    ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                    ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                    ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                    ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                    ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                    ZEEBE_GRPC_CLIENT_RETRY: boolean;
                    ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                    ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
                    ZEEBE_INSECURE_CONNECTION: undefined | boolean;
                };
            },
        >;
        oAuthProvider?: IHeadersProvider<AuthHeader>;
    },
): AdminApiClient
Parameters
- Optionaloptions: {
      config?: DeepPartial<
          {
              CAMUNDA_AUTH_STRATEGY: | "BASIC"
              | "OAUTH"
              | "BEARER"
              | "COOKIE"
              | "NONE";
              CAMUNDA_BASIC_AUTH_PASSWORD: undefined
              | string;
              CAMUNDA_BASIC_AUTH_USERNAME: undefined | string;
              CAMUNDA_CONSOLE_BASE_URL: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
              CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
              CAMUNDA_COOKIE_AUTH_PASSWORD: string;
              CAMUNDA_COOKIE_AUTH_URL: string;
              CAMUNDA_COOKIE_AUTH_USERNAME: string;
              CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
              CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
              CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
              CAMUNDA_JOB_WORKER_MAX_BACKOFF_MS: number;
              CAMUNDA_LOG_LEVEL:
                  | "none"
                  | "error"
                  | "http"
                  | "info"
                  | "warn"
                  | "verbose"
                  | "debug"
                  | "silly";
              CAMUNDA_MODELER_BASE_URL: string;
              CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined
              | string;
              CAMUNDA_OAUTH_DISABLED: boolean;
              CAMUNDA_OAUTH_FAIL_ON_ERROR: boolean;
              CAMUNDA_OAUTH_TOKEN: undefined | string;
              CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
              CAMUNDA_OAUTH_URL: undefined | string;
              CAMUNDA_OPERATE_BASE_URL: string;
              CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
              CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
              CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
              CAMUNDA_SECURE_CONNECTION: undefined | boolean;
              CAMUNDA_SUPPORT_LOG_ENABLED: boolean;
              CAMUNDA_SUPPORT_LOG_FILE_PATH: undefined | string;
              CAMUNDA_TASKLIST_BASE_URL: string;
              CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
              CAMUNDA_TENANT_ID: string;
              CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
              CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
              CAMUNDA_TOKEN_SCOPE: undefined | string;
              CAMUNDA_ZEEBE_OAUTH_AUDIENCE: undefined | string;
              ZEEBE_ADDRESS: undefined | string;
              ZEEBE_CLIENT_ID: undefined | string;
              ZEEBE_CLIENT_SECRET: undefined | string;
              ZEEBE_GRPC_ADDRESS: undefined | string;
              ZEEBE_REST_ADDRESS: string;
              ZEEBE_TOKEN_AUDIENCE: string;
              zeebeGrpcSettings: {
                  GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                  GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                  GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                  GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | 1000;
                  GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                  GRPC_KEEPALIVE_TIME_MS: number;
                  GRPC_KEEPALIVE_TIMEOUT_MS: number;
                  GRPC_MAX_RECONNECT_BACKOFF_MS: string | 10000;
                  GRPC_MIN_RECONNECT_BACKOFF_MS: string | 5000;
                  ZEEBE_CLIENT_LOG_LEVEL: "NONE" | "DEBUG" | "INFO" | "ERROR";
                  ZEEBE_CLIENT_LOG_TYPE: "JSON" | "SIMPLE";
                  ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                  ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                  ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                  ZEEBE_GRPC_CLIENT_RETRY: boolean;
                  ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                  ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
                  ZEEBE_INSECURE_CONNECTION: undefined | boolean;
              };
          },
      >;
      oAuthProvider?: IHeadersProvider<AuthHeader>;
  }
Returns AdminApiClient
- Defined in src/admin/lib/AdminApiClient.ts:31

Methods

activateMonitoring

activateMonitoring(clusterUuid: string): Promise<void>
Activate External Monitoring (BYOM) for a cluster. See the API Documentation for more details.
Parameters
- clusterUuid: string
  The cluster UUID
Returns Promise<void>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:515

activateSecureConnectivity

activateSecureConnectivity(
clusterUuid: string,
request: ActivateSecureConnectivityBody,
): Promise<void>
Activate Secure Connectivity for a cluster. See the API Documentation for more details.
Parameters
- clusterUuid: string
  The cluster UUID
- request: ActivateSecureConnectivityBody
  The allowed principals and regions
Returns Promise<void>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:467

createBackup

createBackup(clusterUuid: string): Promise<Backup>
Create a new backup for a cluster. See the API Documentation for more details.
Parameters
- clusterUuid: string
  The cluster UUID
Returns Promise<Backup>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:635

createClient

createClient(
req: { clientName: string; clusterUuid: string; permissions: string[] },
): Promise<CreatedClusterClient>
Create a new API client for a cluster. See the API Documentation for more details.
Parameters
- req: { clientName: string; clusterUuid: string; permissions: string[] }
Returns Promise<CreatedClusterClient>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:101

createCluster

createCluster(
createClusterRequest: CreateClusterBody,
): Promise<{ clusterId: string }>
Create a new cluster. See the API Documentation for more details.
Parameters
- createClusterRequest: CreateClusterBody
Returns Promise<{ clusterId: string }>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:171

createMember

createMember(email: string, orgRoles: OrganizationRole[]): Promise<null>
Add a member. See the API Documentation for more details.
Parameters
- email: string
- orgRoles: OrganizationRole[]
Returns Promise<null>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:326

createMonitoringClient

createMonitoringClient(
clusterUuid: string,
username: string,
): Promise<CreatedMonitoringClient>
Create a new External Monitoring client for a cluster. See the API Documentation for more details.
Parameters
- clusterUuid: string
  The cluster UUID
- username: string
  The username for the monitoring client
Returns Promise<CreatedMonitoringClient>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:560

createSecret

createSecret(
    __namedParameters: {
        clusterUuid: string;
        secretName: string;
        secretValue: string;
    },
): Promise<null>
Create a new connector secret. See the API Documentation for more details.
Parameters
- __namedParameters: { clusterUuid: string; secretName: string; secretValue: string }
Returns Promise<null>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:244

deactivateMonitoring

deactivateMonitoring(clusterUuid: string): Promise<void>
Deactivate External Monitoring (BYOM) for a cluster. See the API Documentation for more details.
Parameters
- clusterUuid: string
  The cluster UUID
Returns Promise<void>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:529

deactivateSecureConnectivity

deactivateSecureConnectivity(clusterUuid: string): Promise<void>
Deactivate Secure Connectivity for a cluster. See the API Documentation for more details.
Parameters
- clusterUuid: string
  The cluster UUID
Returns Promise<void>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:485

deleteBackup

deleteBackup(clusterUuid: string, backupId: string): Promise<Backup>
Delete a backup. See the API Documentation for more details.
Parameters
- clusterUuid: string
  The cluster UUID
- backupId: string
  The backup ID
Returns Promise<Backup>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:652

deleteClient

deleteClient(clusterUuid: string, clientId: string): Promise<null>
See the API Documentation for more details.
Parameters
- clusterUuid: string
- clientId: string
Returns Promise<null>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:143

deleteCluster

deleteCluster(clusterUuid: string): Promise<null>
Delete a cluster. See the API Documentation for more details.
Parameters
- clusterUuid: string
Returns Promise<null>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:203

deleteMember

deleteMember(email: string): Promise<null>
Delete a member from your organization. See the API Documentation for more details.
Parameters
- email: string
Returns Promise<null>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:346

deleteMonitoringClient

deleteMonitoringClient(clusterUuid: string, clientUuid: string): Promise<void>
Delete an External Monitoring client. See the API Documentation for more details.
Parameters
- clusterUuid: string
  The cluster UUID
- clientUuid: string
  The monitoring client UUID
Returns Promise<void>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:601

deleteSecret

deleteSecret(clusterUuid: string, secretName: string): Promise<null>
Delete a connector secret. See the API Documentation for more details.
Parameters
- clusterUuid: string
- secretName: string
Returns Promise<null>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:267

getActivityEvents

getActivityEvents(): Promise<AuditEvent[]>
Fetch all activity/audit events as JSON. See the API Documentation for more details.

Returns Promise<AuditEvent[]>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:670

getActivityEventsCsv

getActivityEventsCsv(): Promise<string>
Fetch all activity/audit events as CSV. See the API Documentation for more details.

Returns Promise<string>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:683

getBackups

getBackups(clusterUuid: string): Promise<Backup[]>
Get all backups for a cluster. See the API Documentation for more details.
Parameters
- clusterUuid: string
  The cluster UUID
Returns Promise<Backup[]>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:621

getClient

getClient(
clusterUuid: string,
clientId: string,
): Promise<ClusterClientConnectionDetails>
Get the details of an API client. See the API Documentation for more details.
Parameters
- clusterUuid: string
- clientId: string
Returns Promise<ClusterClientConnectionDetails>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:126

getClients

getClients(clusterUuid: string): Promise<ClusterClient[]>
Get an array of the current API clients for this cluster. See the API Documentation for more details.
Parameters
- clusterUuid: string
  The cluster UUID
Returns Promise<ClusterClient[]>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:89

getCluster

getCluster(clusterUuid: string): Promise<Cluster>
Retrieve the metadata for a cluster. See the API Documentation for more details.
Parameters
- clusterUuid: string
Returns Promise<Cluster>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:189

getClusters

getClusters(): Promise<Cluster[]>
Return an array of clusters. See the API Documentation for more details.

Returns Promise<Cluster[]>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:158

getIpRanges

getIpRanges(): Promise<MetaDto>
Get the egress IP ranges for Camunda SaaS. See the API Documentation for more details.

Returns Promise<MetaDto>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:361

getMonitoringClients

getMonitoringClients(clusterUuid: string): Promise<MonitoringClientsResponse>
Get all External Monitoring clients for a cluster. See the API Documentation for more details.
Parameters
- clusterUuid: string
  The cluster UUID
Returns Promise<MonitoringClientsResponse>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:543

getParameters

getParameters(): Promise<Parameters>
Retrieve the available parameters for cluster creation. See the API Documentation for more details.

Returns Promise<Parameters>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:218

getSecrets

getSecrets(clusterUuid: string): Promise<{ [key: string]: string }>
Retrieve the connector secrets. See the API Documentation for more details.
Parameters
- clusterUuid: string
Returns Promise<{ [key: string]: string }>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:231

getSecureConnectivityStatus

getSecureConnectivityStatus(
clusterUuid: string,
): Promise<SecureConnectivityStatusResponse>
Get the Secure Connectivity status for a cluster. See the API Documentation for more details.
Parameters
- clusterUuid: string
  The cluster UUID
Returns Promise<SecureConnectivityStatusResponse>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:499

getUsers

getUsers(): Promise<Member[]>
Retrieve a list of members and pending invites for your organisation. See the API Documentation for more details.

Returns Promise<Member[]>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:310

rotateMonitoringClientPassword

rotateMonitoringClientPassword(
clusterUuid: string,
clientUuid: string,
): Promise<CreatedMonitoringClient>
Rotate the password for an External Monitoring client. See the API Documentation for more details.
Parameters
- clusterUuid: string
  The cluster UUID
- clientUuid: string
  The monitoring client UUID
Returns Promise<CreatedMonitoringClient>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:581

updateCluster

updateCluster(
clusterUuid: string,
updateRequest: UpdateClusterBody,
): Promise<void>
Update a cluster's name, description, or stage label. See the API Documentation for more details.
Parameters
- clusterUuid: string
  The cluster UUID
- updateRequest: UpdateClusterBody
  The fields to update
Returns Promise<void>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:376

updateIpAllowlist

updateIpAllowlist(
clusterUuid: string,
ipallowlist: IpAllowListEntry[],
): Promise<void>
Update the IP allowlist for a cluster. See the API Documentation for more details.
Parameters
- clusterUuid: string
  The cluster UUID
- ipallowlist: IpAllowListEntry[]
  Array of IP allowlist entries
Returns Promise<void>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:427

updateSecret

updateSecret(
    clusterUuid: string,
    secretName: string,
    secretValue: string,
): Promise<void>
Update a connector secret value. See the API Documentation for more details.
Parameters
- clusterUuid: string
  The cluster UUID
- secretName: string
  The name of the secret to update
- secretValue: string
  The new secret value
Returns Promise<void>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:447

upgradeCluster

upgradeCluster(clusterUuid: string): Promise<GenerationUpgradeForClusterDto>
Upgrade a cluster to the latest available generation. See the API Documentation for more details.
Parameters
- clusterUuid: string
  The cluster UUID
Returns Promise<GenerationUpgradeForClusterDto>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:394

wakeCluster

wakeCluster(clusterUuid: string): Promise<void>
Resume a suspended cluster. See the API Documentation for more details.
Parameters
- clusterUuid: string
  The cluster UUID
Returns Promise<void>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:412

whitelistIPs

whitelistIPs(
clusterUuid: string,
ipwhitelist: [{ description: string; ip: string }],
): Promise<null>
Add one or more IPs to the whitelist for the cluster. See the API Documentation for more details.
Parameters
- clusterUuid: string
- ipwhitelist: [{ description: string; ip: string }]
Returns Promise<null>
Throws
- Defined in src/admin/lib/AdminApiClient.ts:284

Class AdminApiClient

Throws

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AdminApiClient

Methods

activateMonitoring

Parameters

Returns Promise<void>

Throws

activateSecureConnectivity

Parameters

Returns Promise<void>

Throws

createBackup

Parameters

Returns Promise<Backup>

Throws

createClient

Parameters

Returns Promise<CreatedClusterClient>

Throws

createCluster

Parameters

Returns Promise<{ clusterId: string }>

Throws

createMember

Parameters

Returns Promise<null>

Throws

createMonitoringClient

Parameters

Returns Promise<CreatedMonitoringClient>

Throws

createSecret

Parameters

Returns Promise<null>

Throws

deactivateMonitoring

Parameters

Returns Promise<void>

Throws

deactivateSecureConnectivity

Parameters

Returns Promise<void>

Throws

deleteBackup

Parameters

Returns Promise<Backup>

Throws

deleteClient

Parameters

Returns Promise<null>

Throws

deleteCluster

Parameters

Returns Promise<null>

Throws

deleteMember

Parameters

Returns Promise<null>

Throws

deleteMonitoringClient

Parameters

Returns Promise<void>

Throws

deleteSecret

Parameters

Returns Promise<null>

Throws

getActivityEvents

Returns Promise<AuditEvent[]>

Throws

getActivityEventsCsv

Returns Promise<string>

Throws