v5.0_Devices

GET devices/config

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns a list of all Devices in the system, with its main configuration data.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/devices/config

Example Request

GET

https://192.168.0.22/api/5.0/devices/config

{
    "data": [
        {
            "uuid": "92081df8-f78d-418e-92b7-87fdab283cd8",
            "label": "MCM9000-SN:9232",
            "created": "2022-01-07T08:06:05.173Z",
            "modified": "2022-02-15T15:08:12.372Z",
            "settings": {
                "color": [
                    "#df6627",
                    "#a88c15"
                ],
                "license_sharing": true,
                "stacking_multicast": "229.245.235.211",
                "stacking_port": 65513,
                "cloud_license": "TjJssjL0H0XCNoHQXJxxxxxFOHCU0PYO8Bwezz",
                "license_server_host": null,
                "disable_http_access": false,
                "disable_ftp_access": false,
                "disable_ftps_access": false,
                "groups": [
                    {
                        "label": "Group1",
                        "type": "Resource"
                    }
                ]
            },
            "access": {
                "url": "192.168.10.132",
                "username": "Admin",
                "password": "Admin"
            }
        },
        {
            "uuid": "2102d188-f7b1-4d6a-a8b4-1bd10653c31b",
            "label": "MCM9000-SN:9898",
            "created": "2022-01-19T09:17:31.376Z",
            "modified": "2022-02-09T02:39:35.441Z",
            "settings": {
                "color": [
                    "#8f6ce0",
                    "#abd93f"
                ],
                "license_sharing": true,
                "stacking_multicast": "229.245.235.211",
                "stacking_port": "65513",
                "cloud_license": "TjJssjL0H0XCNoHQXJxxxxxFOHCU0PYO8Bwezz",
                "license_server_host": null,
                "disable_http_access": false,
                "disable_ftp_access": false,
                "disable_ftps_access": false,
                "groups": []
            },
            "access": {
                "url": "192.168.10.131",
                "username": "Admin",
                "password": "Admin"
            }
        }
    ],
    "metadata": {
        "item_count": 2,
        "total_items": 2,
        "current_page": 1,
        "sort_by": [
            {
                "field": "label",
                "direction": "ASC"
            }
        ],
        "links": {
            "current": "http://192.168.10.53/api/5.0/devices/config"
        }
    }
}

GET devices/config/{uuid}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns an extended single Devices configuration view, specified by the required {uuid} parameter.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/devices/config/{{uuid}}

Parameters

Parameter	Data Type	Description
uuid (required)	string	The UUID of the desired Devices.

Example Request

GET

https://192.168.0.22/api/5.0/devices/config/92081df8-f78d-418e-92b7-87fdab283cd8

{
    "data": {
        "uuid": "92081df8-f78d-418e-92b7-87fdab283cd8",
        "label": "MCM9000-SN:9232",
        "created": "2022-01-07T08:06:05.173Z",
        "modified": "2022-02-15T15:08:12.372Z",
        "settings": {
            "color": [
                "#df6627",
                "#a88c15"
            ],
            "license_sharing": true,
            "stacking_multicast": "229.245.235.211",
            "stacking_port": 65513,
            "cloud_license": "TjJssjL0H0XCNoHQXJxxxxxFOHCU0PYO8Bwezz",
            "license_server_host": null,
            "disable_http_access": false,
            "disable_ftp_access": false,
            "disable_ftps_access": false,
            "groups": [
                {
                    "label": "Group1",
                    "type": "Resource"
                }
            ]
        },
        "access": {
            "url": "192.168.10.132",
            "username": "Admin",
            "password": "Admin"
        }
    },
    "metadata": {}
}

DELETE devices/config/{uuid}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	DELETE

Delete a specific Devices configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/devices/config/{{uuid}}

Parameters

Parameter	Data Type	Description
uuid (required)	string	The UUID of the Devices to be deleted.

Example Request

DELETE

https://192.168.0.22/api/5.0/devices/config/39626cb3-986a-4ac4-9e7a-f9d7658139b6

{
    "data": [
        {
            "uuid": "7a241ae4-b806-4313-b75d-cee92329bf56",
            "created": 1632226738471,
            "type": "Remove Device",
            "state": "Running",
            "progress": 0,
            "attributes": {
                "device": "39626cb3-986a-4ac4-9e7a-f9d7658139b6",
                "type": "Remove Device"
            },
            "result": null
        }
    ],
    "metadata": {}
}

PUT devices/config/{uuid}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	PUT

Edit a Devices configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/devices/config/{{uuid}}

Parameters

Parameter	Data Type	Description
uuid (required)	string	The UUID of the Devices to be edited.

Example Request

PUT

https://192.168.0.22/api/5.0/devices/config/39626cb3-986a-4ac4-9e7a-f9d7658139b6

Body

Response

POST devices/config

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	POST

Add a new Devices, configured according to the attached data request.

*The response recieved is the task created for the request sent.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/devices/config

Example Request

POST

https://192.168.0.22/api/5.0/devices/config

Body

Response

GET devices/info

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Add a new Devices, configured according to the attached data request.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/devices/info

Example Request

GET

https://192.168.0.22/api/5.0/devices/info

GET devices/status

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns the status of devices configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/devices/status

Example Request

GET

https://192.168.0.22/api/5.0/devices/status