Skip to main content
PUT
ClickStack: Update Role
Beta This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future.

ClickStack: Updates a custom role’s permissions, name, and description. Predefined roles cannot be modified.

Authorizations

Authorization
string
header
required

Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Path Parameters

organizationId
string<uuid>
required

ID of the organization that owns the service.

serviceId
string<uuid>
required

ID of the ClickStack service.

clickStackRoleId
string
required

id parameter

Body

application/json
permissions
object[]
required

The replacement set of CASL permissions for the role.

name
string

New role name. Omit to leave the name unchanged.

Example:

"Deploy Bot"

description
string

New role description.

Example:

"Manages dashboards via Terraform"

Response

Successful response

status
number

HTTP status code.

Example:

200

requestId
string<uuid>

Unique id assigned to every request. UUIDv4

result
object
Last modified on July 22, 2026