API Keys Service

Get API Key

Returns the details of the specified API key.

get/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

Response

Example response

{
  "keyInfo": {
    "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\":[]}",
    "active": true,
    "hashed": true,
    "keyPermissions": {
      "presets": [
        {
          "name": "my_preset",
          "permissions": [
            "read_logs"
          ]
        }
      ]
    },
    "name": "my_api_key"
  }
}

Changes

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