Skip to main content

Get configuration job status

GET 
/v2/configuration-jobs/:id/status

Get configuration job status

This endpoint retrieves the current status and tracking information for a configuration job identified by its id.

Path Parameters​

ParameterTypeRequiredDescription
idstring (UUID)YesThe unique identifier of the configuration job

Response​

Success Response​

Status Code: 200 OK

The request was successful and the job status information is returned.

{
    "total": 6,
    "totalPending": 3,
    "totalExecuting": 0,
    "totalCompleted": 3,
    "totalFailed": 0
}

Error Response​

Status Code: 404 Not Found

The specified tracking ID does not exist or the job cannot be found.

{
  "error": "JOB_NOT_FOUND",
  "message": "Configuration job with tracking ID '550e8400-e29b-41d4-a716-446655440000' not found",
  "trackingId": "550e8400-e29b-41d4-a716-446655440000"
}

Notes​

Polling Recommendations
  • For jobs in pending or in_progress status, poll this endpoint periodically to check for updates
    • Recommended polling interval: 30-60 seconds to avoid rate limits
    • Jobs typically complete within 5-15 minutes depending on the number of devices
Job Status Lifecycle

The job progresses through these status states:

  1. pending - Job created but not yet started
  2. in_progress - Job is actively running on devices
  3. completed - All devices have finished successfully
  4. failed - One or more critical errors occurred
  5. cancelled - Job was manually cancelled

Request​

Responses​

Configuration job status