Skip to main content
POST
Create an API key

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

1 to 100 characters, without leading or trailing spaces

Required string length: 1 - 100
Pattern: ^\S(?:.*\S)?$
Example:

"Nightly price check"

permissions
enum<string>[]

Permissions the key carries, each one you hold now. Default: every permission you hold except api_keys:manage

Required array length: 1 - 16 elements
Available options:
tools:read,
usage:read,
tools:build,
runs:create,
jobs:read,
jobs:cancel,
connections:read,
credentials:manage,
api_keys:manage
Example:
integration_id
string

Bind the key to one integration: it then runs only that integration's tools, and carries only tools:read, runs:create, jobs:read and jobs:cancel

Example:

"int_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190"

expires_in_days
integer

Days until the key expires, 1 to 365 (default 90)

Required range: 1 <= x <= 365
Example:

30

deliver
enum<string>

Answer a Dashboard link instead of the secret, so the secret never reaches this client

Available options:
dashboard

Response

With deliver dashboard: where to finish

dashboard_url
string
required

A signed-in Dashboard page where the person finishes this and sees the secret once