Pular para o conteúdo principal
POST
Criar chave

Autorizações

Authorization
string
header
obrigatório

Use o ID da chave e o segredo da chave obtidos no console do ClickHouse Cloud: https://clickhouse.com/docs/cloud/manage/openapi

Parâmetros de caminho

organizationId
string<uuid>
obrigatório

ID da organização proprietária da chave.

Corpo

application/json
expireAt
string<date-time> | null

Timestamp de expiração da chave. Se não estiver presente, for null ou estiver vazio, a chave nunca expira. ISO-8601.

hashData
object
ipAccessList
object[]

Lista de endereços IP com permissão para acessar a API usando esta chave

name
string

Nome da chave.

roles
enum<string>[]

Lista de roles atribuídas à chave. Contém pelo menos 1 elemento.

Opções disponíveis:
admin,
developer,
query_endpoints
state
enum<string>

Estado inicial da chave: 'enabled', 'disabled'. Se não for fornecido, a nova chave será 'enabled'.

Opções disponíveis:
enabled,
disabled

Resposta

Resposta bem-sucedida

requestId
string<uuid>

ID exclusivo atribuído a cada solicitação. UUIDv4

result
object
status
number

Código de status HTTP.

Exemplo:

200

Última modificação em 2 de julho de 2026