Skip to main content
POST
/
v1
/
organizations
/
api_keys
/
{api_key_id}
cURL
curl "https://api.anthropic.com/v1/organizations/api_keys/apikey_01Rj2N8SVvo6BePZj99NhmiT" \
  --header "anthropic-version: 2023-06-01" \
  --header "content-type: application/json" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "status": "active",
    "name": "Developer Key"
  }'
{
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": {
    "id": "<string>",
    "type": "<string>"
  },
  "id": "<string>",
  "name": "<string>",
  "partial_key_hint": "sk-ant-api03-R2D...igAA",
  "status": "active",
  "type": "api_key",
  "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}

Headers

​
x-api-key
string
required

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.

​
anthropic-version
string
required

The version of the Claude API you want to use.

Read more about versioning and our version history here.

Path Parameters

​
api_key_id
string
required

ID of the API key.

Body

application/json
​
name
string

Name of the API key.

Required string length: 1 - 500
​
status
enum<string> | null

Status of the API key.

Available options:
active,
inactive,
archived

Response

Successful Response

​
created_at
string<date-time>
required

RFC 3339 datetime string indicating when the API Key was created.

Example:

"2024-10-30T23:58:27.427722Z"

​
created_by
Created By · object
required

The ID and type of the actor that created the API key.

Example:
{
  "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
  "type": "user"
}
​
id
string
required

ID of the API key.

Example:

"apikey_01Rj2N8SVvo6BePZj99NhmiT"

​
name
string
required

Name of the API key.

Example:

"Developer Key"

​
partial_key_hint
string | null
required

Partially redacted hint for the API key.

Example:

"sk-ant-api03-R2D...igAA"

​
status
enum<string>
required

Status of the API key.

Available options:
active,
inactive,
archived
Example:

"active"

​
type
enum<string>
default:api_key
required

Object type.

For API Keys, this is always "api_key".

Available options:
api_key
Allowed value: "api_key"
​
workspace_id
string | null
required

ID of the Workspace associated with the API key, or null if the API key belongs to the default Workspace.

Example:

"wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"