Firebase Admin icon

Firebase Admin

Interact with Firebase Firestore, Auth, and Storage using Firebase Admin SDK

Storage → Copy File

AI-generated

Summary

Copy a file from one path to another within a Firebase storage bucket, optionally handling existing destination files based on user preference.

Inputs

  • Project Name or ID — Select the Firebase project or specify its ID where the storage bucket resides.
  • Bucket Name or ID — Specify the storage bucket name to use; if omitted, the default bucket is used.
  • Source Path (required) — The path to the source file in the storage bucket to be copied.
  • Destination Path (required) — The path to the destination location in the storage bucket, including the new file name.
  • Options - If File Exists — Determines behavior if a file already exists at the destination path. Options include overwriting the existing file, failing with an error, skipping the copy, or renaming the destination file by adding a timestamp suffix to avoid overwriting.

Output shape

a single record describing the result of the copy operation

The operation returns information about the copied file if successful, or throws an error based on the 'If File Exists' option selected. No pagination or batch copies are supported in this operation.

Links

Discussion