Versions Compared

Old Version 1

changes.mady.by.user Ramya Raman (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Ramya Raman (Unlicensed)

Saved on

Key

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

GET networks/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

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

Resource URL

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

Example Request

GET 

  1. https://192.168.0.22/api/5.01/networks/config

Code Block
languagejson
{
    "data": [
        {
            "uuid": "bbfd98b1f74cc09c-f1415ad0-41e24cf1-90d7ae30-83771d10b2a4e8911fe7362d",
            "label": "Nic1",
            "proxycreated": null"2022-10-25T09:38:03.310Z",
            "modified": "20212022-0710-07T0525T09:4038:4903.308Z310Z",
            "createdproxy": "2021-07-07T05:40:49.308Z"null
        },
        {
            "uuid": "c39393d6944f165b-3826696e-4e2f4810-9e8e8c64-08e2c25e99a26bd7d475e406",
            "label": "Nic2BLUE_1",
            "proxycreated": null"2023-04-13T11:03:11.605Z",
            "modified": "20212023-0704-07T0513T11:4003:5611.491Z605Z",
            "createdproxy": "2021-07-07T05:40:56.491Z"null
        }
    ],
    "metadata": {
        "item_count": 2,
        "total_items": 2,
        "current_page": 1,
        "sort_by": [
            {
   : [
            "field": "label",{
                 "directionlabel": "ASC"
            }
        ],
        "links": {
            "current": "http://192.168.010.2253/api/5.01/networks/config"
        }
    }
}

GET networks/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

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

Resource URL

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

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the desired Networks.

Example Request

GET 

  1. https://192.168.0.22/api/5.01/networks/config/bbfd98b1944f165b-f141696e-41e24810-90d78c64-83771d10b2a46bd7d475e406

Code Block
languagejson
{
    "data": [
        {
   
        "uuid": "bbfd98b1944f165b-f141696e-41e24810-90d78c64-83771d10b2a46bd7d475e406",
            "label": "Nic1BLUE_1",

           "created": "20212023-0704-07T0513T11:4003:4911.308Z605Z",
            "modified": "20212023-0704-07T0513T11:4003:4911.308Z605Z",
            "proxy": null
 
      }
    ],
    "metadata": {}
}

DELETE networks/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Delete a specific Networks configuration.

Resource URL

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

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the Networks to be deleted.

Example Request

DELETE 

  1. https://192.168.0.22/api/5.01/networks/config/aade730a-4d85-44dd-b9f4-21c04f82dbf4

Code Block
languagejson
{
    "data": [
        {
            "success": true
  
     }
    ],
    "metadata": {}
}

 

PUT networks/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Edit a Networks configuration.

Resource URL

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

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the Networks to be edited.

Example Request

PUT 

  1. https://192.168.0.22/api/5.01/networks/config/aade730a-4d85-44dd-b9f4-21c04f82dbf4

Body

Code Block
languagejson
{
    "uuid": "aade730a-4d85-44dd-b9f4-21c04f82dbf4",
    "label": "Managment_edit",
    "created": "2020-09-02T06:55:02.369Z",
    "modified": "2020-09-13T11:30:15.133Z",
    "proxy": null
}

Response

Code Block
languagejson
{
    "data": [
        {
            "uuid": "aade730a-4d85-44dd-b9f4-21c04f82dbf4",
            "label": "Managment_edit",
            "created": "2021-09-21T10:27:05.680Z",
            "modified": "2021-09-21T10:28:22.607Z",
            "proxy": null
        }
    ],
    "metadata": {}
}

POST networks/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

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

Resource URL

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

Example Request

POST 

  1. https://192.168.0.22/api/5.01/networks/config

Body

Code Block
languagejson
{
    "label": "Managment II",
    "proxy": null
}

Response

Code Block
languagejson
{
    "data": [
        {
            "uuid": "aade730a-4d85-44dd-b9f4-21c04f82dbf4",
            "label": "Managment II",
            "created": "2021-09-21T10:27:05.680Z",
            "modified": "2021-09-21T10:27:05.680Z",
            "proxy": null
        }
    ],
    "metadata": {}
}

POST networks/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Add multiple Networks, configured according to the attached data request.

Resource URL

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

Example Request

POST 

  1. https://192.168.0.22/api/5.01/networks/config

Body

Code Block
languagejson
{
    "data": [
        {
    "label": "multi_test_net1",
    "proxy": null
},
 {
    "label": "multi_test_net2",
    "proxy": null
}
    ]
}

Response

Code Block
languagejson
{
    "data": [
        {
            "uuid": "104a0bbd-0b48-4b8d-b644-f0dec96b442b",
            "label": "multi_test_net1",
            "created": "2022-02-23T12:37:34.275Z",
            "modified": "2022-02-23T12:37:34.275Z",
            "proxy": null
        },
        {
            "uuid": "a1eee70d-eb78-4d48-a3d8-de9b61f448fc",
            "label": "multi_test_net2",
            "created": "2022-02-23T12:37:34.275Z",
            "modified": "2022-02-23T12:37:34.275Z",
            "proxy": null
        }
    ],
    "metadata": {}
}

PUT networks/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

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

Resource URL

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

Example Request

PUT 

  1. https://192.168.0.22/api/5.01/networks/config

Body

Code Block
languagejson
{
    "data": [
        {
            "uuid": "104a0bbd-0b48-4b8d-b644-f0dec96b442b",
            "label": "multi_test_net1",
            "proxy": "1.0.0.0"
        },
        {
            "uuid": "a1eee70d-eb78-4d48-a3d8-de9b61f448fc",
            "label": "multi_test_net2",
            "proxy": null
        }
    ],
    "metadata": {}
}

Response

Code Block
languagejson
{
    "data": [
        {
            "uuid": "104a0bbd-0b48-4b8d-b644-f0dec96b442b",
            "label": "multi_test_net1",
            "created": "2022-02-23T12:37:34.275Z",
            "modified": "2022-02-23T12:45:48.109Z",
            "proxy": "1.0.0.0"
        },
        {
            "uuid": "a1eee70d-eb78-4d48-a3d8-de9b61f448fc",
            "label": "multi_test_net2",
            "created": "2022-02-23T12:37:34.275Z",
            "modified": "2022-02-23T12:45:48.109Z",
            "proxy": null
        }
    ],
    "metadata": {}
}

DELETE networks/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Delete multiple Networks configuration.

Resource URL

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

Example Request

DELETE 

  1. https://192.168.0.22/api/5.01/networks/config

Body

Code Block
languagejson
{
    "data": [
        "104a0bbd-0b48-4b8d-b644-f0dec96b442b",
        "a1eee70d-eb78-4d48-a3d8-de9b61f448fc"
    ]
}

Response

Code Block
languagejson
{
    "data": {
        "success": true
    },
    "metadata": {}
}