Tasks
Execute Task
Execute a task on one or more devices. Returns a taskId used to track the status of the task.
Note: The POST /v1/tasks endpoint requires Admin or Operator permissions. To enable it for your account, please contact our support team.
Execute Task › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · taskType="restartDevice" · requires: devices | |
| type = object · taskType="onboardDevice" · requires: devices | |
| type = object · taskType="rotatePassword" · requires: devices | |
| type = object · taskType="rotateSslCertificate" · requires: devices |
taskTyperestartDevice
The devices to restart.
defaultPayloadThe default payload applied to all devices. restartDevice requires no configuration, so this can be omitted, empty, or null.
Execute Task › Responses
Task created successfully.
taskIdThe ID of the created task, use it with GET /v1/tasks/{id} to track progress.
Get Task By ID
Returns the status and details of a task.
Returns 404 if the task is not found or the user does not have access to it.
path Parameters
idThe task id
query Parameters
limitThe number of items to return, default is 100 and maximum is 1000.
offsetThe number of items to skip before starting to collect the result set.
includeStepsSet to true to include the per-step breakdown of each task in the response. By default, steps are not included.
Get Task By ID › Responses
A list of device tasks for the task.
userNameThe user who executed the task.
totalThe total number of device tasks.