- Created by Ramya Raman, last modified on Mar 07, 2022
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 5 Current »
GET interfaces/config
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns a list of all Network Interfaces in the system, with its main configuration data.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/interfaces/config
Example Request
GET
{
"data": [
{
"uuid": "2102d188-f7b1-4d6a-a8b4-1bd10653c300",
"created": "2022-01-19T09:17:31.376Z",
"modified": "2022-02-09T02:39:35.633Z",
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"device": "2102d188-f7b1-4d6a-a8b4-1bd10653c31b",
"iface": "eth0",
"ip_address": "192.168.10.131",
"mask": "255.255.255.0",
"gateway": "192.168.10.252",
"mode": "Static IP",
"mtu": "1500",
"flowcontrol": "Auto",
"igmp": "Auto",
"enable_management": true,
"enable_video_bridge": true,
"management_ttl": 16
},
{
"uuid": "92081df8-f78d-418e-92b7-87fdab283c00",
"created": "2022-01-07T08:06:05.173Z",
"modified": "2022-02-09T02:39:35.633Z",
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"device": "92081df8-f78d-418e-92b7-87fdab283cd8",
"iface": "eth0",
"ip_address": "192.168.10.132",
"mask": "255.255.255.0",
"gateway": "192.168.10.252",
"mode": "Static IP",
"mtu": "1500",
"flowcontrol": "Auto",
"igmp": "Auto",
"enable_management": true,
"enable_video_bridge": true,
"management_ttl": 16
}
],
"metadata": {
"item_count": 2,
"total_items": 2,
"current_page": 1,
"sort_by": [
{
"field": "device",
"direction": "ASC"
},
{
"field": "iface",
"direction": "ASC"
}
],
"links": {
"current": "http://192.168.10.53/api/5.0/interfaces/config"
}
}
}
GET interfaces/config/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns an extended single Network Interfaces configuration view, specified by the required {uuid} parameter.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/interfaces/config/{{uuid}}
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the desired Network Interfaces. |
Example Request
GET
{
"data": {
"uuid": "2102d188-f7b1-4d6a-a8b4-1bd10653c300",
"created": "2022-01-19T09:17:31.376Z",
"modified": "2022-02-09T02:39:35.633Z",
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"device": "2102d188-f7b1-4d6a-a8b4-1bd10653c31b",
"iface": "eth0",
"ip_address": "192.168.10.131",
"mask": "255.255.255.0",
"gateway": "192.168.10.252",
"mode": "Static IP",
"mtu": "1500",
"flowcontrol": "Auto",
"igmp": "Auto",
"enable_management": true,
"enable_video_bridge": true,
"management_ttl": 16
},
"metadata": {}
}
GET interfaces/config/meta
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns all meta data used by Network Interfaces configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/interfaces/config/meta
Example Request
GET
{
"Modes": [
"DHCP",
"Static IP"
],
"Mtus": [
"1500",
"1492",
"1280"
],
"FlowControlModes": [
"Auto",
"Enabled",
"Disabled"
],
"IgmpModes": [
"Auto",
"IGMPv1",
"IGMPv2",
"IGMPv3"
]
}
PUT interfaces/config/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | PUT |
Edit a Network Interfaces configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/interfaces/config/{{uuid}}
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the Network Interfaces to be edited. |
Example Request
PUT
Body
{
"iface": "eth0",
"version": 1631088492,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"device": "2102d188-f7b1-4d6a-a8b4-1bd10653c31b",
"ip_address": "192.168.2.202",
"mask": "255.255.252.0",
"gateway": "192.168.0.252",
"mode": "Static IP",
"mtu": "1500",
"flowcontrol": "Auto",
"igmp": "Auto",
"enable_management": false,
"enable_video_bridge": false,
"management_ttl": 16
}
Response
{
"data": {
"uuid": "2102d188-f7b1-4d6a-a8b4-1bd10653c300",
"created": "2022-01-19T09:17:31.376Z",
"modified": "2022-02-15T14:40:36.208Z",
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"device": "2102d188-f7b1-4d6a-a8b4-1bd10653c31b",
"iface": "eth0",
"ip_address": "192.168.2.202",
"mask": "255.255.252.0",
"gateway": "192.168.0.252",
"mode": "Static IP",
"mtu": "1500",
"flowcontrol": "Auto",
"igmp": "Auto",
"enable_management": false,
"enable_video_bridge": false,
"management_ttl": 16
},
"metadata": {}
}
PUT interfaces/config multi
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | PUT |
Edit multiple Network Interfaces configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/interfaces/config/{{uuid}}
Example Request
PUT
Body
{
"data": [
{
"uuid": "2102d188-f7b1-4d6a-a8b4-1bd10653c300",
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"device": "2102d188-f7b1-4d6a-a8b4-1bd10653c31b",
"iface": "eth0",
"ip_address": "192.168.10.131",
"mask": "255.255.255.0",
"gateway": "192.168.10.252",
"mode": "Static IP",
"mtu": "1500",
"flowcontrol": "Auto",
"igmp": "Auto",
"enable_management": true,
"enable_video_bridge": true,
"management_ttl": 16
},
{
"uuid": "92081df8-f78d-418e-92b7-87fdab283c00",
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"device": "92081df8-f78d-418e-92b7-87fdab283cd8",
"iface": "eth0",
"ip_address": "192.168.10.132",
"mask": "255.255.255.0",
"gateway": "192.168.10.252",
"mode": "Static IP",
"mtu": "1500",
"flowcontrol": "Auto",
"igmp": "Auto",
"enable_management": false,
"enable_video_bridge": false,
"management_ttl": 16
}
]
}
Response
{
"data": [
{
"uuid": "2102d188-f7b1-4d6a-a8b4-1bd10653c300",
"created": "2022-02-22T07:50:45.391Z",
"modified": "2022-02-23T12:50:12.902Z",
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"device": "2102d188-f7b1-4d6a-a8b4-1bd10653c31b",
"iface": "eth0",
"ip_address": "192.168.10.131",
"mask": "255.255.255.0",
"gateway": "192.168.10.252",
"mode": "Static IP",
"mtu": "1500",
"flowcontrol": "Auto",
"igmp": "Auto",
"enable_management": true,
"enable_video_bridge": true,
"management_ttl": 16
},
{
"uuid": "92081df8-f78d-418e-92b7-87fdab283c00",
"created": "2022-02-22T07:51:03.045Z",
"modified": "2022-02-23T12:50:12.902Z",
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"device": "92081df8-f78d-418e-92b7-87fdab283cd8",
"iface": "eth0",
"ip_address": "192.168.10.132",
"mask": "255.255.255.0",
"gateway": "192.168.10.252",
"mode": "Static IP",
"mtu": "1500",
"flowcontrol": "Auto",
"igmp": "Auto",
"enable_management": false,
"enable_video_bridge": false,
"management_ttl": 16
}
],
"metadata": {}
}
- No labels