GET /system/servers/{server_id}/system_time_settings

Retrieves the system time and time zone settings of a server host based on the supplied server ID.

Retrieves the system time and time zone settings of a server host based on the supplied server ID.

Table 1. GET /system/servers/{server_id}/system_time_settings resource details
MIME Type

application/json

Table 2. GET /system/servers/{server_id}/system_time_settings request parameter details
Parameter Type Optionality Data Type MIME Type Description

server_id

path

Required

Number (Integer)

text/plain

Required - The ID of the server.

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3. GET /system/servers/{server_id}/system_time_settings response codes
HTTP Response Code Unique Code Description

200

The requested system time settings record was retrieved.

404

1002

The requested system time settings record with the given server ID cannot be found.

422

1005

One or more parameters are invalid in the request.

500

1020

An error occurred during the attempt to retrieve the requested system time settings with the given server ID.

500

1022

Timeout while performing the task.

Response Description

Server system time settings that contain the following fields:
  • timezone_id - String - the current time zone
  • current_time - Long - The current epoch time (number of milliseconds after Epoch).
  • is_sync_with_ntp_server - boolean - Is the ntp service used to synchronize the system time with configured NTP time servers?
  • ntp_server_addresses - Array - The array of the configured NTP server addresses. Null if is_sync_with_ntp_server is false.

Response Sample


{
    "current_time": 42,
    "ntp_server_addresses": [
        "String"
    ],
    "sync_with_ntp_server": true,
    "timezone_id": "String"
}