ANanthropics

Update API Key

Changed on
post/v1/organizations/api_keys/{api_key_id}

Request

  • Base URL
    https://api.anthropic.com
  • Auth
    none declared

Path parameters

api_key_idstring required

ID of the API key.

Headers

anthropic-versionstring

The version of the Claude API you want to use.

Read more about versioning and our version history here.

Request body

namestring nullable

Name of the API key.

status'active' | 'archived' | 'inactive' nullable

Status of the API key.

Response

Successful Response

created_atstring date-time required

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

expires_atstring date-time nullable required

RFC 3339 datetime string indicating when the API Key expires, or null if it never expires.

idstring required

ID of the API key.

namestring required

Name of the API key.

partial_key_hintstring nullable required

Partially redacted hint for the API key.

status'active' | 'archived' | 'expired' | 'inactive' required

Status of the API key.

type'api_key' required

Object type.

For API Keys, this is always "api_key".

Example response

{
  "created_at": "2024-10-30T23:58:27.427722Z",
  "created_by": {
    "id": "user_01WxYzAbCdEfGhJkMnPqRsTu",
    "type": "user"
  },
  "expires_at": "2024-10-30T23:58:27.427722Z",
  "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
  "name": "Developer Key",
  "partial_key_hint": "sk-ant-api03-R2D...igAA",
  "principal": {
    "user_id": "user_01WxYzAbCdEfGhJkMnPqRsTu"
  },
  "scope": {
    "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
  },
  "status": "active"
}

Changes

  • 94c83daca660Revision changes
    • breaking

      removed the required property from the response with the status

  • a71b45011694Revision changes
    • breaking

      the response's property type changed from no type to object for status

    • info

      added the optional property / to the response with the status

    • info

      removed discriminator from response property for the response status

    • info

      removed from the response property oneOf list for the response status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status