v12

latestOpenAPI 3.0.3raw.githubusercontent.com2026-06-1811583196.1 KB

API Keys

Create API key

Create a new API key. The full secret is returned once in the secret field of the response — store it immediately. Subsequent reads only return the key_prefix.

Pass role_id to bind the key to an account role; the key inherits that role's permissions. To grant per-project access, after creating the key add it as a Project Member on each project (passing api_key_id).

post/api/v1/api-keys

Request body

namestring required

A descriptive label for the key (e.g. Production CI, Backups Lambda)

rate_limit_tier'standard' | 'high'

standard (30 RPS) by default. high (100 RPS) requires support approval — request via email if you need it.

expires_atstring date-time

Optional expiration timestamp. Omit for never-expires keys.

role_idstring uuid

Account-level role to assign. The key inherits this role's account.* permissions. To grant per-project access, add the key as a Project Member after creation.

Response

API key created (full secret returned once)

successboolean

Example response

{
  "data": {
    "key_prefix": "raff_17d70fcf",
    "secret": "raff_17d70fcf7e7510968a4c19279b25707f088f1cc5ad8b74210341d8e470b5bb7a"
  }
}