B2_Command_Line_Tool
master
  • Quick Start Guide
  • Commands
    • Authorize-account command
    • Cancel-all-unfinished-large-files command
    • Cancel-large-file 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-by-id command
    • Download-file-by-name command
    • Get-account-info command
    • Get-bucket command
    • Get-download-auth command
    • Get-download-url-with-auth command
    • Get-file-info command
    • Hide-file 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
      • Named Arguments
    • Update-file-retention command
    • Upload-file command
    • Version command
  • Replication
B2_Command_Line_Tool
  • »
  • Commands »
  • Update-file-legal-hold command
  • Edit on GitHub
Next Previous

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] [--profile PROFILE] [fileName] fileId {on,off}

Positional Arguments¶

fileName
fileId
legalHold

Possible choices: on, off

Named Arguments¶

--profile
Next Previous

© Copyright 2020, Backblaze. Revision 054326de.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: master
Versions
master
stable
v3.6.0
v3.5.0
v3.4.0
v3.3.0
v3.2.1
v3.2.0
v3.1.0
v3.0.3
v3.0.2
v3.0.1
v3.0.0
v2.5.1
v2.5.0
v2.4.0
v2.3.0
v2.2.0
v2.1.0
doc-update
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds