Skip to main content
Create API Key
curl --request POST \
  --url https://api.coralogix.com/mgmt/openapi/latest/aaa/api-keys/v3 \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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",
  "owner": {
    "userId": "<string>"
  }
}
'
{
  "keyId": "my_key_id",
  "name": "my_api_key",
  "value": "my_api_key_value"
}

Authorizations

​
Authorization
string
header
required

API key authentication

Body

application/json

This data structure is used to create an API key.

​
accessPolicy
string

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

Example:

"{\"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
boolean
Example:

true

​
keyPermissions
Key Permissions · object

This data structure allows to specify loose permissions and permission presets for an API key.

​
name
string
Example:

"my_api_key"

​
owner
object

Response

This data structure is the response obtained when creating an API key.

​
keyId
string
Example:

"my_key_id"

​
name
string
Example:

"my_api_key"

​
value
string
Example:

"my_api_key_value"