> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-fix-nav-issues.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Gerenciamento de chaves de API

> O ClickHouse Cloud fornece uma API com OpenAPI que permite gerenciar programaticamente sua conta e aspectos dos seus serviços.

export const Image = ({img, alt, size}) => {
  return <Frame>
      <img src={img} alt={alt} />
    </Frame>;
};

O ClickHouse Cloud fornece uma API com OpenAPI que permite gerenciar programaticamente sua conta e aspectos dos seus serviços.

<Note>
  Este documento aborda a ClickHouse Cloud API. Para endpoints de API do banco de dados, consulte [Cloud Endpoints API](/pt-BR/products/cloud/guides/sql-console/query-endpoints)
</Note>

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

<Image img="https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/openapi1.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=838eafd0a0de6185ae18627a1055e4ee" size="sm" alt="Aba API Keys" border width="433" height="472" data-path="images/cloud/manage/openapi1.png" />

2. 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.

<Image img="https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/openapi2.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=593722f25f605525ce48422f11f9460d" size="md" alt="Página API Keys" border width="1036" height="466" data-path="images/cloud/manage/openapi2.png" />

3. Para criar uma chave de API, especifique o nome da chave, as permissões e o tempo de expiração e, em seguida, clique em `Generate API Key`.

<br />

<Note>
  As permissões correspondem aos [roles predefinidos](/pt-BR/products/cloud/reference/security/console-roles) do ClickHouse Cloud. O role developer tem permissões somente leitura para os serviços atribuídos, e o role admin tem permissões completas de leitura e gravação.
</Note>

<Tip>
  **Query API Endpoints**

  Para usar chaves de API com [Query API Endpoints](/pt-BR/products/cloud/guides/sql-console/query-endpoints), defina Organization Role como `Member` (no mínimo) e conceda ao Service Role acesso a `Query Endpoints`.
</Tip>

<Image img="https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/openapi3.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=53f74d4f5f4d99eecb4e4e61842b0322" size="md" alt="Formulário de criação de chave de API" border width="661" height="410" data-path="images/cloud/manage/openapi3.png" />

4. A próxima tela exibirá o ID da chave e o segredo da chave. Copie esses valores e guarde-os em um local seguro, como um cofre. Esses valores não serão exibidos depois que você sair desta tela.

<Image img="https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/openapi4.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=008971d5bc5321463b55f2a420994ba4" size="md" alt="Detalhes da chave de API" border width="653" height="271" data-path="images/cloud/manage/openapi4.png" />

5. A ClickHouse Cloud API usa [HTTP Basic Authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) para verificar a validade das suas chaves de API. Veja um exemplo de como usar suas chaves de API para enviar solicitações à ClickHouse Cloud API com `curl`:

```bash theme={null}
$ KEY_ID=mykeyid
$ KEY_SECRET=mykeysecret

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

6. Ao voltar para a página **API Keys**, você verá o nome da chave, os últimos quatro caracteres do ID da chave, 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 data de expiração. As chaves também podem ser desativadas ou excluídas nesta tela.

<br />

<Note>
  Excluir uma chave de API é uma ação permanente. Todos os serviços que usam a chave perderão imediatamente o acesso ao ClickHouse Cloud.
</Note>

<Image img="https://mintcdn.com/private-7c7dfe99-fix-nav-issues/-5HsuqGEaVjyHCfx/images/cloud/manage/openapi5.png?fit=max&auto=format&n=-5HsuqGEaVjyHCfx&q=85&s=3aa72a37b3a4f5d85c85372d50c71291" size="md" alt="Página de gerenciamento de API Keys" border width="1092" height="335" data-path="images/cloud/manage/openapi5.png" />

<div id="endpoints">
  ## Endpoints
</div>

Para mais detalhes sobre os endpoints, consulte a [referência da API](/pt-BR/api-reference/organization/get-list-of-available-organizations).
Use sua chave de API e seu API Secret com a URL base `https://api.clickhouse.cloud/v1`.