Andrea Test

Return One Limit for One Project

GET /api/atlas/v2/groups/{groupId}/limits/{limitName}
Digest auth

Returns the specified limit for the specified project. To use this resource, the requesting API Key must have the Project Read Only role.

Path parameters

  • limitName string Required

    Human-readable label that identifies this project limit.

    Limit Name Description Default API Override Limit
    atlas.project.deployment.clusters Limit on the number of clusters in this project 25 90
    atlas.project.deployment.nodesPerPrivateLinkRegion Limit on the number of nodes per Private Link region in this project 50 90
    atlas.project.security.databaseAccess.customRoles Limit on the number of custom roles in this project 100 1400
    atlas.project.security.databaseAccess.users Limit on the number of database users in this project 100 900
    atlas.project.security.networkAccess.crossRegionEntries Limit on the number of cross-region network access entries in this project 40 220
    atlas.project.security.networkAccess.entries Limit on the number of network access entries in this project 200 20
    dataFederation.bytesProcessed.query Limit on the number of bytes processed during a single Data Federation query N/A N/A
    dataFederation.bytesProcessed.daily Limit on the number of bytes processed across all Data Federation tenants for the current day N/A N/A
    dataFederation.bytesProcessed.weekly Limit on the number of bytes processed across all Data Federation tenants for the current week N/A N/A
    dataFederation.bytesProcessed.monthly Limit on the number of bytes processed across all Data Federation tenants for the current month N/A N/A
    atlas.project.deployment.privateServiceConnectionsPerRegionGroup Number of Private Service Connections per Region Group 50 100
    atlas.project.deployment.privateServiceConnectionsSubnetMask Subnet mask for GCP PSC Networks. Has lower limit of 20. 27 27

    Values are atlas.project.security.databaseAccess.users, atlas.project.deployment.clusters, atlas.project.deployment.serverlessMTMs, atlas.project.security.databaseAccess.customRoles, atlas.project.security.networkAccess.entries, atlas.project.security.networkAccess.crossRegionEntries, atlas.project.deployment.nodesPerPrivateLinkRegion, dataFederation.bytesProcessed.query, dataFederation.bytesProcessed.daily, dataFederation.bytesProcessed.weekly, dataFederation.bytesProcessed.monthly, atlas.project.deployment.privateServiceConnectionsPerRegionGroup, or atlas.project.deployment.privateServiceConnectionsSubnetMask.

  • groupId string Required

    Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.

    NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

    Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.

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.

Responses

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

    OK

    One of:
    atlas.project.security.networkAccess.entries object atlas.project.security.networkAccess.entries object atlas.project.security.networkAccess.entries object atlas.project.security.networkAccess.entries object atlas.project.security.networkAccess.entries object atlas.project.security.networkAccess.entries object atlas.project.security.networkAccess.entries object dataFederation.bytesProcessed.weekly object dataFederation.bytesProcessed.weekly object dataFederation.bytesProcessed.weekly object dataFederation.bytesProcessed.weekly object
  • 400 application/json

    Bad Request.

    Hide response attributes Show response attributes object
    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32)

      HTTP status code returned with this error.

      External documentation
    • errorCode string

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.
  • 401 application/json

    Unauthorized.

    Hide response attributes Show response attributes object
    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32)

      HTTP status code returned with this error.

      External documentation
    • errorCode string

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.
  • 404 application/json

    Not Found.

    Hide response attributes Show response attributes object
    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32)

      HTTP status code returned with this error.

      External documentation
    • errorCode string

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.
  • 409 application/json

    Conflict.

    Hide response attributes Show response attributes object
    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32)

      HTTP status code returned with this error.

      External documentation
    • errorCode string

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.
  • 500 application/json

    Internal Server Error.

    Hide response attributes Show response attributes object
    • detail string

      Describes the specific conditions or reasons that cause each type of error.

    • error integer(int32)

      HTTP status code returned with this error.

      External documentation
    • errorCode string

      Application error code returned with this error.

    • parameters array[object]

      Parameters used to give more information about the error.

    • reason string

      Application error message returned with this error.
GET /api/atlas/v2/groups/{groupId}/limits/{limitName} 
atlas api projects getProjectLimit --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20230101001/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.GetProjectLimitApiParams{}
	sdkResp, httpResp, err := client.ProjectsApi.
		GetProjectLimitWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true"
Response examples (200) 
{
  "currentUsage": 42,
  "defaultLimit": 42,
  "maximumLimit": 42,
  "name": "atlas.project.security.networkAccess.entries",
  "value": 42
}
{
  "currentUsage": 42,
  "defaultLimit": 42,
  "maximumLimit": 42,
  "name": "atlas.project.security.networkAccess.entries",
  "value": 42
}
{
  "currentUsage": 42,
  "defaultLimit": 42,
  "maximumLimit": 42,
  "name": "atlas.project.security.networkAccess.entries",
  "value": 42
}
{
  "currentUsage": 42,
  "defaultLimit": 42,
  "maximumLimit": 42,
  "name": "atlas.project.security.networkAccess.entries",
  "value": 42
}
{
  "currentUsage": 42,
  "defaultLimit": 42,
  "maximumLimit": 42,
  "name": "atlas.project.security.networkAccess.entries",
  "value": 42
}
{
  "currentUsage": 42,
  "defaultLimit": 42,
  "maximumLimit": 42,
  "name": "atlas.project.security.networkAccess.entries",
  "value": 42
}
{
  "currentUsage": 42,
  "defaultLimit": 42,
  "maximumLimit": 42,
  "name": "atlas.project.security.networkAccess.entries",
  "value": 42
}
{
  "currentUsage": 42,
  "defaultLimit": 42,
  "maximumLimit": 42,
  "name": "dataFederation.bytesProcessed.weekly",
  "value": 42,
  "lastModifiedDate": "2025-05-04T09:42:00Z",
  "overrunPolicy": "BLOCK"
}
{
  "currentUsage": 42,
  "defaultLimit": 42,
  "maximumLimit": 42,
  "name": "dataFederation.bytesProcessed.weekly",
  "value": 42,
  "lastModifiedDate": "2025-05-04T09:42:00Z",
  "overrunPolicy": "BLOCK"
}
{
  "currentUsage": 42,
  "defaultLimit": 42,
  "maximumLimit": 42,
  "name": "dataFederation.bytesProcessed.weekly",
  "value": 42,
  "lastModifiedDate": "2025-05-04T09:42:00Z",
  "overrunPolicy": "BLOCK"
}
{
  "currentUsage": 42,
  "defaultLimit": 42,
  "maximumLimit": 42,
  "name": "dataFederation.bytesProcessed.weekly",
  "value": 42,
  "lastModifiedDate": "2025-05-04T09:42:00Z",
  "overrunPolicy": "BLOCK"
}
Response examples (400) 
{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}
Response examples (401) 
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
Response examples (404) 
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
Response examples (409) 
{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}
Response examples (500) 
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}