Endpoint

/v1/time/status

GET

Retrieve the time status of the underlying system

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "time_status_response",
  "type": "object",
  "properties": {
    "config": {
      "description": "config",
      "type": "object",
      "properties": {
        "use_ad_for_primary": {
          "description": "Whether to use the Active Directory controller as the primary NTP server",
          "type": "boolean"
        },
        "ntp_servers": {
          "type": "array",
          "items": {
            "description": "List of NTP servers",
            "type": "string"
          }
        }
      }
    },
    "time": {
      "description": "time",
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "TIME_NOT_SYNCHRONIZING",
        "TIME_SYNCHRONIZING"
      ],
      "description": "status:\n * `TIME_NOT_SYNCHRONIZING` - TIME_NOT_SYNCHRONIZING,\n * `TIME_SYNCHRONIZING` - TIME_SYNCHRONIZING"
    }
  }
}