Endpoint

/v1/time/settings

GET

Retrieve the server's time-management configuration. Refer to the 'Set Time Configuration' method for a description of the returned fields.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "conf_time_state",
  "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"
      }
    }
  }
}

PUT

Set the server's time-management configuration.

Parameters

Name Description Required
If-Match ETag for expected version No

Request

Schema

{
  "description": "conf_time_state",
  "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"
      }
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "conf_time_state",
  "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"
      }
    }
  }
}

PATCH

Set just the provided components of the server's time-management configuration.

Parameters

Name Description Required
If-Match ETag for expected version No

Request

Schema

{
  "description": "conf_time_state_patch",
  "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"
      }
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "conf_time_state",
  "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"
      }
    }
  }
}