- Created by Ramya Raman (Unlicensed) on Aug 25, 2023
You are viewing an old version of this content. View the current version.
Compare with Current View Version History
Version 1 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": "efad9663-7e09-4a06-a2f2-6b1d20601796",
"created": "2023-04-13T11:03:11.605Z",
"modified": "2023-05-09T15:24:33.178Z",
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"device": "05011df5-87b1-4141-a3c0-c547657bf9b1",
"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": false,
"enable_video_bridge": false,
"management_ttl": 16,
"enable_nmos": false,
"type": "Physical",
"bonding_mode": "None",
"bonding_interface": "None"
}
],
"metadata": {
"item_count": 1,
"total_items": 1,
"current_page": 1,
"sort_by": [
{
"device": "ASC"
},
{
"iface": "ASC"
}
],
"links": {
"current": "http://192.168.10.53/api/5.1/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": "efad9663-7e09-4a06-a2f2-6b1d20601796",
"created": "2023-04-13T11:03:11.605Z",
"modified": "2023-05-09T15:24:33.178Z",
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"device": "05011df5-87b1-4141-a3c0-c547657bf9b1",
"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": false,
"enable_video_bridge": false,
"management_ttl": 16,
"enable_nmos": false,
"type": "Physical",
"bonding_mode": "None",
"bonding_interface": "None"
},
"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
{
"BondingModes": [
"None",
"Primary",
"Backup"
],
"Types": [
"Physical",
"Vlan",
"LACP Bonding"
],
"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
{
"data": {
"uuid": "efad9663-7e09-4a06-a2f2-6b1d20601796",
"created": "2023-04-13T11:03:11.605Z",
"modified": "2023-05-09T15:24:33.178Z",
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"device": "05011df5-87b1-4141-a3c0-c547657bf9b1",
"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": false,
"enable_video_bridge": false,
"management_ttl": 16,
"enable_nmos": false,
"type": "Physical",
"bonding_mode": "None",
"bonding_interface": "None"
}
}
Response
{
"data": {
"uuid": "efad9663-7e09-4a06-a2f2-6b1d20601796",
"created": "2023-04-13T11:03:11.605Z",
"modified": "2023-08-25T13:09:24.234Z",
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"device": "05011df5-87b1-4141-a3c0-c547657bf9b1",
"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": false,
"enable_video_bridge": false,
"management_ttl": 16,
"enable_nmos": false,
"type": "Physical",
"bonding_mode": "None",
"bonding_interface": "None"
},
"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": "efad9663-7e09-4a06-a2f2-6b1d20601796",
"created": "2023-04-13T11:03:11.605Z",
"modified": "2023-05-09T15:24:33.178Z",
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"device": "05011df5-87b1-4141-a3c0-c547657bf9b1",
"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": false,
"enable_video_bridge": false,
"management_ttl": 16,
"enable_nmos": false,
"type": "Physical",
"bonding_mode": "None",
"bonding_interface": "None"
}
}
Response
{
"data": {
"uuid": "efad9663-7e09-4a06-a2f2-6b1d20601796",
"created": "2023-04-13T11:03:11.605Z",
"modified": "2023-08-25T13:09:24.234Z",
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"device": "05011df5-87b1-4141-a3c0-c547657bf9b1",
"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": false,
"enable_video_bridge": false,
"management_ttl": 16,
"enable_nmos": false,
"type": "Physical",
"bonding_mode": "None",
"bonding_interface": "None"
},
{
"uuid": "2102d188-f7b1-4d6a-a8b4-1bd10653c300",
"created": "2023-04-13T11:03:11.605Z",
"modified": "2023-08-25T13:09:24.234Z",
"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": false,
"enable_video_bridge": false,
"management_ttl": 16,
"enable_nmos": false,
"type": "Physical",
"bonding_mode": "None",
"bonding_interface": "None"
}
"metadata": {}
}
GET interfaces/status
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns the status of Network Interfaces configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/interfaces/status
Example Request
GET
{
"data": [
{
"uuid": "efad9663-7e09-4a06-a2f2-6b1d20601796",
"iface": "eth0",
"device": "05011df5-87b1-4141-a3c0-c547657bf9b1",
"timestamp": "2023-08-25T13:15:15.246Z",
"network_label": "Nic1",
"network": "2a62e295-f305-4d98-b6bb-237467f2221d",
"ip_address": "192.168.10.131",
"mask": "255.255.255.0",
"gateway": "192.168.10.252",
"speed": 10000,
"mac": "00:50:56:A4:C8:79",
"flowcontrol": "Auto",
"mode": "DHCP",
"management_enabled": false,
"video_bridge_enabled": false,
"nmos_enabled": false,
"up": true,
"rx_multicast_bandwidth": 0,
"tx_bandwidth": 36192,
"rx_bandwidth": 15120,
"lldp": {
"name": null,
"iface": null,
"vlan": 0
}
}
],
"metadata": {
"item_count": 1,
"total_items": 1,
"total_pages": 1,
"current_page": 1
}
}
- No labels