Skip to main content
PATCH
Update an API key.

Authorizations

Authorization
string
header
required

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

Path Parameters

key_id
string
required

The public API key identifier (e.g. fkh_a1b2c3d4). Used for lookups, deletion, and updates.

Public API key identifier (e.g. fkh_a1b2c3D4). Composed of the prefix (e.g. "fkh_") followed by a base64url-encoded random suffix containing uppercase and lowercase letters, digits, hyphens, and underscores. Used for lookups, deletion, and updates.

Required string length: 12 - 16
Pattern: ^[a-z0-9]+_[A-Za-z0-9_-]+$

Body

application/json

At least one field must be provided. Only the fields included in the request are updated.

name
string

User-assigned label for the API key. Must be unique per user per organization. Must start with a letter (A-Z or a-z). After that, letters, digits, spaces, hyphens, and underscores are allowed. Leading and trailing whitespace is stripped by the server before saving.

Required string length: 1 - 128
Pattern: ^[A-Za-z][A-Za-z0-9_ -]*$
expires_at
string<date-time>

New expiration timestamp for the API key. Must be a future timestamp (greater than current time) and cannot exceed 100 years from now.

Response

API key updated successfully.

Response object for standard API responses.

api_version
enum<string>
default:3.0

API version.

Available options:
2.0,
3.0
kind
enum<string>
default:NORMAL

Type of response, indicating a normal response.

Available options:
NORMAL
data
object

API key metadata. Never includes secrets or hashes.