v5.1_Networks
- Ramya Raman (Unlicensed)
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": "f74cc09c-5ad0-4cf1-ae30-e8911fe7362d",
"label": "Nic1",
"created": "2022-10-25T09:38:03.310Z",
"modified": "2022-10-25T09:38:03.310Z",
"proxy": null
},
{
"uuid": "944f165b-696e-4810-8c64-6bd7d475e406",
"label": "BLUE_1",
"created": "2023-04-13T11:03:11.605Z",
"modified": "2023-04-13T11:03:11.605Z",
"proxy": null
}
],
"metadata": {
"item_count": 2,
"total_items": 2,
"current_page": 1,
"sort_by": [
{
"label": "ASC"
}
],
"links": {
"current": "http://192.168.10.53/api/5.1/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": "944f165b-696e-4810-8c64-6bd7d475e406",
"label": "BLUE_1",
"created": "2023-04-13T11:03:11.605Z",
"modified": "2023-04-13T11:03:11.605Z",
"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
Response
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
Response
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
Response
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
Response
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
Response