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_nmosuuid": false"2102d188-f7b1-4d6a-a8b4-1bd10653c300",
"uuidcreated": "39626cb32022-986a-4ac4-9e7a-f9d76581390001-19T09:17:31.376Z",
"networkmodified": "c39393d62022-3826-4e2f-9e8e-08e2c25e99a202-09T02:39:35.633Z",
"devicenetwork": "39626cb32a62e295-986af305-4ac44d98-9e7ab6bb-f9d7658139b6237467f2221d",
"ifacedevice": "eth02102d188-f7b1-4d6a-a8b4-1bd10653c31b",
"ip_addressiface": "eth0",
"ip_address": "192.168.210.203131",
"mask": "255.255.252255.0",
"gateway": "192.168.010.252",
"mode": "Static IP",
"mtu": "1500",
"flowcontrol": "Auto",
"igmp": "Auto",
"enable_management": falsetrue,
"enable_video_bridge": falsetrue,
"management_ttl": 16,
},
"modified": "2021-09-21T10:39:00.111Z", {
"createduuid": "2021-09-21T10:38:17.097Z"92081df8-f78d-418e-92b7-87fdab283c00",
}, {"created": "2022-01-07T08:06:05.173Z",
"enable_nmosmodified": false"2022-02-09T02:39:35.633Z",
"uuidnetwork": "f0fd77532a62e295-5843f305-43a34d98-acf7-eaf8065f8000",
"network": "bbfd98b1-f141-41e2-90d7-83771d10b2a4b6bb-237467f2221d",
"device": "f0fd775392081df8-5843f78d-43a3418e-acf792b7-eaf8065f801087fdab283cd8",
"iface": "eth0",
"ip_address": "192.168.210.202132",
"mask": "255.255.252255.0",
"gateway": "192.168.010.252",
"mode": "Static IP",
"mtu": "1500",
"flowcontrol": "Auto",
"igmp": "Auto",
"enable_management": falsetrue,
"enable_video_bridge": falsetrue,
"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.010.2253/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
https://192.168.0.22/api/5.0/interfaces/config/39626cb32102d188-986af7b1-4ac44d6a-9e7aa8b4-f9d7658139001bd10653c300
| Code Block | ||
|---|---|---|
| ||
{
"data": [
{
"uuid": "39626cb32102d188-986af7b1-4ac44d6a-9e7aa8b4-f9d7658139001bd10653c300",
"created": "20212022-0901-21T1019T09:3817:1731.097Z376Z",
"modified": "20212022-0902-21T1009T02:39:0035.111Z633Z",
"network": "c39393d62a62e295-3826f305-4e2f4d98-9e8eb6bb-08e2c25e99a2237467f2221d",
"device": "39626cb32102d188-986af7b1-4ac44d6a-9e7aa8b4-f9d7658139b61bd10653c31b",
"iface": "eth0",
"ip_address": "192.168.210.203131",
"mask": "255.255.252255.0",
"gateway": "192.168.010.252",
"mode": "Static IP",
"mtu": "1500",
"flowcontrol": "Auto",
"igmp": "Auto",
"enable_management": falsetrue,
"enable_video_bridge": falsetrue,
"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
https://192.168.0.22/api/5.0/interfaces/config/f0fd77532102d188-5843f7b1-43a34d6a-acf7a8b4-eaf8065f80001bd10653c300
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" "version": 1631088492,
"network": "bbfd98b12a62e295-f141f305-41e24d98-90d7b6bb-83771d10b2a4237467f2221d",
"device": "f0fd77532102d188-5843f7b1-43a34d6a-acf7a8b4-eaf8065f80101bd10653c31b",
"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": "f0fd77532102d188-5843f7b1-43a34d6a-acf7a8b4-eaf8065f80001bd10653c300",
"created": "20212022-0901-08T0819T09:0817:0731.140Z376Z",
"modified": "20212022-0902-21T1115T14:3040:2936.751Z208Z",
"network": "bbfd98b12a62e295-f141f305-41e24d98-90d7b6bb-83771d10b2a4237467f2221d",
"device": "f0fd77532102d188-5843f7b1-43a34d6a-acf7a8b4-eaf8065f80101bd10653c31b",
"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": truefalse,
"management_ttl": 16
}
],
"metadata": {}
} |