Create an Atlas Search Index¶
The fts
resource allows you to retrieve and edit Atlas Search
analyzers and index configurations for the specified cluster.
The Atlas API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.
To learn how to configure API access for an Atlas project, see Configure Atlas API Access.
Groups and projects are synonymous terms. Your {GROUP-ID}
is the
same as your project ID. For existing groups, your group/project ID
remains the same. The resource and corresponding endpoints use the
term groups
.
For more information about Atlas Search indexes, see Atlas Search and Index Definitions.
Required Roles¶
You must have the:
Project Data Access Read Only
or higher role to view Atlas Search analyzers and indexes using the Atlas UI or API.Project Data Access Admin
or higher role to create and manage Atlas Search analyzers and indexes using the Atlas UI or API.
Resource¶
Base URL: https://cloud.mongodb.com/api/atlas/v1.0
POST /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/fts/indexes
You cannot create an Atlas Search index on any collection in the admin
,
local
, or config
databases in any cluster.
Request Parameters¶
Request Path Parameters¶
Path Element | Type | Necessity | Description |
---|---|---|---|
GROUP-ID | string | Required | Unique identifier for the project that
contains the specified cluster. |
CLUSTER-NAME | string | Required | Name of the cluster that contains the collection on which you
want to create an Atlas Search index. |
Request Query Parameters¶
This endpoint may use any of the HTTP request query parameters available to all Atlas API resources. These are all optional.
Name | Type | Necessity | Description | Default |
---|---|---|---|---|
pageNum | integer | Optional | Page number, starting with one, that Atlas returns of the
total number of objects. | 1 |
itemsPerPage | integer | Optional | Number of items that Atlas returns per page, up to a maximum
of 500. | 100 |
includeCount | boolean | Optional | Flag that indicates whether Atlas returns the totalCount
parameter in the response body. | true |
pretty | boolean | Optional | Flag that indicates whether Atlas returns the JSON
response in the
prettyprint format. | false |
envelope | boolean | Optional | Flag that indicates whether Atlas wraps the response in an envelope. Some API clients cannot access the HTTP response headers or
status code. To remediate this, set Endpoints that return a list of results use the results object as an envelope. Atlas adds the status parameter to the response body. | false |
Request Body Parameters¶
Name | Type | Necessity | Description |
---|---|---|---|
analyzer | string | Optional | analyzer to use when creating the
index. Defaults to lucene.standard. |
collectionName | string | Required | Name of the collection the index is on. |
database | string | Required | Name of the database the collection is in. |
mappings | object | Required | Object containing index specifications for the collection
fields. |
mappings .dynamic | boolean | Conditional | Required if Indicates whether the index uses dynamic or static mappings. For
dynamic mapping, set the value to |
mappings .fields | object | Conditional | Required if Object containing one or more field specifications. |
name | string | Required | Name of the index. |
searchAnalyzer | string | Optional | analyzer to use when searching the
index. Defaults to lucene.standard. |
Response Elements¶
The HTTP response returns a JSON document with an index definition for the newly created index. An index definition contains the following elements:
Name | Type | Description |
---|---|---|
analyzer | Optional | Analyzer to use when creating the
index. |
collectionName | string | Name of the collection the index is on. |
database | string | Name of the database the collection is in. |
indexID | string | Unique identifier for the index. |
mappings | object | Object containing index specifications for the collection
fields. |
mappings .dynamic | boolean | Flag indicating whether the index uses dynamic or static
mappings. |
mappings .fields | object | Object containing one or more field specifications. |
name | string | Name of the index. |
searchAnalyzer | string | Analyzer to use when searching the
index. |
status | string | Status of the index. Value can be one of the following statuses:
|
Example Request¶
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Content-Type: application/json" \ 3 --include \ 4 --request POST "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/fts/indexes?pretty=true" \ 5 --data '{ 6 "collectionName": "orders", 7 "database": "fiscalYear2018", 8 "mappings": { 9 "dynamic": true 10 }, 11 "name": "default" 12 }'
Example Response¶
Response Header¶
401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes}
Response Body¶
The following example response contains an index definition for an
index named default
. This is the default definition with
dynamic mappings for all fields in
the collection.
1 { 2 "collectionName" : "orders", 3 "database" : "fiscalYear2018", 4 "indexID" : "5d12990380eef5303341accd", 5 "mappings" : { 6 "dynamic" : true 7 }, 8 "name" : "default" 9 }