Sign in
JobLock

Renew a named job lock and record progress

Renew a held lock, optionally replacing its progress. The server sets the heartbeat time. Restricted to API keys with global write permission on the lock namespace's scope target.

put/jobLocks/{lock_name}

Path parameters

lock_namestring required

Registered namespace, a dot, then the job's own id, e.g. azure-boards-sync.<integration id>

Request body

lock_keystring required

Key returned when the lock was acquired

progressstring

Opaque progress to store, at most 8192 bytes as UTF-8. Omit to keep the stored progress.

Response

Lock renewed

lock_namestring required

Name of the lock

last_updatedinteger required

Epoch milliseconds of this heartbeat, set by the server

Changes

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