Crear una clave

Crea una nueva clave de API.

POST /v1/organizations/{organizationId}/keys

Crear una clave

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
}

Autorizaciones

Authorization · string · header · requerido

Usa el ID de la clave y el secreto de la clave obtenidos en la consola de ClickHouse Cloud: https://clickhouse.com/docs/cloud/manage/openapi

Parámetros de ruta

organizationId · string<uuid> · requerido

ID de la organización que será propietaria de la clave.

Cuerpo

application/json

expireAt · string<date-time> | null

Marca de tiempo en la que expira la clave. Si no está presente, es null o está vacío, la clave no expira nunca. ISO-8601.

hashData · object

Show child attributes

ipAccessList · object[]

Lista de direcciones IP autorizadas para acceder a la API usando esta clave

Show child attributes

name · string

Nombre de la clave.

roles · enum<string>[]

Lista de roles asignados a la clave. Contiene al menos 1 elemento.

Opciones disponibles: admin, developer, query_endpoints

state · enum<string>

Estado inicial de la clave: 'enabled', 'disabled'. Si no se proporciona, la nueva clave será 'enabled'.

Opciones disponibles: enabled, disabled

Respuesta

200

application/json

Respuesta satisfactoria

requestId · string<uuid>

ID único asignado a cada solicitud. UUIDv4

result · object

Show child attributes

status · number

Código de estado HTTP.

Ejemplo:

200