Gerenciamento de chaves de API

Você pode usar a aba API Keys no menu à esquerda para criar e gerenciar suas chaves de API.

A página API Keys exibirá inicialmente uma solicitação para criar sua primeira chave de API, como mostrado abaixo. Depois que a primeira chave for criada, você poderá criar novas chaves usando o botão New API Key, que aparece no canto superior direito.

Especifique o nome da chave, as permissões e o prazo de expiração.

Para restringir quais clientes podem usar a chave de API, na seção Allow access to this API Key, selecione Specific locations. Insira um endereço IP ou intervalo CIDR, como 203.0.113.1 ou 203.0.113.0/24, e adicione outras entradas conforme necessário.

Os Query API endpoints respeitam allowlists de IP no nível da chave de API. Como as requisições são encaminhadas por proxy de dentro da infraestrutura do ClickHouse, allowlists de IP no nível do serviço não se aplicam. Consulte IP Access Control para mais detalhes.

Clique em Generate API Key quando terminar de configurar a chave.

A próxima tela exibirá seu Key ID e Key secret. Copie esses valores e guarde-os em um local seguro, como um cofre. Eles não serão exibidos novamente depois que você sair desta tela.

A ClickHouse Cloud API usa HTTP Basic Authentication para verificar a validade das suas chaves de API. Veja um exemplo de como usar suas chaves de API para enviar requisições à ClickHouse Cloud API com curl:

$ KEY_ID=mykeyid
$ KEY_SECRET=mykeysecret

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

Ao retornar à página API Keys, você verá o nome da chave, os quatro últimos caracteres do Key ID, as permissões, o status, a data de expiração e o criador. Nesta tela, você pode editar o nome da chave, as permissões e a expiração. As chaves também podem ser desabilitadas ou excluídas nesta tela.