ntp
- POST /infrastructure/ntp/validate
Validate candidate NTP servers
Checks each candidate NTP server from the given node without storing anything and returns one result per server.
- Request JSON Object:
node_ip (string) – (required)
nts (boolean) – NTS is off by default (opt-in): send “nts”: true only with NTS-capable servers. A pool such as pool.ntp.org must be left without NTS.
servers[] (string)
- Status Codes:
200 OK – per-server validation results
400 Bad Request – invalid request body
- GET /infrastructure/ntp/zones
List zones with NTP configuration
Returns every zone with its NTP configuration.
- Status Codes:
200 OK – zones with their NTP configuration
500 Internal Server Error – zones could not be listed
- POST /infrastructure/ntp/zones/{zoneid}/apply
Apply a zone’s NTP servers
Pushes the zone’s stored NTP server list to every node in the zone; the body is optional.
- Parameters:
zoneid (string) – Zone ID
- Status Codes:
200 OK – zone and per-node apply results
207 Multi Status – at least one node failed to apply
400 Bad Request – allowed_subnet is not a CIDR or is a /0
500 Internal Server Error – apply failed
- GET /infrastructure/ntp/zones/{zoneid}/nodes
Get NTP state for a zone’s nodes
Returns the zone roll-up of worst clock offset, skew and sync state, with the per-node server breakdown when per_node is true or 1.
- Parameters:
zoneid (string) – Zone ID
- Query Parameters:
per_node (string) – true or 1 to include the per-node breakdown
- Status Codes:
200 OK – zone roll-up and optional per-node details
500 Internal Server Error – node servers could not be read
- GET /infrastructure/ntp/zones/{zoneid}/servers
Get a zone’s NTP servers
Returns the zone’s effective NTP servers and whether they come from the zone, site or global default.
- Parameters:
zoneid (string) – Zone ID
- Status Codes:
200 OK – zone, servers and source
500 Internal Server Error – zone servers could not be read
- POST /infrastructure/ntp/zones/{zoneid}/servers
Add an NTP server to a zone
Validates one server from a zone node, appends it to the zone list and applies the list to the zone nodes.
- Parameters:
zoneid (string) – Zone ID
- Status Codes:
200 OK – zone, servers, validation result and per-node apply results
207 Multi Status – server added but at least one node failed to apply
400 Bad Request – invalid request body
422 Unprocessable Entity – server rejected (invalid, duplicate or zone full) or zone lookup failed
- PUT /infrastructure/ntp/zones/{zoneid}/servers/{server}
Replace an NTP server in a zone
Replaces the named server in the zone list with the new value after validating it, then applies the list to the zone nodes.
- Parameters:
zoneid (string) – Zone ID
server (string) – Server being replaced
- Status Codes:
200 OK – zone, servers, validation result and per-node apply results
207 Multi Status – server replaced but at least one node failed to apply
400 Bad Request – invalid request body
404 Not Found – zone does not have the named server
409 Conflict – an active job blocks the change
422 Unprocessable Entity – new value failed validation or no site mapped to the zone
- GET /infrastructure/ntp/zones/{zoneid}/timezone
Get a zone’s timezone
Returns the zone’s configured timezone and each node’s current OS timezone.
- Parameters:
zoneid (string) – Zone ID
- Status Codes:
200 OK – zone, configured timezone and per-node timezones
500 Internal Server Error – timezone could not be read