Clock

GET /network/clock

status: stable

Query parameters

  • forceNtpCheck boolean

    NTP checks are cached for short duration to avoid sending too many queries to the central NTP servers. In some cases however, a client may want to force a new check.

    When this flag is set, the request will block until NTP server responds or will timeout after a while without any answer from the NTP server.

Responses

  • 406 application/json

    Not Acceptable

    Hide response attributes Show response attributes object
    • message string Required

      May occur when providing an invalid 'Accept' header.

    • code string Required

      Value is not_acceptable.
  • 200 application/json

    Ok

    Hide response attributes Show response attributes object
    • status string Required

      Values are available, unavailable, or pending.

    • offset object

      if: status == available
      Drift offset of the local clock.

      Hide offset attributes Show offset attributes object
GET /network/clock 
curl \
 --request GET https://localhost:8090/v2/network/clock
Response examples (406) 
{
  "message": "string",
  "code": "not_acceptable"
}
Response examples (200) 
{
  "status": "available",
  "offset": {
    "quantity": 14,
    "unit": "microsecond"
  }
}