Network Interface Configuration

GET networks/config/meta

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns a list of meta data used for network configuration. Data includes mode types for Flow Control, IGMP and IP Assignment Methods.

Resource URL

http://{host}/api/2.0/networks/config/meta/.format

Example Request

GET

http://44.235.52.211/api/2.0/networks/config/meta/.json

{
    "Modes": {
        "1": "DHCP",
        "2": "Static IP"
    },
    "FlowControlModes": {
        "1": "Auto",
        "2": "Enabled",
        "3": "Disabled"
    },
    "IgmpModes": [
        "Auto",
        "Force IGMPv1",
        "Force IGMPv2",
        "Force IGMPv3"
    ],
    "MTUs": {
        "1280": "1280",
        "1492": "1492",
        "1500": "1500"
    }
}

GET networks/config

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns a list of available network interfaces configuration on the system.

Resource URL

http://{host}/api/2.0/networks/config/.format

Example Request

GET

http://44.235.52.211/api/2.0/networks/config/.json

[
    {
        "Network": {
            "id": 901100,
            "network_id": 1,
            "device_id": 9011,
            "iface": "eth0",
            "ip_address": "0.0.0.0",
            "subnet_mask": "0.0.0.0",
            "mtu": "1500",
            "default_gateway": "0.0.0.0",
            "network_interface_mode_id": 1,
            "network_flowcontrol_mode_id": 1,
            "force_igmp_version": 0,
            "enable_management": 0,
            "enable_video_bridge": 0,
            "management_ttl": 16,
            "modified": "1611142282208",
            "created": "1611142282208"
        }
    }
]

GET networks/config/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns a single network interface configuration, specified by network ID.

Resource URL

http://{host}/api/2.0/networks/config/{id}/.format

Parameters

Parameter	Data Type	Description
id (required)	integer	The ID of the network interface. The ID is a combination of the MCM-9000 unit's serial number and the specific interface index. for example: Serial number is "621" and the interface is "eth0". Network ID will be "6210".

Example Request

GET

http://44.235.52.211/api/2.0/networks/config/901100/.json

{
    "Network": {
        "id": 901100,
        "network_id": 1,
        "device_id": 9011,
        "iface": "eth0",
        "ip_address": "0.0.0.0",
        "subnet_mask": "0.0.0.0",
        "mtu": "1500",
        "default_gateway": "0.0.0.0",
        "network_interface_mode_id": 1,
        "network_flowcontrol_mode_id": 1,
        "force_igmp_version": 0,
        "enable_management": 0,
        "enable_video_bridge": 0,
        "management_ttl": 16,
        "modified": "1611142282208",
        "created": "1611142282208"
    }
}

PUT networks/config/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	PUT

Update network interface configuration.

Resource URL

http://{host}/api/2.0/networks/config/{id}/.format

Parameters

Parameter	Data Type	Description
id (required)	integer	ID of the network to be updated.

Example Request

PUT

http://44.235.52.211/api/2.0/networks/config/901100/.json

GET networks/config/name

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns a list of available network names.

Resource URL

http://{host}/api/2.0/networks/config/name/.format

Example Request

GET

http://44.235.52.211/api/2.0/networks/config/name/.json

POST networks/config/name/{network_name}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	POST

Adds a network name to the available name list.

Resource URL

http://{host}/api/2.0/networks/config/name/{network_name}/.format

Parameters

Parameter	Data Type	Description
network_name (required)	string	Name of the network to be added.

Example Request

POST

http://44.235.52.211/api/2.0/networks/config/name/video/.json

PUT networks/config/name/{networkName_id}/{new_networkName}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	PUT

Updates network name.

Resource URL

http://{host}/api/2.0/networks/config/name/{networkName_id}/{new_networkName}/.format

Parameters

Parameter

Data Type

Description

networkName_id

(required)

integer

ID of the network to be updated.

new_networkName
(required)

string

Name of the network to be updated.

Example Request

PUT

http://44.235.52.211/api/2.0/networks/config/name/3/video2/.json

DELETE outputs/config/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	DELETE

Deletes a network name from the list.

Resource URL

http://{host}/api/2.0/outputs/config/{id}/.format

Parameters

Parameter	Data Type	Description
id (required)	integer	The ID of the desired network.

Example Request

DELETE

http://44.235.52.211/api/2.0/networks/config/name/4/.json

Network Interface Configuration

GET networks/config/meta

Resource Information

Resource URL

Example Request

GET networks/config

Resource Information

Resource URL

Example Request

GET networks/config/{id}

Resource Information

Resource URL

Parameters

Example Request

PUT networks/config/{id}

Resource Information

Resource URL

Parameters

Example Request

GET networks/config/name

Resource Information

Resource URL

Example Request

POST networks/config/name/{network_name}

Resource Information

Resource URL

Parameters

Example Request

PUT networks/config/name/{networkName_id}/{new_networkName}

Resource Information

Resource URL

Parameters

Example Request

DELETE outputs/config/{id}

Resource Information

Resource URL

Parameters

Example Request

Related content