キーを更新

API keyのプロパティを更新します。

PATCH /v1/organizations/{organizationId}/keys/{keyId}

キーを更新

cURL

curl --request PATCH \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys/{keyId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "expireAt": "2023-11-07T05:31:56Z",
  "ipAccessList": [
    {
      "description": "<string>",
      "source": "<string>"
    }
  ],
  "name": "<string>",
  "roles": []
}
'

200

{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "createdAt": "2023-11-07T05:31:56Z",
    "expireAt": "2023-11-07T05:31:56Z",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ipAccessList": [
      {
        "description": "<string>",
        "source": "<string>"
      }
    ],
    "keySuffix": "<string>",
    "name": "<string>",
    "roles": [],
    "usedAt": "2023-11-07T05:31:56Z"
  },
  "status": 200
}

承認

Authorization · string · header · 必須

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

パスパラメータ

organizationId · string<uuid> · 必須

keyを所有する組織のID。

keyId · string<uuid> · 必須

更新するkeyのID。

ボディ

application/json

expireAt · string<date-time> | null

キーの有効期限を示すタイムスタンプ。null または空の場合、キーの有効期限はありません。ISO-8601。

ipAccessList · object[]

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

Show child attributes

name · string

キーの名前

roles · enum<string>[]

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

利用可能なオプション: admin, developer, query_endpoints

state · enum<string>

キーの状態: 'enabled'、'disabled'。

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

レスポンス

200

application/json

成功時のレスポンス

requestId · string<uuid>

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

result · object

Show child attributes

status · number

HTTPステータスコード。

例:

200