Создать ключ

Создаёт новый API-ключ.

POST /v1/organizations/{organizationId}/keys

Создать ключ

cURL

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

200

{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "key": {
      "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"
    },
    "keyId": "<string>",
    "keySecret": "<string>"
  },
  "status": 200
}

Авторизации

Authorization · string · header · обязательно

Используйте идентификатор ключа и секрет ключа, полученные в консоли ClickHouse Cloud: https://clickhouse.com/docs/cloud/manage/openapi

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

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

Идентификатор организации, которой будет принадлежать ключ.

Тело

application/json

expireAt · string<date-time> | null

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

hashData · object

Show child attributes

ipAccessList · object[]

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

Show child attributes

name · string

Имя ключа.

roles · enum<string>[]

Список ролей, назначенных ключу. Содержит как минимум 1 элемент.

Доступные опции: admin, developer, query_endpoints

state · enum<string>

Начальное состояние ключа: 'enabled', 'disabled'. Если не указано, новый ключ будет 'enabled'.

Доступные опции: enabled, disabled

Ответ

200

application/json

Успешный ответ

requestId · string<uuid>

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

result · object

Show child attributes

status · number

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

Пример:

200