List Postgres server logs | ClickHouse Docs

GET/v1/organizations/{organizationId}/postgres/{postgresId}/logs

This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future.

Returns PostgreSQL server log entries for a Postgres service within the given time window, most recent first by default (override with sort_order). Results are paginated with limit/offset; advance offset until a page returns fewer than limit entries to read the full window. The time range must not exceed 30 days, and to_date must be after from_date.

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 organization that owns the Postgres service.

format: uuid
postgresIdstringrequired
ID of the requested Postgres service.

format: uuid

Query parameters

from_datestringrequired
Inclusive start of the time window (RFC 3339 date-time).

format: date-time
to_datestringrequired
Inclusive end of the time window (RFC 3339 date-time).

format: date-time
body_containsoptionalstring
Case-sensitive substring the log body must contain.
severityoptionalstring
Filter to log entries with this PostgreSQL severity (for example, ERROR, WARNING, LOG).
sort_orderoptionalascordesc
Sort order. One of asc or desc.

Default: "desc"
limitoptionalinteger
Maximum number of results to return.

maximum: 2000, minimum: 1
Default: 50
offsetoptionalinteger
Number of results to skip before returning.

minimum: 0
Default: 0

Response

JSON

200

Successful response

JSON

statusoptionalnumber
HTTP status code.

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

format: uuid
resultoptionalarray ofobject
3 properties
- timestampstringrequired
  Time the entry was logged (RFC 3339).
  
  format: date-time
- severitystringrequired
  PostgreSQL severity of the entry (for example, LOG, WARNING, ERROR, FATAL, PANIC).
- bodystringrequired
  Raw log entry body as emitted by PostgreSQL. Structured bodies are returned as a JSON-encoded string.

List Postgres server logs

curl --request GET \
  --url 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/postgres/497f6eca-6276-4993-bfeb-53cbbbba6f08/logs?from_date=2019-08-24T14%3A15%3A22Z&to_date=2019-08-24T14%3A15%3A22Z' \
  --header 'Authorization: Basic <token>'

const url = 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/postgres/497f6eca-6276-4993-bfeb-53cbbbba6f08/logs?from_date=2019-08-24T14%3A15%3A22Z&to_date=2019-08-24T14%3A15%3A22Z';
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/postgres/497f6eca-6276-4993-bfeb-53cbbbba6f08/logs?from_date=2019-08-24T14%3A15%3A22Z&to_date=2019-08-24T14%3A15%3A22Z"

headers = {"Authorization": "Basic <token>"}

response = requests.get(url, headers=headers)

print(response.text)

Response example

{
  "status": 200,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "result": [
    {
      "timestamp": "2019-08-24T14:15:22Z",
      "severity": "string",
      "body": "string"
    }
  ]
}

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

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