MongoDBMongoDB Atlas Administration API v2
PATCH/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}/failoverConnections/{failoverConnectionId}
Manage update Group Stream Connection Failover Connection.
Contract-preserving PATCH endpoint for update Group Stream Connection Failover Connection 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
updateGroupStreamConnectionFailoverConnection- Server
https://cloud.mongodb.com- Authentication
- ServiceAccounts, DigestAuth
Request parameters
envelope
queryboolean
envelope value in the Atlas Administration API contract.
pretty
queryboolean
pretty value in the Atlas Administration API contract.
groupId
pathstringrequired
group Id value in the Atlas Administration API contract.
32b6e34b3d91647abb20e7b8
tenantName
pathstringrequired
tenant Name value in the Atlas Administration API contract.
connectionName
pathstringrequired
connection Name value in the Atlas Administration API contract.
failoverConnectionId
pathstringrequired
failover Connection Id value in the Atlas Administration API contract.
Request body
StreamsFailoverConnectionrequired
Content-Type: application/vnd.atlas.2025-03-12+json
Properties: idlinksnameregionstatetype
Responses
200
StreamsFailoverConnectionapplication/vnd.atlas.2025-03-12+json
Successful supplier response.
Properties: idlinksnameregionstatetype
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
429
ApiErrorapplication/json
Supplier response with HTTP status 429.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
500
ApiErrorapplication/json
Supplier response with HTTP status 500.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
{
"links": {
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
},
"state": "PENDING",
"type": "Kafka"
}