Skip to main content
Theme
Home

Create API Key

POSThttps://api.coralogix.com/mgmt/openapi/5/aaa/api-keys/v3

Creates a new API key for the authenticated team.

Authorizations

Authorizationstringheaderrequired
API key authentication
The value is a Coralogix API key. Create a personal or team API key and assign its permissions.

Request​

Body

application/json
    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

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

    Example: true

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

    name#string

    Display name.

    Example: my_api_key
    owner#object

    Owner.

    oneOf
    object
    owner.organisationId#string

    Organisation identifier of the API key owner.

    owner.teamId#int64

    The team id.

    Possible values: >= 0

    owner.userId#string

    User identifier of the API key owner.

Response

application/json

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

    keyId#string

    Key identifier.

    Example: my_key_id
    name#string

    Display name.

    Example: my_api_key
    value#string

    The value.

    Example: my_api_key_value