Obtener los detalles de la clave - ClickHouse Documentation

GET

organizations

{organizationId}

keys

{keyId}

Obtener los detalles de la clave

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys/{keyId} \
  --header 'Authorization: Basic <encoded-value>'

{
  "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
}

Autorizaciones

Authorization

string

header

requerido

Usa el ID 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 solicitada.

keyId

string<uuid>

requerido

ID de la clave solicitada.

Respuesta

Respuesta exitosa

requestId

string<uuid>

ID único asignado a cada solicitud. UUIDv4

result

object

Show child attributes

status

number

Código de estado HTTP.

Ejemplo:

200

Última modificación el 10 de junio de 2026

Eliminar la claveElimina la clave de API. Solo se puede eliminar una clave que no se haya utilizado para autenticar la solicitud activa.

Obtener los detalles de la clave

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys/{keyId} \
  --header 'Authorization: Basic <encoded-value>'

{
  "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
}