Skip to main content
PATCH
Update an AI Gateway access key

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Unique identifier for an AI Gateway access key.

Body

application/json
name
string | null

User-friendly label for this access key.

Maximum string length: 255
description
string | null

Human-readable description of this access key.

Maximum string length: 255
metadata
string | null

Arbitrary user-defined metadata for this access key.

Maximum string length: 4096
accessKeyConfigurationId
string | null

ID of an access key configuration. PATCH: omit to preserve the current link, send null to revert to allow-all scope, or send an ID to link a configuration.

Response

The updated AI Gateway access key.

id
string
required

Unique identifier for this access key.

uri
string
required

URI of this AI Gateway Access Key API resource.

createdAt
string<date-time>
required

Timestamp when the access key was created.

updatedAt
string<date-time>
required

Timestamp when the access key was last updated.

createdBy
object
required
lastUpdatedBy
object
required
keyRedacted
string
required

Redacted display form of the access key token.

name
string

User-friendly label for this access key.

description
string

Human-readable description of this access key.

metadata
string

Arbitrary user-defined metadata for this access key.

token
string

Plaintext access key token. Only returned when the key is first created.

lastUsed
string<date-time> | null

Timestamp when the access key was last used.

accessKeyConfiguration
object | null

Linked access key configuration, or null for allow-all scope.