Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
GET devices/config
Resource Information
Requires Authentication? | |
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
| Code Block | ||
|---|---|---|
| ||
{
"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": "TjJTjL0H0XCNoHQXJQFCA8qGcFOHCU0PYO8BwesRTjJssjL0H0XCNoHQXJxxxxxFOHCU0PYO8Bwezz",
"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": "TjJTjL0H0XCNoHQXJQFCA8qGcFOHCU0PYO8BwesRTjJssjL0H0XCNoHQXJxxxxxFOHCU0PYO8Bwezz",
"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? | |
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 | string | The UUID of the desired Devices. |
Example Request
GET
| Code Block | ||
|---|---|---|
| ||
{
"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": "TjJTjL0H0XCNoHQXJQFCA8qGcFOHCU0PYO8BwesRTjJssjL0H0XCNoHQXJxxxxxFOHCU0PYO8Bwezz",
"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": {}
} |
GET devices/config/meta
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns all meta data used by Devices configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/devices/config/meta
Example Request
GET
| Code Block | ||
|---|---|---|
| ||
{} |
DELETE devices/config/{uuid}
Resource Information
Requires Authentication? | |
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 | string | The UUID of the Devices to be deleted. |
Example Request
DELETE
| Code Block | ||
|---|---|---|
| ||
{
"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? | |
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 | string | The UUID of the Devices to be edited. |
Example Request
PUT
Body
| Code Block | ||
|---|---|---|
| ||
{
"label": "MCM9000-SN:1992",
"settings": {
"color": [
"#A9835A",
"#82F4E4"
],
"license_sharing": true,
"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"
}
} |
Response
| Code Block | ||
|---|---|---|
| ||
{
"data": [
{
"uuid": "39626cb3-986a-4ac4-9e7a-f9d7658139b6",
"label": "MCM9000-SN:1992",
"created": "2021-09-21T10:38:17.097Z",
"modified": "2021-09-21T12:12:50.929Z",
"settings": {
"color": [
"#A9835A",
"#82F4E4"
],
"license_sharing": true,
"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? | |
Response Formats | json |
HTTP Methods | POST |
Add a new Devices, configured according to the attached data request.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/devices/config
Example Request
POST
Body
| Code Block | ||
|---|---|---|
| ||
{
"url": "http://192.168.1.122",
"username": "test",
"password": "test"
} |
Response
| Code Block | ||
|---|---|---|
| ||
{
"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": {}
} |
Add a new Devices, configured according to the attached data request.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/devices/info
Example Request
GET
| Code Block | ||
|---|---|---|
| ||
{
"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"
},
{
"BIOS Version": " 6.00"
},
{
"BIOS Release Date": " 05/28/2020"
},
{
"Motherboard Manufacturer": " Intel Corporation"
},
{
"Motherboard Product Name": " 440BX Desktop Reference Platform"
},
{
"Motherboard Version": " None"
},
{
"Motherboard Serial Number": " None"
},
{
"System Manufacturer": " VMware, Inc."
},
{
"System Product Name": " VMware Virtual Platform"
},
{
"System Version": " None"
},
{
"System Serial Number": " VMware-56 4d 51 e7 01 b0 c4 72-2e 13 57 9d 3d 34 99 fb"
},
{
"Network Device": "eth0: e1000 7.3.21-k8-NAPI, fw: on cpu 1"
}
],
"processed": "2021-09-21T12:27:08.665Z"
}
],
"metadata": {
"item_count": 1,
"total_items": 1,
"total_pages": 1,
"current_page": 1
}
} |