Page Comparison

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

Code Block

language	json

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

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

Code Block

language	json

{
    "data": [
        {
            "stacking_portuuid": 65513,
"92081df8-f78d-418e-92b7-87fdab283cd8",
               "cloud_license"label": "TjJssjL0H0XCNoHQXJxxxxxFOHCU0PYO8BwezzMCM9000-SN:9232",
                "license_server_host": null"created": "2022-01-07T08:06:05.173Z",
                "disable_http_access"modified": false"2022-02-15T15:08:12.372Z",
                "disable_ftp_access"settings": false,{
                "disable_ftps_accesscolor": false,
    [
           "groups": [        "#df6627",
            {        "#a88c15"
                "label": "Group1"],
                "license_sharing": true,
      "type": "Resource"         "stacking_multicast": "229.245.235.211",
          }      "stacking_port": 65513,
         ]       "cloud_license": "TjJssjL0H0XCNoHQXJxxxxxFOHCU0PYO8Bwezz",
    },             "accesslicense_server_host": {null,
                "urldisable_http_access": "192.168.10.132"false,
                "usernamedisable_ftp_access": "Admin"false,
                "passworddisable_ftps_access": "Admin"
false,
           }     "groups": [
   },               {  {
          "uuid": "2102d188-f7b1-4d6a-a8b4-1bd10653c31b",             "label": "MCM9000-SN:9898Group1",
            "created": "2022-01-19T09:17:31.376Z",             "modifiedtype": "2022-02-09T02:39:35.441Z",
 Resource"
          "settings": {         }
       "color": [        ]
            "#8f6ce0"},
            "access": {
      "#abd93f"                 ]"url": "192.168.10.132",
                "license_sharingusername": true"Admin",
                "stacking_multicastpassword": "229.245.235.211",Admin"
            }
       "stacking_port": "65513", },
        {
         "cloud_license   "uuid": "TjJssjL0H0XCNoHQXJxxxxxFOHCU0PYO8Bwezz2102d188-f7b1-4d6a-a8b4-1bd10653c31b",
   
            "license_server_hostlabel": null,
  "MCM9000-SN:9898",
             "disable_http_accesscreated": false,
  "2022-01-19T09:17:31.376Z",
             "disable_ftp_accessmodified": false"2022-02-09T02:39:35.441Z",
                "disable_ftps_access"settings": false,{
                "groupscolor": []
            },        "#8f6ce0",
    "access": {                 "url": "192.168.10.131","#abd93f"
                "username": "Admin"],
                "passwordlicense_sharing": "Admin"true,
            }      "stacking_multicast": "229.245.235.211",
  }     ],     "metadata": {         "itemstacking_countport": 2"65513",
        "total_items": 2,         "currentcloud_pagelicense": 1"TjJssjL0H0XCNoHQXJxxxxxFOHCU0PYO8Bwezz",
        "sort_by": [             {"license_server_host": null,
                "fielddisable_http_access": "label"false,
                "directiondisable_ftp_access": "ASC"false,
            }    "disable_ftps_access": false,
                "groups": []
            },
            "linksaccess": {
                "currenturl": "http://192.168.10.53/api/5.0/devices/config"131",
             }   "username": "Admin",
 }
}

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

Code Block

language	json

{
    "data               "password": "Admin"
            }
        }
    ],
    "metadata": {
        "uuiditem_count": "92081df8-f78d-418e-92b7-87fdab283cd8",2,
        "labeltotal_items": "MCM9000-SN:9232"2,
        "createdcurrent_page": "2022-01-07T08:06:05.173Z"1,
        "modifiedsort_by": "2022-02-15T15:08:12.372Z", [
           "settings": {
                "colorfield": "label",
[                "direction": "#df6627ASC",
            }
     "#a88c15"   ],
         ],"links": {
            "license_sharingcurrent": true,
            "stacking_multicast": "229.245.235.211","http://192.168.10.53/api/5.0/devices/config"
        }
   "stacking_port": 65513,
            "cloud_license": "TjJssjL0H0XCNoHQXJxxxxxFOHCU0PYO8Bwezz",
            "license_server_host": null,
            "disable_http_access": false,
            "disable_ftp_access": false,
    }
}

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

Code Block

language	json

{
    "data": {
        "disable_ftps_accessuuid": false,
   "92081df8-f78d-418e-92b7-87fdab283cd8",
        "groupslabel": ["MCM9000-SN:9232",
        "created": "2022-01-07T08:06:05.173Z",
      {  "modified": "2022-02-15T15:08:12.372Z",
        "settings": {
       "label": "Group1",    "color": [
               "type": "Resource#df6627",
                }"#a88c15"
            ]
   ,
    },         "accesslicense_sharing": {true,
            "urlstacking_multicast": "192229.168245.10235.132211",
            "usernamestacking_port": "Admin"65513,
            "passwordcloud_license": "AdminTjJssjL0H0XCNoHQXJxxxxxFOHCU0PYO8Bwezz",
        }     },"license_server_host": null,
        "metadata    "disable_http_access": {}
}

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

Code Block

language	json

{
    "data": [ false,
            "disable_ftp_access": false,
            "disable_ftps_access": false,
            "groups": [
                {
                   { "label": "Group1",
          "uuid": "7a241ae4-b806-4313-b75d-cee92329bf56",         "type": "Resource"
  "created": 1632226738471,              }
 "type": "Remove Device",         ]
   "state": "Running",    },
        "progressaccess": 0,{
            "attributesurl": {
   "192.168.10.132",
            "deviceusername": "39626cb3-986a-4ac4-9e7a-f9d7658139b6Admin",
                "typepassword": "Admin"Remove
Device"        }
    },
            "result": null
        }
    ],
    "metadata": {}
}

PUT

DELETE devices/config/{uuid}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods

PUT

DELETE

Edit 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

edited

deleted.

Example Request

PUTDELETE

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

Body

Code Block

language	json

{
    "labeldata": "MCM9000-SN:1992", [
        {
  "settings": {         "coloruuid": ["7a241ae4-b806-4313-b75d-cee92329bf56",
            "#A9835Acreated": 1632226738471,
            "#82F4E4type": "Remove Device",
      ],         "license_sharing"state": true,"Running",
            "stacking_multicastprogress": "229.245.235.211"0,
        "stacking_port    "attributes": "65513",
{
       "cloud_license": null,         "license_server_hostdevice": null,
"39626cb3-986a-4ac4-9e7a-f9d7658139b6",
       "disable_http_access": false,         "disable_ftp_accesstype": false,"Remove Device"
           "disable_ftps_access": false
    },
 
  "access": {         "urlresult": "http://192.168.0.100",null
        "username": "test",}
    ],
    "passwordmetadata": "test"
    }
}

Response

Code Block

language	json

{
    "data": [
        {
            "uuid": "39626cb3-{}
}

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

Code Block

language	json

{
            "label": "MCM9000-SN:1992",    
    "settings": {
        "createdcolor": "2021-09-21T10:38:17.097Z",[
            "modified": "2021-09-21T12:12:50.929Z#A9835A",
            "settings#82F4E4":
{        ],
        "colorlicense_sharing": [true,
          "stacking_multicast": "229.245.235.211",
        "stacking_port": "#A9835A65513",
        "cloud_license": null,
          "#82F4E4"
"license_server_host": null,
        "disable_http_access": false,
     ],   "disable_ftp_access": false,
            "license_sharing": true,"disable_ftps_access": false
    },
    "access": {
        "stacking_multicasturl": "229.245.235.211",
 http://192.168.0.100",
              "stacking_port"username": 65513"test",
                "cloud_license"password": null,"test"
    }
}

Response

Code Block

language	json

{
    "data": [
    "license_server_host": null,    {
            "disable_http_accessuuid": false"39626cb3-986a-4ac4-9e7a-f9d7658139b6",
                "disable_ftp_access"label": false"MCM9000-SN:1992",
                "disable_ftps_access": false"created": "2021-09-21T10:38:17.097Z",
             }"modified": "2021-09-21T12:12:50.929Z",
            "accesssettings": {
                "urlcolor": "http://192.168.0.100", [
                   "username": "test#A9835A",
                    "password#82F4E4":
"test"             }   ],
     }      ],     "metadatalicense_sharing": true,
  {}
}

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

Code Block

language	json

{
    "url": "http://192.168.1.122",
    "username": "test",
    "password": "test"
}

Response

Code Block

language	json

{
    "data": [
        {              "stacking_multicast": "229.245.235.211",
                "stacking_port": 65513,
                "cloud_license": null,
                "license_server_host": null,
                "disable_http_access": false,
                "disable_ftp_access": false,
                "disable_ftps_access": false
            },
            "access": {
                "url": "http://192.168.0.100",
                "username": "test",
                "password": "test"
            }
        }
    ],
    "metadata": {}
}

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

Code Block

language	json

{
    "url": "http://192.168.1.122",
    "username": "test",
    "password": "test"
}

Response

Code Block

language	json

{
    "data": [
        {
            "uuid": "ec3481e6-c65f-4766-a17a-78ff1e6ee802",
            "created": 1632226617310,
            "type": "Add Device",
            "state": "Running",
            "progress": 0,
            "attributes": {
                "url": "192.168.1.122",
                "username": "test",
                "password": "test"
            },
            "result": null
        }
    ],
    "metadata": {}
}

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

Code Block

language	json

{
    "data": [
        {
            "uuid": "f0fd7753-5843-43a3-acf7-eaf8065f8010",
            "timestamp": "2021-09-21T12:27:09.155Z",
            "uptime": "2021-09-21T11:09:35.920Z",
            "local": true,
            "series": "MCM-9000 Series",
            "model": "MCM-9000",
            "serial": "9202",
            "version": "5.5.6",
            "mode": "Monitor & Display",
            "platform": "Intel(R) Xeon(R) Gold 6140 CPU @ 2.30GHz (x16), 16 GB Ram",
            "license": {
                "available": 0,
                "expiration": null,
                "features": "Full Monitoring,Light Monitoring,Mosaic Output,Recording,Centralized Error Display,Stacking,Descrambling"
            },
            "hardware": [
                {
                    "Memory Error Correction": " None"
                },
                {
                    "Memory Slot": " RAM slot #0 ( RAM slot #0 ) -  16384 MB  Unknown"
                },
                {
                    "Memory Slot": " RAM slot #1 ( RAM slot #1 ) -  No Module Installed"
                },
                {
                    "Memory Slot": " RAM slot #2 ( RAM slot #2 ) -  No Module Installed"
                },
                {
                    "Memory Slot": " RAM slot #3 ( RAM slot #3 ) -  No Module Installed"
                },
                {
                    "Memory Slot": " RAM slot #4 ( RAM slot #4 ) -  No Module Installed"
                },
                {
                    "Memory Slot": " RAM slot #5 ( RAM slot #5 ) -  No Module Installed"
                },
                {
                    "Memory Slot": " RAM slot #6 ( RAM slot #6 ) -  No Module Installed"
                },
                {
                    "Memory Slot": " RAM slot #7 ( RAM slot #7 ) -  No Module Installed"
                },
                {
                    "Memory Slot": " RAM slot #8 ( RAM slot #8 ) -  No Module Installed"
                },
                {
                    "Memory Slot": " RAM slot #9 ( RAM slot #9 ) -  No Module Installed"
                },
                {
                    "Memory Slot": " RAM slot #10 ( RAM slot #10 ) -  No Module Installed"
                },
                {
                    "CPU Model": " Intel(R) Xeon(R) Gold 6140 CPU @ 2.30GHz,  2300 MHz"
                },
                {
                    "CPU Details": ""
                },
                {
                    "CPU Model": " Intel(R) Xeon(R) Gold 6140 CPU @ 2.30GHz,  2300 MHz"
                },
                {
                    "CPU Details": ""
                },
                {
                    "BIOS Vendor": " Phoenix Technologies LTD"
                },
                {
                    "uuidBIOS Version": "ec3481e6-c65f-4766-a17a-78ff1e6ee802", 6.00"
               "created": 1632226617310},
             "type": "Add Device",   {
                    "stateBIOS Release Date": "Running", 05/28/2020"
               "progress": 0},
               "attributes": {
                 "url   "Motherboard Manufacturer": "192.168.1.122",
     Intel Corporation"
           "username": "test",    },
            "password": "test"   {
         },           "Motherboard Product Name"result": null" 440BX Desktop Reference Platform"
    }     ],     "metadata": {}
}

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

Code Block

language	json

{
    "data": [  },
                {
                    "Motherboard Version": " None"
                },
                {
               "uuid     "Motherboard Serial Number": "f0fd7753-5843-43a3-acf7-eaf8065f8010", None"
            "timestamp": "2021-09-21T12:27:09.155Z",   },
         "uptime": "2021-09-21T11:09:35.920Z",      {
      "local": true,             "seriesSystem Manufacturer": "MCM-9000 Series", VMware, Inc."
            "model": "MCM-9000",   },
         "serial": "9202",      {
      "version": "5.5.6",             "modeSystem Product Name": "Monitor VMware &Virtual DisplayPlatform",
            "platform": "Intel(R) Xeon(R) Gold 6140},
CPU @ 2.30GHz (x16), 16 GB Ram",          {
  "license": {                 "availableSystem Version": 0,"  None"
              "expiration": null  },
                "features": "Full Monitoring,Light Monitoring,Mosaic Output,Recording,Centralized Error Display,Stacking,Descrambling"{
                  },  "System Serial Number": " VMware-56 4d 51 e7 01 b0  "hardware": [
     c4 72-2e 13 57 9d 3d 34 99 fb"
          {      },
               "Memory Error{
Correction": " None"                 }, "Network Device": "eth0: e1000 7.3.21-k8-NAPI, fw:  on cpu 1"
      {          }
          "Memory Slot": "],
RAM slot #0 ( RAM slot #0 ) -  16384 MB  Unknown"processed": "2021-09-21T12:27:08.665Z"
        }
       }],
    "metadata": {
        "item_count": 1,
{            "total_items": 1,
        "Memory Slottotal_pages": "1,
RAM slot #1 ( RAM slot #1 ) -  No Module Installed"
 "current_page": 1
        }
}

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

Code Block

language	json

{
    "data": [
},        {
        {       "uuid": "05011df5-87b1-4141-a3c0-c547657bf9b1",
             "Memory Slotlabel": " RAM slot #2 ( RAM slot #2 ) -  No Module Installed"MCM9000-SN:9898",
                }"status": "Up",
                {
 "timestamp": "2023-07-27T11:49:47.784Z",
                  "Memory Slot"licenses": "{
RAM slot #3 ( RAM slot #3 ) -  No Module Installed"    "limit": 3000,
           },     "used": 1,
          {      "available": 2999
            },
"Memory Slot": " RAM slot #4 ( RAM slot #4 ) -  No Module Installed""clock": {
                "active": }false,
                {
      "offset": null,
             "Memory Slot": " RAM slot #5 ( RAM slot #5 ) -  No Module Installed"
  "locked": false
            },
             },"images": [
                {
                    "Memory Slotindex": " RAM slot #6 ( RAM slot #6 ) -  No Module Installed"1,
                    "firmware": "1.1.8",
           },         "software": "6.2.0",
      {              "active": false,
     "Memory Slot": " RAM slot #7 ( RAM slot #7 ) -  No Module Installed"next": false
                },
                {
                    "Memory Slotindex": "2,
RAM slot #8 ( RAM slot #8 ) -  No Module Installed"        "firmware": "1.1.8",
       },             "software": "6.3.0",
  {                     "Memory Slot"active": "true,
RAM slot #9 ( RAM slot #9 ) -  No Module Installed"        "next": true
       },         }
       {     ],
            "resources": {
 "Memory Slot": " RAM slot #10 ( RAM slot #10 ) -  No Module Installed"channels": {
               },     "limit": 88,
          {          "used": 1
          "CPU Model": " Intel(R) Xeon(R) Gold 6140},
CPU @ 2.30GHz,  2300 MHz"           "recorders": {
    },                 {"limit": 100,
                    "CPU Detailsused": ""0
                },
                "uncompressed": {
                    "CPU Model": " Intel(R) Xeon(R) Gold 6140 CPU @ 2.30GHz,  2300 MHz"limit": 0,
                    "used": 0
                },
                "encoders": {
                    "CPU Detailslimit": 24,
""                 },   "used": 0
            {    },
                "BIOS Vendordescramblers": {
" Phoenix Technologies LTD"                 },"limit": 88,
                    {"used": 0
                },
  "BIOS Version": " 6.00"           "total": {
    },                 {"limit": 70,
                    "BIOS Release Dateused": " 05/28/2020"5
                },
                "mlx": {
                    "Motherboard Manufacturertemperature": "[]
Intel Corporation"                 },
                "cpu": {
                    "Motherboard Product Name": " 440BX Desktop Reference Platform"frequency": {
                        "min": },2,
                        "max": 2,
   {                     "Motherboard Versionavg": " None"2
                    },

               {     "temperature": [
              "Motherboard Serial Number": " None"      {
          },                 { "cpu": 1,
                  "System Manufacturer": " VMware, Inc."      "temperature": 100
         },               },
 {                     "System Product Name":{
" VMware Virtual Platform"                 },        "cpu": 2,
       {                     "System Versiontemperature": " None"100
                },        }
        {            ],
        "System Serial Number": " VMware-56 4d 51 e7 01 b0 c4 72-2e 13 57 9d 3d 34 99 fb""used": 4.7
                },
                "memory": {
                    "Network Deviceused": "eth0: e1000 7.3.21-k8-NAPI, fw:  on cpu 1"4215720,
                    "allocated": 20511704
  }             ], }
           "processed": "2021-09-21T12:27:08.665Z" }
        }
    ],
    "metadata": {
        "itemtotal_countitems": 1,
        "totalitems_per_itemspage": 1,
        "total_pages": 1,
        "current_page": 1,
        "item_count": 1
    }
}

Page Comparison

Versions Compared

Old Version 6

New Version Current

Key

GET devices/config

Resource Information

Resource URL

Example Request

GET devices/config

Resource Information

Resource URL

Example Request

GET devices/config/{uuid}

Resource Information

Resource URL

Parameters

Example Request

GET devices/config/{uuid}

Resource Information

Resource URL

Parameters

Example Request

DELETE devices/config/{uuid}

Resource Information

Resource URL

Parameters

Example Request

DELETE devices/config/{uuid}

Resource Information

Resource URL

Parameters

Example Request

PUT devices/config/{uuid}

Resource Information

Resource URL

Parameters

Example Request

POST devices/config

Resource Information

Resource URL

Example Request

POST devices/config

Resource Information

Resource URL

Example Request

GET devices/info

Resource Information

Resource URL

Example Request

GET devices/info

Resource Information

Resource URL

Example Request

GET devices/status

Resource Information

Resource URL

Example Request