Sign in

v56

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01142337440.5 KB
APIKeyService
API Keys

Update an API key

Updates an API key.

patch/v1/workspaces/{workspaceId}/api_keys/{id}

Path parameters

workspaceIdstring required
Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q

The workspace the API key belongs to (path).

idstring required
Example:apikey_01HXKD2E5NQM3T9AYWCFCSPNQY

The API key to update.

Request body

workspaceIdstring

The workspace the API key belongs to (path).

idstring

The API key to update.

updateMaskstring field-mask

Fields to update.

Example request

{
  "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
  "id": "apikey_01HXKD2E5NQM3T9AYWCFCSPNQY"
}

Response

OK

state'STATE_UNSPECIFIED' | 'STATE_ENABLED' | 'STATE_DISABLED' enum required

The current lifecycle state of the API key. Output only. Keys are created STATE_ENABLED; use the :disable and :enable actions to transition between states.

Example response

{
  "metadata": {
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
  },
  "info": {
    "createdBy": {
      "metadata": {
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
      }
    }
  }
}