Configure Time Settings

Configure Time Settings
Configure Time Settings (NTP, Date & Timezone)

Configures time settings for the HCX Manager appliance. Supports NTP server configuration, manual time setting, and timezone selection.

Validations:

  • NTP server must be valid hostname or IP address
  • Timezone must be valid (e.g., America/Los_Angeles, UTC, Europe/London)
  • Datetime format: MMM dd yyyy HH:mm:ss (e.g., Nov 14 2025 10:30:00)
  • Cannot set manual datetime when NTP is configured

Important Notes:

  • Services restart may be required: Component services may need restart for NTP changes to take effect
  • NTP servers can be hostnames or IP addresses
  • Timezone changes take effect immediately
  • Incorrect time can cause certificate validation failures
Request
URI
PUT
https://{server}:9443/system/timesettings
COPY
Request Body
TimeSettingsConfiguration of type(s) application/json
Required
{
    "ntpServer": [
        "pool.ntp.org",
        "time.google.com"
    ],
    "datetime": "Nov 14 2025 10:30:00",
    "timezone": "America/Los_Angeles"
}
array of string
ntpServer
Optional

List of NTP server hostnames or IP addresses

string
datetime
Optional

Manual date/time (only when NTP not configured). Format is 'MMM dd yyyy HH:mm:ss'

string
timezone
Optional

Timezone identifier (e.g., America/Los_Angeles, UTC, Europe/London)

Authentication
This operation uses the following authentication methods.
Responses
200

Time settings configured successfully

Returns TimeSettingsConfiguration of type(s) application/json
{
    "ntpServer": [
        "pool.ntp.org",
        "time.google.com"
    ],
    "datetime": "Nov 14 2025 10:30:00",
    "timezone": "America/Los_Angeles"
}
array of string
ntpServer
Optional

List of NTP server hostnames or IP addresses

string
datetime
Optional

Manual date/time (only when NTP not configured). Format is 'MMM dd yyyy HH:mm:ss'

string
timezone
Optional

Timezone identifier (e.g., America/Los_Angeles, UTC, Europe/London)


400

Bad request - Invalid time settings configuration

Returns ErrorResponse of type(s) application/json
{
    "isSuccess": false,
    "message": "Request schema validation failed",
    "httpStatusCode": 400
}
boolean
isSuccess
Required

Indicates if the operation was successful

string
message
Required

Human-readable error message

integer
httpStatusCode
Required

HTTP status code


500

Internal server error - Failed to configure time settings

Returns ErrorResponse of type(s) application/json
{
    "isSuccess": false,
    "message": "Request schema validation failed",
    "httpStatusCode": 400
}
boolean
isSuccess
Required

Indicates if the operation was successful

string
message
Required

Human-readable error message

integer
httpStatusCode
Required

HTTP status code


Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/system/timesettings