This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-23 00:19 UTC.
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Allows changing the friendly name, activation status, and optional expiration date of an API key to support rotation policies and incident response.
Values
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
Field
Type
Description
namerequired
string
New human-friendly label for the key (optional)nullablemax length 32
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
activerequired
boolean
Set to true to enable the key, false to disable it
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
expireAtrequired
string (date-time)
Optional UTC timestamp to set/update expiration; null clears expirationnullable
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
allowedCidrsrequired
array of stringarray of
Gets or sets the source addresses this key may be used from, as CIDR ranges or bare IPv4 or
IPv6 addresses. `null` or empty means the key is not bound to any address and may be
used from anywhere, which is the default and what every existing key carries.nullablemax items 50
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
scopesrequired
array of stringarray of
Gets or sets the capability scopes this key is restricted to. `null` or empty means the
key is unrestricted, which is the default and what every existing key carries.nullable
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
This model has no documented fields.
Reconnecting to the server
Could not reconnect
This session has ended
Attempt 1
Your work on this page is still here. Retrying keeps it; reloading starts the page again.
The server no longer holds this page's state, so it has to be loaded again.