hide_file Method

Hides a file.

Syntax

def hide_file(bucket_id: str, file_name: str) -> str: ...

Remarks

This method hides the file named FileName in the bucket specified by BucketId by creating a special version of the file called a hide marker.

If the latest version of a file is a hide marker, then the file will not appear in the results returned by list_files, nor can it be downloaded by name using download_file. However:

• Any version of the file (excluding hide markers) can still be downloaded directly using download_file_by_id.
• All versions of the file can still be deleted, either all at once using delete_file, or individually using delete_file_version.
• All versions of the file will still appear in the results returned by list_file_versions, and can still be queried individually using get_file_info.

To unhide a file, simply delete the hide marker using delete_file_version.

The currently-authenticated application key must have the writeFiles capability to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.