Versions Compared

Old Version 4

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

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": [
        {
  "iface": "eth0",             "ip_address"uuid": "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",
            "iface": "eth0",
            "flowcontrolip_address": "Auto192.168.10.131",
            "igmpmask": "Auto255.255.255.0",
            "enable_managementgateway": true"192.168.10.252",
            "mode": "Static "enable_video_bridge": true,
            "management_ttl": 16
        },
        {
   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-01-07T08:06:05.173Z",
            "modified": "2022-02-09T02:39:35.633Z",
            "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": true,
            "enable_video_bridge": true,
            "management_ttl": 16
        }
    ],
    "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.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 

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

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_count": 2,
  "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 

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

Code Block
languagejson
{
     "total_itemsModes": 2,[
        "current_page": 1DHCP",
        "sort_by": [Static IP"
             {
                "field": "device",
           ],
    "directionMtus": "ASC"
   [
        }"1500",
        "1492",
   {     "1280"
      ],
    "fieldFlowControlModes": "iface",[
        "Auto",
       "direction": "ASCEnabled",
        "Disabled"
   } ],
    "IgmpModes": [
 ],         "linksAuto":,
 {       "IGMPv1",
     "current": "http://192.168.10.53/api/5.0/interfaces/config"   "IGMPv2",
        }"IGMPv3"
    }]
}

GET

PUT interfaces/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns an extended single

PUT

Edit a 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 to be edited.

Example Request

GETPUT 

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

Body

{ "data": { "uuid": "2102d188-f7b1-4d6a-a8b4-1bd10653c300",
Code Block
languagejson
json
{
        "creatediface": "2022-01-19T09:17:31.376Zeth0",
        "modifiedversion": "2022-02-09T02:39:35.633Z"1631088492,
        "network": "2a62e295-f305-4d98-b6bb-237467f2221d",
        "device": "2102d188-f7b1-4d6a-a8b4-1bd10653c31b",
        "iface": "eth0",
        "ip_address": "192.168.102.131202",
        "mask": "255.255.255252.0",
        "gateway": "192.168.100.252",
        "mode": "Static IP",
        "mtu": "1500",
        "flowcontrol": "Auto",
        "igmp": "Auto",
        "enable_management": truefalse,
        "enable_video_bridge": true,
        "management_ttl_video_bridge": 16false,
    },     "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 

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

Code Block
languagejson
{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",
        "Modesnetwork": [ "2a62e295-f305-4d98-b6bb-237467f2221d",
        "device": "DHCP2102d188-f7b1-4d6a-a8b4-1bd10653c31b",
        "iface"Static: IP"eth0",
    ],     "Mtusip_address": ["192.168.2.202",
        "1500",
        "1492mask": "255.255.252.0",
        "1280gateway"
    ],
    "FlowControlModes": [: "192.168.0.252",
        "mode": "AutoStatic IP",
        "mtu": "Enabled1500",
        "Disabledflowcontrol": "Auto",
   ],     "IgmpModesigmp": ["Auto",
        "Auto"enable_management": false,
        "IGMPv1"enable_video_bridge": false,
        "IGMPv2",management_ttl": 16
    },
    "IGMPv3metadata":     ]
{}
}

PUT interfaces/config

/{uuid}

multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Edit a multiple 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
{
    "data": [
        {
            "ifaceuuid": "eth0",
    2102d188-f7b1-4d6a-a8b4-1bd10653c300",
   "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": false, true,
            "enable_video_bridge": falsetrue,
            "management_ttl": 16
}

Response

Code Block
languagejson
{     "data": {  },
      "uuid": "2102d188-f7b1-4d6a-a8b4-1bd10653c300",
      {
  "created": "2022-01-19T09:17:31.376Z",         "modifieduuid": "2022-02-15T14:40:36.208Z",92081df8-f78d-418e-92b7-87fdab283c00",
            "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",         "igmpflowcontrol": "Auto",
        "enable_management": false,
            "enable_video_bridgeigmp": false"Auto",
            "enable_management_ttl": false,
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 

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

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

Response

Code Block
languagejson
{
    "data": [
        {
            "uuid": "2102d188-f7b1-4d6a-a8b4-1bd10653c300-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",
            "network": "2a62e295-f305-4d98-b6bb-237467f2221d"},
        {
   "device         "uuid": "92081df8-f78d-418e-92b7-87fdab283cd887fdab283c00",
            "ifacecreated": "eth02022-02-22T07:51:03.045Z",
            "ip_addressmodified": "192.168.10.1322022-02-23T12:50:12.902Z",
            "masknetwork": "255.255.255.02a62e295-f305-4d98-b6bb-237467f2221d",
            "gatewaydevice": "192.168.10.25292081df8-f78d-418e-92b7-87fdab283cd8",
            "modeiface": "Static IPeth0",
            "mtuip_address": "1500192.168.10.132",
            "flowcontrolmask": "Auto255.255.255.0",
            "igmpgateway": "Auto192.168.10.252",
            "enable_managementmode": "Static falseIP",
            "enable_video_bridgemtu": false"1500",
            "management_ttlflowcontrol": 16
      "Auto",
 }     ] }

Response

Code Block
languagejson
{     "dataigmp": [ "Auto",
             {"enable_management": false,
            "uuidenable_video_bridge": "2102d188-f7b1-4d6a-a8b4-1bd10653c300"false,
            "createdmanagement_ttl": "2022-02-22T07:50:45.391Z",
  16
        }
     ],
    "modified": "2022-02-23T12:50:12.902Z",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
{
            "network": "2a62e295-f305-4d98-b6bb-237467f2221d",
            "device": "2102d188-f7b1-4d6a-a8b4-1bd10653c31b","data": [
        {
            "ifaceuuid": "eth0efad9663-7e09-4a06-a2f2-6b1d20601796",
            "ip_addressdevice": "192.168.10.13105011df5-87b1-4141-a3c0-c547657bf9b1",
            "maskiface": "255.255.255.0eth0",
            "gatewaytimestamp": "192.168.10.2522023-07-27T11:46:32.760Z",
            "modelldp": {
 "Static IP",              "mtuname": "1500"null,
                "flowcontroliface": "Auto"null,
                "igmpvlan": "Auto",0
            "enable_management": true},
            "enable_video_bridgenetwork": true"2a62e295-f305-4d98-b6bb-237467f2221d",
            "managementnetwork_ttllabel": 16 "Nic1",
             }"ip_address": "192.168.10.131",
        {             "uuid"mask": "92081df8-f78d-418e-92b7-87fdab283c00255.255.255.0",
            "createdgateway": "2022-02-22T07:51:03.045Z192.168.10.252",
            "modifiedspeed": "2022-02-23T12:50:12.902Z"10000,
            "networkmac": "2a62e295-f305-4d98-b6bb-237467f2221d00:50:56:A4:C8:79",
            "deviceflowcontrol": "92081df8-f78d-418e-92b7-87fdab283cd8Auto",
            "ifacemode": "eth0DHCP",
            "ipmanagement_addressenabled": "192.168.10.132"false,
            "maskvideo_bridge_enabled": "255.255.255.0"false,
            "gatewaynmos_enabled": "192.168.10.252"false,
            "modeup": "Static IP"true,
            "mtu"rx_multicast_bandwidth": "1500"168,
            "flowcontroltx_bandwidth": "Auto"111536,
            "igmprx_bandwidth": "Auto",34360
        }
   "enable_management": false ],
    "metadata": {
        "enableitem_video_bridgecount": false1,
   
        "managementtotal_ttlitems": 161,
        }
"total_pages": 1,
   ],     "metadatacurrent_page": { 1
    }
}