This endpoint contains NTP server addresses.

URL

GET https://<IP-address-of-SPS>/api/configuration/datetime/ntp_servers

Cookies

Cookie name	Description	Required	Values
session_id	Contains the authentication token of the user	Required	The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For more information on authentication, see Authenticate to the SPS REST API. NOTE: This session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format).

Sample request

The following command lists NTP server addresses.

curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/datetime/ntp_servers

Response

The following is a sample response received when listing NTP server addresses.

For more information on the meta object, see Message format.

{
  "body": [
    {
      "selection": "fqdn",
      "value": "pool.ntp.org"
    }
  ],
  "key": "ntp_servers",
  "meta": {
    "first": "/api/configuration/datetime/ntp_servers",
    "href": "/api/configuration/datetime/ntp_servers",
    "last": "/api/configuration/datetime/timezone",
    "next": "/api/configuration/datetime/timezone",
    "parent": "/api/configuration/datetime",
    "previous": null,
    "transaction": "/api/transaction"
  }
}

Element		Type	Description
key		string	Top level element, contains the ID of the endpoint.
body		Top level element (list)	Contains the list of NTP server addresses.
	selection	string	Defines the address type (IP or domain name). Possible values are: fqdn The NTP server address is provided as a fully qualified domain name. ip The NTP server address is provided as an IP address.
	value	string	The address of the NTP server.

Add an NTP server

To add an NTP server's address, you have to:

1. Open a transaction.

   For more information, see Open a transaction.

2. Create the JSON object for the new NTP server address list.

   POST the JSON object to the https://<IP-address-of-SPS>/api/configuration/datetime/ntp_servers endpoint. You can find a detailed description of the available parameters listed in Element .

3. Commit your changes.

   For more information, see Commit a transaction.

Modify an NTP server address

To modify an NTP server's address, you have to:

1. Open a transaction.

   For more information, see Open a transaction.

2. Modify the JSON object of the NTP server address list.

   PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/datetime/ntp_servers endpoint. You can find a detailed description of the available parameters listed in Element .

3. Commit your changes.

   For more information, see Commit a transaction.

Status and error codes

The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.

Code	Description	Notes
201	Created	The new resource was successfully created.
400	InvalidQuery	The requested filter or its value is invalid.
401	Unauthenticated	The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved.
403	Unauthorized	The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved.
404	NotFound	The requested object does not exist.