Class KeyManagementApi

Hierarchy

KeyManagementApi

Index

Constructors

Properties

configuration requestFactory responseProcessor

Methods

createAPIKey createApplicationKey deleteAPIKey deleteApplicationKey getAPIKey getApplicationKey listAPIKeys listApplicationKeys updateAPIKey updateApplicationKey

Constructors

constructor

new KeyManagementApi(configuration: Configuration, requestFactory?: KeyManagementApiRequestFactory, responseProcessor?: KeyManagementApiResponseProcessor): v1.KeyManagementApi
Parameters
- configuration: Configuration
- Optional requestFactory: KeyManagementApiRequestFactory
- Optional responseProcessor: KeyManagementApiResponseProcessor
Returns v1.KeyManagementApi
- Defined in packages/datadog-api-client-v1/apis/KeyManagementApi.ts:1081

Properties

`Private` configuration

configuration: Configuration

`Private` requestFactory

requestFactory: KeyManagementApiRequestFactory

`Private` responseProcessor

responseProcessor: KeyManagementApiResponseProcessor

Methods

createAPIKey

createAPIKey(param: v1.KeyManagementApiCreateAPIKeyRequest, options?: Configuration): Promise<ApiKeyResponse>
Creates an API key with a given name.
Parameters
- param: v1.KeyManagementApiCreateAPIKeyRequest
  
  The request object
- Optional options: Configuration
Returns Promise<ApiKeyResponse>
- Defined in packages/datadog-api-client-v1/apis/KeyManagementApi.ts:1097

createApplicationKey

createApplicationKey(param: KeyManagementApiCreateApplicationKeyRequest, options?: Configuration): Promise<v1.ApplicationKeyResponse>
Create an application key with a given name.
Parameters
- param: KeyManagementApiCreateApplicationKeyRequest
  
  The request object
- Optional options: Configuration
Returns Promise<v1.ApplicationKeyResponse>
- Defined in packages/datadog-api-client-v1/apis/KeyManagementApi.ts:1118

deleteAPIKey

deleteAPIKey(param: v1.KeyManagementApiDeleteAPIKeyRequest, options?: Configuration): Promise<ApiKeyResponse>
Delete a given API key.
Parameters
- param: v1.KeyManagementApiDeleteAPIKeyRequest
  
  The request object
- Optional options: Configuration
Returns Promise<ApiKeyResponse>
- Defined in packages/datadog-api-client-v1/apis/KeyManagementApi.ts:1139

deleteApplicationKey

deleteApplicationKey(param: v1.KeyManagementApiDeleteApplicationKeyRequest, options?: Configuration): Promise<v1.ApplicationKeyResponse>
Delete a given application key.
Parameters
- param: v1.KeyManagementApiDeleteApplicationKeyRequest
  
  The request object
- Optional options: Configuration
Returns Promise<v1.ApplicationKeyResponse>
- Defined in packages/datadog-api-client-v1/apis/KeyManagementApi.ts:1160

getAPIKey

getAPIKey(param: v1.KeyManagementApiGetAPIKeyRequest, options?: Configuration): Promise<ApiKeyResponse>
Get a given API key.
Parameters
- param: v1.KeyManagementApiGetAPIKeyRequest
  
  The request object
- Optional options: Configuration
Returns Promise<ApiKeyResponse>
- Defined in packages/datadog-api-client-v1/apis/KeyManagementApi.ts:1181

getApplicationKey

getApplicationKey(param: v1.KeyManagementApiGetApplicationKeyRequest, options?: Configuration): Promise<v1.ApplicationKeyResponse>
Get a given application key.
Parameters
- param: v1.KeyManagementApiGetApplicationKeyRequest
  
  The request object
- Optional options: Configuration
Returns Promise<v1.ApplicationKeyResponse>
- Defined in packages/datadog-api-client-v1/apis/KeyManagementApi.ts:1202

listAPIKeys

listAPIKeys(options?: Configuration): Promise<ApiKeyListResponse>
Get all API keys available for your account.
Parameters
- Optional options: Configuration
Returns Promise<ApiKeyListResponse>
- Defined in packages/datadog-api-client-v1/apis/KeyManagementApi.ts:1223

listApplicationKeys

listApplicationKeys(options?: Configuration): Promise<ApplicationKeyListResponse>
Get all application keys available for your Datadog account.
Parameters
- Optional options: Configuration
Returns Promise<ApplicationKeyListResponse>
- Defined in packages/datadog-api-client-v1/apis/KeyManagementApi.ts:1238

updateAPIKey

updateAPIKey(param: v1.KeyManagementApiUpdateAPIKeyRequest, options?: Configuration): Promise<ApiKeyResponse>
Edit an API key name.
Parameters
- param: v1.KeyManagementApiUpdateAPIKeyRequest
  
  The request object
- Optional options: Configuration
Returns Promise<ApiKeyResponse>
- Defined in packages/datadog-api-client-v1/apis/KeyManagementApi.ts:1256

updateApplicationKey

updateApplicationKey(param: v1.KeyManagementApiUpdateApplicationKeyRequest, options?: Configuration): Promise<v1.ApplicationKeyResponse>
Edit an application key name.
Parameters
- param: v1.KeyManagementApiUpdateApplicationKeyRequest
  
  The request object
- Optional options: Configuration
Returns Promise<v1.ApplicationKeyResponse>
- Defined in packages/datadog-api-client-v1/apis/KeyManagementApi.ts:1278

Generated using TypeDoc