Batch Tasks API Reference

This section describes the API endpoints for managing batch tasks, including creating, listing, updating, and deleting batch tasks, as well as retrieving task results and managing task triggers.

1. Batch Task Management

Feature: Manage batch tasks for device management

• List Batch Tasks GET /api/v1/orgs/{orgId}/batches
• Create Batch Task POST /api/v1/orgs/{orgId}/batches
• Delete Batch Task DELETE /api/v1/orgs/{orgId}/batches/{batchId}

2. Batch Task Details and Updates

Feature: Retrieve and update details of specific batch tasks

• Get Batch Task Details GET /api/v1/orgs/{orgId}/batches/{batchId}
• Update Batch Task PUT /api/v1/orgs/{orgId}/batches/{batchId}
• Partially Update Batch Task PATCH /api/v1/orgs/{orgId}/batches/{batchId}

3. Batch Task Execution and Results

Feature: Manage execution and results of batch tasks

• Get Batch Task Devices GET /api/v1/orgs/{orgId}/batches/{batchId}/devices
• Get Batch Task Results GET /api/v1/orgs/{orgId}/batches/{batchId}/results
• Update Batch Task Status PUT /api/v1/orgs/{orgId}/batches/{batchId}/status
• Get Batch Task Triggers GET /api/v1/orgs/{orgId}/batches/{batchId}/triggers
• Start Batch Task POST /api/v1/orgs/{orgId}/batches/{batchId}:start

4. Individual Task Management

Feature: Manage individual tasks within batch tasks

• Create Individual Task POST /api/v1/orgs/{orgId}/tasks
• List Individual Tasks GET /api/v1/orgs/{orgId}/tasks
• Delete Individual Task DELETE /api/v1/orgs/{orgId}/tasks/{taskId}
• Get Individual Task Details GET /api/v1/orgs/{orgId}/tasks/{taskId}
• Update Individual Task PUT /api/v1/orgs/{orgId}/tasks/{taskId}

---

Last updated on Mar-31, 2026 | Version 1.0.0