Get organization details

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

GET /v1/organizations/{organizationId}

Get organization details

cURL

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId} \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "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"
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

organizationId · string<uuid> · required

ID of the requested organization.

Response

200

application/json

Successful response

status · number

HTTP status code.

Example:

200

requestId · string<uuid>

Unique id assigned to every request. UUIDv4

result · object

Show child attributes