MongoDB/getSystemStatus

Online calls unavailable · details below

MongoDBMongoDB Atlas Administration API v2

GET/api/atlas/v2

Read get System Status.

Contract-preserving GET endpoint for get System Status 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
getSystemStatus
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.

Responses

200

SystemStatusapplication/vnd.atlas.2023-01-01+json

Successful supplier response.

Properties: apiKeyappNamebuildlinksthrottling

401

ApiErrorapplication/json

Supplier response with HTTP status 401.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

403

ApiErrorapplication/json

Supplier response with HTTP status 403.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

429

ApiErrorapplication/json

Supplier response with HTTP status 429.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

500

ApiErrorapplication/json

Supplier response with HTTP status 500.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

{
  "apiKey": {
    "accessList": {},
    "id": "32b6e34b3d91647abb20e7b8",
    "roles": {
      "groupId": "32b6e34b3d91647abb20e7b8",
      "orgId": "32b6e34b3d91647abb20e7b8"
    }
  },
  "appName": "MongoDB Atlas",
  "build": "83be55e140f493c88e7f578aae96548dd881587b",
  "links": {
    "href": "https://cloud.mongodb.com/api/atlas",
    "rel": "self"
  },
  "throttling": false
}