Runs

Force revoke File Locks by path

Revokes file locks by provided path, file_name and lock_owner. Returns list of locks that were failed to revoke.

post/runs/{id}/file_locks/revoke_by_path

Request

  • Base URL
    https://localhost:8446/api/v2
  • Auth
    API key in header Authorization

Path parameters

idnumber required

Job run id

Request body

locks_to_revokeobject required

Locks to revoke. Array or locks to revoke. Required and must not be empty.

locks_to_revoke.file_namestring required

File name.

locks_to_revoke.pathstring required

Path. Path relatively to job folder.

locks_to_revoke.lock_ownerstring

Lock owner. If not provided, all locks (applied by all Agents) will be revoked for this file.

Response

Successful response

failed_to_revokeobject required

Failed to revoke. Array of locks that were failed to revoke.

file_namestring required

File name.

pathstring required

Path.

reasonstring required

Reason.

Changes

No recorded changes to this operation across all 1 revision of this API.