API Keys Service

Update API Key

Updates the specified API key.

put/aaa/api-keys/v3/{key_id}

Request

  • Base URL: https://api.eu1.coralogix.com/mgmt/openapi/5
  • URL: https://api.eu1.coralogix.com/mgmt/openapi/5/aaa/api-keys/v3/{key_id}
  • Auth: API key in header Authorization

Path parameters

key_idstring required

Key identifier.

Example:my_key_id

Request body

accessPolicystring

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.

isActiveboolean

Whether the API key is active. Set to false to deactivate without deleting.

newNamestring

New display name for the API key.

Example request

{
  "accessPolicy": "{\"version\":\"2025-01-01\",\"default\":{\"permissions\":{\"data-ingest-api-keys:ReadAccessPolicy\":\"grant\",\"data-ingest-api-keys:Manage\":\"deny\",\"data-ingest-api-keys:UpdateAccessPolicy\":\"deny\",\"data-ingest-api-keys:ReadConfig\":\"grant\"}},\"rules\":[]}",
  "isActive": true,
  "newName": "my_new_name"
}

Response

UpdateApiKeyResponse required

Response returned after successfully updating an API key.

Changes

No recorded changes to this operation across all 1 revision of this API.