Skip to main content
PATCH
Update Api Key

Headers

authorization
string | null
x-api-key
string | null
x-tenant-id
string | null

Path Parameters

key_id
string<uuid>
required

Cookies

factio_access_token
string | null

Body

application/json

Schema for updating an API key (partial update).

name
string | null

Human-readable name for the API key

Maximum string length: 255
scopes
string[] | null

List of scopes/permissions for this API key

Response

Successful Response

Schema for API key response (key_hash is never exposed).

id
string<uuid>
required
name
string
required
key_prefix
string
required
scopes
string[] | null
required
is_active
boolean
required
created_at
string<date-time>
required
last_used_at
string<date-time> | null
required