Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

List Query API endpoints

View as MarkdownEdit this pageReport an issueSet up docs MCP
GET/v1/organizations/{organizationId}/services/{serviceId}/query-api-endpoints

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

Returns all active Query API endpoints for the service.

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)$

Query parameters

  • cursoroptionalstring

    Cursor returned in pagination.nextCursor from the previous page.

  • limitoptionalinteger

    Maximum number of records to return per page. Defaults to 100. Maximum is 100.

    maximum: 100
    Default: 100

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
    2 properties
    • itemsarray ofobjectrequired

      Active Query API endpoints for the service, including both owner types.

      8 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.

      • databasestringrequired

        Database used by the Query API endpoint.

      • 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.

    • paginationobjectrequired
      4 properties
      • totalRecordsintegerrequired

        Total number of records available.

      • currentCursorstringornullrequired

        Cursor for the current page. Null for the first page.

        2 variants

        One of the following:

        • string
        • null
      • nextCursorstringornullrequired

        Cursor for the next page. Null if there are no more results.

        2 variants

        One of the following:

        • string
        • null
      • limitintegerrequired

        Maximum number of records returned per page.

Navigation