Return the Status of This MongoDB Application

GET /api/atlas/v2

This resource returns information about the MongoDB application along with API key meta data.

Query parameters

envelope boolean

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Default value is false.
pretty boolean

Flag that indicates whether the response body should be in the prettyprint format.

Default value is false.

Prettyprint

Responses

200 application/vnd.atlas.2023-01-01+json

OK
Hide headers attributes Show headers attributes
- RateLimit-Limit
  
  The maximum number of requests that a user can make within a specific time window.
- RateLimit-Remaining
  
  The number of requests remaining in the current rate limit window before the limit is reached.
Hide response attributes Show response attributes object
- apiKey object | null Required
  
  Details contained in one API key.
  
  Hide apiKey attributes Show apiKey attributes object | null
  
  accessList array[object] Required
  
  List of network addresses granted access to this API using this API key.
  
  Hide accessList attributes Show accessList attributes object
  
  cidrBlock string | null
  
  Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that found in this project's access list.
  
  Format should match the following pattern: ^((([0-9]{1,3}\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$.
  
  ipAddress string | null Required
  
  IP address included in the API access list.
  
  Format should match the following pattern: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$.
  
  id string Required
  
  Unique 24-hexadecimal digit string that identifies this organization API key.
  
  Format should match the following pattern: ^([a-f0-9]{24})$.
  
  publicKey string Required
  
  Public API key value set for the specified organization API key.
  
  Minimum length is 8, maximum length is 8.
  
  roles array[object] Required
  
  List that contains roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the Cloud user.
  
  Hide roles attributes Show roles attributes object
  
  MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. Each role can apply to one organization or one project but not both.
  
  groupId string
  
  Unique 24-hexadecimal digit string that identifies the project to which this role belongs. You can set a value for this parameter or orgId but not both in the same request.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
  
  orgId string
  
  Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. You can set a value for this parameter or groupId but not both in the same request.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
  
  roleName string
  
  Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.
  
  MongoDB Cloud User Roles
- appName string Required
  
  Human-readable label that identifies the service from which you requested this response.
  
  Value is MongoDB Atlas.
- build string Required
  
  Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.
- links array[object]
  
  List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
  
  Web Linking Specification (RFC...
  
  Hide links attributes Show links attributes object
  
  href string
  
  Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
  
  rel string
  
  Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
- throttling boolean Required
  
  Flag that indicates whether someone enabled throttling on this service.
401 application/json

Unauthorized.
Hide response attributes Show response attributes object
- badRequestDetail object | null
  
  Bad request detail.
  
  Hide badRequestDetail attribute Show badRequestDetail attribute object | null
  
  fields array[object]
  
  Describes all violations in a client request.
  
  Hide fields attributes Show fields attributes object
  
  description string Required
  
  A description of why the request element is bad.
  
  field string Required
  
  A path that leads to a field in the request body.
- detail string | null
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32) Required
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string Required
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string | null
  
  Application error message returned with this error.
403 application/json

Forbidden.
Hide response attributes Show response attributes object
- badRequestDetail object | null
  
  Bad request detail.
  
  Hide badRequestDetail attribute Show badRequestDetail attribute object | null
  
  fields array[object]
  
  Describes all violations in a client request.
  
  Hide fields attributes Show fields attributes object
  
  description string Required
  
  A description of why the request element is bad.
  
  field string Required
  
  A path that leads to a field in the request body.
- detail string | null
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32) Required
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string Required
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string | null
  
  Application error message returned with this error.
429 application/json

Too Many Requests.
Hide headers attributes Show headers attributes
- RateLimit-Limit
  
  The maximum number of requests that a user can make within a specific time window.
- RateLimit-Remaining
  
  The number of requests remaining in the current rate limit window before the limit is reached.
- Retry-After
  
  The minimum time you should wait, in seconds, before retrying the API request. This header might be returned for 429 or 503 error responses.
Hide response attributes Show response attributes object
- badRequestDetail object | null
  
  Bad request detail.
  
  Hide badRequestDetail attribute Show badRequestDetail attribute object | null
  
  fields array[object]
  
  Describes all violations in a client request.
  
  Hide fields attributes Show fields attributes object
  
  description string Required
  
  A description of why the request element is bad.
  
  field string Required
  
  A path that leads to a field in the request body.
- detail string | null
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32) Required
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string Required
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string | null
  
  Application error message returned with this error.
500 application/json

Internal Server Error.
Hide response attributes Show response attributes object
- badRequestDetail object | null
  
  Bad request detail.
  
  Hide badRequestDetail attribute Show badRequestDetail attribute object | null
  
  fields array[object]
  
  Describes all violations in a client request.
  
  Hide fields attributes Show fields attributes object
  
  description string Required
  
  A description of why the request element is bad.
  
  field string Required
  
  A path that leads to a field in the request body.
- detail string | null
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32) Required
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string Required
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string | null
  
  Application error message returned with this error.

GET /api/atlas/v2

atlas api root getSystemStatus --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.GetSystemStatusApiParams{}
	sdkResp, httpResp, err := client.RootApi.
		GetSystemStatusWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2?pretty=true"

Response examples (200)

# Headers

# Payload
{
  "apiKey": {
    "accessList": [
      {
        "cidrBlock": "string",
        "ipAddress": "string"
      }
    ],
    "id": "32b6e34b3d91647abb20e7b8",
    "publicKey": "string",
    "roles": [
      {
        "groupId": "32b6e34b3d91647abb20e7b8",
        "orgId": "32b6e34b3d91647abb20e7b8",
        "roleName": "string"
      }
    ]
  },
  "appName": "MongoDB Atlas",
  "build": "83be55e140f493c88e7f578aae96548dd881587b",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "throttling": true
}

Response examples (401)

{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 401,
  "errorCode": "NOT_ORG_GROUP_CREATOR",
  "reason": "Unauthorized"
}

Response examples (403)

{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 403,
  "errorCode": "CANNOT_CHANGE_GROUP_NAME",
  "reason": "Forbidden"
}

Response examples (429)

{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 429,
  "errorCode": "RATE_LIMITED",
  "reason": "Too Many Requests"
}

Response examples (500)

{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 500,
  "errorCode": "UNEXPECTED_ERROR",
  "reason": "Internal Server Error"
}