Atualizar chave

Atualiza as propriedades da API key.

PATCH /v1/organizations/{organizationId}/keys/{keyId}

Atualizar chave

cURL

curl --request PATCH \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys/{keyId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "expireAt": "2023-11-07T05:31:56Z",
  "ipAccessList": [
    {
      "description": "<string>",
      "source": "<string>"
    }
  ],
  "name": "<string>",
  "roles": []
}
'

200

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

Autorizações

Authorization · string · header · obrigatório

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

Parâmetros de caminho

organizationId · string<uuid> · obrigatório

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

keyId · string<uuid> · obrigatório

ID da chave a ser atualizada.

Corpo

application/json

expireAt · string<date-time> | null

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

ipAccessList · object[]

Lista de endereços IP autorizados a acessar a API usando esta chave

Show child attributes

name · string

Nome da chave

roles · enum<string>[]

Lista de funções atribuídas à chave. Contém pelo menos 1 elemento.

Opções disponíveis: admin, developer, query_endpoints

state · enum<string>

Estado da chave: 'enabled', 'disabled'.

Opções disponíveis: enabled, disabled

Resposta

200

application/json

Resposta bem-sucedida

requestId · string<uuid>

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

result · object

Show child attributes

status · number

Código de status HTTP.

Exemplo:

200