Versions Compared

Old Version 3

changes.mady.by.user Ramya Raman (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Ramya Raman (Unlicensed)

Saved on

Key

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

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 

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

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

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

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

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

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

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

Body
Expand
titleBODY
Code Block
languagejson
{
    "Network": {
   "id": 901100,
   "network_id": 3,
   "device_id": 9011,
   "iface": "eth0",
   "ip_address": "0.0.0.0",
   "subnet_mask": "255.255.255.0",
   "default_gateway": "0.0.0.0",
   "network_interface_mode_id": 1,
   "network_flowcontrol_mode_id": 1,
   "force_igmp_version": 0,
   "enable_management": 1,
   "management_ttl": 2,
   "modified": "1384861816759",
   "created": "1384861121395"
}
}
Response

Expand
titleRESPONSE
Code Block
languagejson
{
    "Network": {
        "id": 901100,
        "network_id": 3,
        "device_id": 9011,
        "iface": "eth0",
        "ip_address": "0.0.0.0",
        "subnet_mask": "255.255.255.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": 1,
        "enable_video_bridge": 0,
        "management_ttl": 2,
        "modified": "1619512726835",
        "created": "1611142282208"
    }
}

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 

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

Expand
titleRESPONSE
Code Block
languagejson
[
    {
        "NetworkName": {
            "id": 1,
            "title": "Nic1",
            "proxy": "",
            "modified": "1611142282208",
            "created": "1611142282208"
        }
    },
    {
        "NetworkName": {
            "id": 2,
            "title": "Nic2",
            "proxy": "",
            "modified": "1611142282208",
            "created": "1611142282208"
        }
    },
    {
        "NetworkName": {
            "id": 3,
            "title": "g",
            "proxy": "",
            "modified": "1611142282208",
            "created": "1611142282208"
        }
    }
]

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 

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

Expand
titleRESPONSE
Code Block
languagejson
{
    "NetworkName": {
        "id": 4,
        "title": "video",
        "proxy": "",
        "modified": "1619513075042",
        "created": "1619513075042"
    }
}

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 

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

Expand
Body
titleBODY
Code Block
languagejson
{
    "Network": {
   "id": 901100,
   "network_id": 3,
   "device_id": 9011,
   "iface": "eth0",
   "ip_address": "0.0.0.0",
   "subnet_mask": "255.255.255.0",
   "default_gateway": "0.0.0.0",
   "network_interface_mode_id": 1,
   "network_flowcontrol_mode_id": 1,
   "force_igmp_version": 0,
   "enable_management": 1,
   "management_ttl": 2,
   "modified": "1384861816759",
   "created": "1384861121395"
}
}
Expand
title
Response
RESPONSE
Code Block
languagejson
{
    "NetworkName": {
        "id": 3,
        "title": "video2",
        "proxy": "",
        "modified": "1619515956703",
        "created": "1611142282208"
    }
}

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 

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

Expand
titleRESPONSE
Code Block
languagejson
{
    "success": true
}