API Reference

Use the export method to download a backup files as a compressed ZIP archive.

try {
  const id = "user_id_here"; // The ID of the user for whom the backup is being downloaded.

  const [data, error] = await sdk.export({ id });

  // Check for success
  if (error) {
    console.error("Failed to download backup file:", error);
  } else {
    console.log("Backup downloaded successfully.");
  }
} catch (error) {
  console.error(
    "An unexpected error occurred while downloading the backup:",
    error.message
  );
}

Params

  • userId (string)

Required API Key Permission

  • ADMIN