Skip to main content
POST
Issue an API key

Authorizations

Authorization
string
header
required

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

Headers

checkfu-version
enum<string>
required
Available options:
2026-08-31
idempotency-key
string
required
Required string length: 1 - 255

Path Parameters

organization_id
string
required
Pattern: ^org_[0-9a-f]{32}$

Body

application/json

Create an API key with optional mechanical Runner enrollment intent.

display_name
string
required
Required string length: 1 - 255
role
enum<string>
required
Available options:
root,
admin,
developer,
runner,
viewer
scope
object
required
rate_limit_per_minute
integer
required
Required range: 0 < x <= 2147483647
expires_at
string | null

A canonical UTC ISO-8601 timestamp with millisecond precision.

Maximum string length: 24
Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
runner_enrollment
object

Mechanical Runner enrollment intent. The API validates placement and stamps authority.

Response

Success

api_key
object
required
secret
string
required
Minimum string length: 1