Get a Query API endpoint | ClickHouse Docs

GET/v1/organizations/{organizationId}/services/{serviceId}/query-api-endpoints/{endpointId}

Disclaimer: This beta endpoint is evolving; the API contract may change.

Returns a Query API endpoint.

Permission

The API key must have the control-plane:service:view-query-api-endpoints 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, pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$
serviceIdstringrequired
ID of the requested service.

format: uuid, pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$
endpointIdstringrequired
ID of the requested Query API endpoint.

format: uuid, pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$

Response

JSON

200

Successful response.

JSON

statusintegerrequired
HTTP status code.

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

format: uuid, pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$
resultobjectrequired
10 properties
- idstringrequired
  Unique ID of the Query API endpoint.
  
  format: uuid, pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$
- namestringrequired
  Name of the Query API endpoint.
- sqlstringrequired
  SQL executed by the endpoint.
  
  maxLength: 4194304
- databasestringrequired
  Database used by the Query API endpoint.
- parametersmap ofstringrequired
  Query parameters.
- apiKeyIdsarray ofstringrequired
  API key IDs allowed to call the endpoint.
  
  format: uuid, pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$
- rolesarray ofstringrequired
  Database roles used by the endpoint.
- allowedOriginsarray ofstringrequired
  Origins allowed by the endpoint CORS policy.
- urlstringrequired
  Public URL used to execute the endpoint.
  
  format: uri
  Example: "https://queries.clickhouse.cloud/run/00000000-0000-0000-0000-000000000000"
- ownerTypeuserorqueryApiEndpointrequired
  Owner type of the Query API endpoint. Endpoints with a user owned query cannot be updated or deleted through this API.

Get a Query API endpoint

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

const url = 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/query-api-endpoints/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/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/query-api-endpoints/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",
    "name": "string",
    "sql": "string",
    "database": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "apiKeyIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "roles": [
      "string"
    ],
    "allowedOrigins": [
      "string"
    ],
    "url": "https://queries.clickhouse.cloud/run/00000000-0000-0000-0000-000000000000",
    "ownerType": "user"
  }
}

{
  "error": "string",
  "issues": [
    {
      "path": [
        "string"
      ],
      "code": "string",
      "message": "string"
    }
  ],
  "status": 400,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

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

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

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