v34

OpenAPI 3.1.0raw.githubusercontent.com2026-07-130042.4 KB

apiCredentials

Update an API Credential

Update the specified API Credential.

patch/v1/organizations/{organizationId}/api-credentials/{apiCredentialId}

Path parameters

organizationIdstring required

The <code>id</code> of the Organization whose API Credential you want to update.

apiCredentialIdstring required

The <code>clientId</code> of the API Credential to update.

Request body

namestring

Human-readable name of the API Credential.

descriptionstring

Brief description of the purpose and usage for the API Credential.

enabledboolean

If <code>true</code>, the API Credential is enabled. Otherwise, <code>false</code>.

ipAllowliststring[]

Omit to leave unchanged. Pass an empty array to clear the stored IP allowlist.

Example request

{
  "name": "Auto-Manage-Workspaces",
  "description": "Used for automated Workspace management",
  "enabled": true,
  "roles": {
    "workspaces": [
      {
        "workspaceId": "main"
      }
    ]
  },
  "ipAllowlist": [
    "10.0.0.1/32"
  ]
}

Response

API Credential updated