メインコンテンツへスキップ
POST
キーを作成

承認

Authorization
string
header
必須

ClickHouse Cloud console で取得した key ID と key secret を使用してください: https://clickhouse.com/docs/cloud/manage/openapi

パスパラメータ

organizationId
string<uuid>
必須

keyを所有する組織のID。

ボディ

application/json
expireAt
string<date-time> | null

キーの有効期限を示すタイムスタンプ。存在しない場合、null の場合、または空の場合、キーは無期限です。ISO-8601。

hashData
object
ipAccessList
object[]

このキーを使用して API へのアクセスを許可する IP アドレスの一覧

name
string

キーの名前。

roles
enum<string>[]

キーに割り当てられたロールの一覧。少なくとも 1 つの要素を含みます。

利用可能なオプション:
admin,
developer,
query_endpoints
state
enum<string>

キーの初期状態: 'enabled'、'disabled'。指定しない場合、新しいキーは 'enabled' になります。

利用可能なオプション:
enabled,
disabled

レスポンス

成功時のレスポンス

requestId
string<uuid>

各リクエストに割り当てられる一意のID。UUIDv4

result
object
status
number

HTTPステータスコード。

:

200

最終更新日 2026年7月2日