Method: projects.databases.collectionGroups.indexes.create
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
POST https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/collectionGroups/*}/indexes
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. A parent name of the form projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}
|
Request body
The request body contains an instance of Index.
Response body
If successful, the response body contains a newly created instance of Operation.
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,["# Method: projects.databases.collectionGroups.indexes.create\n\nCreates a composite index. This returns a [google.longrunning.Operation](/docs/firestore/reference/rest/Shared.Types/Operation) which may be used to track the status of the creation. The metadata for the operation will be the type [IndexOperationMetadata](/docs/firestore/reference/rest/Shared.Types/IndexOperationMetadata).\n\n### HTTP request\n\n`POST https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/collectionGroups/*}/indexes`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. A parent name of the form `projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}` |\n\n### Request body\n\nThe request body contains an instance of [Index](/docs/firestore/reference/rest/Shared.Types/FieldOperationMetadata#Index).\n\n### Response body\n\nIf successful, the response body contains a newly created instance of [Operation](/docs/firestore/reference/rest/Shared.Types/Operation).\n\n### Authorization 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)."]]
