Обновить ключ

Обновляет свойства API-ключа.

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: https://clickhouse.com/docs/cloud/manage/openapi

Параметры пути

organizationId · string<uuid> · обязательно

ID организации, которой принадлежит ключ.

keyId · string<uuid> · обязательно

ID ключа, который нужно обновить.

Тело

application/json

expireAt · string<date-time> | null

Временная метка истечения срока действия ключа. Если значение null или пустое, срок действия ключа не истекает. ISO-8601.

ipAccessList · object[]

Список IP-адресов, которым разрешен доступ к API с использованием этого ключа

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>

Уникальный идентификатор, присваиваемый каждому запросу. UUIDv4

result · object

Show child attributes

status · number

Код состояния HTTP.

Пример:

200