Class ConsoleApiClient

Hierarchy

ConsoleApiClient

Index

Constructors

Properties

Methods

createClient createCluster createSecret deleteClient deleteCluster deleteSecret getClient getClients getCluster getClusters getParameters getSecrets whitelistIPs

Constructors

constructor

new ConsoleApiClient(userAgent?: string): ConsoleApiClient
Parameters
- Optional userAgent: string
Returns ConsoleApiClient
- Defined in node_modules/camunda-console-client/dist/lib/ConsoleAPIClient.d.ts:5

Properties

`Private` getHeaders

getHeaders: any

`Private` gotOptions

gotOptions: any

`Private` userAgentString

userAgentString: any

Methods

createClient

createClient(req: {
    clientName: string;
    clusterUuid: string;
    permissions: string[];
}): Promise<CreatedClusterClient>
Description
Create a new API client for a cluster. See the API Documentation for more details.

Returns
Parameters
- req: {
      clientName: string;
      clusterUuid: string;
      permissions: string[];
  }
  - clientName: string
  - clusterUuid: string
  - permissions: string[]
Returns Promise<CreatedClusterClient>
- Defined in node_modules/camunda-console-client/dist/lib/ConsoleAPIClient.d.ts:18

createCluster

createCluster(createClusterRequest: CreateClusterBody): Promise<{
clusterId: string;
}>
Description
Create a new cluster. See the API Documentation for more details.
Parameters
- createClusterRequest: CreateClusterBody
Returns Promise<{
clusterId: string;
}>
- Defined in node_modules/camunda-console-client/dist/lib/ConsoleAPIClient.d.ts:45

createSecret

createSecret(__namedParameters: {
    clusterUuid: string;
    secretName: string;
    secretValue: string;
}): Promise<null>
Description
Create a new connector secret. See the API Documentation for more details.
Parameters
- __namedParameters: {
      clusterUuid: string;
      secretName: string;
      secretValue: string;
  }
  - clusterUuid: string
  - secretName: string
  - secretValue: string
Returns Promise<null>
- Defined in node_modules/camunda-console-client/dist/lib/ConsoleAPIClient.d.ts:76

deleteClient

deleteClient(clusterUuid: string, clientId: string): Promise<null>
Description
See the API Documentation for more details.
Parameters
- clusterUuid: string
- clientId: string
Returns Promise<null>
- Defined in node_modules/camunda-console-client/dist/lib/ConsoleAPIClient.d.ts:35

deleteCluster

deleteCluster(clusterUuid: string): Promise<null>
Description
Delete a cluster. See the API Documentation for more details.
Parameters
- clusterUuid: string
Returns Promise<null>
- Defined in node_modules/camunda-console-client/dist/lib/ConsoleAPIClient.d.ts:59

deleteSecret

deleteSecret(clusterUuid: string, secretName: string): Promise<null>
Description
Delete a connector secret. See the API Documentation for more details.
Parameters
- clusterUuid: string
- secretName: string
Returns Promise<null>
- Defined in node_modules/camunda-console-client/dist/lib/ConsoleAPIClient.d.ts:85

getClient

getClient(clusterUuid: string, clientId: string): Promise<ClusterClientConnectionDetails>
Description
Get the details of an API client. See the API Documentation for more details.

Returns
Parameters
- clusterUuid: string
- clientId: string
Returns Promise<ClusterClientConnectionDetails>
- Defined in node_modules/camunda-console-client/dist/lib/ConsoleAPIClient.d.ts:29

getClients

getClients(clusterUuid: string): Promise<ClusterClient[]>
Description
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[]>
- Defined in node_modules/camunda-console-client/dist/lib/ConsoleAPIClient.d.ts:13

getCluster

getCluster(clusterUuid: string): Promise<Cluster>
Description
Retrieve the metadata for a cluster. See the API Documentation for more details.
Parameters
- clusterUuid: string
Returns Promise<Cluster>
- Defined in node_modules/camunda-console-client/dist/lib/ConsoleAPIClient.d.ts:53

getClusters

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

Returns Promise<Cluster[]>
- Defined in node_modules/camunda-console-client/dist/lib/ConsoleAPIClient.d.ts:40

getParameters

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

Returns Promise<Parameters>
- Defined in node_modules/camunda-console-client/dist/lib/ConsoleAPIClient.d.ts:64

getSecrets

getSecrets(clusterUuid: string): Promise<{
[key: string]: string;
}>
Description
Retrieve the connector secrets. See the API Documentation for more details.
Parameters
- clusterUuid: string
Returns Promise<{
[key: string]: string;
}>
- Defined in node_modules/camunda-console-client/dist/lib/ConsoleAPIClient.d.ts:69

whitelistIPs

whitelistIPs(clusterUuid: string, ipwhitelist: [{
description: string;
ip: string;
}]): Promise<unknown>
Description
Add one or more IPs to the whitelist for the cluster. See the API Documentation for more details.

Returns
Parameters
- clusterUuid: string
- ipwhitelist: [{
  description: string;
  ip: string;
  }]
Returns Promise<unknown>
- Defined in node_modules/camunda-console-client/dist/lib/ConsoleAPIClient.d.ts:92

Class ConsoleApiClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional userAgent: string

Returns ConsoleApiClient

Properties

Private getHeaders

Private gotOptions

Private userAgentString

Methods

createClient

Description

Returns

Parameters

req: { clientName: string; clusterUuid: string; permissions: string[]; }

clientName: string

clusterUuid: string

permissions: string[]

Returns Promise<CreatedClusterClient>

createCluster

Description

Parameters

createClusterRequest: CreateClusterBody

Returns Promise<{ clusterId: string; }>

createSecret

Description

Parameters

__namedParameters: { clusterUuid: string; secretName: string; secretValue: string; }

clusterUuid: string

secretName: string

secretValue: string

Returns Promise<null>

deleteClient

Description

Parameters

clusterUuid: string

clientId: string

Returns Promise<null>

deleteCluster

Description

Parameters

clusterUuid: string

Returns Promise<null>

deleteSecret

Description

Parameters

clusterUuid: string

secretName: string

Returns Promise<null>

getClient

Description

Returns

Parameters

clusterUuid: string

clientId: string

Returns Promise<ClusterClientConnectionDetails>

getClients

Description

Parameters

clusterUuid: string

Returns Promise<ClusterClient[]>

getCluster

Description

Parameters

clusterUuid: string

Returns Promise<Cluster>

getClusters

Description

Returns Promise<Cluster[]>

getParameters

Description

Returns Promise<Parameters>

getSecrets

Description

`Optional` userAgent: string

`Private` getHeaders

`Private` gotOptions

`Private` userAgentString

req: {
clientName: string;
clusterUuid: string;
permissions: string[];
}

Returns Promise<{
clusterId: string;
}>

__namedParameters: {
clusterUuid: string;
secretName: string;
secretValue: string;
}

Returns Promise<{
[key: string]: string;
}>

ipwhitelist: [{
description: string;
ip: string;
}]