Versions Compared

Version Old Version 1 New Version Current
Changes made by

Ramya Raman (Unlicensed)

Ramya Raman (Unlicensed)

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.010.2253/api/5.1/interfaces/config

Code Block
languagejson
{
    "data": [
        {
            "uuid": "efad9663-7e09-4a06-a2f2-6b1d20601796",
            "created": "2023-0410-13T1110T10:0340:1131.605Z016Z",
            "modified": "2023-0510-09T1510T10:2440:3331.178Z016Z",
            "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"
        },
    ],    {
  "metadata": {         "item_countuuid": 1,
  "b887d54b-f474-4327-b1c0-8c7828a99d0f",
     "total_items": 1,         "current_pagecreated": 1"2023-10-10T10:40:31.016Z",
        "sort_by": [   "modified": "2023-12-07T10:54:55.685Z",
         {   "network": "523147ed-4d49-4fdd-bfc1-6d9428628327",
            "device": "ASC"05011df5-87b1-4141-a3c0-c547657bf9b1",
            }"iface": "eth0.10",
            {
"ip_address": null,
               "ifacemask": "ASC"null,
            }
"gateway": null,
       ],     "mode": "DHCP",
            "linksmtu": {"1500",
            "currentflowcontrol": "Auto",
            "http://192.168.10.53/api/5.1/interfaces/config"igmp": "Auto",
        }    "enable_management": 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.1/interfaces/config/efad9663-7e09-4a06-a2f2-6b1d20601796

Code Block
languagejson
{       "enable_video_bridge": true,
            "management_ttl": 16,
            "enable_nmos": true,
            "datatype": { "Vlan",
            "uuidvlan_interface": "efad9663-7e09-4a06-a2f2-6b1d20601796",
         "created   "vlan_id": "2023-04-13T11:03:11.605Z",10
        "modified": "2023-05-09T15:24:33.178Z",},
        {
  "network": "2a62e295-f305-4d98-b6bb-237467f2221d",         "deviceuuid": "05011df5ce930fb4-87b17c4f-414141e4-a3c082b0-c547657bf9b173dca1687fe0",
            "ifacecreated": "eth02023-12-08T12:27:54.749Z",
        "ip_address    "modified": "192.168.10.1312023-12-08T12:27:54.749Z",
            "masknetwork": "255.255.255.0",2a62e295-f305-4d98-b6bb-237467f2221d",
            "gatewaydevice": "192.168.10.252c5a4e74d-d0ba-441a-bbab-44513a4e0931",
            "modeiface": "Static IPeth0",
            "mtuip_address": "1500192.168.10.132",
            "flowcontrolmask": "Auto255.255.255.0",
        "igmp": "Auto",
        "enable_management": false,    "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 

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

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

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

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

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

Body

Code Block
languagejson
{
    "data": {
        "enable_video_bridgeuuid": false"b887d54b-f474-4327-b1c0-8c7828a99d0f",
        "management_ttlnetwork": 16,
        "enable_nmos": false"523147ed-4d49-4fdd-bfc1-6d9428628327",
        "typedevice": "Physical05011df5-87b1-4141-a3c0-c547657bf9b1",
        "bonding_modeiface": "None"eth0.10",
        "bondingip_interfaceaddress": "None"null,
    },     "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.1/interfaces/config/meta

Code Block
languagejson
{mask": null,
        "gateway": null,
        "BondingModesmode": ["DHCP",
        "Nonemtu": "1500",
        "flowcontrol": "PrimaryAuto",
        "Backupigmp": "Auto",
   ],     "Typesenable_management": [true,
        "Physical"enable_video_bridge": true,
        "Vlan"management_ttl": 16,
        "LACP Bonding"
enable_nmos": true,
   ],     "Modestype": "Vlan",
[        "vlan_interface": "DHCPefad9663-7e09-4a06-a2f2-6b1d20601796",
        "vlan_id"Static: IP"12
    ],}
}

Response

Code Block
languagejson
{
    "Mtusdata": [{
        "uuid": "1500b887d54b-f474-4327-b1c0-8c7828a99d0f",
        "created": "14922023-10-10T10:40:31.016Z",
        "1280modified": "2023-12-13T11:11:44.647Z",
   ],     "FlowControlModesnetwork": ["523147ed-4d49-4fdd-bfc1-6d9428628327",
        "Auto"device": "05011df5-87b1-4141-a3c0-c547657bf9b1",
        "Enablediface": "eth0.12",
        "Disabledip_address": null,
   ],     "IgmpModesmask": [null,
        "Autogateway": null,
        "IGMPv1mode",
        "IGMPv2: "DHCP",
        "IGMPv3mtu"
  : "1500",
 ]
}

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.1/interfaces/config/efad9663-7e09-4a06-a2f2-6b1d20601796

Body

Code Block
languagejson
{
    "data": {       "flowcontrol": "Auto",
        "igmp": "Auto",
        "enable_management": true,
        "enable_video_bridge": true,
        "uuidmanagement_ttl": "efad9663-7e09-4a06-a2f2-6b1d20601796"16,
        "createdenable_nmos": "2023-04-13T11:03:11.605Z"true,
        "modifiedtype": "2023-05-09T15:24:33.178ZVlan",
        "networkvlan_interface": "2a62e295efad9663-f3057e09-4d984a06-b6bba2f2-237467f2221d6b1d20601796",
        "device": "05011df5-87b1-4141-a3c0-c547657bf9b1",vlan_id": 12
    },
    "ifacemetadata": "eth0",
        "ip_address": "{}
}

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

  1. https://192.168.10.

131", "mask": "255.255.255.0", "gateway": "192.168.10.252",

  1. 53/api/5.0/interfaces/config

Body

Code Block
languagejson
{
        "modedata": "Static{
IP",         "mtunetwork": "1500523147ed-4d49-4fdd-bfc1-6d9428628327",
        "flowcontroldevice": "Auto05011df5-87b1-4141-a3c0-c547657bf9b1",
        "igmpiface": "Autoeth0.10",
        "enableip_managementaddress": falsenull,
        "enable_video_bridgemask": falsenull,
        "management_ttlgateway": 16null,
        "enable_nmos": false,
        "typemode": "PhysicalDHCP",
        "bonding_modemtu": "None1500",
        "bonding_interfaceflowcontrol": "NoneAuto",
    }
}

Response

Code Block
languagejson
{     "dataigmp": {"Auto",
        "uuidenable_management": "efad9663-7e09-4a06-a2f2-6b1d20601796"true,
        "createdenable_video_bridge": "2023-04-13T11:03:11.605Z"true,
        "modified": "2023-08-25T13:09:24.234Z"management_ttl": 16,
        "networkenable_nmos": "2a62e295-f305-4d98-b6bb-237467f2221d"true,
        "devicetype": "05011df5-87b1-4141-a3c0-c547657bf9b1Vlan",
        "ifacevlan_interface": "eth0efad9663-7e09-4a06-a2f2-6b1d20601796",
        "ipvlan_addressid": "192.168.10.131",12
    }
}

Response

Code Block
languagejson
{
  "mask":  "255.255.255.0",data": {
        "gatewayuuid": "192.168.10.25247498ea3-309c-48ba-ab6c-0a3f60f6beb2",
        "modecreated": "Static IP2023-12-13T11:19:57.465Z",
        "mtumodified": "15002023-12-13T11:19:57.465Z",
        "flowcontrolnetwork": "Auto523147ed-4d49-4fdd-bfc1-6d9428628327",
        "igmpdevice": "Auto05011df5-87b1-4141-a3c0-c547657bf9b1",
        "enable_managementiface": false"eth0.12",
        "enableip_video_bridgeaddress": falsenull,
        "management_ttlmask": 16null,
        "enable_nmosgateway": falsenull,
        "typemode": "PhysicalDHCP",
        "bonding_modemtu": "None1500",
        "bonding_interfaceflowcontrol": "NoneAuto",
    },     "metadataigmp": {}
}

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
{"Auto",
        "enable_management": true,
        "dataenable_video_bridge": {true,
        "uuidmanagement_ttl": 16,
       "efad9663-7e09-4a06-a2f2-6b1d20601796" "enable_nmos": true,
        "createdtype": "2023-04-13T11:03:11.605ZVlan",
        "modifiedvlan_interface": "2023-05-09T15:24:33.178Zefad9663-7e09-4a06-a2f2-6b1d20601796",
        "network": "2a62e295-f305-4d98-b6bb-237467f2221d"vlan_id": 12
    },
    "metadata":    "device": "05011df5-87b1-4141-a3c0-c547657bf9b1",
    {}
}

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.10.53/api/5.0/interfaces/status

Code Block
languagejson
{
    "ifacedata": "eth0",
        "ip_address": "192.168.10.131",[
        {
  "mask": "255.255.255.0",         "gatewayuuid": "192.168.10.252efad9663-7e09-4a06-a2f2-6b1d20601796",
            "modeiface": "Static IPeth0",
            "mtudevice": "150005011df5-87b1-4141-a3c0-c547657bf9b1",
            "flowcontroltimestamp": "Auto",2023-12-13T11:25:08.815Z",
            "igmpnetwork_label": "AutoNic1",
            "enable_managementnetwork": false,
   "2a62e295-f305-4d98-b6bb-237467f2221d",
    "enable_video_bridge": false,         "managementip_ttladdress": 16"192.168.10.131",
        "enable_nmos": false,
        "typemask": "Physical",255.255.255.0",
            "bonding_modegateway": "None192.168.10.252",
         "bonding_interface   "speed": "None" 10000,
      } }

Response

Code Block
languagejson
{     "data": {mac": "00:50:56:A4:C8:79",
            "uuidflowcontrol": "efad9663-7e09-4a06-a2f2-6b1d20601796Auto",
        "created": "2023-04-13T11:03:11.605Z",    "mode": "DHCP",
            "modifiedmanagement_enabled": "2023-08-25T13:09:24.234Z",false,
            "networkvideo_bridge_enabled": "2a62e295-f305-4d98-b6bb-237467f2221d",false,
            "devicenmos_enabled": "05011df5-87b1-4141-a3c0-c547657bf9b1"false,
            "ifaceup": "eth0",true,
            "iprx_multicast_addressbandwidth": "192.168.10.131"456,
        "mask    "tx_bandwidth": "255.255.255.0",127504,
            "gatewayrx_bandwidth": "192.168.10.252",602752,
            "modelldp": "Static IP", {
                "mtuname": "1500"null,
        "flowcontrol": "Auto",         "igmpiface": "Auto"null,
        "enable_management": false,         "enable_video_bridgevlan": 0
 false,         "management_ttl": 16, }
       "enable_nmos": false },
        "type": "Physical",{
            "bonding_modeuuid": "None47498ea3-309c-48ba-ab6c-0a3f60f6beb2",
        "bonding_interface    "iface": "None"
    },
eth0.12",
   {         "uuiddevice": "2102d18805011df5-f7b187b1-4d6a4141-a8b4a3c0-1bd10653c300c547657bf9b1",
            "createdtimestamp": "2023-0412-13T11:0325:1108.605Z815Z",
            "modifiednetwork_label": "2023-08-25T13:09:24.234ZNic2",
            "network": "2a62e295523147ed-f3054d49-4d984fdd-b6bbbfc1-237467f2221d6d9428628327",
        "device": "2102d188-f7b1-4d6a-a8b4-1bd10653c31b",          "ifaceip_address": "eth0",null,
            "ip_addressmask": "192255.168255.10255.131255",
            "maskgateway": null,
  "255.255.255.0",          "speed": 10000,
            "gatewaymac": "192.168.10.252",00:50:56:A4:C8:79",
            "modeflowcontrol": "Static IPAuto",
            "mtumode": "1500DHCP",
            "flowcontrolmanagement_enabled": "Auto"false,
         "igmp   "video_bridge_enabled": "Auto"false,
            "enablenmos_managementenabled": falsetrue,
        "enable_video_bridge    "up": falsetrue,
        "management_ttl    "rx_multicast_bandwidth": 160,
            "enabletx_nmosbandwidth": false0,
            "typerx_bandwidth": "Physical",0,
            "bonding_modelldp": "None",
 {
      "bonding_interface": "None"     }     "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
{"name": null,
                "iface": null,
                "datavlan": [ 0
            }
        },
        {
            "uuid": "efad9663ce930fb4-7e097c4f-4a0641e4-a2f282b0-6b1d2060179673dca1687fe0",
            "iface": "eth0",
            "device": "05011df5c5a4e74d-87b1d0ba-4141441a-a3c0bbab-c547657bf9b144513a4e0931",
            "timestamp": "2023-0812-25T1313T11:1522:1523.246Z378Z",
            "network_label": "Nic1",
            "network": "2a62e295-f305-4d98-b6bb-237467f2221d",
            "ip_address": "192.168.10.131132",
            "mask": "255.255.255.0",
            "gateway": "192.168.10.252",
            "speed": 10000,
            "mac": "00:500C:5629:A4F8:C8B9:795A",
            "flowcontrol": "Auto",
            "mode": "DHCP",
            "management_enabled": false,
            "video_bridge_enabled": false,
            "nmos_enabled": false,
            "up": true,
            "rx_multicast_bandwidth": 0,
            "tx_bandwidth": 3619210996376,
            "rx_bandwidth": 1512031299544,
            "lldp": {
                "name": null,
                "iface": null,
                "vlan": 0
            }
        }
    ],
    "metadata": {
        "item_count": 13,
        "total_items": 13,
        "total_pages": 1,
        "current_page": 1
    }
}