How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
MongoDB

MongoDB Atlas Search API

Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. Also returns and updates user-defined analyzers for the specified cluster.

Documentation Provider Profile APIs.io OpenAPI GitHub

MongoDB Atlas Search API is one of 53 APIs that MongoDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Atlas Search. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, and a changelog.

This API exposes 18 operations across 8 paths, and defines 24 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://cloud.mongodb.com.

18 operations 8 paths 24 schemas 4 DELETE7 GET4 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://cloud.mongodb.com/api/atlas/v2
Authentication
HTTP Digest, OAuth 2.0
License
CC BY-NC-SA 3.0 US
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

MongoDB Atlas Search API declares 2 security schemes for authenticating requests. It uses HTTP digest authentication (DigestAuth). It supports OAuth 2.0 (ServiceAccounts) using the clientCredentials flow. By default, every request must be authenticated.

  • ServiceAccounts — Learn more about [Service Accounts](https://www.mongodb.com/docs/atlas/api/service-accounts-overview).

Paths & Operations 18

Across 8 paths, the API surfaces 18 operations — 4 DELETE, 7 GET, 4 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Atlas Search 18

Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. Also returns and updates user-defined analyzers for the specified cluster.

POST
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexesdeprecated
Create One Atlas Search Index
createGroupClusterFtsIndex 4 params body → 200400401403404409429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}deprecated
Return All Atlas Search Indexes for One Collection
listGroupClusterFtsIndex 6 params → 200401403404429500
DELETE
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}deprecated
Remove One Atlas Search Index
deleteGroupClusterFtsIndex 5 params → 204400401403404429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}deprecated
Return One Atlas Search Index
getGroupClusterFtsIndex 5 params → 200401403404429500
PATCH
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}deprecated
Update One Atlas Search Index
updateGroupClusterFtsIndex 5 params body → 200400401403404409429500
DELETE
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment
Delete Search Nodes
deleteGroupClusterSearchDeployment 4 params → 204400401403404409429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment
Return All Search Nodes
getGroupClusterSearchDeployment 4 params → 200400401403404429500
PATCH
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment
Update Search Nodes
updateGroupClusterSearchDeployment 4 params body → 200400401403404409429500
POST
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment
Create Search Nodes
createGroupClusterSearchDeployment 4 params body → 201400401403404409429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes
Return All Atlas Search Indexes for One Cluster
listGroupClusterSearchIndexes 4 params → 200400401403404429500503
POST
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes
Create One Atlas Search Index
createGroupClusterSearchIndex 4 params body → 201400401403404409429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}
Return All Atlas Search Indexes for One Collection
listGroupClusterSearchIndex 6 params → 200400401403404429500503
DELETE
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}
Remove One Atlas Search Index by Name
deleteGroupClusterSearchIndexByName 7 params → 204400401403404429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}
Return One Atlas Search Index by Name
getGroupClusterSearchIndexByName 7 params → 200400401403404429500
PATCH
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}
Update One Atlas Search Index by Name
updateGroupClusterSearchIndexByName 7 params body → 200400401403404409429500
DELETE
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}
Remove One Atlas Search Index by ID
deleteGroupClusterSearchIndex 5 params → 204400401403404429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}
Return One Atlas Search Index by ID
getGroupClusterSearchIndex 5 params → 200400401403404429500503
PATCH
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}
Update One Atlas Search Index by ID
updateGroupClusterSearchIndex 5 params body → 200400401403404409429500

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are SearchIndexResponse (10 properties), TextSearchIndexDefinition (9 properties), ClusterSearchIndex (8 properties), ApiError (6 properties). Each schema is shown below with its type and property counts.

BasicDBObject
object
ApiError
object
6 properties 2 required
ApiSearchDeploymentSpecView
object
2 properties 2 required
ApiSearchDeploymentRequestView
object
1 property 1 required
SearchHostStatusDetail
object
5 properties
SearchIndexDefinitionVersion
object
Object which includes the version number of the index definition and the time that the index definition was created.
2 properties
FieldViolation
object
2 properties 2 required
SearchSynonymMappingDefinition
object
Synonyms used for this full text index.
3 properties 3 required
SearchIndexDefinition
object
The search index definition set by the user.
2 properties
VectorSearchIndexDefinition
object
The vector search index definition set by the user.
4 properties 1 required
SearchIndexCreateRequest
object
4 properties 3 required
SearchIndexResponse
object
10 properties
ApiSearchDeploymentResponseView
object
5 properties
TextSearchIndexDefinition
object
The text search index definition set by the user.
9 properties 1 required
SearchTypeSets
object
Type sets for an Atlas Search index definition.
2 properties 2 required
SearchIndexUpdateRequest
object
1 property 1 required
BadRequestDetail
object
Bad request detail.
1 property
SearchMainIndexStatusDetail
object
Contains status information about the active index.
5 properties
Fields
object
SearchMappings
object
Index specifications for the collection's fields.
2 properties
ClusterSearchIndex
object
8 properties 3 required
SearchStagedIndexStatusDetail
object
Contains status information about an index building in the background.
5 properties
SynonymSource
object
Data set that stores words and their applicable synonyms.
1 property 1 required
AtlasSearchAnalyzer
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mongodb-atlas-search-api-openapi.yml Raw ↑

Other APIs MongoDB publishes across the network.

MongoDB Atlas Data API
AE Profile APIs.io
MongoDB Atlas App Services Admin API
AE Profile APIs.io
MongoDB Access Tracking API
AE Profile APIs.io
MongoDB Activity Feed API
AE Profile APIs.io
MongoDB Alert Configurations API
AE Profile APIs.io
MongoDB Alerts API
AE Profile APIs.io
MongoDB Auditing API
AE Profile APIs.io
MongoDB AWS Clusters DNS API
AE Profile APIs.io
MongoDB Cloud Backups API
AE Profile APIs.io
MongoDB Cloud Migration Service API
AE Profile APIs.io
MongoDB Cloud Provider Access API
AE Profile APIs.io
MongoDB Cluster Outage Simulation API
AE Profile APIs.io
#Atlas Search
← Back to M APIs
API Details
ID
mongodb:mongodb-atlas-search-api
Base URL
https://cloud.mongodb.com/api/atlas/v2
Docs
https://www.mongodb.com/docs/atlas/api/
Provider
MongoDB
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=mongodb-atlas-search-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/mongodb-atlas-search-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of MongoDB Atlas Search API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.