NTP and PTP Server and Status

Owned by Ramya Raman (Unlicensed)
Last updated: Jul 01, 2024
11 min read

GET ntp_servers

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of all NTP Servers configuration data.

Resource URL

http://{host}/api/2.0/ntp_servers/.format

Example Request

GET 

  1. http://44.235.52.211/api/2.0/ntp_servers/.json

[ { "NtpServer": { "id": 1, "title": "utcnist.colorado.edu", "ip_address": "128.138.140.44", "network_id": 0, "status": "Got reply, offset 0.012 delay 0.100", "modified": "1612441532120", "created": "1611142282208" } }, { "NtpServer": { "id": 2, "title": "utcnist2coloradoedu", "ip_address": "128.138.141.172", "network_id": 0, "status": "No reply received in time. Next query in 6 secs", "modified": "1612441530920", "created": "1611142282208" } } ]

 

 

GET ntp_servers/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a single specific NTP Server configuration data.

Resource URL

http://{host}/api/2.0/ntp_servers/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired NTP Server to be viewed.

Example Request

GET 

  1. http://44.235.52.211/api/2.0/ntp_servers/1/.json

{     "NtpServer": {         "id": 1,         "title": "utcnist.colorado.edu",         "ip_address": "128.138.140.44",         "network_id": 0,         "status": "Sending query",         "modified": "1612441579839",         "created": "1611142282208"     } }

 

 

POST ntp_servers

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Adds a new NTP Server configuration.

Resource URL

http://{host}/api/2.0/ntp_servers/.format

Example Request

POST

  1. http://44.235.52.211/api/2.0/ntp_servers/.json

{ "NtpServer": { "title": "NEW_NIST", "ip_address": "64.90.182.55", "network_id": 0 } }

 

  

PUT ntp_servers/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Updates a single specific NTP Server configuration.

Resource URL

http://{host}/api/2.0/ntp_servers/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired NTP Server to be updated.

Example Request

PUT

  1. http://44.235.52.211/api/2.0/ntp_servers/1/.json

 

 

DELETE ntp_servers/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Deletes a single specific NTP Server configuration.

Resource URL

http://{host}/api/2.0/ntp_servers/{id}/.format

Parameters

Parameter

Data Type

Description

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired NTP to be deleted.

Example Request

DELETE 

  1. http://44.235.52.211/api/2.0/ntp_servers/6/.json

 

 

GET device_clocks/command/sync

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Synchronizes local clock.

Resource URL

http://{host}/api/2.0/device_clocks/command/sync/.format

Example Request

GET

  1. http://44.235.52.211/api/2.0/device_clocks/command/sync/.json

 

 

GET device_clocks/{device_id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns current status of local clock.

Resource URL

http://{host}/api/2.0/device_clocks/{device_id}/.format

Parameters

Parameter

Data Type

Description

Parameter

Data Type

Description

device_id
(required)

integer

The Device ID for which the Device Clock displays the clock status.

Example Request

GET

  1. http://44.235.52.211/api/2.0/device_clocks/9011/.json

 

 

GET ntp/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of all NTP Servers configuration data.

Resource URL

http://{host}/api/2.0/ntp/config/.format

Example Request

GET 

  1. http://44.235.52.211/api/2.0/ntp/config/.json

 

 

GET ntp/config/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a single specific NTP Server configuration data.

Resource URL

http://{host}/api/2.0/ntp/config/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired NTP Server to be viewed.

Example Request

GET 

  1. http://44.235.52.211/api/2.0/ntp/config/1/.json

 

 

POST ntp/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Adds a new NTP Server configuration.

Resource URL

http://{host}/api/2.0/ntp/config/.format

Example Request

POST

  1. http://44.235.52.211/api/2.0/ntp/config/.json

 

  

PUT ntp/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Updates a single specific NTP Server configuration.

Resource URL

http://{host}/api/2.0/ntp/config/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired NTP Server to be updated.

Example Request

PUT

  1. http://44.235.52.211/api/2.0/ntp/config/6/.json

 

 

DELETE ntp/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Deletes a single specific NTP Server configuration.

Resource URL

http://{host}/api/2.0/ntp/config/{id}/.format

Parameters

Parameter

Data Type

Description

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired NTP to be deleted.

Example Request

DELETE 

  1. http://44.235.52.211/api/2.0/ntp/config/6/.json

 

 

GET ptp/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of all PTP Servers configuration data.

Resource URL

http://{host}/api/2.0/ptp/config/.format

Example Request

GET 

  1. http://62.90.243.12:443/api/2.0/ptp/config/.json

 

 

GET ptp/config/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a single specific PTP Server configuration data.

Resource URL

http://{host}/api/2.0/ptp/config/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired PTP Server to be viewed.

Example Request

GET 

  1. http://62.90.243.12:443/api/2.0/ptp/config/1/.json

 

 

GET ptp/status

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns current PTP status.

Resource URL

http://{host}/api/2.0/ptp/status/.format

Example Request

GET 

  1. http://62.90.243.12:443/api/2.0/ptp/status/.json

 

 

POST ptp/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Adds a new PTP Server configuration.

Resource URL

http://{host}/api/2.0/ptp/config/.format

Example Request

POST

  1. http://44.235.52.211/api/2.0/ptp/config/.json

 

  

PUT ptp/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Updates a single specific PTP Server configuration.

Resource URL

http://{host}/api/2.0/ptp/config/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired PTP Server to be updated.

Example Request

PUT

  1. http://44.235.52.211/api/2.0/ptp/config/5/.json

 

 

DELETE ptp/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Deletes a single specific PTP Server configuration.

Resource URL

http://{host}/api/2.0/ptp/config/{id}/.format

Parameters

Parameter

Data Type

Description

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired PTP to be deleted.

Example Request

DELETE 

  1. http://44.235.52.211/api/2.0/ptp/config/5/.json