Skip to content
You're viewing documentation for v2026.11.6-beta. It may be out of date.Go to latest
TimescaleDB Enterprise
Esc
↑↓navigate↵open⌘Jpreview

Get the console clock

The console compares the clock of its host with the public NTP pool every 5 minutes. When the pool does not answer, it compares the clock with the clocks of the servers.

GET/api/v1/console/clock
Authorization
tse_sessionAPI key · cookierequired
Responses
200

OK

checked_atstring<date-time>

The time of the last measurement

limit_secondsinteger<int64>required

The largest offset for which the status is ok

offset_secondsnumber<double>

The time to add to the console clock to get the reference time. Absent when the status is unknown

referencestring

The NTP server that answered, or the number of servers

sourcestring

The reference: an NTP server, or the clocks of the servers

Allowed:ntpservers
statusstringrequired

ok: the clock is within limit_seconds of the reference. wrong: it is not. unknown: no NTP server answered, and fewer than two servers have clocks that agree

Allowed:okwrongunknown
default

Error

codestring

Stable code of the refusal, when the route has codes

detailsstring[]

Additional detail, e.g. per-field validation failures

errorstringrequired

Human-readable error message

Request
curl -X GET 'https://console.example.com/api/v1/console/clock' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "checked_at": "2019-08-24T14:15:22Z",
  "limit_seconds": 0,
  "offset_seconds": 0.1,
  "reference": "string",
  "source": "ntp",
  "status": "ok"
}