Versions Compared

Old Version 3

changes.mady.by.user Ramya Raman

Saved on

compared with

New Version Current

changes.mady.by.user Ramya Raman

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 

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

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

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 

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

Code Block
languagejson
{
    "data": [
        {
            "uuid": "92081df82102d188-f78df7b1-418e4d6a-92b7a8b4-87fdab283c001bd10653c300",
            "created": "2022-01-07T0819T09:0617:0531.173Z376Z",
            "modified": "2022-02-09T02:39:35.633Z",
            "network": "2a62e295-f305-4d98-b6bb-237467f2221d",
            "device": "92081df82102d188-f78df7b1-418e4d6a-92b7a8b4-87fdab283cd81bd10653c31b",
            "iface": "eth0",
            "ip_address": "192.168.10.132131",
            "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": {         "item_countuuid": 2,"92081df8-f78d-418e-92b7-87fdab283c00",
            "total_itemscreated": 2"2022-01-07T08:06:05.173Z",
        "current_page": 1,         "sort_by": ["modified": "2022-02-09T02:39:35.633Z",
             {
  "network": "2a62e295-f305-4d98-b6bb-237467f2221d",
             "fielddevice": "device92081df8-f78d-418e-92b7-87fdab283cd8",
                "directioniface": "ASCeth0",
            },
"ip_address": "192.168.10.132",
           { "mask": "255.255.255.0",
              "fieldgateway": "iface192.168.10.252",
 
              "directionmode": "ASCStatic IP",
            }
"mtu": "1500",
       ],         "linksflowcontrol": {"Auto",
            "currentigmp": "http://192.168.10.53/api/5.0/interfaces/config"
"Auto",
            "enable_management": true,
            "enable_video_bridge": true,
        }     }
}

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 

  1. https://192.168.0.22/api/5.0/interfaces/config/2102d188-f7b1-4d6a-a8b4-1bd10653c300

Code Block
languagejson
{
    "data": {"management_ttl": 16
        }
    ],
    "metadata": {
        "item_count": 2,
        "total_items": 2,
        "current_page": 1,
        "sort_by": [
            {
                "field": "device",
        "uuid": "2102d188-f7b1-4d6a-a8b4-1bd10653c300",
        "createddirection": "2022-01-19T09:17:31.376Z",ASC"
           "modified": "2022-02-09T02:39:35.633Z", },
         "network": "2a62e295-f305-4d98-b6bb-237467f2221d",  {
      "device": "2102d188-f7b1-4d6a-a8b4-1bd10653c31b",         "ifacefield": "eth0iface",
        "ip_address": "192.168.10.131",
          "maskdirection": "255.255.255.0",ASC"
         "gateway": "192.168.10.252",  }
      "mode": "Static IP"],
        "mtulinks": "1500",{
            "flowcontrolcurrent": "Auto",
        "igmp": "Auto",http://192.168.10.53/api/5.0/interfaces/config"
         "enable_management": true,}
         "enable_video_bridge": true,
        "management_ttl": 16
    },
    "metadata": {}
}

GET interfaces/config/meta

Resource Information

Requires 
}
}

GET interfaces/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns all meta data used by an extended single Network Interfaces configuration view, specified by the required {uuid} parameter.

Resource URL

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

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the desired Network Interfaces.

Example Request

GET 

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

meta

  1. 2102d188-f7b1-4d6a-a8b4-1bd10653c300

Code Block
languagejson
{
    "Modesdata": [{
        "DHCPuuid",
        "Static IP": "2102d188-f7b1-4d6a-a8b4-1bd10653c300",
    ],     "Mtuscreated": ["2022-01-19T09:17:31.376Z",
        "1500modified": "2022-02-09T02:39:35.633Z",
        "1492network": "2a62e295-f305-4d98-b6bb-237467f2221d",
        "1280device": "2102d188-f7b1-4d6a-a8b4-1bd10653c31b",
   ],     "FlowControlModesiface": ["eth0",
        "Auto"ip_address": "192.168.10.131",
        "Enabledmask": "255.255.255.0",
        "Disabledgateway": "192.168.10.252",
   ],     "IgmpModesmode": [ "Static IP",
        "Automtu": "1500",
        "IGMPv1flowcontrol": "Auto",
        "igmp": "IGMPv2Auto",
        "IGMPv3enable_management": true,
        "enable_video_bridge": true,
        "management_ttl": 16
    },
 ]   "metadata": {}
}

PUT

GET interfaces/config/

{uuid}

meta

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Edit a

GET

Returns all meta data used by 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.

meta

Example Request

PUTGET 

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

/2102d188-f7b1-4d6a-a8b4-1bd10653c300

Body

Code Block
languagejson
{

  1. /meta

Code Block
languagejson
{
    "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 

  1. https://192.168.0.22/api/5.0/interfaces/config/2102d188-f7b1-4d6a-a8b4-1bd10653c300

Body

Code Block
languagejson
{
        "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
languagejson
{
    "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 

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

Body

Code Block
languagejson
{
    "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
languagejson
{
    "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",
            "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",
            "created": "2022-02-22T07:51:03.045Z",
            "modified": "2022-02-23T12:50:12.902Z",
            "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
        }
    ],
    "metadata": {}
}

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 

  1. https://192.168.0.22/api/5.0/interfaces/status

Code Block
languagejson
{
    "data": [
        {
            "uuid": "efad9663-7e09-4a06-a2f2-6b1d20601796",
            "device": "05011df5-87b1-4141-a3c0-c547657bf9b1",
            "iface": "eth0",
            "timestamp": "2023-07-27T11:46:32.760Z",
            "versionlldp": 1631088492, {
                "networkname": "2a62e295-f305-4d98-b6bb-237467f2221d"null,
        "device": "2102d188-f7b1-4d6a-a8b4-1bd10653c31b",         "ip_addressiface": "192.168.2.202"null,
        "mask": "255.255.252.0",
        "gatewayvlan": "192.168.0.252",0
          "mode": "Static IP"},
            "mtunetwork": "15002a62e295-f305-4d98-b6bb-237467f2221d",
         "flowcontrol   "network_label": "AutoNic1",
            "igmpip_address": "Auto192.168.10.131",
         "enable_management": false,   "mask": "255.255.255.0",
            "enable_video_bridgegateway": false"192.168.10.252",
        "management_ttl    "speed": 16
}

Response

Code Block
languagejson
{10000,
    "data": {         "uuidmac": "2102d188-f7b1-4d6a-a8b4-1bd10653c300",00:50:56:A4:C8:79",
            "createdflowcontrol": "2022-01-19T09:17:31.376ZAuto",
            "modifiedmode": "2022-02-15T14:40:36.208ZDHCP",
            "networkmanagement_enabled": "2a62e295-f305-4d98-b6bb-237467f2221d"false,
        "device": "2102d188-f7b1-4d6a-a8b4-1bd10653c31b"    "video_bridge_enabled": false,
        "iface    "nmos_enabled": "eth0"false,
        "ip_address    "up": "192.168.2.202",true,
          "mask  "rx_multicast_bandwidth": "255.255.252.0"168,
        "gateway    "tx_bandwidth": "192.168.0.252",111536,
         "mode   "rx_bandwidth": "Static34360
IP",        }
"mtu": "1500",    ],
    "flowcontrolmetadata": "Auto",{
        "igmpitem_count": "Auto"1,
        "enabletotal_managementitems": false1,
        "enabletotal_video_bridgepages": false1,
        "managementcurrent_ttlpage": 16
    },1
     "metadata": {}
}