atlas api atlasSearch createAtlasSearchIndex
On this page
experimental: Creates one Atlas Search index on the specified collection.
Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'createAtlasSearchIndex'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndex
Syntax
atlas api atlasSearch createAtlasSearchIndex [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--clusterName | string | true | name of the cluster that contains the collection on which to create an Atlas Search index |
--envelope | false | flag that indicates whether Application wraps the response in an envelope JSON object | |
--file | string | false | path to the file which contains the api request contents |
--groupId | string | true | unique 24-hexadecimal digit string that identifies your project |
-h, --help | false | help for createAtlasSearchIndex | |
--output | string | false | preferred api format, can be ["json", go-template] This value defaults to "json". |
--output-file | string | false | file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) |
--pretty | false | flag that indicates whether the response body should be in the prettyprint format | |
--version | string | false | api version to use when calling the api call [options: "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30". |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |