- Created by Ramya Raman on Aug 25, 2023
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
Version 1 Current »
GET networks/config
Resource Information
Requires Authentication? | |
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
{
"data": [
{
"uuid": "bbfd98b1-f141-41e2-90d7-83771d10b2a4",
"label": "Nic1",
"proxy": null,
"modified": "2021-07-07T05:40:49.308Z",
"created": "2021-07-07T05:40:49.308Z"
},
{
"uuid": "c39393d6-3826-4e2f-9e8e-08e2c25e99a2",
"label": "Nic2",
"proxy": null,
"modified": "2021-07-07T05:40:56.491Z",
"created": "2021-07-07T05:40:56.491Z"
}
],
"metadata": {
"item_count": 2,
"total_items": 2,
"current_page": 1,
"sort_by": [
{
"field": "label",
"direction": "ASC"
}
],
"links": {
"current": "http://192.168.0.22/api/5.0/networks/config"
}
}
}
GET networks/config/{uuid}
Resource Information
Requires Authentication? | |
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 | string | The UUID of the desired Networks. |
Example Request
GET
{
"data": [
{
"uuid": "bbfd98b1-f141-41e2-90d7-83771d10b2a4",
"label": "Nic1",
"created": "2021-07-07T05:40:49.308Z",
"modified": "2021-07-07T05:40:49.308Z",
"proxy": null
}
],
"metadata": {}
}
DELETE networks/config/{uuid}
Resource Information
Requires Authentication? | |
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 | string | The UUID of the Networks to be deleted. |
Example Request
DELETE
{
"data": [
{
"success": true
}
],
"metadata": {}
}
PUT networks/config/{uuid}
Resource Information
Requires Authentication? | |
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 | string | The UUID of the Networks to be edited. |
Example Request
PUT
Body
{
"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
{
"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? | |
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
Body
{
"label": "Managment II",
"proxy": null
}
Response
{
"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? | |
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
Body
{
"data": [
{
"label": "multi_test_net1",
"proxy": null
},
{
"label": "multi_test_net2",
"proxy": null
}
]
}
Response
{
"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? | |
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
Body
{
"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
{
"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? | |
Response Formats | json |
HTTP Methods | DELETE |
Delete multiple Networks configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/networks/config/{{uuid}}
Example Request
DELETE
Body
{
"data": [
"104a0bbd-0b48-4b8d-b644-f0dec96b442b",
"a1eee70d-eb78-4d48-a3d8-de9b61f448fc"
]
}
Response
{
"data": {
"success": true
},
"metadata": {}
}
- No labels