Method: projects.databases.exportDocuments

Exports a copy of all or a subset of documents from Google Cloud Firestore to Google Cloud Storage. Updates made between export start time and export completion time might not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage.

HTTP request

POST https://firestore.googleapis.com/v1beta1/{name=projects/*/databases/*}:exportDocuments

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
name

string

Database to export. Should be of the form: projects/{projectId}/databases/{databaseId}.

Request body

The request body contains data with the following structure:

JSON representation
{
  "collectionIds": [
    string
  ],
  "outputUriPrefix": string
}
Fields
collectionIds[]

string

Which collection ids to export. Unspecified means all collections.

outputUriPrefix

string

The output URI. Currently only supports Google Cloud Storage URIs of the form: gs://BUCKET_NAME[/NAMESPACE_PATH], where BUCKET_NAME is the name of the Google Cloud Storage bucket and NAMESPACE_PATH is an optional Google Cloud Storage namespace path. When choosing a name, be sure to consider Google Cloud Storage naming guidelines: https://cloud.google.com/storage/docs/naming. If the URI is a bucket (without a namespace path), a prefix will be generated based on the start time.

Response body

If successful, the response body contains an instance of Operation.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Firestore