API Keys

Update Api Key

Update an API key's name, scopes, expiry, or IP allowlist.

Omitted fields are left untouched.

patch/v1/api-keys/{api_key_id}

Request

  • Base URL: https://api.fettle.sh (the document declares no server; this is the origin it was published from)
  • URL: https://api.fettle.sh/v1/api-keys/{api_key_id}
  • Auth: API key in header Authorization

Path parameters

api_key_idstring uuid required

Headers

X-Organization-Idstring uuid nullable

Request body

namestring nullable
scopesApiScope[] nullable
expires_atstring date-time nullable
allowed_cidrsstring[] nullable

Response

Successful Response

idstring uuid required
namestring required
prefixstring required
scopesApiScope[] required
status'ACTIVE' | 'REVOKED' | 'EXPIRED' required

Derived lifecycle state of a key. Never stored — see ApiKeyService.get_status.

allowed_cidrsstring[] nullable required
expires_atstring date-time nullable required
revoked_atstring date-time nullable required
last_used_atstring date-time nullable required
rotation_grace_expires_atstring date-time nullable required
created_by_user_idstring uuid required
created_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.