Package com.datadog.api.client.v1.api

Class KeyManagementApi

java.lang.Object

com.datadog.api.client.v1.api.KeyManagementApi

@Generated("https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class KeyManagementApi
extends Object

Constructor Summary

Constructors

Constructor	Description
KeyManagementApi()
KeyManagementApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiKeyResponse	createAPIKey(ApiKey body)	Create an API key.
CompletableFuture<ApiKeyResponse>	createAPIKeyAsync(ApiKey body)	Create an API key.
ApiResponse<ApiKeyResponse>	createAPIKeyWithHttpInfo(ApiKey body)	Creates an API key with a given name.
CompletableFuture<ApiResponse<ApiKeyResponse>>	createAPIKeyWithHttpInfoAsync(ApiKey body)	Create an API key.
ApplicationKeyResponse	createApplicationKey(ApplicationKey body)	Create an application key.
CompletableFuture<ApplicationKeyResponse>	createApplicationKeyAsync(ApplicationKey body)	Create an application key.
ApiResponse<ApplicationKeyResponse>	createApplicationKeyWithHttpInfo(ApplicationKey body)	Create an application key with a given name.
CompletableFuture<ApiResponse<ApplicationKeyResponse>>	createApplicationKeyWithHttpInfoAsync(ApplicationKey body)	Create an application key.
ApiKeyResponse	deleteAPIKey(String key)	Delete an API key.
CompletableFuture<ApiKeyResponse>	deleteAPIKeyAsync(String key)	Delete an API key.
ApiResponse<ApiKeyResponse>	deleteAPIKeyWithHttpInfo(String key)	Delete a given API key.
CompletableFuture<ApiResponse<ApiKeyResponse>>	deleteAPIKeyWithHttpInfoAsync(String key)	Delete an API key.
ApplicationKeyResponse	deleteApplicationKey(String key)	Delete an application key.
CompletableFuture<ApplicationKeyResponse>	deleteApplicationKeyAsync(String key)	Delete an application key.
ApiResponse<ApplicationKeyResponse>	deleteApplicationKeyWithHttpInfo(String key)	Delete a given application key.
CompletableFuture<ApiResponse<ApplicationKeyResponse>>	deleteApplicationKeyWithHttpInfoAsync(String key)	Delete an application key.
ApiClient	getApiClient()	Get the API client.
ApiKeyResponse	getAPIKey(String key)	Get API key.
CompletableFuture<ApiKeyResponse>	getAPIKeyAsync(String key)	Get API key.
ApiResponse<ApiKeyResponse>	getAPIKeyWithHttpInfo(String key)	Get a given API key.
CompletableFuture<ApiResponse<ApiKeyResponse>>	getAPIKeyWithHttpInfoAsync(String key)	Get API key.
ApplicationKeyResponse	getApplicationKey(String key)	Get an application key.
CompletableFuture<ApplicationKeyResponse>	getApplicationKeyAsync(String key)	Get an application key.
ApiResponse<ApplicationKeyResponse>	getApplicationKeyWithHttpInfo(String key)	Get a given application key.
CompletableFuture<ApiResponse<ApplicationKeyResponse>>	getApplicationKeyWithHttpInfoAsync(String key)	Get an application key.
ApiKeyListResponse	listAPIKeys()	Get all API keys.
CompletableFuture<ApiKeyListResponse>	listAPIKeysAsync()	Get all API keys.
ApiResponse<ApiKeyListResponse>	listAPIKeysWithHttpInfo()	Get all API keys available for your account.
CompletableFuture<ApiResponse<ApiKeyListResponse>>	listAPIKeysWithHttpInfoAsync()	Get all API keys.
ApplicationKeyListResponse	listApplicationKeys()	Get all application keys.
CompletableFuture<ApplicationKeyListResponse>	listApplicationKeysAsync()	Get all application keys.
ApiResponse<ApplicationKeyListResponse>	listApplicationKeysWithHttpInfo()	Get all application keys available for your Datadog account.
CompletableFuture<ApiResponse<ApplicationKeyListResponse>>	listApplicationKeysWithHttpInfoAsync()	Get all application keys.
void	setApiClient(ApiClient apiClient)	Set the API client.
ApiKeyResponse	updateAPIKey(String key, ApiKey body)	Edit an API key.
CompletableFuture<ApiKeyResponse>	updateAPIKeyAsync(String key, ApiKey body)	Edit an API key.
ApiResponse<ApiKeyResponse>	updateAPIKeyWithHttpInfo(String key, ApiKey body)	Edit an API key name.
CompletableFuture<ApiResponse<ApiKeyResponse>>	updateAPIKeyWithHttpInfoAsync(String key, ApiKey body)	Edit an API key.
ApplicationKeyResponse	updateApplicationKey(String key, ApplicationKey body)	Edit an application key.
CompletableFuture<ApplicationKeyResponse>	updateApplicationKeyAsync(String key, ApplicationKey body)	Edit an application key.
ApiResponse<ApplicationKeyResponse>	updateApplicationKeyWithHttpInfo(String key, ApplicationKey body)	Edit an application key name.
CompletableFuture<ApiResponse<ApplicationKeyResponse>>	updateApplicationKeyWithHttpInfoAsync(String key, ApplicationKey body)	Edit an application key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

KeyManagementApi

public KeyManagementApi()

KeyManagementApi

public KeyManagementApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

Get the API client.

Returns:

API client

setApiClient

public void setApiClient(ApiClient apiClient)

Set the API client.

Parameters:

apiClient - an instance of API client

createAPIKey

public ApiKeyResponse createAPIKey(ApiKey body)
                            throws ApiException

Create an API key.

See createAPIKeyWithHttpInfo(com.datadog.api.client.v1.model.ApiKey).

Parameters:

body - (required)

Returns:

ApiKeyResponse

Throws:

ApiException - if fails to make API call

createAPIKeyAsync

public CompletableFuture<ApiKeyResponse> createAPIKeyAsync(ApiKey body)

Create an API key.

See createAPIKeyWithHttpInfoAsync(com.datadog.api.client.v1.model.ApiKey).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiKeyResponse>

createAPIKeyWithHttpInfo

public ApiResponse<ApiKeyResponse> createAPIKeyWithHttpInfo(ApiKey body)
                                                     throws ApiException

Creates an API key with a given name.

Note: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the V2 Key Management endpoints instead.

Parameters:

body - (required)

Returns:

ApiResponse<ApiKeyResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
429	Too many requests	-

createAPIKeyWithHttpInfoAsync

public CompletableFuture<ApiResponse<ApiKeyResponse>> createAPIKeyWithHttpInfoAsync(ApiKey body)

Create an API key.

See createAPIKeyWithHttpInfo(com.datadog.api.client.v1.model.ApiKey).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<ApiKeyResponse>>

createApplicationKey

public ApplicationKeyResponse createApplicationKey(ApplicationKey body)
                                            throws ApiException

Create an application key.

See createApplicationKeyWithHttpInfo(com.datadog.api.client.v1.model.ApplicationKey).

Parameters:

body - (required)

Returns:

ApplicationKeyResponse

Throws:

ApiException - if fails to make API call

createApplicationKeyAsync

public CompletableFuture<ApplicationKeyResponse> createApplicationKeyAsync(ApplicationKey body)

Create an application key.

See createApplicationKeyWithHttpInfoAsync(com.datadog.api.client.v1.model.ApplicationKey).

Parameters:

body - (required)

Returns:

CompletableFuture<ApplicationKeyResponse>

createApplicationKeyWithHttpInfo

public ApiResponse<ApplicationKeyResponse> createApplicationKeyWithHttpInfo(ApplicationKey body)
                                                                     throws ApiException

Create an application key with a given name. This endpoint is disabled for organizations in One-Time Read mode.

Note: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the V2 Key Management endpoints instead.

Parameters:

body - (required)

Returns:

ApiResponse<ApplicationKeyResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
409	Conflict	-
429	Too many requests	-

createApplicationKeyWithHttpInfoAsync

public CompletableFuture<ApiResponse<ApplicationKeyResponse>> createApplicationKeyWithHttpInfoAsync(ApplicationKey body)

Create an application key.

See createApplicationKeyWithHttpInfo(com.datadog.api.client.v1.model.ApplicationKey).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<ApplicationKeyResponse>>

deleteAPIKey

public ApiKeyResponse deleteAPIKey(String key)
                            throws ApiException

Delete an API key.

See deleteAPIKeyWithHttpInfo(java.lang.String).

Parameters:

key - The specific API key you are working with. (required)

Returns:

ApiKeyResponse

Throws:

ApiException - if fails to make API call

deleteAPIKeyAsync

public CompletableFuture<ApiKeyResponse> deleteAPIKeyAsync(String key)

Delete an API key.

See deleteAPIKeyWithHttpInfoAsync(java.lang.String).

Parameters:

key - The specific API key you are working with. (required)

Returns:

CompletableFuture<ApiKeyResponse>

deleteAPIKeyWithHttpInfo

public ApiResponse<ApiKeyResponse> deleteAPIKeyWithHttpInfo(String key)
                                                     throws ApiException

Delete a given API key.

Note: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the V2 Key Management endpoints instead.

Parameters:

key - The specific API key you are working with. (required)

Returns:

ApiResponse<ApiKeyResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
404	Not Found	-
429	Too many requests	-

deleteAPIKeyWithHttpInfoAsync

public CompletableFuture<ApiResponse<ApiKeyResponse>> deleteAPIKeyWithHttpInfoAsync(String key)

Delete an API key.

See deleteAPIKeyWithHttpInfo(java.lang.String).

Parameters:

key - The specific API key you are working with. (required)

Returns:

CompletableFuture<ApiResponse<ApiKeyResponse>>

deleteApplicationKey

public ApplicationKeyResponse deleteApplicationKey(String key)
                                            throws ApiException

Delete an application key.

See deleteApplicationKeyWithHttpInfo(java.lang.String).

Parameters:

key - The specific APP key you are working with. (required)

Returns:

ApplicationKeyResponse

Throws:

ApiException - if fails to make API call

deleteApplicationKeyAsync

public CompletableFuture<ApplicationKeyResponse> deleteApplicationKeyAsync(String key)

Delete an application key.

See deleteApplicationKeyWithHttpInfoAsync(java.lang.String).

Parameters:

key - The specific APP key you are working with. (required)

Returns:

CompletableFuture<ApplicationKeyResponse>

deleteApplicationKeyWithHttpInfo

public ApiResponse<ApplicationKeyResponse> deleteApplicationKeyWithHttpInfo(String key)
                                                                     throws ApiException

Delete a given application key. This endpoint is disabled for organizations in One-Time Read mode.

Note: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the V2 Key Management endpoints instead.

Parameters:

key - The specific APP key you are working with. (required)

Returns:

ApiResponse<ApplicationKeyResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
403	Forbidden	-
404	Not Found	-
429	Too many requests	-

deleteApplicationKeyWithHttpInfoAsync

public CompletableFuture<ApiResponse<ApplicationKeyResponse>> deleteApplicationKeyWithHttpInfoAsync(String key)

Delete an application key.

See deleteApplicationKeyWithHttpInfo(java.lang.String).

Parameters:

key - The specific APP key you are working with. (required)

Returns:

CompletableFuture<ApiResponse<ApplicationKeyResponse>>

getAPIKey

public ApiKeyResponse getAPIKey(String key)
                         throws ApiException

Get API key.

See getAPIKeyWithHttpInfo(java.lang.String).

Parameters:

key - The specific API key you are working with. (required)

Returns:

ApiKeyResponse

Throws:

ApiException - if fails to make API call

getAPIKeyAsync

public CompletableFuture<ApiKeyResponse> getAPIKeyAsync(String key)

Get API key.

See getAPIKeyWithHttpInfoAsync(java.lang.String).

Parameters:

key - The specific API key you are working with. (required)

Returns:

CompletableFuture<ApiKeyResponse>

getAPIKeyWithHttpInfo

public ApiResponse<ApiKeyResponse> getAPIKeyWithHttpInfo(String key)
                                                  throws ApiException

Get a given API key.

Note: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the V2 Key Management endpoints instead.

Parameters:

key - The specific API key you are working with. (required)

Returns:

ApiResponse<ApiKeyResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
403	Forbidden	-
404	Not Found	-
429	Too many requests	-

getAPIKeyWithHttpInfoAsync

public CompletableFuture<ApiResponse<ApiKeyResponse>> getAPIKeyWithHttpInfoAsync(String key)

Get API key.

See getAPIKeyWithHttpInfo(java.lang.String).

Parameters:

key - The specific API key you are working with. (required)

Returns:

CompletableFuture<ApiResponse<ApiKeyResponse>>

getApplicationKey

public ApplicationKeyResponse getApplicationKey(String key)
                                         throws ApiException

Get an application key.

See getApplicationKeyWithHttpInfo(java.lang.String).

Parameters:

key - The specific APP key you are working with. (required)

Returns:

ApplicationKeyResponse

Throws:

ApiException - if fails to make API call

getApplicationKeyAsync

public CompletableFuture<ApplicationKeyResponse> getApplicationKeyAsync(String key)

Get an application key.

See getApplicationKeyWithHttpInfoAsync(java.lang.String).

Parameters:

key - The specific APP key you are working with. (required)

Returns:

CompletableFuture<ApplicationKeyResponse>

getApplicationKeyWithHttpInfo

public ApiResponse<ApplicationKeyResponse> getApplicationKeyWithHttpInfo(String key)
                                                                  throws ApiException

Get a given application key. This endpoint is disabled for organizations in One-Time Read mode.

Note: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the V2 Key Management endpoints instead.

Parameters:

key - The specific APP key you are working with. (required)

Returns:

ApiResponse<ApplicationKeyResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
403	Forbidden	-
404	Not Found	-
429	Too many requests	-

getApplicationKeyWithHttpInfoAsync

public CompletableFuture<ApiResponse<ApplicationKeyResponse>> getApplicationKeyWithHttpInfoAsync(String key)

Get an application key.

See getApplicationKeyWithHttpInfo(java.lang.String).

Parameters:

key - The specific APP key you are working with. (required)

Returns:

CompletableFuture<ApiResponse<ApplicationKeyResponse>>

listAPIKeys

public ApiKeyListResponse listAPIKeys()
                               throws ApiException

Get all API keys.

See listAPIKeysWithHttpInfo().

Returns:

ApiKeyListResponse

Throws:

ApiException - if fails to make API call

listAPIKeysAsync

public CompletableFuture<ApiKeyListResponse> listAPIKeysAsync()

Get all API keys.

See listAPIKeysWithHttpInfoAsync().

Returns:

CompletableFuture<ApiKeyListResponse>

listAPIKeysWithHttpInfo

public ApiResponse<ApiKeyListResponse> listAPIKeysWithHttpInfo()
                                                        throws ApiException

Get all API keys available for your account.

Note: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the V2 Key Management endpoints instead.

Returns:

ApiResponse<ApiKeyListResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
403	Forbidden	-
429	Too many requests	-

listAPIKeysWithHttpInfoAsync

public CompletableFuture<ApiResponse<ApiKeyListResponse>> listAPIKeysWithHttpInfoAsync()

Get all API keys.

See listAPIKeysWithHttpInfo().

Returns:

CompletableFuture<ApiResponse<ApiKeyListResponse>>

listApplicationKeys

public ApplicationKeyListResponse listApplicationKeys()
                                               throws ApiException

Get all application keys.

See listApplicationKeysWithHttpInfo().

Returns:

ApplicationKeyListResponse

Throws:

ApiException - if fails to make API call

listApplicationKeysAsync

public CompletableFuture<ApplicationKeyListResponse> listApplicationKeysAsync()

Get all application keys.

See listApplicationKeysWithHttpInfoAsync().

Returns:

CompletableFuture<ApplicationKeyListResponse>

listApplicationKeysWithHttpInfo

public ApiResponse<ApplicationKeyListResponse> listApplicationKeysWithHttpInfo()
                                                                        throws ApiException

Get all application keys available for your Datadog account. This endpoint is disabled for organizations in One-Time Read mode.

Note: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the V2 Key Management endpoints instead.

Returns:

ApiResponse<ApplicationKeyListResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
403	Forbidden	-
429	Too many requests	-

listApplicationKeysWithHttpInfoAsync

public CompletableFuture<ApiResponse<ApplicationKeyListResponse>> listApplicationKeysWithHttpInfoAsync()

Get all application keys.

See listApplicationKeysWithHttpInfo().

Returns:

CompletableFuture<ApiResponse<ApplicationKeyListResponse>>

updateAPIKey

public ApiKeyResponse updateAPIKey(String key,
 ApiKey body)
                            throws ApiException

Edit an API key.

See updateAPIKeyWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.ApiKey).

Parameters:

key - The specific API key you are working with. (required)

body - (required)

Returns:

ApiKeyResponse

Throws:

ApiException - if fails to make API call

updateAPIKeyAsync

public CompletableFuture<ApiKeyResponse> updateAPIKeyAsync(String key,
 ApiKey body)

Edit an API key.

See updateAPIKeyWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.model.ApiKey).

Parameters:

key - The specific API key you are working with. (required)

body - (required)

Returns:

CompletableFuture<ApiKeyResponse>

updateAPIKeyWithHttpInfo

public ApiResponse<ApiKeyResponse> updateAPIKeyWithHttpInfo(String key,
 ApiKey body)
                                                     throws ApiException

Edit an API key name.

Note: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the V2 Key Management endpoints instead.

Parameters:

key - The specific API key you are working with. (required)

body - (required)

Returns:

ApiResponse<ApiKeyResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
404	Not Found	-
429	Too many requests	-

updateAPIKeyWithHttpInfoAsync

public CompletableFuture<ApiResponse<ApiKeyResponse>> updateAPIKeyWithHttpInfoAsync(String key,
 ApiKey body)

Edit an API key.

See updateAPIKeyWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.ApiKey).

Parameters:

key - The specific API key you are working with. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<ApiKeyResponse>>

updateApplicationKey

public ApplicationKeyResponse updateApplicationKey(String key,
 ApplicationKey body)
                                            throws ApiException

Edit an application key.

See updateApplicationKeyWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.ApplicationKey).

Parameters:

key - The specific APP key you are working with. (required)

body - (required)

Returns:

ApplicationKeyResponse

Throws:

ApiException - if fails to make API call

updateApplicationKeyAsync

public CompletableFuture<ApplicationKeyResponse> updateApplicationKeyAsync(String key,
 ApplicationKey body)

Edit an application key.

See updateApplicationKeyWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.model.ApplicationKey).

Parameters:

key - The specific APP key you are working with. (required)

body - (required)

Returns:

CompletableFuture<ApplicationKeyResponse>

updateApplicationKeyWithHttpInfo

public ApiResponse<ApplicationKeyResponse> updateApplicationKeyWithHttpInfo(String key,
 ApplicationKey body)
                                                                     throws ApiException

Edit an application key name. This endpoint is disabled for organizations in One-Time Read mode.

Note: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the V2 Key Management endpoints instead.

Parameters:

key - The specific APP key you are working with. (required)

body - (required)

Returns:

ApiResponse<ApplicationKeyResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
404	Not Found	-
409	Conflict	-
429	Too many requests	-

updateApplicationKeyWithHttpInfoAsync

public CompletableFuture<ApiResponse<ApplicationKeyResponse>> updateApplicationKeyWithHttpInfoAsync(String key,
 ApplicationKey body)

Edit an application key.

See updateApplicationKeyWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.ApplicationKey).

Parameters:

key - The specific APP key you are working with. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<ApplicationKeyResponse>>