Skip to main content

Create api-key

POST 
/api/v1/partner/settings/api-keys

Create a new client API key with an optional route allowlist.

Request​

Body

required
    name stringrequired

    Possible values: non-empty

    full_access boolean

    Default value: false

    allowed_routes string[]

    Possible values: non-empty

    Default value: ``

    Route ids (e.g. 'POST /api/v8/partner/documents') and/or preset tokens (e.g. 'preset:lens-sdk') this key may use; ignored when full_access is true. GET /api/v1/partner/settings/api-keys/available-permissions for the full list of valid values.

    manager_ids integer[]

    Default value: ``

    webhook_url uri

    Possible values: non-empty and <= 2083 characters

    HTTPS URL that receives webhooks triggered by requests made with this key. When set, it overrides the client-level webhook URL for those requests. Send null to clear it.

    expires_at date-time

Responses​

An API key

Schema
    id integerrequired
    name (string | null)

    Possible values: non-empty

    key (string | null)

    Possible values: non-empty

    full_access booleanrequired
    allowed_routes string[]required

    Possible values: non-empty

    status stringrequired

    Possible values: non-empty

    managers object[]
  • Array [
    • id integerrequired
    name stringrequired

    Possible values: non-empty

    email stringrequired

    Possible values: non-empty

    is_owner booleanrequired
    active booleanrequired
  • ]
    • webhook_url uri

    Possible values: non-empty and <= 2083 characters

    last_used_at date-time
    expires_at date-time
    created date-time
Loading...