2026-09-01
▼ ▲ firestore.projects.databases.collectionGroups.indexes.delete
HTTP Method : DELETE
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/databases/[^/]+/collectionGroups/[^/]+/indexes/[^/]+$
Location : path
Type : string
Description : A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
Description : Deletes a composite index.
Scopes :
Path : v1beta2/{+name}
Flat Path : v1beta2/projects/{projectsId}/databases/{databasesId}/collectionGroups/{collectionGroupsId}/indexes/{indexesId}
Parameter Order : name
▼ ▲ firestore.projects.databases.collectionGroups.indexes.create
Parameter Order : parent
Description : Creates 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 will be the type IndexOperationMetadata.
HTTP Method : POST
Scopes :
Flat Path : v1beta2/projects/{projectsId}/databases/{databasesId}/collectionGroups/{collectionGroupsId}/indexes
Path : v1beta2/{+parent}/indexes
Parameters :
parent
Required : Yes
Location : path
Pattern : ^projects/[^/]+/databases/[^/]+/collectionGroups/[^/]+$
Description : A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
Type : string
▼ ▲ firestore.projects.databases.collectionGroups.indexes.get
Scopes :
Parameters :
name
Description : A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
Type : string
Pattern : ^projects/[^/]+/databases/[^/]+/collectionGroups/[^/]+/indexes/[^/]+$
Required : Yes
Location : path
Parameter Order : name
HTTP Method : GET
Description : Gets a composite index.
Flat Path : v1beta2/projects/{projectsId}/databases/{databasesId}/collectionGroups/{collectionGroupsId}/indexes/{indexesId}
Path : v1beta2/{+name}
▼ ▲ firestore.projects.databases.collectionGroups.indexes.list
Parameters :
parent
Location : path
Pattern : ^projects/[^/]+/databases/[^/]+/collectionGroups/[^/]+$
Type : string
Description : A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
Required : Yes
filter
Location : query
Description : The filter to apply to list results.
Type : string
pageSize
Type : integer
Format : int32
Location : query
Description : The number of results to return.
pageToken
Type : string
Description : A page token, returned from a previous call to FirestoreAdmin.ListIndexes, that may be used to get the next page of results.
Location : query
HTTP Method : GET
Parameter Order : parent
Path : v1beta2/{+parent}/indexes
Flat Path : v1beta2/projects/{projectsId}/databases/{databasesId}/collectionGroups/{collectionGroupsId}/indexes
Description : Lists composite indexes.
Scopes :
▼ ▲ firestore.projects.databases.collectionGroups.fields.get
HTTP Method : GET
Path : v1beta2/{+name}
Parameter Order : name
Parameters :
name
Pattern : ^projects/[^/]+/databases/[^/]+/collectionGroups/[^/]+/fields/[^/]+$
Description : A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}`
Type : string
Required : Yes
Location : path
Description : Gets the metadata and configuration for a Field.
Scopes :
Flat Path : v1beta2/projects/{projectsId}/databases/{databasesId}/collectionGroups/{collectionGroupsId}/fields/{fieldsId}
▼ ▲ firestore.projects.databases.collectionGroups.fields.list
Parameters :
pageSize
Type : integer
Description : The number of results to return.
Location : query
Format : int32
pageToken
Type : string
Location : query
Description : A page token, returned from a previous call to FirestoreAdmin.ListFields, that may be used to get the next page of results.
parent
Pattern : ^projects/[^/]+/databases/[^/]+/collectionGroups/[^/]+$
Description : A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
Type : string
Required : Yes
Location : path
filter
Type : string
Location : query
Description : The filter to apply to list results. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false`.
Flat Path : v1beta2/projects/{projectsId}/databases/{databasesId}/collectionGroups/{collectionGroupsId}/fields
Path : v1beta2/{+parent}/fields
Parameter Order : parent
HTTP Method : GET
Description : Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false`.
Scopes :
▼ ▲ firestore.projects.databases.collectionGroups.fields.patch
Scopes :
Parameter Order : name
Parameters :
updateMask
Location : query
Type : string
Format : google-fieldmask
Description : A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field.
name
Pattern : ^projects/[^/]+/databases/[^/]+/collectionGroups/[^/]+/fields/[^/]+$
Description : A field name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path may be a simple field name, e.g. `address` or a path to fields within map_value , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths may be quoted using ` (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block) `\`address.city\`` represents a field named `address.city`, not the map key `city` in the field `address`. `\`*\`` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration.
Type : string
Location : path
Required : Yes
HTTP Method : PATCH
Path : v1beta2/{+name}
Description : Updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to FirestoreAdmin.UpdateField should provide a field mask to avoid changing any configuration that the caller isn't aware of. The field mask should be specified as: `{ paths: "index_config" }`. This call returns a google.longrunning.Operation which may be used to track the status of the field update. The metadata for the operation will be the type FieldOperationMetadata. To configure the default field settings for the database, use the special `Field` with resource name: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`.
Flat Path : v1beta2/projects/{projectsId}/databases/{databasesId}/collectionGroups/{collectionGroupsId}/fields/{fieldsId}
▼ ▲ firestore.projects.databases.importDocuments
Path : v1beta2/{+name}:importDocuments
Flat Path : v1beta2/projects/{projectsId}/databases/{databasesId}:importDocuments
Scopes :
Parameter Order : name
HTTP Method : POST
Description : Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.
Parameters :
name
Description : Database to import into. Should be of the form: `projects/{project_id}/databases/{database_id}`.
Location : path
Pattern : ^projects/[^/]+/databases/[^/]+$
Required : Yes
Type : string
▼ ▲ firestore.projects.databases.exportDocuments
HTTP Method : POST
Parameter Order : name
Parameters :
name
Pattern : ^projects/[^/]+/databases/[^/]+$
Location : path
Type : string
Required : Yes
Description : Database to export. Should be of the form: `projects/{project_id}/databases/{database_id}`.
Path : v1beta2/{+name}:exportDocuments
Flat Path : v1beta2/projects/{projectsId}/databases/{databasesId}:exportDocuments
Description : Exports 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 documents may 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.
Scopes :