Struct ApiKeysClient 

pub struct ApiKeysClient { /* private fields */ }

The API Keys API client. Read more at https://coralogix.com/docs/api-keys/

Implementations

impl ApiKeysClient

pub fn new(auth_context: AuthContext, region: CoralogixRegion) -> Result<Self>

Creates a new client for the APIKeys API.

Arguments

• auth_context - The AuthContext to use for authentication.
• region - The CoralogixRegion to connect to.

pub async fn create( &self, name: String, owner: Option<Owner>, presets: Vec<String>, permissions: Vec<String>, hashed: bool, ) -> Result<CreateApiKeyResponse>

Creates a new API Key

Arguments

• name - The name of the API key.
• owner - The Owner of the API key.
• presets - The presets of the API key.
• permissions - The permissions of the API key.
• hashed - Whether the API key should be encrypted.

Note that when the API key is hashed, it will not be possible to retrieve it later.

pub async fn update( &self, key_id: String, is_active: Option<bool>, new_name: Option<String>, presets: Option<Vec<String>>, permissions: Option<Vec<String>>, ) -> Result<UpdateApiKeyResponse>

Updates an API key.

Arguments

• key_id - The ID of the API key to update.
• is_active - Whether the API key should be active.
• new_name - The new name of the API key.
• presets - The new presets of the API key.
• permissions - The new permissions of the API key.

pub async fn delete(&self, key_id: String) -> Result<DeleteApiKeyResponse>

Deletes an API key.

Arguments

• key_id - The ID of the API key to delete.

pub async fn get(&self, key_id: String) -> Result<GetApiKeyResponse>

Retrieves an API key by its ID.

Arguments

• key_id - The ID of the API key to retrieve.