Skip to main content

​
API Keys service overview

Coralogix API Keys provide secure, fine-grained access control for all platform APIs, enabling safe and auditable integrations with third-party systems, CI/CD pipelines, and automation scripts. The API Keys API allows users to programmatically create, retrieve, update, and delete API keys, each scoped with specific permissions or permission presets. In addition, API keys support policy-based access control (PBAC), letting you control which users and groups can view or manage each key through configurable access policies. Keys can be assigned to users, teams, or organizations, and tailored with granular read/write permissions across Coralogix services. Learn more in our API Keys documentation.

​
Examples

​
Send-Your-Data API key Access Policy

{
  "version": "v2025-01-01",
  "rules": [],
  "default": {
    "permissions": {
      "data-ingest-api-keys:ReadConfig": "grant",
      "data-ingest-api-keys:Manage": "grant",
      "data-ingest-api-keys:ReadAccessPolicy": "grant",
      "data-ingest-api-keys:UpdateAccessPolicy": "grant"
    },
  }
}

​
Send-Your-Data API key Access Policy with rules

NB: Rule amount is unlimited. 
{
  "version": "v2025-01-01",
  "rules": [
    {
      "targets": [
        {
          "group": "120173"
        },
        {
          "group": "87434"
        }
      ],
      "permissions": {
        "data-ingest-api-keys:ReadConfig": "grant",
        "data-ingest-api-keys:Manage": "grant"
      },
      "additionalInfo": null
    }
  ],
  "default": {
    "permissions": {
      "data-ingest-api-keys:ReadConfig": "grant",
      "data-ingest-api-keys:Manage": "grant",
      "data-ingest-api-keys:ReadAccessPolicy": "grant",
      "data-ingest-api-keys:UpdateAccessPolicy": "grant"
    },
    "additionalInfo": null
  }
}

​
Permissions

​
Send-Your-Data API key

"data-ingest-api-keys:ReadConfig": "Read Send-Your-Data-Key",
"data-ingest-api-keys:Manage": "Update Send-Your-Data-Key",
"data-ingest-api-keys:ReadAccessPolicy": "Read Access Policy",
"data-ingest-api-keys:UpdateAccessPolicy": "Manage Access Policy"

​
Team key

"team-custom-api-keys:ReadConfig": "Read Team API key",
"team-custom-api-keys:Manage": "Update Team API Key",
"team-custom-api-keys:ReadAccessPolicy": "Read Access Policy",
"team-custom-api-keys:UpdateAccessPolicy": "Update Access Policy"