Administrar claves de API

Puede usar la pestaña claves de API del menú de la izquierda para crear y administrar sus claves de API.

La página claves de API mostrará inicialmente un mensaje para crear su primera clave de API, como se muestra a continuación. Después de crear su primera clave, puede crear nuevas claves con el botón New API Key que aparece en la esquina superior derecha.

Especifique el nombre de la clave, sus permisos y el tiempo de expiración.

Para restringir qué clientes pueden usar la clave de API, en la sección Allow access to this API Key, seleccione Specific locations. Introduzca una dirección IP o un rango CIDR, como 203.0.113.1 o 203.0.113.0/24, y agregue entradas adicionales según sea necesario.

Los Query API endpoints respetan las listas de IP permitidas a nivel de clave de API. Como las solicitudes se enrutan mediante proxy desde la infraestructura interna de ClickHouse, las listas de IP permitidas a nivel de servicio no se aplican. Consulte IP Access Control para obtener más información.

Haga clic en Generate API Key cuando haya terminado de configurar la clave.

La siguiente pantalla mostrará su ID de clave y el secreto de la clave. Copie estos valores y guárdelos en un lugar seguro, como una bóveda. Estos valores no volverán a mostrarse después de salir de esta pantalla.

La ClickHouse Cloud API usa autenticación básica HTTP para verificar la validez de sus claves de API. A continuación, se muestra un ejemplo de cómo usar sus claves de API para enviar solicitudes a la ClickHouse Cloud API con curl:

$ KEY_ID=mykeyid
$ KEY_SECRET=mykeysecret

$ curl --user $KEY_ID:$KEY_SECRET https://api.clickhouse.cloud/v1/organizations

Al volver a la página claves de API, verá el nombre de la clave, los últimos cuatro caracteres del ID de clave, los permisos, el estado, la fecha de expiración y el creador. Desde esta pantalla puede editar el nombre de la clave, los permisos y la expiración. También puede deshabilitar o eliminar claves desde esta pantalla.