Class KeyManagementApi

Hierarchy

KeyManagementApi

Index

Constructors

Properties

configuration requestFactory responseProcessor

Methods

createAPIKey createCurrentUserApplicationKey deleteAPIKey deleteApplicationKey deleteCurrentUserApplicationKey getAPIKey getApplicationKey getCurrentUserApplicationKey listAPIKeys listApplicationKeys listCurrentUserApplicationKeys updateAPIKey updateApplicationKey updateCurrentUserApplicationKey

Constructors

constructor

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

Properties

`Private` configuration

configuration: Configuration

`Private` requestFactory

requestFactory: KeyManagementApiRequestFactory

`Private` responseProcessor

responseProcessor: KeyManagementApiResponseProcessor

Methods

createAPIKey

createAPIKey(param: v2.KeyManagementApiCreateAPIKeyRequest, options?: Configuration): Promise<APIKeyResponse>
Create an API key.
Parameters
- param: v2.KeyManagementApiCreateAPIKeyRequest
  
  The request object
- Optional options: Configuration
Returns Promise<APIKeyResponse>
- Defined in packages/datadog-api-client-v2/apis/KeyManagementApi.ts:1895

createCurrentUserApplicationKey

createCurrentUserApplicationKey(param: KeyManagementApiCreateCurrentUserApplicationKeyRequest, options?: Configuration): Promise<v2.ApplicationKeyResponse>
Create an application key for current user
Parameters
- param: KeyManagementApiCreateCurrentUserApplicationKeyRequest
  
  The request object
- Optional options: Configuration
Returns Promise<v2.ApplicationKeyResponse>
- Defined in packages/datadog-api-client-v2/apis/KeyManagementApi.ts:1916

deleteAPIKey

deleteAPIKey(param: v2.KeyManagementApiDeleteAPIKeyRequest, options?: Configuration): Promise<void>
Delete an API key.
Parameters
- param: v2.KeyManagementApiDeleteAPIKeyRequest
  
  The request object
- Optional options: Configuration
Returns Promise<void>
- Defined in packages/datadog-api-client-v2/apis/KeyManagementApi.ts:1937

deleteApplicationKey

deleteApplicationKey(param: v2.KeyManagementApiDeleteApplicationKeyRequest, options?: Configuration): Promise<void>
Delete an application key
Parameters
- param: v2.KeyManagementApiDeleteApplicationKeyRequest
  
  The request object
- Optional options: Configuration
Returns Promise<void>
- Defined in packages/datadog-api-client-v2/apis/KeyManagementApi.ts:1958

deleteCurrentUserApplicationKey

deleteCurrentUserApplicationKey(param: KeyManagementApiDeleteCurrentUserApplicationKeyRequest, options?: Configuration): Promise<void>
Delete an application key owned by current user
Parameters
- param: KeyManagementApiDeleteCurrentUserApplicationKeyRequest
  
  The request object
- Optional options: Configuration
Returns Promise<void>
- Defined in packages/datadog-api-client-v2/apis/KeyManagementApi.ts:1979

listAPIKeys

listAPIKeys(param?: KeyManagementApiListAPIKeysRequest, options?: Configuration): Promise<APIKeysResponse>
List all API keys available for your account.
Parameters
- param: KeyManagementApiListAPIKeysRequest = {}
  
  The request object
- Optional options: Configuration
Returns Promise<APIKeysResponse>
- Defined in packages/datadog-api-client-v2/apis/KeyManagementApi.ts:2068

listApplicationKeys

listApplicationKeys(param?: KeyManagementApiListApplicationKeysRequest, options?: Configuration): Promise<ListApplicationKeysResponse>
List all application keys available for your org
Parameters
- param: KeyManagementApiListApplicationKeysRequest = {}
  
  The request object
- Optional options: Configuration
Returns Promise<ListApplicationKeysResponse>
- Defined in packages/datadog-api-client-v2/apis/KeyManagementApi.ts:2099

listCurrentUserApplicationKeys

listCurrentUserApplicationKeys(param?: KeyManagementApiListCurrentUserApplicationKeysRequest, options?: Configuration): Promise<ListApplicationKeysResponse>
List all application keys available for current user
Parameters
- param: KeyManagementApiListCurrentUserApplicationKeysRequest = {}
  
  The request object
- Optional options: Configuration
Returns Promise<ListApplicationKeysResponse>
- Defined in packages/datadog-api-client-v2/apis/KeyManagementApi.ts:2126

updateAPIKey

updateAPIKey(param: v2.KeyManagementApiUpdateAPIKeyRequest, options?: Configuration): Promise<APIKeyResponse>
Update an API key.
Parameters
- param: v2.KeyManagementApiUpdateAPIKeyRequest
  
  The request object
- Optional options: Configuration
Returns Promise<APIKeyResponse>
- Defined in packages/datadog-api-client-v2/apis/KeyManagementApi.ts:2156

updateApplicationKey

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

updateCurrentUserApplicationKey

updateCurrentUserApplicationKey(param: KeyManagementApiUpdateCurrentUserApplicationKeyRequest, options?: Configuration): Promise<v2.ApplicationKeyResponse>
Edit an application key owned by current user
Parameters
- param: KeyManagementApiUpdateCurrentUserApplicationKeyRequest
  
  The request object
- Optional options: Configuration
Returns Promise<v2.ApplicationKeyResponse>
- Defined in packages/datadog-api-client-v2/apis/KeyManagementApi.ts:2200

Class KeyManagementApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration

Optional requestFactory: KeyManagementApiRequestFactory

Optional responseProcessor: KeyManagementApiResponseProcessor

Returns v2.KeyManagementApi

Properties

Private configuration

Private requestFactory

Private responseProcessor

Methods

createAPIKey

Parameters

param: v2.KeyManagementApiCreateAPIKeyRequest

Optional options: Configuration

Returns Promise<APIKeyResponse>

createCurrentUserApplicationKey

Parameters

param: KeyManagementApiCreateCurrentUserApplicationKeyRequest

Optional options: Configuration

Returns Promise<v2.ApplicationKeyResponse>

deleteAPIKey

Parameters

param: v2.KeyManagementApiDeleteAPIKeyRequest

Optional options: Configuration

Returns Promise<void>

deleteApplicationKey

Parameters

param: v2.KeyManagementApiDeleteApplicationKeyRequest

Optional options: Configuration

Returns Promise<void>

deleteCurrentUserApplicationKey

Parameters

param: KeyManagementApiDeleteCurrentUserApplicationKeyRequest

Optional options: Configuration

Returns Promise<void>

getAPIKey

Parameters

param: v2.KeyManagementApiGetAPIKeyRequest

Optional options: Configuration

Returns Promise<APIKeyResponse>

getApplicationKey

Parameters

param: v2.KeyManagementApiGetApplicationKeyRequest

Optional options: Configuration

Returns Promise<v2.ApplicationKeyResponse>

getCurrentUserApplicationKey

Parameters

param: KeyManagementApiGetCurrentUserApplicationKeyRequest

Optional options: Configuration

Returns Promise<v2.ApplicationKeyResponse>

listAPIKeys

Parameters

param: KeyManagementApiListAPIKeysRequest = {}

Optional options: Configuration

Returns Promise<APIKeysResponse>

listApplicationKeys

Parameters

param: KeyManagementApiListApplicationKeysRequest = {}

Optional options: Configuration

Returns Promise<ListApplicationKeysResponse>

listCurrentUserApplicationKeys

Parameters

param: KeyManagementApiListCurrentUserApplicationKeysRequest = {}

Optional options: Configuration

Returns Promise<ListApplicationKeysResponse>

updateAPIKey

Parameters

param: v2.KeyManagementApiUpdateAPIKeyRequest

Optional options: Configuration

Returns Promise<APIKeyResponse>

updateApplicationKey

Parameters

`Optional` requestFactory: KeyManagementApiRequestFactory

`Optional` responseProcessor: KeyManagementApiResponseProcessor

`Private` configuration

`Private` requestFactory

`Private` responseProcessor

`Optional` options: Configuration

`Optional` options: Configuration

`Optional` options: Configuration

`Optional` options: Configuration

`Optional` options: Configuration

`Optional` options: Configuration

`Optional` options: Configuration

`Optional` options: Configuration

`Optional` options: Configuration

`Optional` options: Configuration

`Optional` options: Configuration

`Optional` options: Configuration

`Optional` options: Configuration

`Optional` options: Configuration