Method: projects.databases.indexes.get

Gets an index.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

The name of the index. For example: projects/{projectId}/databases/{databaseId}/indexes/{index_id}

Request body

The request body must be empty.

Response body

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

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.