Struct datadog_api_client::datadogV2::api::api_key_management::KeyManagementAPI

source · 
pub struct KeyManagementAPI { /* private fields */ }
Expand description

Manage your Datadog API and application keys. You need an API key and an application key for a user with the required permissions to interact with these endpoints. The full list of API and application keys can be seen on your Datadog API page.

Implementations§

source§

impl KeyManagementAPI

source

pub fn new() -> Self

source

pub fn with_config(config: Configuration) -> Self

Examples found in repository?
examples/v2_key-management_GetCurrentUserApplicationKey.rs (line 8)
6
7
8
9
10
11
12
13
14
15
16
17

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = KeyManagementAPI::with_config(configuration);
    let resp = api
        .get_current_user_application_key("app_key_id".to_string())
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}
More examples
Hide additional examples
examples/v2_key-management_ListApplicationKeys.rs (line 9)
7
8
9
10
11
12
13
14
15
16
17
18

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = KeyManagementAPI::with_config(configuration);
    let resp = api
        .list_application_keys(ListApplicationKeysOptionalParams::default())
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}
examples/v2_key-management_ListCurrentUserApplicationKeys.rs (line 9)
7
8
9
10
11
12
13
14
15
16
17
18

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = KeyManagementAPI::with_config(configuration);
    let resp = api
        .list_current_user_application_keys(ListCurrentUserApplicationKeysOptionalParams::default())
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}
examples/v2_key-management_DeleteAPIKey.rs (line 10)
6
7
8
9
10
11
12
13
14
15
16
17

async fn main() {
    // there is a valid "api_key" in the system
    let api_key_data_id = std::env::var("API_KEY_DATA_ID").unwrap();
    let configuration = datadog::Configuration::new();
    let api = KeyManagementAPI::with_config(configuration);
    let resp = api.delete_api_key(api_key_data_id.clone()).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}
examples/v2_key-management_CreateAPIKey.rs (line 16)
10
11
12
13
14
15
16
17
18
19
20
21
22
23

async fn main() {
    let body = APIKeyCreateRequest::new(APIKeyCreateData::new(
        APIKeyCreateAttributes::new("Example-Key-Management".to_string()),
        APIKeysType::API_KEYS,
    ));
    let configuration = datadog::Configuration::new();
    let api = KeyManagementAPI::with_config(configuration);
    let resp = api.create_api_key(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}
examples/v2_key-management_GetAPIKey.rs (line 11)
7
8
9
10
11
12
13
14
15
16
17
18
19
20

async fn main() {
    // there is a valid "api_key" in the system
    let api_key_data_id = std::env::var("API_KEY_DATA_ID").unwrap();
    let configuration = datadog::Configuration::new();
    let api = KeyManagementAPI::with_config(configuration);
    let resp = api
        .get_api_key(api_key_data_id.clone(), GetAPIKeyOptionalParams::default())
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}
Additional examples can be found in:
source

pub fn with_client_and_config( config: Configuration, client: ClientWithMiddleware, ) -> Self

source

pub async fn create_api_key( &self, body: APIKeyCreateRequest, ) -> Result<APIKeyResponse, Error<CreateAPIKeyError>>

Create an API key.

Examples found in repository?
examples/v2_key-management_CreateAPIKey.rs (line 17)
10
11
12
13
14
15
16
17
18
19
20
21
22
23

async fn main() {
    let body = APIKeyCreateRequest::new(APIKeyCreateData::new(
        APIKeyCreateAttributes::new("Example-Key-Management".to_string()),
        APIKeysType::API_KEYS,
    ));
    let configuration = datadog::Configuration::new();
    let api = KeyManagementAPI::with_config(configuration);
    let resp = api.create_api_key(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}
source

pub async fn create_api_key_with_http_info( &self, body: APIKeyCreateRequest, ) -> Result<ResponseContent<APIKeyResponse>, Error<CreateAPIKeyError>>

Create an API key.

source

pub async fn create_current_user_application_key( &self, body: ApplicationKeyCreateRequest, ) -> Result<ApplicationKeyResponse, Error<CreateCurrentUserApplicationKeyError>>

Create an application key for current user

Examples found in repository?
examples/v2_key-management_CreateCurrentUserApplicationKey.rs (line 17)
10
11
12
13
14
15
16
17
18
19
20
21
22
23

async fn main() {
    let body = ApplicationKeyCreateRequest::new(ApplicationKeyCreateData::new(
        ApplicationKeyCreateAttributes::new("Example-Key-Management".to_string()),
        ApplicationKeysType::APPLICATION_KEYS,
    ));
    let configuration = datadog::Configuration::new();
    let api = KeyManagementAPI::with_config(configuration);
    let resp = api.create_current_user_application_key(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}
More examples
Hide additional examples
examples/v2_key-management_CreateCurrentUserApplicationKey_3383369233.rs (line 24)
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

async fn main() {
    let body = ApplicationKeyCreateRequest::new(ApplicationKeyCreateData::new(
        ApplicationKeyCreateAttributes::new("Example-Key-Management".to_string()).scopes(Some(
            vec![
                "dashboards_read".to_string(),
                "dashboards_write".to_string(),
                "dashboards_public_share".to_string(),
            ],
        )),
        ApplicationKeysType::APPLICATION_KEYS,
    ));
    let configuration = datadog::Configuration::new();
    let api = KeyManagementAPI::with_config(configuration);
    let resp = api.create_current_user_application_key(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}
source

pub async fn create_current_user_application_key_with_http_info( &self, body: ApplicationKeyCreateRequest, ) -> Result<ResponseContent<ApplicationKeyResponse>, Error<CreateCurrentUserApplicationKeyError>>

Create an application key for current user

source

pub async fn delete_api_key( &self, api_key_id: String, ) -> Result<(), Error<DeleteAPIKeyError>>

Delete an API key.

Examples found in repository?
examples/v2_key-management_DeleteAPIKey.rs (line 11)
6
7
8
9
10
11
12
13
14
15
16
17

async fn main() {
    // there is a valid "api_key" in the system
    let api_key_data_id = std::env::var("API_KEY_DATA_ID").unwrap();
    let configuration = datadog::Configuration::new();
    let api = KeyManagementAPI::with_config(configuration);
    let resp = api.delete_api_key(api_key_data_id.clone()).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}
source

pub async fn delete_api_key_with_http_info( &self, api_key_id: String, ) -> Result<ResponseContent<()>, Error<DeleteAPIKeyError>>

Delete an API key.

source

pub async fn delete_application_key( &self, app_key_id: String, ) -> Result<(), Error<DeleteApplicationKeyError>>

Delete an application key

Examples found in repository?
examples/v2_key-management_DeleteApplicationKey.rs (line 12)
6
7
8
9
10
11
12
13
14
15
16
17
18
19

async fn main() {
    // there is a valid "application_key" in the system
    let application_key_data_id = std::env::var("APPLICATION_KEY_DATA_ID").unwrap();
    let configuration = datadog::Configuration::new();
    let api = KeyManagementAPI::with_config(configuration);
    let resp = api
        .delete_application_key(application_key_data_id.clone())
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}
source

pub async fn delete_application_key_with_http_info( &self, app_key_id: String, ) -> Result<ResponseContent<()>, Error<DeleteApplicationKeyError>>

Delete an application key

source

pub async fn delete_current_user_application_key( &self, app_key_id: String, ) -> Result<(), Error<DeleteCurrentUserApplicationKeyError>>

Delete an application key owned by current user

Examples found in repository?
examples/v2_key-management_DeleteCurrentUserApplicationKey.rs (line 12)
6
7
8
9
10
11
12
13
14
15
16
17
18
19

async fn main() {
    // there is a valid "application_key" in the system
    let application_key_data_id = std::env::var("APPLICATION_KEY_DATA_ID").unwrap();
    let configuration = datadog::Configuration::new();
    let api = KeyManagementAPI::with_config(configuration);
    let resp = api
        .delete_current_user_application_key(application_key_data_id.clone())
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}
source

pub async fn delete_current_user_application_key_with_http_info( &self, app_key_id: String, ) -> Result<ResponseContent<()>, Error<DeleteCurrentUserApplicationKeyError>>

Delete an application key owned by current user

source

pub async fn get_api_key( &self, api_key_id: String, params: GetAPIKeyOptionalParams, ) -> Result<APIKeyResponse, Error<GetAPIKeyError>>

Get an API key.

Examples found in repository?
examples/v2_key-management_GetAPIKey.rs (line 13)
7
8
9
10
11
12
13
14
15
16
17
18
19
20

async fn main() {
    // there is a valid "api_key" in the system
    let api_key_data_id = std::env::var("API_KEY_DATA_ID").unwrap();
    let configuration = datadog::Configuration::new();
    let api = KeyManagementAPI::with_config(configuration);
    let resp = api
        .get_api_key(api_key_data_id.clone(), GetAPIKeyOptionalParams::default())
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}
source

pub async fn get_api_key_with_http_info( &self, api_key_id: String, params: GetAPIKeyOptionalParams, ) -> Result<ResponseContent<APIKeyResponse>, Error<GetAPIKeyError>>

Get an API key.

source

pub async fn get_application_key( &self, app_key_id: String, params: GetApplicationKeyOptionalParams, ) -> Result<ApplicationKeyResponse, Error<GetApplicationKeyError>>

Get an application key for your org.

Examples found in repository?
examples/v2_key-management_GetApplicationKey.rs (lines 13-16)
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

async fn main() {
    // there is a valid "application_key" in the system
    let application_key_data_id = std::env::var("APPLICATION_KEY_DATA_ID").unwrap();
    let configuration = datadog::Configuration::new();
    let api = KeyManagementAPI::with_config(configuration);
    let resp = api
        .get_application_key(
            application_key_data_id.clone(),
            GetApplicationKeyOptionalParams::default(),
        )
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}
source

pub async fn get_application_key_with_http_info( &self, app_key_id: String, params: GetApplicationKeyOptionalParams, ) -> Result<ResponseContent<ApplicationKeyResponse>, Error<GetApplicationKeyError>>

Get an application key for your org.

source

pub async fn get_current_user_application_key( &self, app_key_id: String, ) -> Result<ApplicationKeyResponse, Error<GetCurrentUserApplicationKeyError>>

Get an application key owned by current user

Examples found in repository?
examples/v2_key-management_GetCurrentUserApplicationKey.rs (line 10)
6
7
8
9
10
11
12
13
14
15
16
17

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = KeyManagementAPI::with_config(configuration);
    let resp = api
        .get_current_user_application_key("app_key_id".to_string())
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}
source

pub async fn get_current_user_application_key_with_http_info( &self, app_key_id: String, ) -> Result<ResponseContent<ApplicationKeyResponse>, Error<GetCurrentUserApplicationKeyError>>

Get an application key owned by current user

source

pub async fn list_api_keys( &self, params: ListAPIKeysOptionalParams, ) -> Result<APIKeysResponse, Error<ListAPIKeysError>>

List all API keys available for your account.

Examples found in repository?
examples/v2_key-management_ListAPIKeys.rs (lines 13-15)
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

async fn main() {
    // there is a valid "api_key" in the system
    let api_key_data_attributes_name = std::env::var("API_KEY_DATA_ATTRIBUTES_NAME").unwrap();
    let configuration = datadog::Configuration::new();
    let api = KeyManagementAPI::with_config(configuration);
    let resp = api
        .list_api_keys(
            ListAPIKeysOptionalParams::default().filter(api_key_data_attributes_name.clone()),
        )
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}
source

pub async fn list_api_keys_with_http_info( &self, params: ListAPIKeysOptionalParams, ) -> Result<ResponseContent<APIKeysResponse>, Error<ListAPIKeysError>>

List all API keys available for your account.

source

pub async fn list_application_keys( &self, params: ListApplicationKeysOptionalParams, ) -> Result<ListApplicationKeysResponse, Error<ListApplicationKeysError>>

List all application keys available for your org

Examples found in repository?
examples/v2_key-management_ListApplicationKeys.rs (line 11)
7
8
9
10
11
12
13
14
15
16
17
18

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = KeyManagementAPI::with_config(configuration);
    let resp = api
        .list_application_keys(ListApplicationKeysOptionalParams::default())
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}
source

pub async fn list_application_keys_with_http_info( &self, params: ListApplicationKeysOptionalParams, ) -> Result<ResponseContent<ListApplicationKeysResponse>, Error<ListApplicationKeysError>>

List all application keys available for your org

source

pub async fn list_current_user_application_keys( &self, params: ListCurrentUserApplicationKeysOptionalParams, ) -> Result<ListApplicationKeysResponse, Error<ListCurrentUserApplicationKeysError>>

List all application keys available for current user

Examples found in repository?
examples/v2_key-management_ListCurrentUserApplicationKeys.rs (line 11)
7
8
9
10
11
12
13
14
15
16
17
18

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = KeyManagementAPI::with_config(configuration);
    let resp = api
        .list_current_user_application_keys(ListCurrentUserApplicationKeysOptionalParams::default())
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}
source

pub async fn list_current_user_application_keys_with_http_info( &self, params: ListCurrentUserApplicationKeysOptionalParams, ) -> Result<ResponseContent<ListApplicationKeysResponse>, Error<ListCurrentUserApplicationKeysError>>

List all application keys available for current user

source

pub async fn update_api_key( &self, api_key_id: String, body: APIKeyUpdateRequest, ) -> Result<APIKeyResponse, Error<UpdateAPIKeyError>>

Update an API key.

Examples found in repository?
examples/v2_key-management_UpdateAPIKey.rs (line 20)
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

async fn main() {
    // there is a valid "api_key" in the system
    let api_key_data_id = std::env::var("API_KEY_DATA_ID").unwrap();
    let body = APIKeyUpdateRequest::new(APIKeyUpdateData::new(
        APIKeyUpdateAttributes::new("Example-Key-Management".to_string()),
        api_key_data_id.clone(),
        APIKeysType::API_KEYS,
    ));
    let configuration = datadog::Configuration::new();
    let api = KeyManagementAPI::with_config(configuration);
    let resp = api.update_api_key(api_key_data_id.clone(), body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}
source

pub async fn update_api_key_with_http_info( &self, api_key_id: String, body: APIKeyUpdateRequest, ) -> Result<ResponseContent<APIKeyResponse>, Error<UpdateAPIKeyError>>

Update an API key.

source

pub async fn update_application_key( &self, app_key_id: String, body: ApplicationKeyUpdateRequest, ) -> Result<ApplicationKeyResponse, Error<UpdateApplicationKeyError>>

Edit an application key

Examples found in repository?
examples/v2_key-management_UpdateApplicationKey.rs (line 22)
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

async fn main() {
    // there is a valid "application_key" in the system
    let application_key_data_id = std::env::var("APPLICATION_KEY_DATA_ID").unwrap();
    let body = ApplicationKeyUpdateRequest::new(ApplicationKeyUpdateData::new(
        ApplicationKeyUpdateAttributes::new()
            .name("Application Key for managing dashboards-updated".to_string()),
        application_key_data_id.clone(),
        ApplicationKeysType::APPLICATION_KEYS,
    ));
    let configuration = datadog::Configuration::new();
    let api = KeyManagementAPI::with_config(configuration);
    let resp = api
        .update_application_key(application_key_data_id.clone(), body)
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}
source

pub async fn update_application_key_with_http_info( &self, app_key_id: String, body: ApplicationKeyUpdateRequest, ) -> Result<ResponseContent<ApplicationKeyResponse>, Error<UpdateApplicationKeyError>>

Edit an application key

source

pub async fn update_current_user_application_key( &self, app_key_id: String, body: ApplicationKeyUpdateRequest, ) -> Result<ApplicationKeyResponse, Error<UpdateCurrentUserApplicationKeyError>>

Edit an application key owned by current user

Examples found in repository?
examples/v2_key-management_UpdateCurrentUserApplicationKey.rs (line 22)
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

async fn main() {
    // there is a valid "application_key" in the system
    let application_key_data_id = std::env::var("APPLICATION_KEY_DATA_ID").unwrap();
    let body = ApplicationKeyUpdateRequest::new(ApplicationKeyUpdateData::new(
        ApplicationKeyUpdateAttributes::new()
            .name("Application Key for managing dashboards-updated".to_string()),
        application_key_data_id.clone(),
        ApplicationKeysType::APPLICATION_KEYS,
    ));
    let configuration = datadog::Configuration::new();
    let api = KeyManagementAPI::with_config(configuration);
    let resp = api
        .update_current_user_application_key(application_key_data_id.clone(), body)
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}
source

pub async fn update_current_user_application_key_with_http_info( &self, app_key_id: String, body: ApplicationKeyUpdateRequest, ) -> Result<ResponseContent<ApplicationKeyResponse>, Error<UpdateCurrentUserApplicationKeyError>>

Edit an application key owned by current user

Trait Implementations§

source§

impl Clone for KeyManagementAPI

source§

fn clone(&self) -> KeyManagementAPI

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for KeyManagementAPI

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Default for KeyManagementAPI

source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more