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일