Versions Compared

Old Version 1

changes.mady.by.user Ramya Raman

Saved on

compared with

New Version Current

changes.mady.by.user Ramya Raman

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

Code Block
languagejson
{ "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",

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

Code Block
languagejson
{
    "data": [
        {
            "modifieduuid": "2021-09-21T05:15:05.822Z79aba7c7-d17b-4d4f-a54d-04a44132f563",
            "createdlabel": "2021-09-21T05:15:05.822Z"NTP",
        }     ]"ip_address": "192.168.0.1",
    "metadata": {         "item_count""network": 3null,
         "total_items   "modified": 3,
   "2021-07-04T07:46:08.869Z",
    "current_page": 1,       "created":  "sort_by": ["2021-07-04T07:46:08.869Z"
        },
    {    {
            "fielduuid": "labelffdc8974-02f9-4a43-aa3f-bbc7f73a333a",
                "directionlabel": "ASCtest",
            }
"ip_address": "192.168.0.3",
       ],         "linksnetwork": {"c39393d6-3826-4e2f-9e8e-08e2c25e99a2",
            "currentmodified": "https://192.168.0.22/api/5.0/ntp/config2021-09-21T05:15:37.734Z",
            "created": "2021-09-21T05:15:18.309Z"
        },
    }
}

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

Code Block
languagejson
{
    "data": [    {
            "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)

string

The UUID of the desired ntp.

Example Request

GET 

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

Code Block
languagejson
{
    "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": {}
}

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)

string

The UUID of the ntp to be deleted.

Example Request

DELETE 

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

Code Block
languagejson
{
    "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)

string

The UUID of the ntp to be edited.

Example Request

PUT 

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

Body

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

Response

Code Block
languagejson
{
    "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

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

Response

Code Block
languagejson
{
    "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": {}
}

POST ntp/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Add multiple 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

Code Block
languagejson
{
    "data": [
        {
    "label": "multi_NTP_Test1",
    "ip_address": "192.168.0.1",
    "network": "Auto"
},
        {
    "label": "multi_NTP_Test2",
    "ip_address": "192.168.0.3",
    "network": "Auto"
}
    ]
}

Response

Code Block
languagejson
{
    "data": [
        {
            "uuid": "2cd2edf2-3165-4155-9b35-40a3b526ff06",
            "label": "multi_NTP_Test1",
            "created": "2022-02-23T09:58:53.496Z",
            "modified": "2022-02-23T09:58:53.496Z",
            "ip_address": "192.168.0.1",
            "network": "Auto"
        },
        {
            "uuid": "0e1355d196d12ce5-fd65916e-4e014b24-918ea2d3-e2bb68d956956e76f14ca36a",
            "label": "testmulti_NTP_NtpTest2",
            "created": "20212022-0902-21T0523T09:1558:0553.822Z496Z",
            "modified": "20212022-0902-21T0523T09:1558:0553.822Z496Z",
            "ip_address": "192.168.0.23",
            "network": "c39393d6-3826-4e2f-9e8e-08e2c25e99a2Auto"
        }
    ],
    "metadata": {}
}

GET

PUT ntp/config

/meta

multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns all meta data used by NTP configuration

PUT

Edit multiple NTP, configured according to the attached data request.

Resource URL

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

Example Request

GETPOST 

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

Body

Code Block

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

{
Code Block
languagejson
languagejson
{}

DELETE ntp/config/{uuid}

Resource Information

json
{
    "data": [
        {
            "uuid": "2cd2edf2-3165-4155-9b35-40a3b526ff06",
            "label": "multi_NTP_Test1_edited",
            "ip_address": "192.168.0.1",
            "datanetwork": ["Auto"
        },
        {
            "uuid": "96d12ce5-916e-4b24-a2d3-6e76f14ca36a",
     "success": true       "label": "multi_NTP_Test2_edited",
         }     ],
    "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

Code Block
languagejson
{
    "label": "test_NTP","ip_address": "192.168.0.3",
            "network": "Auto"
        }
    ]
}

Response

Code Block
languagejson
{
    "data": [
        {
            "uuid": "2cd2edf2-3165-4155-9b35-40a3b526ff06",
            "label": "multi_NTP_Test1_edited",
            "created": "2022-02-23T09:58:53.496Z",
            "modified": "2022-02-23T10:01:52.221Z",
            "ip_address": "192.168.0.31",
            "network": "c39393d6-3826-4e2f-9e8e-08e2c25e99a2"
}

Response

Code Block
languagejson
{Auto"
       "data": [ },
        {
            "uuid": "ffdc897496d12ce5-02f9916e-4a434b24-aa3fa2d3-bbc7f73a333a6e76f14ca36a",
            "label": "testmulti_NTP_Test2_edited",
            "created": "20212022-0902-21T0523T09:1558:1853.309Z496Z",
            "modified": "20212022-0902-21T0523T10:2401:4652.105Z221Z",
            "ip_address": "192.168.0.3",
            "network": "c39393d6-3826-4e2f-9e8e-08e2c25e99a2Auto"
        }
    ],
    "metadata": {}
}

POST

DELETE ntp/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

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

DELETE

Delete multiple NTP configuration.

Resource URL

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

Example Request

POST 

https://192.168.0.22/api/5.0

/ntp/configBody

Example Request

Code Block
languagejson
{ "label": "NTP new", "ip_address": "

DELETE 

  1. https://192.168.0

.1", "network": "c39393d6-3826-4e2f-9e8e-08e2c25e99a2" }

Response

Code Block
languagejson
{ "data": [ { "uuid": "6a14b85d-9c0a-44e3-954c-db71bd10e839",

  1. .22/api/5.0/ntp/config

Body

Code Block
languagejson
{
     "labeldata": "NTP[
new",             "created": "2021-09-21T05:29:06.310Z",
            "modified": "2021-09-21T05:29:06.310Z",
   "2cd2edf2-3165-4155-9b35-40a3b526ff06",
        "ip_address": "192.168.0.1",96d12ce5-916e-4b24-a2d3-6e76f14ca36a"
      ]
}

Respone

Code Block
languagejson
{
      "networkdata": "c39393d6-3826-4e2f-9e8e-08e2c25e99a2"{
        "success": }true
    ]},
    "metadata": {}
}