API Keys Service

Create API Key

Creates a new API key for the authenticated team.

post/aaa/api-keys/v3

Request

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

Request body

accessPolicystring

JSON string representing the access policy for this API key. Defines granular permissions for users and groups.

hashedboolean

Whether the value is stored as a one-way hash.

namestring

Display name.

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

Response

keyIdstring

Key identifier.

namestring

Display name.

valuestring

The value.

Example response

{
  "keyId": "my_key_id",
  "name": "my_api_key",
  "value": "my_api_key_value"
}

Changes

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