Skip to main content
POST
/
v1
/
organizations
/
{organizationId}
/
services
/
{serviceId}
/
serviceQueryEndpoint
Upsert the service query endpoint for a given instance
curl --request POST \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/serviceQueryEndpoint \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "roles": [],
  "openApiKeys": [
    "<string>"
  ],
  "allowedOrigins": "<string>"
}
'
{
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "id": "<string>",
    "openApiKeys": [
      "<string>"
    ],
    "roles": [],
    "allowedOrigins": "<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 requested organization.

​
serviceId
string<uuid>
required

ID of the requested service.

Body

application/json
​
roles
enum<string>[]

The roles

Available options:
sql_console_read_only,
sql_console_admin
​
openApiKeys
string[]

The version of the service query endpoint

​
allowedOrigins
string

The allowed origins as comma separated list of domains

Response

Successful response

​
status
number

HTTP status code.

Example:

200

​
requestId
string<uuid>

Unique id assigned to every request. UUIDv4

​
result
object