Get organization details | ClickHouse Docs

GET/v1/organizations/{organizationId}

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

Authorizationstringheaderrequired
Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

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

Get organization details

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08 \
  --header 'Authorization: Basic <token>'

const url = 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08';
const options = {method: 'GET', headers: {Authorization: 'Basic <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08"

headers = {"Authorization": "Basic <token>"}

response = requests.get(url, headers=headers)

print(response.text)

Response example

{
  "status": 200,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "result": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "createdAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "privateEndpoints": [
      {
        "id": "string",
        "description": "string",
        "cloudProvider": "gcp",
        "region": "ap-northeast-1"
      }
    ],
    "byocConfig": [
      {
        "id": "string",
        "state": "infra-ready",
        "accountName": "string",
        "regionId": "ap-northeast-1",
        "cloudProvider": "gcp",
        "displayName": "string"
      }
    ],
    "enableCoreDumps": true
  }
}

{
  "status": 400,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

{
  "status": 500,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}