Cancel retire devices
This call cancels retire devices.
Required Role
See Authentication for complete details on ensuring that the credentials you use for basic authentication belong to a user with the necessary role for this API call.
Required Role |
|---|
Category: Device Management Role Description: Retire device |
HTTP method
PUT
Request URI
api/v2/devices/cancelretire
Request parameters
Parameter | Description | Sample Value |
|---|---|---|
adminDeviceSpaceId | Required Parameter Type: Query Data Type: Number Device space ID of the administrator. | 1 |
deviceUuids | Required Parameter Type: Request body Data Type: String The device UUIDs of the devices to cancel retire. | |
note | Parameter Type: Request body Data Type: String Note clarifying the cancel retire request. | "note": "alert(\"Test\”)” |
Response fields
Field | Description |
|---|---|
results | Container for results. |
resultId | ID of the result. |
resultMessage | Message for the result. |
records | List of devices affected. |
resultCount | Count of devices affected. |
actionType | Describes the action type, in this case, CANCEL RETIRE. |
deviceResults | Indicates the outcome for the action per device. |
successful | Indicates success, true or false. |
Sample request and response
Request
curl --location --request PUT 'https://[Ivanti EPMM]/api/v2/devices/cancelretire?adminDeviceSpaceId=1' \
--header 'Content-Type: application/json' \
--data ' {"deviceUuids": ["3d394988-f5a0-45b6-9958-2d30c8e21ccd"], "note": "alert(\"Test\")"}'
Response
{
"results": [
{
"resultId": "114",
"resultMessage": null,
"records": [
"3d394988-f5a0-45b6-9958-2d30c8e21ccd"
]
}
],
"resultCount": 1,
"actionType": "CANCEL_RETIRE",
"deviceResults": {
"3d394988-f5a0-45b6-9958-2d30c8e21ccd": "Device Action Successful"
},
"successful": true
}