Upsert the service query endpoint for a given instance

POST/v1/organizations/{organizationId}/services/{serviceId}/serviceQueryEndpoint

Create the service query endpoint that allows executing queries via API.

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
serviceIdstringrequired
ID of the requested service.

format: uuid

Request bodyJSON

rolesoptionalarray ofsql_console_read_onlyorsql_console_admin
The roles
openApiKeysoptionalarray ofstring
The version of the service query endpoint
allowedOriginsoptionalstring
The allowed origins as comma separated list of domains

Response

JSON

200

Successful response

JSON

statusoptionalnumber
HTTP status code.

Example: 200
requestIdoptionalstring
Unique id assigned to every request. UUIDv4

format: uuid
resultoptionalobject
4 properties
- idoptionalstring
  The id of the service query endpoint
- openApiKeysoptionalarray ofstring
  List of OpenAPI keys that can access the service query endpoint
- rolesoptionalarray ofsql_console_read_onlyorsql_console_admin
  List of roles that can access the service query endpoint
- allowedOriginsoptionalstring
  The allowed origins as comma separated list of domains

Upsert the service query endpoint for a given instance

curl --request POST \
  --url https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/serviceQueryEndpoint \
  --header 'Authorization: Basic <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "roles": [
    "sql_console_read_only"
  ],
  "openApiKeys": [
    "string"
  ],
  "allowedOrigins": "string"
}
'

const url = 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/serviceQueryEndpoint';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Basic <token>'},
  body: JSON.stringify({
    roles: ['sql_console_read_only'],
    openApiKeys: ['string'],
    allowedOrigins: 'string'
  })
};

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/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/serviceQueryEndpoint"

payload = {
    "roles": ["sql_console_read_only"],
    "openApiKeys": ["string"],
    "allowedOrigins": "string"
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Basic <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "status": 200,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "result": {
    "id": "string",
    "openApiKeys": [
      "string"
    ],
    "roles": [
      "sql_console_read_only"
    ],
    "allowedOrigins": "string"
  }
}

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

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