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

ClickStack: Creates a new custom role for the team.

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.

Body

application/json
name
string
required

Role name. Must be unique within the team and not collide with a predefined role.

Example:

"Deploy Bot"

permissions
object[]
required

The CASL permissions to grant to the role.

description
string

Human-readable 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