API Keys
Update API Keys
POST
Headers
Your unique Admin API key for authentication.
This key is required in the header of all Admin API requests, to authenticate your account and access Anthropic's services. Get your Admin API key through the Console.
Path Parameters
ID of the API key.
Body
application/json
Name of the API key.
Required string length:
1 - 500
Status of the API key.
Available options:
active
, inactive
, archived
Response
200 - application/json
RFC 3339 datetime string indicating when the API Key was created.
The ID and type of the actor that created the API key.
ID of the API key.
Name of the API key.
Partially redacted hint for the API key.
Status of the API key.
Available options:
active
, inactive
, archived
Object type.
For API Keys, this is always "api_key"
.
Available options:
api_key
ID of the Workspace associated with the API key, or null if the API key belongs to the default Workspace.
Was this page helpful?