Queries the details of edge agent packages.
Try it now
Test
RAM authorization
Request syntax
GET HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| PackageIds |
string |
No |
The list of package IDs. Separate multiple IDs with commas. |
cmag-0c1g77wjljl9hc**** |
| LicenseKeys |
string |
No |
The list of license keys. Separate multiple keys with commas. |
lic-ez197xvdf0j5eo0***** |
| DeviceClass |
string |
No |
The device type filter. Valid values: BOX, PHONE, PAD, and OTHER. |
BOX |
| Status |
string |
No |
The package status filter. |
ACTIVE |
| NextToken |
string |
No |
The pagination token. Leave this parameter empty for the first query. For subsequent queries, use the value returned in the previous response. |
AAAAAV3MpHK1AP0pfERHZN5pu6kU**** |
| MaxResults |
integer |
No |
The maximum number of entries per page. Valid values: 1 to 100. Default value: 20. |
20 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The request ID. |
5C5CEF0A-D6E1-58D3-8750-67DB4F82**** |
| NextToken |
string |
The pagination token for the next page. An empty value indicates that no more data exists. |
AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc**** |
| MaxResults |
integer |
The actual number of entries returned on the current page. |
20 |
| TotalCount |
integer |
The total number of records. |
30 |
| Packages |
array<object> |
The list of packages. |
|
|
object |
The collection of package information. |
||
| PackageId |
string |
The package ID. |
cmag-0c1g77wjljl9hc**** |
| Status |
string |
The package status. |
ACTIVE |
| DeviceClass |
string |
The device type. |
BOX |
| PackageSpec |
string |
The package specification. Currently, only hardware is supported. |
hardware |
| ExpireDate |
string |
The expiration time. |
2026-01-05 10:04:07 |
| LicenseKeys |
array |
The list of license keys. |
|
|
string |
The license key. |
lic-ez197xvdf0j5eo0***** |
Examples
Success response
JSON format
{
"RequestId": "5C5CEF0A-D6E1-58D3-8750-67DB4F82****",
"NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****",
"MaxResults": 20,
"TotalCount": 30,
"Packages": [
{
"PackageId": "cmag-0c1g77wjljl9hc****",
"Status": "ACTIVE",
"DeviceClass": "BOX",
"PackageSpec": "hardware",
"ExpireDate": "2026-01-05 10:04:07",
"LicenseKeys": [
"lic-ez197xvdf0j5eo0*****"
]
}
]
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.