Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

GET ntp/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of all NTP in the system, with its main configuration data.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/ntp/config

Example Request

GET 

  1. https://192.168.0.22/api/5.0/ntp/config

{
    "data": [
        {
            "uuid": "79aba7c7-d17b-4d4f-a54d-04a44132f563",
            "label": "NTP",
            "ip_address": "192.168.0.1",
            "network": null,
            "modified": "2021-07-04T07:46:08.869Z",
            "created": "2021-07-04T07:46:08.869Z"
        },
        {
            "uuid": "ffdc8974-02f9-4a43-aa3f-bbc7f73a333a",
            "label": "test",
            "ip_address": "192.168.0.3",
            "network": "c39393d6-3826-4e2f-9e8e-08e2c25e99a2",
            "modified": "2021-09-21T05:15:37.734Z",
            "created": "2021-09-21T05:15:18.309Z"
        },
        {
            "uuid": "0e1355d1-fd65-4e01-918e-e2bb68d95695",
            "label": "test_Ntp",
            "ip_address": "192.168.0.2",
            "network": "c39393d6-3826-4e2f-9e8e-08e2c25e99a2",
            "modified": "2021-09-21T05:15:05.822Z",
            "created": "2021-09-21T05:15:05.822Z"
        }
    ],
    "metadata": {
        "item_count": 3,
        "total_items": 3,
        "current_page": 1,
        "sort_by": [
            {
                "field": "label",
                "direction": "ASC"
            }
        ],
        "links": {
            "current": "https://192.168.0.22/api/5.0/ntp/config"
        }
    }
}

GET ntp/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns an extended single NTP configuration view, specified by the required {uuid} parameter.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/ntp/config/{{uuid}}

Parameters

Parameter

Data Type

Description

uuid
(required)

byte

The UUID of the desired encoder.

Example Request

GET 

  1. https://192.168.0.22/api/5.0/ntp/config/0e1355d1-fd65-4e01-918e-e2bb68d95695

{
    "data": [
        {
            "uuid": "0e1355d1-fd65-4e01-918e-e2bb68d95695",
            "label": "test_Ntp",
            "created": "2021-09-21T05:15:05.822Z",
            "modified": "2021-09-21T05:15:05.822Z",
            "ip_address": "192.168.0.2",
            "network": "c39393d6-3826-4e2f-9e8e-08e2c25e99a2"
        }
    ],
    "metadata": {}
}

GET ntp/config/meta

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns all meta data used by NTP configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/ntp/config/meta

Example Request

GET 

  1. https://192.168.0.22/api/5.0/ntp/config/meta

{}

DELETE ntp/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Delete a specific NTP configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/ntp/config/{{uuid}}

Parameters

Parameter

Data Type

Description

uuid
(required)

byte

The UUID of the output to be deleted.

Example Request

DELETE 

  1. https://192.168.0.22/api/5.0/ntp/config/0e1355d1-fd65-4e01-918e-e2bb68d95695

{
    "data": [
        {
            "success": true
        }
    ],
    "metadata": {}
}

 

PUT ntp/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Edit a NTP configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/ntp/config/{{uuid}}

Parameters

Parameter

Data Type

Description

uuid
(required)

byte

The UUID of the encoder to be edited.

Example Request

PUT 

  1. https://192.168.0.22/api/5.0/ntp/config/ffdc8974-02f9-4a43-aa3f-bbc7f73a333a

Body

{
    "label": "test_NTP",
    "ip_address": "192.168.0.3",
    "network": "c39393d6-3826-4e2f-9e8e-08e2c25e99a2"
}

Response

{
    "data": [
        {
            "uuid": "ffdc8974-02f9-4a43-aa3f-bbc7f73a333a",
            "label": "test_NTP",
            "created": "2021-09-21T05:15:18.309Z",
            "modified": "2021-09-21T05:24:46.105Z",
            "ip_address": "192.168.0.3",
            "network": "c39393d6-3826-4e2f-9e8e-08e2c25e99a2"
        }
    ],
    "metadata": {}
}

POST ntp/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Add a new NTP, configured according to the attached data request.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/ntp/config

Example Request

POST 

  1. https://192.168.0.22/api/5.0/ntp/config

Body

{
    "label": "NTP new",
    "ip_address": "192.168.0.1",
    "network": "c39393d6-3826-4e2f-9e8e-08e2c25e99a2"
}

Response

{
    "data": [
        {
            "uuid": "6a14b85d-9c0a-44e3-954c-db71bd10e839",
            "label": "NTP new",
            "created": "2021-09-21T05:29:06.310Z",
            "modified": "2021-09-21T05:29:06.310Z",
            "ip_address": "192.168.0.1",
            "network": "c39393d6-3826-4e2f-9e8e-08e2c25e99a2"
        }
    ],
    "metadata": {}
}
  • No labels