v5.0_Network Interfaces

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

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

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

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

Response

 


 

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

Response

 


 

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