Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
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
| Code Block | ||
|---|---|---|
| ||
{
"data": [
{
"enable_nmos": false,
"uuid": "39626cb3-986a-4ac4-9e7a-f9d765813900",
"network": "c39393d6-3826-4e2f-9e8e-08e2c25e99a2",
"device": "39626cb3-986a-4ac4-9e7a-f9d7658139b6",
"iface": "eth0",
"ip_address": "192.168.2.203",
"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,
"modified": "2021-09-21T10:39:00.111Z",
"created": "2021-09-21T10:38:17.097Z"
},
{
"enable_nmos": false,
"uuid": "f0fd7753-5843-43a3-acf7-eaf8065f8000",
"network": "bbfd98b1-f141-41e2-90d7-83771d10b2a4",
"device": "f0fd7753-5843-43a3-acf7-eaf8065f8010",
"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,
"modified": "2021-09-21T10:38:50.396Z",
"created": "2021-09-08T08:08:07.140Z"
}
],
"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.0.22/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
| Code Block | ||
|---|---|---|
| ||
{
"data": [
{
"uuid": "39626cb3-986a-4ac4-9e7a-f9d765813900",
"created": "2021-09-21T10:38:17.097Z",
"modified": "2021-09-21T10:39:00.111Z",
"network": "c39393d6-3826-4e2f-9e8e-08e2c25e99a2",
"device": "39626cb3-986a-4ac4-9e7a-f9d7658139b6",
"iface": "eth0",
"ip_address": "192.168.2.203",
"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": {}
} |
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
| Code Block | ||
|---|---|---|
| ||
{
"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
| Code Block | ||
|---|---|---|
| ||
{
"uuid": "f0fd7753-5843-43a3-acf7-eaf8065f8000",
"iface": "eth0",
"version": 1631088492,
"modified": "2021-09-21T11:10:18.148Z",
"created": "2021-05-31T10:08:46.219Z",
"network": "bbfd98b1-f141-41e2-90d7-83771d10b2a4",
"device": "f0fd7753-5843-43a3-acf7-eaf8065f8010",
"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": true,
"enable_nmos": false,
"management_ttl": 16
} |
Response
| Code Block | ||
|---|---|---|
| ||
{
"data": [
{
"uuid": "f0fd7753-5843-43a3-acf7-eaf8065f8000",
"created": "2021-09-08T08:08:07.140Z",
"modified": "2021-09-21T11:30:29.751Z",
"network": "bbfd98b1-f141-41e2-90d7-83771d10b2a4",
"device": "f0fd7753-5843-43a3-acf7-eaf8065f8010",
"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": true,
"management_ttl": 16
}
],
"metadata": {}
} |