Page Comparison

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.0.22/api/5.0/interfaces/config

Code Block

language	json

{ "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" }, {

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.0.22/api/5.0/interfaces/config

Code Block

language	json

{
    "data": [
        {
   "enable_nmos": false,             "uuid": "f0fd77532102d188-5843f7b1-43a34d6a-acf7a8b4-eaf8065f80001bd10653c300",
            "networkcreated": "bbfd98b12022-f141-41e2-90d7-83771d10b2a401-19T09:17:31.376Z",
            "devicemodified": "f0fd77532022-5843-43a3-acf7-eaf8065f801002-09T02:39:35.633Z",
            "ifacenetwork": "eth02a62e295-f305-4d98-b6bb-237467f2221d",
            "device": "2102d188-f7b1-4d6a-a8b4-1bd10653c31b",
            "iface": "eth0",
            "ip_address": "192.168.210.202131",
            "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  {
            "uuid": "92081df8-f78d-418e-92b7-87fdab283c00",
            "created": "20212022-0901-08T0807T08:0806:0705.140Z173Z",
        }     ]"modified": "2022-02-09T02:39:35.633Z",
    "metadata": {         "item_countnetwork": 2,"2a62e295-f305-4d98-b6bb-237467f2221d",
            "total_itemsdevice": 2,"92081df8-f78d-418e-92b7-87fdab283cd8",
         "current_page   "iface": 1"eth0",
            "sortip_byaddress": ["192.168.10.132",
            {
 "mask": "255.255.255.0",
              "fieldgateway": "device192.168.10.252",
   
            "directionmode": "ASCStatic IP",
            }"mtu": "1500",
            {
"flowcontrol": "Auto",
               "fieldigmp": "ifaceAuto",
                "direction"enable_management": "ASC"true,
            }
  "enable_video_bridge": true,
     ],         "linksmanagement_ttl": { 16
        }
    ],
    "currentmetadata": "http://192.168.0.22/api/5.0/interfaces/config"
{
        "item_count": 2,
       } "total_items": 2,
  }
}

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.0.22/api/5.0/interfaces/config/39626cb3-986a-4ac4-9e7a-f9d765813900

Code Block

language	json

{
    "data": [
        {      "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?	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.0.22/api/5.0/interfaces/config/2102d188-f7b1-4d6a-a8b4-1bd10653c300

Code Block

language	json

{
    "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?	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.0.22/api/5.0/interfaces/config/meta

Code Block

language	json

{
    "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.0.22/api/5.0/interfaces/config/2102d188-f7b1-4d6a-a8b4-1bd10653c300

Body

Code Block

language	json

{
        "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

Code Block

language	json

{
    "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?	Yes
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

https://192.168.0.22/api/5.0/interfaces/config

Body

Code Block

language	json

{
    "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

Code Block

language	json

{
    "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",
            "uuidiface": "39626cb3-986a-4ac4-9e7a-f9d765813900eth0",
            "createdip_address": "2021-09-21T10:38:17.097Z192.168.10.131",
            "modifiedmask": "2021-09-21T10:39:00.111Z255.255.255.0",
            "networkgateway": "c39393d6-3826-4e2f-9e8e-08e2c25e99a2192.168.10.252",
            "devicemode": "39626cb3-986a-4ac4-9e7a-f9d7658139b6Static IP",
            "ifacemtu": "eth01500",
            "ip_addressflowcontrol": "192.168.2.203Auto",
            "maskigmp": "255.255.252.0Auto",
            "gatewayenable_management": "192.168.0.252"true,
            "modeenable_video_bridge": "Static IP"true,
            "mtumanagement_ttl": "1500",16
        },
       "flowcontrol": "Auto", {
            "igmpuuid": "Auto92081df8-f78d-418e-92b7-87fdab283c00",
            "enable_managementcreated": false"2022-02-22T07:51:03.045Z",
            "enable_video_bridge": falsemodified": "2022-02-23T12:50:12.902Z",
            "management_ttlnetwork": 16
"2a62e295-f305-4d98-b6bb-237467f2221d",
       }     ],
    "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.0.22/api/5.0/interfaces/config/meta

Code Block

language	json

{
    "Modes": ["device": "92081df8-f78d-418e-92b7-87fdab283cd8",
            "iface": "eth0",
            "ip_address": "192.168.10.132",
            "mask":  "DHCP","255.255.255.0",
            "Static IP"gateway": "192.168.10.252",
    ],        "Mtusmode": ["Static IP",
       "1500",         "1492"mtu": "1500",
        "1280"     ]"flowcontrol": "Auto",
    "FlowControlModes": [       "igmp":  "Auto",
        "Enabled",     "enable_management": false,
  "Disabled"     ],     "IgmpModesenable_video_bridge": [false,
         "Auto",   "management_ttl": 16
    "IGMPv1",    }
    "IGMPv2"],
 
      "IGMPv3metadata": {}
   ]
}

PUT

GET interfaces/

config/{uuid}

status

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods

PUT

Edit a

GET

Returns the status of 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}}/interfaces/status

Example Request

GET

https://192.168.0.22/api/5.0/interfaces

/config/f0fd7753-5843-43a3-acf7-eaf8065f8000

Body

Code Block

language	json

{ "uuid": "f0fd7753-5843-43a3-acf7-eaf8065f8000",

/status

Code Block

language	json

{
     "ifacedata": "eth0",[
        "version": 1631088492,{
         "modified": "2021-09-21T11:10:18.148Z",         "created"uuid": "2021-05-31T10:08:46.219Z",efad9663-7e09-4a06-a2f2-6b1d20601796",
            "networkdevice": "bbfd98b105011df5-f14187b1-41e24141-90d7a3c0-83771d10b2a4c547657bf9b1",
            "deviceiface": "f0fd7753-5843-43a3-acf7-eaf8065f8010eth0",
            "ip_addresstimestamp": "192.168.2.202",
 2023-07-27T11:46:32.760Z",
            "lldp": {
      "mask": "255.255.252.0",         "gatewayname": "192.168.0.252"null,
        "mode": "Static IP",
        "mtuiface": "1500"null,
        "flowcontrol": "Auto",         "igmpvlan": "Auto",0
        "enable_management": false,      },
  "enable_video_bridge": true,         "enable_nmosnetwork": false"2a62e295-f305-4d98-b6bb-237467f2221d",
            "managementnetwork_ttllabel": 16
}

Response

Code Block

language	json

{"Nic1",
     "data": [      "ip_address": "192.168.10.131",
 {
            "uuidmask": "f0fd7753-5843-43a3-acf7-eaf8065f8000255.255.255.0",
            "createdgateway": "2021-09-08T08:08:07.140Z192.168.10.252",
            "modifiedspeed": "2021-09-21T11:30:29.751Z"10000,
            "networkmac": "bbfd98b1-f141-41e2-90d7-83771d10b2a400:50:56:A4:C8:79",
            "deviceflowcontrol": "f0fd7753-5843-43a3-acf7-eaf8065f8010Auto",
            "ifacemode": "eth0DHCP",
            "ipmanagement_addressenabled": "192.168.2.202"false,
            "maskvideo_bridge_enabled": "255.255.252.0"false,
            "gatewaynmos_enabled": "192.168.0.252"false,
            "modeup": "Static IP"true,
            "mturx_multicast_bandwidth": "1500"168,
            "flowcontroltx_bandwidth": "Auto"111536,
            "igmprx_bandwidth": "Auto",34360
        }
   "enable_management": false ],
    "metadata": {
        "enableitem_video_bridgecount": true1,
 
          "managementtotal_ttlitems": 161,
        }
"total_pages": 1,
   ],     "metadatacurrent_page": {1
    }
}

Page Comparison

Versions Compared

Old Version 2

New Version Current

Key

GET interfaces/config

Resource Information

Resource URL

Example Request

GET interfaces/config

Resource Information

Resource URL

Example Request

GET interfaces/config/{uuid}

Resource Information

Resource URL

Parameters

Example Request

GET interfaces/config/{uuid}

Resource Information

Resource URL

Parameters

Example Request

GET interfaces/config/meta

Resource Information

Resource URL

Example Request

PUT interfaces/config/{uuid}

Resource Information

Resource URL

Parameters

Example Request

PUT interfaces/config multi

Resource Information

Resource URL

Example Request

GET interfaces/config/meta

Resource Information

Resource URL

Example Request

GET interfaces/

status

Resource Information

Resource URL

Parameters

Example Request

Example Request