Method: projects.databases.indexes.list

Stay organized with collections Save and categorize content based on your preferences.

Lists the indexes that match the specified filters.

HTTP request

GET https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*}/indexes

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

The database name. For example: projects/{projectId}/databases/{databaseId}

Query parameters

Parameters
filter

string
pageSize

integer

The standard List page size.
pageToken

string

The standard List page token.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

The response for FirestoreAdmin.ListIndexes.

JSON representation 
{
  "indexes": [
    {
      object (Index)
    }
  ],
  "nextPageToken": string
}
Fields
indexes[]

object (Index)

The indexes.
nextPageToken

string

The standard List next-page token.

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 Authentication Overview.