Method: projects.databases.collectionGroups.indexes.get
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://firestore.googleapis.com/v1/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. A name of the form projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/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/datastorehttps://www.googleapis.com/auth/cloud-platform
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-21 UTC.
[null,null,["Last updated 2025-01-21 UTC."],[],[],null,["Gets a composite index.\n\nHTTP request\n\n`GET https://firestore.googleapis.com/v1/{name=projects/*/databases/*/collectionGroups/*/indexes/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nPath parameters\n\nRequest body\n\nThe request body must be empty.\n\nResponse body\n\nIf successful, the response body contains an instance of [Index](/docs/firestore/reference/rest/Shared.Types/FieldOperationMetadata#Index).\n\nAuthorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/datastore`\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]
