MongoDBMongoDB Atlas Administration API v2
PATCH/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}
Manage update Group Cluster Search Index By Name.
Contract-preserving PATCH endpoint for update Group Cluster Search Index By Name in the MongoDB Atlas Administration API. Resource-specific values are supplied by the caller at runtime.
All 540 MongoDB Atlas administration endpoints from a fixed Apache-2.0 OpenAPI revision. Hub provides documentation and an independent SDK/CLI, but never proxies account, organization, project, network, backup, or operational data; callers connect directly with local credentials.
Request
- operationId
updateGroupClusterSearchIndexByName- Server
https://cloud.mongodb.com- Authentication
- ServiceAccounts, DigestAuth
Request parameters
envelope
queryboolean
envelope value in the Atlas Administration API contract.
groupId
pathstringrequired
group Id value in the Atlas Administration API contract.
32b6e34b3d91647abb20e7b8
pretty
queryboolean
pretty value in the Atlas Administration API contract.
clusterName
pathstringrequired
cluster Name value in the Atlas Administration API contract.
collectionName
pathstringrequired
collection Name value in the Atlas Administration API contract.
databaseName
pathstringrequired
database Name value in the Atlas Administration API contract.
indexName
pathstringrequired
index Name value in the Atlas Administration API contract.
Request body
SearchIndexUpdateRequestrequired
Content-Type: application/vnd.atlas.2024-05-30+json
Properties: definition
Responses
200
SearchIndexResponseapplication/vnd.atlas.2024-05-30+json
Successful supplier response.
Properties: collectionNamedatabaseindexIDlatestDefinitionlatestDefinitionVersionnamequeryablestatusstatusDetailtype
400
ApiErrorapplication/json
Supplier response with HTTP status 400.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
401
ApiErrorapplication/json
Supplier response with HTTP status 401.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
403
ApiErrorapplication/json
Supplier response with HTTP status 403.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
404
ApiErrorapplication/json
Supplier response with HTTP status 404.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
409
ApiErrorapplication/json
Supplier response with HTTP status 409.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
429
ApiErrorapplication/json
Supplier response with HTTP status 429.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
500
ApiErrorapplication/json
Supplier response with HTTP status 500.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
{
"indexID": "32b6e34b3d91647abb20e7b8",
"latestDefinition": {
"numPartitions": 1,
"storedSource": {
"include | exclude": [
"field1",
"field2"
]
}
},
"latestDefinitionVersion": {
"version": 0
},
"queryable": false,
"status": "DELETING"
}