Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

Update organization details

View as MarkdownEdit this pageReport an issueSet up docs MCP
PATCH/v1/organizations/{organizationId}

Updates organization fields. Requires ADMIN auth key role.

Authorizations

Path parameters

  • organizationIdstringrequired

    ID of the organization to update.

    format: uuid

Request bodyJSON

  • nameoptionalstring

    Name of the organization.

  • privateEndpointsoptionalobject
    2 properties
    • adddeprecatedarray ofobject

      DEPRECATED. Elements to add. Executed after "remove" part is processed. Please use the Update Service Basic Details endpoint with the privateEndpointIds field instead to modify the private endpoints.

      4 properties
      • idoptionalstring

        Private endpoint identifier

      • descriptionoptionalstring

        Optional description of private endpoint

      • cloudProvideroptionalgcporawsorazure

        Cloud provider in which the private endpoint is lcoated

      • regionoptionalap-northeast-1orap-northeast-2orap-south-1orap-southeast-1orap-southeast-2orca-central-1+18 more

        Region in which the private endpoint is located

    • removeoptionalarray ofobject

      Elements to remove. Executed before "add" part is processed.

      4 properties
      • idoptionalstring

        Private endpoint identifier

      • descriptionoptionalstring

        Optional description of private endpoint

      • cloudProvideroptionalgcporawsorazure

        Cloud provider in which the private endpoint is lcoated

      • regionoptionalap-northeast-1orap-northeast-2orap-south-1orap-southeast-1orap-southeast-2orca-central-1+18 more

        Region in which the private endpoint is located

  • enableCoreDumpsoptionalboolean

    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

JSON

200

Successful response

JSON
  • statusoptionalnumber

    HTTP status code.

    Example: 200
  • requestIdoptionalstring

    Unique id assigned to every request. UUIDv4

    format: uuid
  • resultoptionalobject
    6 properties
    • idoptionalstring

      Unique organization ID.

      format: uuid
    • createdAtoptionalstring

      The timestamp the organization was created. ISO-8601.

      format: date-time
    • nameoptionalstring

      Name of the organization.

    • privateEndpointsoptionalarray ofobject

      List of private endpoints for organization

      4 properties
      • idoptionalstring

        Private endpoint identifier

      • descriptionoptionalstring

        Description of private endpoint

      • cloudProvideroptionalgcporawsorazure

        Cloud provider in which the private endpoint is lcoated

      • regionoptionalap-northeast-1orap-northeast-2orap-south-1orap-southeast-1orap-southeast-2orca-central-1+18 more

        Region in which the private endpoint is located

    • byocConfigoptionalarray ofobject

      BYOC configuration for the organization

      6 properties
      • idoptionalstring

        Unique identifier of the BYOC configuration

      • stateoptionalinfra-readyorinfra-provisioningorinfra-terminated

        State of the infrastructure

      • accountNameoptionalstring

        Name of the account

      • regionIdoptionalap-northeast-1orap-northeast-2orap-south-1orap-southeast-1orap-southeast-2orca-central-1+18 more

        Region for which the BYOC has been configured and where it is possible to create services

      • cloudProvideroptionalgcporawsorazure

        Cloud provider of the region

      • displayNameoptionalstring

        Human readable name for infrastructure

    • enableCoreDumpsoptionalboolean

      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.

Navigation