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": [ { "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",

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": [
        {
  "iface": "eth0",
            "ip_addressuuid": "192.168.10.1312102d188-f7b1-4d6a-a8b4-1bd10653c300",
            "maskcreated": "255.255.255.02022-01-19T09:17:31.376Z",
            "gatewaymodified": "192.168.10.2522022-02-09T02:39:35.633Z",
            "modenetwork": "Static IP2a62e295-f305-4d98-b6bb-237467f2221d",
            "mtudevice": "15002102d188-f7b1-4d6a-a8b4-1bd10653c31b",
            "flowcontroliface": "Autoeth0",
            "igmpip_address": "Auto192.168.10.131",
            "enable_managementmask": true"255.255.255.0",
            "enable_video_bridgegateway": true"192.168.10.252",
            "management_ttlmode": 16"Static IP",
       },     "mtu": "1500",
  {             "uuidflowcontrol": "92081df8-f78d-418e-92b7-87fdab283c00Auto",
            "createdigmp": "2022-01-07T08:06:05.173ZAuto",
            "modifiedenable_management": "2022-02-09T02:39:35.633Z"true,
            "networkenable_video_bridge": "2a62e295-f305-4d98-b6bb-237467f2221d"true,
            "devicemanagement_ttl": "92081df8-f78d-418e-92b7-87fdab283cd8",16
        },
       "iface": "eth0", {
            "ip_addressuuid": "192.168.10.13292081df8-f78d-418e-92b7-87fdab283c00",
            "maskcreated": "255.255.255.02022-01-07T08:06:05.173Z",
            "gatewaymodified": "192.168.10.2522022-02-09T02:39:35.633Z",
            "modenetwork": "Static IP2a62e295-f305-4d98-b6bb-237467f2221d",
            "mtudevice": "150092081df8-f78d-418e-92b7-87fdab283cd8",
            "flowcontroliface": "Autoeth0",
            "igmpip_address": "Auto192.168.10.132",
            "enable_managementmask": true"255.255.255.0",
            "enable_video_bridgegateway": true"192.168.10.252",
            "management_ttlmode": 16"Static IP",
        }     ]"mtu": "1500",
    "metadata": {         "item_countflowcontrol": 2"Auto",
        "total_items    "igmp": 2"Auto",
            "currentenable_pagemanagement": 1true,
        "sort_by": [    "enable_video_bridge": true,
            "management_ttl": 16
 {       }
    ],
    "fieldmetadata": "device",{
        "item_count": 2,
       "direction": "ASC"total_items": 2,
        "current_page": 1,
    },    "sort_by": [
            {
                "field": "ifacedevice",
                "direction": "ASC"
            },
        ],    {
    "links": {             "currentfield": "http://192.168.10.53/api/5.0/interfaces/config"iface",
                "direction": "ASC"
            }
        ],
        }
}

GET interfaces/config/{uuid}

Resource Information

Requires

"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": [ "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/{uuid}

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": "DHCP2a62e295-f305-4d98-b6bb-237467f2221d",
        "Static IP"    "device": "92081df8-f78d-418e-92b7-87fdab283cd8",
    ],        "Mtusiface": ["eth0",
            "1500ip_address": "192.168.10.132",
        "1492",    "mask": "255.255.255.0",
   "1280"     ],     "FlowControlModesgateway": ["192.168.10.252",
        "Auto",    "mode":     "Enabled"Static IP",
        "Disabled"     ],
"mtu": "1500",
   "IgmpModes": [        "flowcontrol": "Auto",
            "igmp": "IGMPv1Auto",
            "IGMPv2"enable_management": false,
        "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/

"enable_video_bridge": false,
            "management_ttl": 16
        }
    ]
}

Response

Code Block

language	json

{
    "data": [
        {
            "uuid": "2102d188-f7b1-4d6a-a8b4-1bd10653c300

Body

Code Block

language	json

{",
            "created": "2022-02-22T07:50:45.391Z",
            "ifacemodified": "eth02022-02-23T12:50:12.902Z",
 
      "version": 1631088492,         "network": "2a62e295-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
        },
      "management_ttl": 16 }

Response

Code Block

language	json

{
    "data": {         "uuid": "2102d18892081df8-f7b1f78d-4d6a418e-a8b492b7-1bd10653c30087fdab283c00",
            "created": "2022-0102-19T0922T07:1751:3103.376Z045Z",
            "modified": "2022-02-15T1423T12:4050:3612.208Z902Z",
            "network": "2a62e295-f305-4d98-b6bb-237467f2221d",
            "device": "2102d18892081df8-f7b1f78d-4d6a418e-a8b492b7-1bd10653c31b87fdab283cd8",
            "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": false,
            "enable_video_bridge": false,
            "management_ttl": 16
        }
    ],
    "metadata": {}
}

Versions Compared

Old Version 3

New Version 4

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

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/{uuid}

Resource Information

Resource URL

Example Request

PUT interfaces/config/{uuid}

Resource Information

Resource URL

Parameters

Example Request