Atualizar detalhes da organization

Atualiza os campos da organização. Requer a função ADMIN da chave de autenticação.

PATCH /v1/organizations/{organizationId}

Atualizar detalhes da organization

cURL

curl --request PATCH \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "privateEndpoints": {
    "add": [
      {
        "description": "<string>",
        "id": "<string>"
      }
    ],
    "remove": [
      {
        "description": "<string>",
        "id": "<string>"
      }
    ]
  }
}
'

200

{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "byocConfig": [
      {
        "accountName": "<string>",
        "id": "<string>"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "privateEndpoints": [
      {
        "description": "<string>",
        "id": "<string>"
      }
    ]
  },
  "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 a ser atualizada.

Corpo

application/json

name · string

Nome da organização.

privateEndpoints · object

Show child attributes

Resposta

200

application/json

Resposta bem-sucedida

requestId · string<uuid>

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

result · object

Show child attributes

status · number

Código de status HTTP.

Exemplo:

200