B2_Command_Line_Tool
v3.18.0
  • Quick Start Guide
  • Commands
    • Authorize-account command
    • Cancel-all-unfinished-large-files command
    • Cancel-large-file command
    • Cat command
    • Clear-account command
    • Copy-file-by-id command
    • Create-bucket command
    • Create-key command
    • Delete-bucket command
    • Delete-file-version command
    • Delete-key command
    • Download-file command
    • Download-file-by-id command
    • Download-file-by-name command
    • File-info command
    • Get-account-info command
    • Get-bucket command
    • Get-download-auth command
    • Get-download-url-with-auth command
    • Get-file-info command
    • Get-url command
    • Hide-file command
    • install-autocomplete command
    • List-buckets command
    • List-keys command
    • List-parts command
    • List-unfinished-large-files command
    • Ls command
    • Make-friendly-url command
    • Make-url command
    • replication-setup command
    • Rm command
    • Sync command
    • Update-bucket command
    • Update-file-legal-hold command
      • Positional Arguments
    • Update-file-retention command
    • Upload-file command
    • Version command
  • Replication
B2_Command_Line_Tool
  • Commands
  • Update-file-legal-hold command
  • Edit on GitHub
Previous Next

Update-file-legal-hold command

Only works in buckets with fileLockEnabled=true.

Specifying the fileName is more efficient than leaving it out. If you omit the fileName, it requires an initial query to B2 to get the file name, before making the call to delete the file. This extra query requires the readFiles capability.

Requires capability:

  • writeFileLegalHolds

  • readFiles (if file name not provided)

b2 update-file-legal-hold [-h] [fileName] fileId {on,off}

Positional Arguments

fileName
fileId
legalHold

Possible choices: on, off

Previous Next

© Copyright 2024, Backblaze. Revision 0cd38827.

Built with Sphinx using a theme provided by Read the Docs.