Cloud Firestore API
Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development.
Data & analytics#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development.
Endpoints 40
projects.databases
- POSTBulk deletes a subset of documents from Google Cloud Firestore
/v1/:name:bulkDeleteDocumentsBulk deletes a subset of documents from Google Cloud Firestore. Documents created or updated after the underlying system starts to process the request will… - POSTCreates a new database by cloning an existing one
/v1/:parent/databases:cloneCreates a new database by cloning an existing one. The new database must be in the same cloud region or multi-region location as the existing database. This… - GETList all the databases in the project.
/v1/:parent/databases?showDeleted=trueList all the databases in the project. - POSTCreate a database.
/v1/:parent/databases?databaseId=stringCreate a database. - POSTExports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google…
/v1/:name:exportDocumentsExports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to… - POSTImports documents into Google Cloud Firestore
/v1/:name:importDocumentsImports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can… - POSTCreates a new database by restoring from an existing backup
/v1/:parent/databases:restoreCreates a new database by restoring from an existing backup. The new database must be in the same cloud region or multi-region location as the existing…
projects.locations.backups
- GETGets information about a backup.
/v1/:nameGets information about a backup. - DELETEDeletes a backup.
/v1/:nameDeletes a backup. - GETLists all the backups.
/v1/:parent/backups?filter=stringLists all the backups.
projects.databases.documents
- PATCHUpdates or inserts a document.
/v1/:name?currentDocument.exists=true¤tDocument.updateTime=string&mask.fieldPaths=string&requestOptions.requestTags=string&updateMask.fieldPaths=stringUpdates or inserts a document. - POSTGets multiple documents
/v1/:database/documents:batchGetGets multiple documents. Documents returned by this method are not guaranteed to be returned in the same order that they were requested. - POSTApplies a batch of write operations
/v1/:database/documents:batchWriteApplies a batch of write operations. The BatchWrite method does not apply the write operations atomically and can apply them out of order. Method does not… - POSTStarts a new transaction.
/v1/:database/documents:beginTransactionStarts a new transaction. - POSTCommits a transaction, while optionally updating documents.
/v1/:database/documents:commitCommits a transaction, while optionally updating documents. - GETLists documents.
/v1/:parent/:collectionId?mask.fieldPaths=string&orderBy=string&pageSize=0&pageToken=string&readTime=string&recursive=true&requestOptions.requestTags=string&showMissing=true&transaction=stringLists documents. - POSTCreates a new document.
/v1/:parent/:collectionId?documentId=string&mask.fieldPaths=string&requestOptions.requestTags=stringCreates a new document. - POSTExecutes a pipeline query.
/v1/:database/documents:executePipelineExecutes a pipeline query. - POSTLists all the collection IDs underneath a document.
/v1/:parent:listCollectionIdsLists all the collection IDs underneath a document. - POSTListens to changes
/v1/:database/documents:listenListens to changes. This method is only available via gRPC or WebChannel (not REST). - POSTPartitions a query by returning partition cursors that can be used to run the query in parallel
/v1/:parent:partitionQueryPartitions a query by returning partition cursors that can be used to run the query in parallel. The returned partition cursors are split points that can be… - POSTRolls back a transaction.
/v1/:database/documents:rollbackRolls back a transaction. - POSTRuns an aggregation query
/v1/:parent:runAggregationQueryRuns an aggregation query. Rather than producing Document results like Firestore.RunQuery, this API allows running an aggregation to produce a series of… - POSTRuns a query.
/v1/:parent:runQueryRuns a query. - POSTStreams batches of document updates and deletes, in order
/v1/:database/documents:writeStreams batches of document updates and deletes, in order. This method is only available via gRPC or WebChannel (not REST).
projects.databases.backupSchedules
- GETList backup schedules.
/v1/:parent/backupSchedulesList backup schedules. - POSTCreates a backup schedule on a database
/v1/:parent/backupSchedulesCreates a backup schedule on a database. At most two backup schedules can be configured on a database, one daily backup schedule and one weekly backup schedule.
projects.databases.changeStreams
- GETLists all change streams in a database.
/v1/:parent/changeStreamsLists all change streams in a database. - POSTCreates a new change stream for the database.
/v1/:parent/changeStreams?changeStreamId=stringCreates a new change stream for the database.
projects.databases.collectionGroups.fields
- GETLists the field configuration and metadata for this database
/v1/:parent/fields?filter=string&pageSize=0&pageToken=stringLists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly…
projects.databases.collectionGroups.indexes
- GETLists composite indexes.
/v1/:parent/indexes?filter=string&pageSize=0&pageToken=stringLists composite indexes. - POSTCreates a composite index
/v1/:parent/indexesCreates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation…
projects.databases.operations
- POSTStarts asynchronous cancellation on a long-running operation
/v1/:name:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the… - GETLists operations that match the specified filter in the request
/v1/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
projects.databases.userCreds
- GETList all user creds in the database
/v1/:parent/userCredsList all user creds in the database. Note that the returned resource does not contain the secret value itself. - POSTCreate a user creds.
/v1/:parent/userCreds?userCredsId=stringCreate a user creds. - POSTDisables a user creds
/v1/:name:disableDisables a user creds. No-op if the user creds are already disabled. - POSTEnables a user creds
/v1/:name:enableEnables a user creds. No-op if the user creds are already enabled. - POSTResets the password of a user creds.
/v1/:name:resetPasswordResets the password of a user creds.
projects.locations
- GETLists information about the supported locations for this service
/v1/:name/locations?extraLocationTypes=string&filter=string&pageSize=0&pageToken=stringLists information about the supported locations for this service. This method lists locations based on the resource scope provided in the…
API details
- Base URL
https://firestore.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 2 scopes
An API key in the key query parameter - Operations
- 40 operations on 32 pathsPOST 27GET 11PATCH 1DELETE 1
- Main resources
- projects.databases.documents 15projects.databases 7projects.databases.userCreds 5projects.locations.backups 3projects.databases.backupSchedules 2projects.databases.changeStreams 2projects.databases.collectionGroups.indexes 2projects.databases.operations 2projects.databases.collectionGroups.fields 1projects.locations 1
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Cloud Firestore API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Cloud Firestore API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Bulk deletes a subset of documents from Google Cloud Firestore” (POST /v1/:name:bulkDeleteDocuments), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Cloud Firestore API?
Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development. It is listed under Data & analytics and has 40 endpoints.
Who publishes the Cloud Firestore API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Cloud Firestore API?
Requests go to https://firestore.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Cloud Firestore API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 2 scopes; an API key in the key query parameter.
How many endpoints does the Cloud Firestore API have?
40 operations on 32 paths (27 POST, 11 GET, 1 PATCH, 1 DELETE). The largest groups are projects.databases.documents, projects.databases, projects.databases.userCreds, projects.locations.backups.
Is forking the Cloud Firestore API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.