v5.1_Network Interfaces

GET interfaces/config

Resource Information

Requires Authentication?	Yes
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

https://192.168.10.53/api/5.1/interfaces/config

{
    "data": [
        {
            "uuid": "efad9663-7e09-4a06-a2f2-6b1d20601796",
            "created": "2023-10-10T10:40:31.016Z",
            "modified": "2023-10-10T10:40:31.016Z",
            "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": "b887d54b-f474-4327-b1c0-8c7828a99d0f",
            "created": "2023-10-10T10:40:31.016Z",
            "modified": "2023-12-07T10:54:55.685Z",
            "network": "523147ed-4d49-4fdd-bfc1-6d9428628327",
            "device": "05011df5-87b1-4141-a3c0-c547657bf9b1",
            "iface": "eth0.10",
            "ip_address": null,
            "mask": null,
            "gateway": null,
            "mode": "DHCP",
            "mtu": "1500",
            "flowcontrol": "Auto",
            "igmp": "Auto",
            "enable_management": true,
            "enable_video_bridge": true,
            "management_ttl": 16,
            "enable_nmos": true,
            "type": "Vlan",
            "vlan_interface": "efad9663-7e09-4a06-a2f2-6b1d20601796",
            "vlan_id": 10
        },
        {
            "uuid": "ce930fb4-7c4f-41e4-82b0-73dca1687fe0",
            "created": "2023-12-08T12:27:54.749Z",
            "modified": "2023-12-08T12:27:54.749Z",
            "network": "2a62e295-f305-4d98-b6bb-237467f2221d",
            "device": "c5a4e74d-d0ba-441a-bbab-44513a4e0931",
            "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,
            "enable_nmos": false,
            "type": "Physical",
            "bonding_mode": "None",
            "bonding_interface": "None"
        }
    ],
    "metadata": {
        "item_count": 3,
        "total_items": 3,
        "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?	Yes
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 (required)	string	The UUID of the desired Network Interfaces.

Example Request

GET

https://192.168.10.53/api/5.1/interfaces/config/b887d54b-f474-4327-b1c0-8c7828a99d0f

{
    "data": {
        "uuid": "b887d54b-f474-4327-b1c0-8c7828a99d0f",
        "created": "2023-10-10T10:40:31.016Z",
        "modified": "2023-12-07T10:54:55.685Z",
        "network": "523147ed-4d49-4fdd-bfc1-6d9428628327",
        "device": "05011df5-87b1-4141-a3c0-c547657bf9b1",
        "iface": "eth0.10",
        "ip_address": null,
        "mask": null,
        "gateway": null,
        "mode": "DHCP",
        "mtu": "1500",
        "flowcontrol": "Auto",
        "igmp": "Auto",
        "enable_management": true,
        "enable_video_bridge": true,
        "management_ttl": 16,
        "enable_nmos": true,
        "type": "Vlan",
        "vlan_interface": "efad9663-7e09-4a06-a2f2-6b1d20601796",
        "vlan_id": 10
    },
    "metadata": {}
}

GET interfaces/config/meta

Resource Information

Requires Authentication?	Yes
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

https://192.168.10.53/api/5.1/interfaces/config/meta

{
    "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?	Yes
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 (required)	string	The UUID of the Network Interfaces to be edited.

Example Request

PUT

https://192.168.10.53/api/5.1/interfaces/config/b887d54b-f474-4327-b1c0-8c7828a99d0f

Body

Response

POST interfaces/config multi

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	PUT

Adds a Network Interfaces configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/interfaces/config/{{uuid}}

Example Request

POST

https://192.168.10.53/api/5.0/interfaces/config

Body

Response

GET interfaces/status

Resource Information

Requires Authentication?	Yes
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

https://192.168.10.53/api/5.0/interfaces/status