Skip to main content

Renew a capture-agent job lease and report progress

POST 

/api/v1/capture-agent/jobs/:job_id/heartbeat

Requires the narrow device credential plus the current lease token. Extends the lease and records scanning or uploading; a stale lease conflicts and a durable cancellation request stops the job.

Request​

Responses​

Lease renewed and reported progress stored

Response Headers
    X-Request-Id

    Opaque request correlation identifier. ProblemDetails.requestId carries the same value on JSON failures.