Skip to content
ClickHouse Docs
49.6kGet Started

Get organization details

GET/v1/organizations/{organizationId}
API playground

Returns details of a single organization. In order to get the details, the auth key must belong to the organization.

Permission

The API key must have the control-plane:organization:view permission.

Authorizations

Path parameters

  • organizationIdstringrequired

    ID of the requested organization.

    format: uuid

Response

JSON

200

Successful response

JSON
  • statusoptionalnumber

    HTTP status code.

    Example: 200
  • requestIdoptionalstring

    Unique id assigned to every request. UUIDv4

    format: uuid
  • resultoptionalobject
    7 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

      7 properties
      • idoptionalstring

        Unique identifier of the BYOC configuration

      • stateoptionalinfra-provisioningorinfra-terminatedorinfra-terminatingorinfra-readyorinfra-degradedorinfra-upgrading

        State of the infrastructure

        Example: "infra-ready"
      • accountIdoptionalstring

        Cloud account ID the BYOC infrastructure is bound to: AWS account ID, GCP project ID, or Azure subscription ID

        Example: "123456789012"
      • accountNamedeprecatedstring

        DEPRECATED. Use accountId instead. Cloud account ID the BYOC infrastructure is bound to

      • 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.

    • capabilitiesoptionalobject
      1 properties
      • snapshotsoptionalboolean

        Whether the organization is eligible to use service snapshots: true only when the organization has the snapshots feature enabled, is on a PPv2 tier, and has the backups entitlement — the same conditions enforced when a snapshotConfiguration is saved. Check this before configuring snapshots on a service. Snapshots apply to primary services only, so a secondary/replica service is rejected regardless of organization eligibility.

Report an issue
Navigation