Skip to main content
POST
Create key
Creates new API key.

授权

Authorization
string
header
必填

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

路径参数

organizationId
string<uuid>
必填

ID of the organization that will own the key.

请求体

application/json
name
string

Name of the key.

expireAt
string<date-time> | null

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

state
enum<string>

Initial state of the key: 'enabled', 'disabled'. If not provided the new key will be 'enabled'.

可用选项:
enabled,
disabled
hashData
object
roles
enum<string>[]
已弃用

DEPRECATED. Use assignedRoleIds instead. List of roles assigned to the key. Contains at least 1 element.

可用选项:
admin,
developer,
query_endpoints
assignedRoleIds
string<uuid>[]

Array of role UUIDs to assign to the API key

ipAccessList
object[]

List of IP addresses allowed to access the API using this key

响应

Successful response

status
number

HTTP status code.

示例:

200

requestId
string<uuid>

Unique id assigned to every request. UUIDv4

result
object
最后修改于 2026年7月24日