CRcriblio
apiCredentials

Update an API Credential

Changed on

Update the specified API Credential.

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

Request

  • Base URL
    https://gateway.cribl.cloud
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://login.cribl.cloud/oauth/token
    • or HTTP bearer

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

Changes

  • 530e0f792d9fRevision changes
    • info

      added the new billing_reader enum value to the request property /////////

  • 6129323514c1Revision changes
    • info

      added the new insights enum value to the request property /////////////