Query API endpoints

List Query API endpoints

Returns all active Query API endpoints for the service.

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

Request

Base URL: https://api.clickhouse.cloud
URL: https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/query-api-endpoints
Auth: HTTP basic

Path parameters

organizationIdstring uuid required

ID of the requested organization.

serviceIdstring uuid required

ID of the requested service.

Query parameters

cursorstring

Cursor returned as nextCursor on the previous page.

limitinteger

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

Response

Successful response.

limitinteger required

Maximum number of results returned in this page.

totalCountinteger nullable required

Total number of results across all pages. It has only informative value, thus is not guaranteed and it is provided on a best-effort basis. Null if the total count is unknown.

nextCursorstring nullable required

Cursor for the next page, to be sent as the cursor query parameter. Null on the last page.

statusinteger required

HTTP status code.

requestIdstring uuid required

Unique id assigned to every request. UUIDv4

Example response

{
  "result": [
    {
      "url": "https://queries.clickhouse.cloud/run/00000000-0000-0000-0000-000000000000"
    }
  ],
  "status": 200
}

Changes

No recorded changes to this operation across all 1 revision of this API.