API keys

Update key

Updates API key properties.

patch/v1/organizations/{organizationId}/keys/{keyId}

Request

  • Base URL: https://api.clickhouse.cloud
  • URL: https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys/{keyId}
  • Auth: HTTP basic

Path parameters

organizationIdstring uuid required

ID of the organization that owns the key.

keyIdstring uuid required

ID of the key to update.

Request body

namestring

Name of the key

rolesstring[]

DEPRECATED. Use assignedRoleIds instead. List of roles assigned to the key.

assignedRoleIdsstring[]

Array of role UUIDs to assign to the API key

expireAtstring date-time nullable

Timestamp the key expires. If null or is empty the key never expires. ISO-8601.

state'enabled' | 'disabled'

State of the key: 'enabled', 'disabled'.

Response

Successful response

statusnumber

HTTP status code.

requestIdstring uuid

Unique id assigned to every request. UUIDv4

Example response

{
  "status": 200
}

Changes

No recorded changes to this operation across all 1 revision of this API.