Skip to main content
PATCH
/
v1
/
organizations
/
{organizationId}
Update organization details
curl --request PATCH \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "privateEndpoints": {
    "add": [
      {
        "id": "<string>",
        "description": "<string>"
      }
    ],
    "remove": [
      {
        "id": "<string>",
        "description": "<string>"
      }
    ]
  }
}
'
{
  "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>"
      }
    ],
    "byocConfig": [
      {
        "id": "<string>",
        "accountName": "<string>"
      }
    ]
  }
}

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 organization to update.

Body

application/json
​
name
string

Name of the organization.

​
privateEndpoints
object

Response

Successful response

​
status
number

HTTP status code.

Example:

200

​
requestId
string<uuid>

Unique id assigned to every request. UUIDv4

​
result
object