Sign in
Background Tasks

Get background task state

Retrieve the state and progress of a server-side background task started by another endpoint (for example, device configuration restore). Finished tasks remain available for a limited time after completion.

get/v1/background-tasks/{task-id}

Path parameters

task-idinteger required

Task ID returned by the endpoint that started the task

Response

Task state

idinteger

Task ID

descriptionstring

Human-readable task description

state'pending' | 'running' | 'completed' | 'failed'

Current task state

progressinteger

Completion percentage reported by the task

completionTimestring date-time nullable

Time the task finished (null while pending or running)

failureReasonstring nullable

Failure details (null unless state is failed)

Changes

Changed in 1 of the 115 revisions of this API.1