Cancel pending command processing

POST

/v1/organizations/:organizationId/mdm/windows/enterprise/devices/:winDeviceId/commands/:winCommandId/:cmdId/cancel

Cancel pending command processing

Required Permission: mdm.windows.command.cancel

Cancel pending command in batch preventing further processing on device and marking operation as canceled for audit tracking.

Request

Add parameter in header authorization

Example: Authorization: Bearer <token>

organizationId string

required

Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

winDeviceId string

required

Match pattern: ^(([a-fA-F0-9]{24})|(\w{1,}))$

winCommandId string

required

Windows command batch identifier containing the action to be canceled.

Match pattern: ^[a-fA-F0-9]{24}$

cmdId string

required

Specific command action identifier within the batch to cancel preventing further processing.

≤ 128 characters

Responses

200 Response application/json

status boolean optional

data object optional

canceled string optional

Indicates that the wind command was successfully canceled. Returns "OK" when the cancellation is completed.

OK

{
    "status": true,
    "data": {
        "canceled": "OK"
    }
}

400 Response application/json

status boolean optional

false

error object optional

code number optional

5143

message string optional

Win command not in pending status

{
    "status": false,
    "error": {
        "code": 5050,
        "message": "Feature not allowed for you billing plan"
    }
}

401 Response application/json

status boolean optional

false

error object optional

code number optional

4004

message string optional

Invalid Token

{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}

404 Response application/json

status boolean optional

false

error object optional

code number optional

3001

message string optional

Entity not found

{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}