Organization

Update organization details

Updates organization fields. Requires ADMIN auth key role.

patch/v1/organizations/{organizationId}

Request

  • Base URL: https://api.clickhouse.cloud
  • URL: https://api.clickhouse.cloud/v1/organizations/{organizationId}
  • Auth: HTTP basic

Path parameters

organizationIdstring uuid required

ID of the organization to update.

Request body

namestring

Name of the organization.

enableCoreDumpsboolean

Whether crash reports (core dumps) collection is enabled for services in the organization. When disabled at the organization level, individual services cannot enable crash reports.

Response

Successful response

statusnumber

HTTP status code.

requestIdstring uuid

Unique id assigned to every request. UUIDv4

Example response

{
  "status": 200,
  "result": {
    "byocConfig": [
      {
        "state": "infra-ready",
        "accountId": "123456789012"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.