Sign in
JobLock

Acquire a named job lock

Acquire a named lock for a background job. A lock left without a heartbeat past its namespace's steal timeout may be taken over. The previous holder's progress is returned so the job can resume. Restricted to API keys with global write permission on the lock namespace's scope target.

post/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>

Response

Lock acquired

lock_namestring required

Name of the lock

lock_keystring required

Key that renews or releases the lock while it is held

acquired_timeinteger required

Epoch milliseconds when the lock was acquired

last_updatedinteger required

Epoch milliseconds of the lock's last write, set by the server

progressstring

Opaque progress last recorded on the lock, kept across holders

Changes

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