Update API Key

PUThttps://api.eu1.coralogix.com/mgmt/openapi/5/aaa/api-keys/v3/{key_id}

Updates the specified API key.

Authorizations

Authorizationstringheaderrequired

API key authentication

The value is a Coralogix API key. Create a personal or team API key and assign its permissions.

Request

Path Parameters

key_id# stringrequired

Key identifier.

Example: my_key_id

Body

application/json

accessPolicy#string

JSON string representing the access policy for this API key. Defines granular permissions for users and groups. To delete an existing policy, pass an empty string. Omit to keep the policy.

Example:

{"version":"2025-01-01","default":{"permissions":{"team-custom-api-keys:ReadAccessPolicy":"grant","team-custom-api-keys:Manage":"deny","team-custom-api-keys:UpdateAccessPolicy":"deny","team-custom-api-keys:ReadConfig":"grant"}},"rules":[]}

isActive#boolean

Whether the API key is active. Set to false to deactivate without deleting. Omit to keep the current state. A new key is active, and the create operation cannot change that.

Example: true

newName#string

New display name for the API key. Omit to keep the name.

Possible values: non-empty

Example: my_new_name

permissions# object

Replaces the permissions of the key. Omit to keep them. An object without permissions removes every permission.

presets# object

Replaces the presets of the key. Omit to keep them. An object without presets removes every preset.

Response