Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

Get a Query API endpoint

View as MarkdownEdit this pageReport an issueSet up docs MCP
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.

Authorizations

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.

Navigation