# Google Cloud Firestore Cloud Firestore Projects API

**Canonical:** https://apis.io/apis/google-cloud-firestore/google-cloud-firestore-projects-api/  
**Provider:** Google Cloud Firestore — https://apis.io/providers/google-cloud-firestore/  
**Base URL:** https://firestore.googleapis.com  
**Documentation:** https://cloud.google.com/firestore/docs

Google Cloud Firestore Cloud Firestore Projects API is published by [Google Cloud Firestore](https://apis.io/providers/google-cloud-firestore/) on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Cloud Firestore Projects. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, and 6 JSON Schemas.

The Cloud Firestore Projects API from Google Cloud Firestore — 42 operation(s) for cloud firestore projects.

## Operations (60)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/projects/{projectsId}/locations` | List locations |
| GET | `/v1/projects/{projectsId}/locations/{locationsId}` | Get locations |
| GET | `/v1/projects/{projectsId}/locations/{locationsId}/backups` | List backups |
| DELETE | `/v1/projects/{projectsId}/locations/{locationsId}/backups/{backupsId}` | Delete backups |
| GET | `/v1/projects/{projectsId}/locations/{locationsId}/backups/{backupsId}` | Get backups |
| GET | `/v1/projects/{projectsId}/databases/{databasesId}` | Get databases |
| DELETE | `/v1/projects/{projectsId}/databases/{databasesId}` | Delete databases |
| PATCH | `/v1/projects/{projectsId}/databases/{databasesId}` | Patch databases |
| POST | `/v1/projects/{projectsId}/databases/{databasesId}:importDocuments` | Import documents databases |
| POST | `/v1/projects/{projectsId}/databases:clone` | Clone databases |
| POST | `/v1/projects/{projectsId}/databases` | Create databases |
| GET | `/v1/projects/{projectsId}/databases` | List databases |
| POST | `/v1/projects/{projectsId}/databases:restore` | Restore databases |
| POST | `/v1/projects/{projectsId}/databases/{databasesId}:exportDocuments` | Export documents databases |
| POST | `/v1/projects/{projectsId}/databases/{databasesId}:bulkDeleteDocuments` | Bulk delete documents databases |
| GET | `/v1/projects/{projectsId}/databases/{databasesId}/changeStreams` | List changeStreams |
| POST | `/v1/projects/{projectsId}/databases/{databasesId}/changeStreams` | Create changeStreams |
| DELETE | `/v1/projects/{projectsId}/databases/{databasesId}/changeStreams/{changeStreamsId}` | Delete changeStreams |
| GET | `/v1/projects/{projectsId}/databases/{databasesId}/changeStreams/{changeStreamsId}` | Get changeStreams |
| DELETE | `/v1/projects/{projectsId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}` | Delete backupSchedules |
| PATCH | `/v1/projects/{projectsId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}` | Patch backupSchedules |
| GET | `/v1/projects/{projectsId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}` | Get backupSchedules |
| POST | `/v1/projects/{projectsId}/databases/{databasesId}/backupSchedules` | Create backupSchedules |
| GET | `/v1/projects/{projectsId}/databases/{databasesId}/backupSchedules` | List backupSchedules |
| DELETE | `/v1/projects/{projectsId}/databases/{databasesId}/userCreds/{userCredsId}` | Delete userCreds |
| GET | `/v1/projects/{projectsId}/databases/{databasesId}/userCreds/{userCredsId}` | Get userCreds |
| POST | `/v1/projects/{projectsId}/databases/{databasesId}/userCreds/{userCredsId}:resetPassword` | Reset password userCreds |
| POST | `/v1/projects/{projectsId}/databases/{databasesId}/userCreds/{userCredsId}:enable` | Enable userCreds |
| POST | `/v1/projects/{projectsId}/databases/{databasesId}/userCreds/{userCredsId}:disable` | Disable userCreds |
| POST | `/v1/projects/{projectsId}/databases/{databasesId}/userCreds` | Create userCreds |
| GET | `/v1/projects/{projectsId}/databases/{databasesId}/userCreds` | List userCreds |
| GET | `/v1/projects/{projectsId}/databases/{databasesId}/documents/{collectionId}` | List documents documents |
| POST | `/v1/projects/{projectsId}/databases/{databasesId}/documents:rollback` | Rollback documents |
| POST | `/v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:partitionQuery` | Partition query documents |
| POST | `/v1/projects/{projectsId}/databases/{databasesId}/documents:batchWrite` | Batch write documents |
| POST | `/v1/projects/{projectsId}/databases/{databasesId}/documents:batchGet` | Batch get documents |
| POST | `/v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:runAggregationQuery` | Run aggregation query documents |
| POST | `/v1/projects/{projectsId}/databases/{databasesId}/documents:commit` | Commit documents |
| POST | `/v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:listCollectionIds` | List collection ids documents |
| PATCH | `/v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}` | Patch documents |
| POST | `/v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}` | Create document documents |
| DELETE | `/v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}` | Delete documents |
| GET | `/v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}` | Get documents |
| POST | `/v1/projects/{projectsId}/databases/{databasesId}/documents:beginTransaction` | Begin transaction documents |
| POST | `/v1/projects/{projectsId}/databases/{databasesId}/documents:listen` | Listen documents |
| POST | `/v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:runQuery` | Run query documents |
| POST | `/v1/projects/{projectsId}/databases/{databasesId}/documents:write` | Write documents |
| POST | `/v1/projects/{projectsId}/databases/{databasesId}/documents:executePipeline` | Execute pipeline documents |
| GET | `/v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}/{collectionId}` | List documents |
| GET | `/v1/projects/{projectsId}/databases/{databasesId}/collectionGroups/{collectionGroupsId}/fields/{fieldsId}` | Get fields |
| PATCH | `/v1/projects/{projectsId}/databases/{databasesId}/collectionGroups/{collectionGroupsId}/fields/{fieldsId}` | Patch fields |
| GET | `/v1/projects/{projectsId}/databases/{databasesId}/collectionGroups/{collectionGroupsId}/fields` | List fields |
| GET | `/v1/projects/{projectsId}/databases/{databasesId}/collectionGroups/{collectionGroupsId}/indexes` | List indexes |
| POST | `/v1/projects/{projectsId}/databases/{databasesId}/collectionGroups/{collectionGroupsId}/indexes` | Create indexes |
| GET | `/v1/projects/{projectsId}/databases/{databasesId}/collectionGroups/{collectionGroupsId}/indexes/{indexesId}` | Get indexes |
| DELETE | `/v1/projects/{projectsId}/databases/{databasesId}/collectionGroups/{collectionGroupsId}/indexes/{indexesId}` | Delete indexes |
| DELETE | `/v1/projects/{projectsId}/databases/{databasesId}/operations/{operationsId}` | Delete operations |
| GET | `/v1/projects/{projectsId}/databases/{databasesId}/operations/{operationsId}` | Get operations |
| GET | `/v1/projects/{projectsId}/databases/{databasesId}/operations` | List operations |
| POST | `/v1/projects/{projectsId}/databases/{databasesId}/operations/{operationsId}:cancel` | Cancel operations |

## Machine-readable artifacts (11)

- **OpenAPI** — https://artifacts.apis.io/google-cloud-firestore/openapi/google-cloud-firestore-projects-api-openapi.yml
- **Documentation** — https://cloud.google.com/firestore/docs/reference/rest
- **Authentication** — https://cloud.google.com/firestore/docs/authentication
- **GettingStarted** — https://cloud.google.com/firestore/docs/quickstart
- **JSONSchema** — https://artifacts.apis.io/google-cloud-firestore/json-schema/google-cloud-firestore-google-firestore-admin-v1-database-schema.json
- **JSONSchema** — https://artifacts.apis.io/google-cloud-firestore/json-schema/google-cloud-firestore-google-firestore-admin-v1-index-schema.json
- **JSONSchema** — https://artifacts.apis.io/google-cloud-firestore/json-schema/google-cloud-firestore-partition-query-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/google-cloud-firestore/json-schema/google-cloud-firestore-document-schema.json
- **JSONSchema** — https://artifacts.apis.io/google-cloud-firestore/json-schema/google-cloud-firestore-google-firestore-admin-v1-field-schema.json
- **JSONSchema** — https://artifacts.apis.io/google-cloud-firestore/json-schema/google-cloud-firestore-execute-pipeline-response-schema.json
- **APIsJSON** — https://artifacts.apis.io/google-cloud-firestore/apis.yml

## Tags

Cloud Firestore Projects

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/google-cloud-firestore/google-cloud-firestore-projects-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/google-cloud-firestore/.