[metadata]
description: Explore the Atlas Administration API, which provides RESTful access to a wide range of Atlas features, including versioning, authentication, and rate limiting.
og:description: Explore the Atlas Administration API, which provides RESTful access to a wide range of Atlas features, including versioning, authentication, and rate limiting.
og:image: https://www.mongodb.com/docs/assets/meta_generic.png
og:image:alt: MongoDB logo featuring a green leaf on a dark green background.
og:title: Atlas Administration API Reference - Atlas - MongoDB Docs
og:type: website
og:url: https://www.mongodb.com/
robots: index
twitter:card: summary_large_image
twitter:description: Explore the Atlas Administration API, which provides RESTful access to a wide range of Atlas features, including versioning, authentication, and rate limiting.
twitter:image: https://www.mongodb.com/docs/assets/meta_generic.png
twitter:image:alt: MongoDB logo featuring a green leaf on a dark green background.
twitter:site: @mongodb
twitter:title: Atlas Administration API Reference - Atlas - MongoDB Docs
viewport: width=device-width, initial-scale=1

[canonical-links]
https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/

[document-links]
ACID Transactions: https://www.mongodb.com/resources/basics/databases/acid-transactions
AI Models: /docs/voyageai/
API Authentication Methods: /docs/atlas/api/api-authentication/
API Changelog: /docs/atlas/reference/api-resources-spec/changelog/#std-label-versioned-api-changelog
API Error Codes: /docs/atlas/reference/api-errors/
API Rate Limits: /docs/atlas/api/api-rate-limit/
API Specification: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/
API Versioning Overview: /docs/atlas/api/versioned-api-overview/#std-label-api-versioning-overview
APIs: /docs/atlas/api/
Admin API Overview: /docs/atlas/api/atlas-admin-api-ref/
Administration API: /docs/atlas/api/atlas-admin-api/
Artificial Intelligence: https://www.mongodb.com/solutions/use-cases/artificial-intelligence
Atlas Administration API Authentication Methods.: /docs/atlas/api/api-authentication/#std-label-api-authentication
Atlas Administration API Error Codes.: /docs/atlas/reference/api-errors/#std-label-atlas-api-error-codes
Atlas Administration API Rate Limits.: /docs/atlas/api/api-rate-limit/#std-label-api-rate-limiting
Atlas Administration API Specification.: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/
Atlas Architecture Center: /docs/atlas/architecture/current/
Atlas Build and scale with an AI-ready platform: https://www.mongodb.com/atlas
Atlas Documentation Get started using Atlas: https://www.mongodb.com/docs/atlas/
Atlas Go SDK: /docs/atlas/sdk/
Atlas Kubernetes Operator: /docs/atlas/operator/current/
Atlas Status: https://status.mongodb.com/
Atlas User Roles.: /docs/atlas/reference/user-roles/#std-label-user-roles
Atlas Users: /docs/atlas/access/manage-org-users/
Atlas for Government: /docs/atlas/government/
BSON timestamp: https://www.mongodb.com/docs/manual/reference/bson-types/#timestamps
Back Project Access: /docs/atlas/configure-api-access-project/
Backup and Restore: /docs/current/core/backups/
Backup, Restore, and Archive: /docs/atlas/backup-restore-cluster/
Blog Read articles and announcements: https://www.mongodb.com/blog
Careers Start your next adventure: https://www.mongodb.com/company/careers
Careers: https://www.mongodb.com/careers
Client Libraries: /docs/drivers/
Cloud Manager: /docs/cloud-manager/
Clusters: /docs/atlas/create-connect-deployments/
Community Edition Develop locally with MongoDB: https://www.mongodb.com/products/self-managed/community-edition
Community Edition: https://www.mongodb.com/try/download/community
Community Join a global community of developers: https://www.mongodb.com/community/
Company Learn more about who we are: https://www.mongodb.com/company
Compass Work with MongoDB data in a GUI: https://www.mongodb.com/products/tools/compass
Connect with Us: https://www.mongodb.com/company/contact/social-media-hub
Connect with an expert: https://www.mongodb.com/company/contact
Contact Us: https://www.mongodb.com/company/contact
Controllers for Kubernetes Operator: /docs/kubernetes/current/
Courses and Certification Learn for free from MongoDB: https://learn.mongodb.com/
Customer Portal: https://support.mongodb.com/welcome
Customer Support: https://www.mongodb.com/services/support
Database Deploy a multi-cloud database: https://www.mongodb.com/products/platform/atlas-database
Deployment: /docs/deployment/
Development: /docs/development/
Docs Home: /docs/
Docs Home: https://www.mongodb.com/docs/
Document Databases: https://www.mongodb.com/resources/basics/databases/document-databases
Download: https://www.mongodb.com/try/download/community
Download: https://www.mongodb.com/try/download/enterprise
Edge and Mobile: https://www.mongodb.com/solutions/use-cases/edge-and-mobile
Embedding and Reranking API: https://www.mongodb.com/docs/voyageai/api-reference/overview/
Enterprise Advanced Run and manage MongoDB yourself: https://www.mongodb.com/products/self-managed/enterprise-advanced
Enterprise Advanced: https://www.mongodb.com/try/download/enterprise
Events and Webinars Find an event or webinar near you: https://www.mongodb.com/events
Exit Codes & Statuses: /docs/current/reference/exit-codes/
Explore Your Data: /docs/atlas/atlas-ui/
Financial Services: https://www.mongodb.com/solutions/industries/financial-services
Gaming: https://www.mongodb.com/solutions/use-cases/gaming
Get Started with Terraform: /docs/atlas/terraform/
Get Started with the Atlas Administration API.: /docs/atlas/configure-api-access/#std-label-atlas-admin-api-access
Get Started: /docs/atlas/configure-api-access/
Get Started: /docs/get-started/
Get Started: https://www.mongodb.com/cloud/atlas/register
GitHub: https://github.com/mongodb
GraphQL APIs on AWS: /docs/atlas/graphql-api/
Healthcare: https://www.mongodb.com/solutions/industries/healthcare
ISO-8601: http://en.wikipedia.org/wiki/ISO8601
Installation: /docs/current/installation/
Integrations Integrations with third-party services: https://cloud.mongodb.com/ecosystem/?filter=integration
Intelligent Search: https://www.mongodb.com/solutions/use-cases/intelligent-search
Investor Relations: https://investors.mongodb.com
Kubernetes Operator (Deprecated): /docs/kubernetes-operator/v1.33
Leadership Meet our executive team: https://www.mongodb.com/company/leadership
Learn more: https://investors.mongodb.com/
Learn more: https://www.mongodb.com/services/consulting/ai-applications-program
Learn more: https://www.mongodb.com/solutions/startups
Legal: https://www.mongodb.com/legal
MEAN Stack: https://www.mongodb.com/resources/languages/mean-stack
MERN Stack: https://www.mongodb.com/resources/languages/mern-stack
Make an API Request.: /docs/atlas/configure-api-access/#std-label-prog-access-usage
Manage Billing: /docs/atlas/billing/
Manage Programmatic Access to Multiple Organizations.: /docs/atlas/configure-api-access-mult-org/#std-label-prog-access-mult-orgs
Manage Programmatic Access to a Project.: /docs/atlas/configure-api-access-project/#std-label-atlas-admin-api-access-project
Manage Programmatic Access to an Organization.: /docs/atlas/configure-api-access-org/#std-label-atlas-admin-api-access-org
Management: /docs/management/
Manufacturing: https://www.mongodb.com/solutions/industries/manufacturing
Migrate or Import Data: /docs/atlas/import/
Migrate to Flex Clusters: /docs/atlas/flex-migration/
Migrate to New API Version: /docs/atlas/api/migrate-to-new-version/
Migration Guide: /docs/atlas/api/migrate-to-new-version/#std-label-atlas-migrate-api-version
Modernization: https://www.mongodb.com/solutions/use-cases/modernize
MongoDB 8.0 Our fastest version ever: https://www.mongodb.com/products/updates/version-release
MongoDB Atlas AWS CloudFormation Resources: https://github.com/mongodb/mongodbatlas-cloudformation-resources?tab=readme-ov-file#readme
MongoDB Atlas Terraform Provider: https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs
MongoDB Atlas: https://www.mongodb.com/cloud/atlas/register
MongoDB Cloud Status API: https://www.mongodb.com/docs/api/doc/cloud-status/
MongoDB Drivers Use drivers and libraries for MongoDB: https://www.mongodb.com/docs/drivers/
Monitor Clusters: /docs/atlas/monitoring-alerts/
Monitor Clusters: /docs/current/administration/monitoring/
More API Resources: /docs/atlas/reference/more-api-resources/
Newsroom Read press releases and news stories: https://www.mongodb.com/company/newsroom
Next API Authentication Methods: /docs/atlas/api/api-authentication/
NoSQL Databases: https://www.mongodb.com/resources/basics/databases/nosql-explained
Operations Checklist: /docs/current/administration/production-checklist-operations/
Ops Manager: /docs/ops-manager/current/
Overview: /docs/atlas/
Overview: /docs/atlas/infrastructure/
Partners Learn about our partner ecosystem: https://www.mongodb.com/company/partners
Payments: https://www.mongodb.com/solutions/use-cases/payments
Pricing: https://www.mongodb.com/pricing
Privacy Policy: https://www.mongodb.com/legal/privacy/privacy-policy
Production Notes: /docs/atlas/production-notes/
Production Notes: /docs/current/administration/production-notes/
Project Read Only: /docs/atlas/reference/user-roles/#mongodb-authrole-Project-Read-Only
Project Settings: https://cloud.mongodb.com/go?l=https%3A%2F%2Fcloud.mongodb.com%2Fv2%2F%3Cproject%3E%23%2Fsettings%2FgroupSettings
Public Sector: https://www.mongodb.com/solutions/industries/public-sector
RAG Database: https://www.mongodb.com/resources/basics/artificial-intelligence/retrieval-augmented-generation
Reference: /docs/atlas/reference/
Relational Migrator Migrate to MongoDB with confidence: https://www.mongodb.com/products/tools/relational-migrator
Release Notes: https://www.mongodb.com/docs/atlas/release-notes/
Release Notes: https://www.mongodb.com/docs/manual/release-notes/
Resources Hub Get help building the next big thing with MongoDB: https://www.mongodb.com/resources
Retail: https://www.mongodb.com/solutions/industries/retail
Rotate Service Account Secrets: /docs/atlas/tutorial/rotate-service-account-secrets/
Search Deliver engaging search experiences: https://www.mongodb.com/products/platform/atlas-search
Search and Vector Search: /docs/search/self-managed/current/
Security Information: https://www.mongodb.com/company/contact/mongodb-vulnerability-disclosure-policy
Security: /docs/current/core/self-managed-security/
See Stories: https://www.mongodb.com/solutions/customer-case-studies
Server Documentation Learn to use MongoDB: https://www.mongodb.com/docs/manual/
Serverless Development: https://www.mongodb.com/solutions/use-cases/serverless
Sign In: https://account.mongodb.com/account/login
Sign Up: https://www.mongodb.com/cloud/atlas/register
Solutions Library Organized and tailored solutions to kick-start projects: https://www.mongodb.com/docs/atlas/architecture/current/solutions-library
Status code definition: https://tools.ietf.org/html/2616#section-6.1.1
Status code: https://tools.ietf.org/html/2616#section-6.1.1
Stream Processing Integrate MongoDB and Kafka: https://www.mongodb.com/products/platform/atlas-stream-processing
Support: https://www.mongodb.com/services/support
Telecommunications: https://www.mongodb.com/solutions/industries/telecommunications
Terraform Modules: /docs/atlas/terraform-modules-landing-zone/
Tools and Connectors Learn how to connect to MongoDB: https://www.mongodb.com/docs/tools-and-connectors/
Tools: /docs/tools-and-connectors/
Trust Center: https://www.mongodb.com/products/platform/trust
V1.0 API Specification: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v1/
Vector Databases: https://www.mongodb.com/resources/basics/databases/vector-databases
Vector Search Design intelligent apps with gen AI: https://www.mongodb.com/products/platform/atlas-vector-search
Versioned API Changelog: /docs/atlas/reference/api-resources-spec/changelog/
Versioning Overview: /docs/atlas/api/versioned-api-overview/
View All Products Explore our full developer suite: https://www.mongodb.com/products
Web Linking Specification: https://tools.ietf.org/html/rfc8288
access list: /docs/atlas/configure-api-access/#std-label-enable-api-access-list
authentication method: /docs/atlas/api/api-authentication/#std-label-api-authentication
billing: /docs/atlas/billing/#std-label-atlas-billing
database user: https://www.mongodb.com/docs/manual/reference/database-users/#std-label-security-database-users
https://www.mongodb.com
roles: https://www.mongodb.com/docs/manual/reference/built-in-roles/#std-label-database-user-roles
v2.0 API Specification: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/

[structured-data]
{"@context":"https://schema.org","@type":"HowTo","image":"https://webimages.mongodb.com/_com_assets/cms/kuyj2focmkbxv7gh3-stacked_default_slate_blue.svg?auto=format%252Ccompress","name":"Project ID","step":[{"@type":"HowToStep","name":"In Atlas, go to the Project Settings page.","text":"If it's not already displayed, select the organization that contains your desired project from the  Organizations menu in the navigation bar.If it's not already displayed, select your desired project from the Projects menu in the navigation bar.In the sidebar, click the  icon next to Project Overview. The Project Settings page displays."},{"@type":"HowToStep","text":"Copy the string listed under the Project ID heading."}]}
{"@context":"https://schema.org","@type":"SoftwareSourceCode","codeSampleType":"code snippet","programmingLanguage":"JSON","text":"{\n  \"detail\" : \"Cannot find resource /api/atlas/v1.0/softwareComponents/version.\",\n  \"error\" : 404,\n  \"errorCode\" : \"RESOURCE_NOT_FOUND\",\n  \"parameters\" : [ \"/api/atlas/v1.0/softwareComponents/version\" ],\n  \"reason\" : \"Not Found\"\n}\n"}
{"@context":"https://schema.org","@type":"SoftwareSourceCode","codeSampleType":"code snippet","programmingLanguage":"Shell","text":"curl --header 'Authorization: Bearer {ACCESS-TOKEN}' \\\n  --header 'Accept: application/json' \\\n  --include \\\n  --request GET \"https://cloud.mongodb.com/api/atlas/v1.0?pretty=true\"\n"}

[content]
Atlas Administration API Reference - Atlas - MongoDB Docs
For AI agents: a documentation index is available at https://www.mongodb.com/docs/llms.txt — markdown versions of all pages are available by appending .md to any URL path.
Products
Platform
Atlas
Build and scale with an AI-ready platform
Platform Services
Database
Deploy a multi-cloud database
Search
Deliver engaging search experiences
Vector Search
Design intelligent apps with gen AI
Stream Processing
Integrate MongoDB and Kafka
Self Managed
Enterprise Advanced
Run and manage MongoDB yourself
Community Edition
Develop locally with MongoDB
Tools
Compass
Work with MongoDB data in a GUI
Integrations
Integrations with third-party services
Relational Migrator
Migrate to MongoDB with confidence
View All Products
Explore our full developer suite
MongoDB 8.0
Our fastest version ever
Build with MongoDB Atlas
Get started for free in minutes
Sign Up
Test Enterprise Advanced
Develop with MongoDB on-premises
Download
Try Community Edition
Explore the latest version of MongoDB
Download
Resources
Documentation
Atlas Documentation
Get started using Atlas
Server Documentation
Learn to use MongoDB
Tools and Connectors
Learn how to connect to MongoDB
MongoDB Drivers
Use drivers and libraries for MongoDB
Resources Hub
Get help building the next big thing with MongoDB
Connect
Community
Join a global community of developers
Courses and Certification
Learn for free from MongoDB
Events and Webinars
Find an event or webinar near you
Solutions
Use cases
Artificial Intelligence
Modernization
Payments
Serverless Development
Gaming
Intelligent Search
Edge and Mobile
Industries
Financial Services
Telecommunications
Healthcare
Retail
Public Sector
Manufacturing
Solutions Library
Organized and tailored solutions to kick-start projects
AI Applications Program
Expedite your AI journey with expert guidance
Learn more
Startups and AI Innovators
For world-changing ideas and AI pioneers
Learn more
Customer Case Studies
Hear directly from our users
See Stories
Company
Careers
Start your next adventure
Blog
Read articles and announcements
Newsroom
Read press releases and news stories
Partners
Learn about our partner ecosystem
Leadership
Meet our executive team
Company
Learn more about who we are
Contact Us
Reach out to MongoDB
Connect with an expert
Investors
Visit our investor portal
Learn more
Pricing
Eng
Support
Sign In
Get Started
Products
Platform
Atlas
Build and scale with an AI-ready platform
Platform Services
Database
Deploy a multi-cloud database
Search
Deliver engaging search experiences
Vector Search
Design intelligent apps with gen AI
Stream Processing
Integrate MongoDB and Kafka
Self Managed
Enterprise Advanced
Run and manage MongoDB yourself
Community Edition
Develop locally with MongoDB
Tools
Compass
Work with MongoDB data in a GUI
Integrations
Integrations with third-party services
Relational Migrator
Migrate to MongoDB with confidence
View All Products
Explore our full developer suite
MongoDB 8.0
Our fastest version ever
Build with MongoDB Atlas
Get started for free in minutes
Sign Up
Test Enterprise Advanced
Develop with MongoDB on-premises
Download
Try Community Edition
Explore the latest version of MongoDB
Download
Resources
Documentation
Atlas Documentation
Get started using Atlas
Server Documentation
Learn to use MongoDB
Tools and Connectors
Learn how to connect to MongoDB
MongoDB Drivers
Use drivers and libraries for MongoDB
Resources Hub
Get help building the next big thing with MongoDB
Connect
Community
Join a global community of developers
Courses and Certification
Learn for free from MongoDB
Events and Webinars
Find an event or webinar near you
Solutions
Use cases
Artificial Intelligence
Modernization
Payments
Serverless Development
Gaming
Intelligent Search
Edge and Mobile
Industries
Financial Services
Telecommunications
Healthcare
Retail
Public Sector
Manufacturing
Solutions Library
Organized and tailored solutions to kick-start projects
AI Applications Program
Expedite your AI journey with expert guidance
Learn more
Startups and AI Innovators
For world-changing ideas and AI pioneers
Learn more
Customer Case Studies
Hear directly from our users
See Stories
Company
Careers
Start your next adventure
Blog
Read articles and announcements
Newsroom
Read press releases and news stories
Partners
Learn about our partner ecosystem
Leadership
Meet our executive team
Company
Learn more about who we are
Contact Us
Reach out to MongoDB
Connect with an expert
Investors
Visit our investor portal
Learn more
Pricing
Eng
Support
Sign In
Get Started
Docs Menu
Ask MongoDB AI
Docs Home
/
/
Administration API
Docs Home
/
Management
/
APIs
/
Administration API
Docs Home
/
Management
/
APIs
/
Administration API
Atlas Administration API Reference
Copy page
The Atlas Administration API follows the principles of the
REST
architectural style to expose a number of internal resources that enable programmatic access to administrative features in
Atlas
. To view the full list of available Atlas Administration API endpoints, see the
Atlas Administration API Specification.
The Atlas Administration API doesn't provide access to the data stored in your clusters. To read or write data in a database, you must authenticate to your cluster using the credentials for a
database user
with the appropriate read or write
roles
. You can use the Atlas Administration API to create and manage database users.
As with changes made through the
Atlas
web interface, changes made through the Atlas Administration API are subject to
Atlas
billing
. If you incur charges, you must have a valid credit card on file with
Atlas
or risk having your organization locked.
The
API
has the following features:
Resource Versioning
Atlas
provides a versioned Atlas Administration API, which includes versioning at the individual Atlas Administration API resource-level. Use these resources and the following sections to learn more about the Atlas Administration API:
API Versioning Overview
Migration Guide
API Specification
API Changelog
JSON
entities
All entities are expressed in
JSON
.
Browsable interface
Using a consistent linking mechanism, you can browse the entire Atlas Administration API by starting at the root resource and following links to related resources.
HTTPS
-Only
You can only access the Atlas Administration API via
HTTPS
, ensuring all data sent over the network is fully encrypted using
TLS
.
User Access Control
Each
Atlas
user's Atlas Administration API capabilities match the permissions granted by their
Atlas
User Roles.
Example
A user with the
Project Read Only
role in a
Atlas
project can't modify any resource within that project, whether through the
Atlas
user interface or the Atlas Administration API.
API
Network Access List
Atlas
can secure access to its Atlas Administration API through an
API
access list
. This list restricts access to the
API
to specific IP or
CIDR
addresses. Each
authentication method
has its own Atlas Administration API access list. When you create a new organization using the Atlas UI,
Atlas
enables the
API
access list requirement by default.
Tip
Get Started with the Atlas Administration API.
HTTP
Methods
All resources support a subset of these common
HTTP
Methods:
Method
Purpose
GET
Retrieve the
JSON
representation of a resource.
POST
Create a new resource using the provided
JSON
representation.
PUT
Replace a resource with the provided
JSON
representation.
PATCH
Update the specified fields in a resource using the provided
JSON
representation.
DELETE
Remove a resource.
HEAD
Returns the response header without the
JSON
representation of the resource.
JSON
All entities are represented in
JSON
. The following rules and conventions apply:
Content Type Request Header
When sending
JSON
to the server via
POST
or
PUT
, make sure to specify the correct content type request header:
Content-Type: application/json
.
Invalid Fields
Invalid fields are
rejected
rather than
ignored
. For example, if you attempt to create a new entity and misspell one of the fields, or attempt to update an existing entity and include a field that can't be modified, the server responds with a 400 status code and an error message stating which field is invalid.
ISO-8601-Formatted Dates
All dates are returned as
ISO-8601
-formatted strings designated in UTC. When sending dates to the server (i.e., as query parameters or fields in
POST
or
PATCH
request entities), use ISO-8601-formatted dates. If you do not specify a time zone, UTC is assumed. However, it is highly recommended that you include a time zone designator to avoid any ambiguity.
BSON Timestamps
In some cases, a timestamp is returned as a
BSON timestamp
, most notably in the backup resources. These are represented in
JSON
documents as an object with two fields:
date
, which is an ISO-8601-formatted date string in UTC with granularity to the second, and
increment
a 32-bit integer.
Field Names for Fields with Numbers
Fields that contain numeric values in a particular unit will be named so as to disambiguate the unit being used.
Empty Fields
Fields that do not have a current value are returned with an appropriate default value.
Fields that do not have a sensible default value are omitted from the entity.
Field Order
The fields in the
JSON
documents returned by the server are in no particular order, and the order may change. Do not depend on the order of the fields.
Linking
Each resource includes one or more links to sub-resources and/or related resources. Links are placed in the
links
field of an entity, which is an array of link relation objects. Each link relation has two fields:
Field
Description
rel
Name (or type) of the relation. Many of these are considered Extension Relation Types and are prefixed by
http://mms.mongodb.com
.
href
The target
URL
.
All entities include at least one link relation called
self
, which is simply its own
URL
. When an entity is part of a list, then it only includes the
self
link relation.
For more information, refer to the
Web Linking Specification
. Note that although the specification describes a format for including links in the
HTTP
response headers, doing so is not a requirement. To make the Atlas Administration API easily browsable, it includes the links in the response body rather than in the response headers.
Lists
Some resources return a list of entities. When a list of entities is expected in a response, the results are returned in batches bounded by the following query parameters:
Field
Description
pageNum
Page number (1-based). Defaults to
1
if not specified.
itemsPerPage
Number of items to return per page, up to a maximum of 500. Defaults to
100
if not specified.
includeCount
Specifies whether the response returns the
totalCount
field. Defaults to
true
if not specified.
The response entity contains three fields:
Field
Description
totalCount
The total number of items in the entire result set.
results
The result set, which is an array of entity documents.
links
Contains one to three link relations:
previous
for the previous page of results (omitted for the first page);
next
for the next page of results (omitted for the last page); and
self
for the current page (always present).
If you make a request for a list of entities and there are no results, then the Atlas Administration API responds with a 200 status code and the
results
array is empty. It does
not
respond with a 404 in this case, since the list of entities may not be empty at some point in the future. However, if you request a list of entities in a context that does not exist (e.g., the list of hosts for a non-existent project), then this
does
result in a 404 response status.
Envelopes
Some clients might not be able to access the
HTTP
response headers and/or status code. In that case, you can request that the response include an "envelope," which is simply an extra layer of information in the
JSON
document and contains any relevant details that would normally be in the response headers. By default, the Atlas Administration API does
not
include the response in an envelope. To request one, simply add the query parameter
envelope=true
.
For responses that contain a single entity, the envelope contains two fields:
Field
Description
status
The
HTTP
status code.
content
The requested entity.
For responses that contain a list of entities, there is already an envelope that wraps the results, so specifying
envelope=true
only adds the
status
field to the existing envelope.
Pretty Printing
By default, extraneous whitespace is stripped from the
JSON
returned by the server. To ask for pretty-printed
JSON
, simply append the
pretty=true
query parameter to any request:
curl --header 'Authorization: Bearer {ACCESS-TOKEN}' \
--header 'Accept: application/json' \
--include \
--request GET "https://cloud.mongodb.com/api/atlas/v1.0?pretty=true"
Response Codes
Responses use the standard
HTTP
response codes, including:
Code
Meaning
Notes
200
OK
The request was successful. This is typically the response to a successful
GET
request.
201
Created
A new resource was created. This is typically the response to a successful
POST
request.
202
Accepted
A request for an asynchronous operation was accepted.
400
Bad Request
Something was wrong with the client request.
401
Unauthorized
Authentication is required but was not present in the request. Typically this means that the authentication information was omitted from the request, the provided credentials are incorrect, or the user associated with the given authentication method is not allowed to access the requested resource.
403
Forbidden
Access to the specified resource is not permitted.
404
Not Found
The requested resource does not exist.
405
Method Not Allowed
The
HTTP
method is not supported for the specified resource. Keep in mind that each resource may only support a subset of
HTTP
methods. For example, you can't
DELETE
the root resource.
409
Conflict
This is the response to a request to create or modify a property of an entity that is unique when an existing entity already exists with the same value for that property.
5xx
Various server errors
Something unexpected went wrong. Try again later and consider notifying
Atlas
Support.
Errors
When a request returns an error, the response body contains a
JSON
document. This document includes details about why the Atlas Administration API request failed. The document contains five parameters:
Parameter
Data Type
Description
detail
string
Human-readable description that
Atlas
returns for the errant Atlas Administration API request.
error
integer
Status code
returned in the header of the
HTTP
response.
errorCode
string
Named constant that represents the errant Atlas Administration API request. To learn about these constants, see
Atlas Administration API Error Codes.
parameters
array
List of parameters that provide further details about the error.
reason
string
Status code definition
returned in the header of the
HTTP
response.
Example
Atlas
returns the following response body when you make a request in the incorrect format:
1
{
2
"detail"
:
"Cannot find resource /api/atlas/v1.0/softwareComponents/version."
,
3
"error"
:
404
,
4
"errorCode"
:
"RESOURCE_NOT_FOUND"
,
5
"parameters"
:
[
"/api/atlas/v1.0/softwareComponents/version"
]
,
6
"reason"
:
"Not Found"
7
}
Project ID
Your Project ID is a string value that uniquely identifies a
Atlas
project.
Atlas
projects were previously identified as "groups". Some
Atlas
endpoints reference
group
or
{GROUP-ID}
as part of the request path, query, or body parameters. For any endpoint that requires your
{GROUP-ID}
, specify your Project ID instead.
To retrieve your project ID:
1
In
Atlas
, go to the
Project Settings
page.
If it's not already displayed, select the organization that contains your desired project from the
Organizations
menu
in the navigation bar.
If it's not already displayed, select your desired project from the
Projects
menu in the navigation bar.
In the sidebar, click the
icon next to
Project Overview
.
The
Project Settings
page displays.
2
Copy the string listed under the
Project ID
heading.
Authentication
The Atlas Administration API uses one of two methods to authenticate requests: service accounts or
API
keys. This ensures that the access tokens and keys that serve as usernames and passwords are never sent over the network. To learn more, see
Atlas Administration API Authentication Methods.
For usage details, see
Make an
API
Request.
Important
We recommend you use service accounts instead of
API
keys to authenticate to the Atlas Administration API.
API
keys are a legacy authentication method.
Rate Limiting
Atlas
uses
rate limiting
to control the rate of requests sent to the V2
API
endpoints within a specified timeframe to prevent overload and ensure fair usage.
Atlas
uses the Token Bucket Algorithm to limit the number of requests it processes. To learn more, see
Atlas Administration API Rate Limits.
Next Steps
To get started, see
Get Started with the Atlas Administration API.
To manage programmatic access to the Atlas Administration API, see any of the following procedures:
Manage Programmatic Access to an Organization.
Manage Programmatic Access to Multiple Organizations.
Manage Programmatic Access to a Project.
Back
Project Access
Next
API Authentication Methods
Rate this page
On this page
HTTP
Methods
JSON
Linking
Lists
Envelopes
Pretty Printing
Response Codes
Errors
Project ID
Authentication
Rate Limiting
Next Steps
On this page
HTTP
Methods
JSON
Linking
Lists
Envelopes
Pretty Printing
Response Codes
Errors
Project ID
Authentication
Rate Limiting
Next Steps
Docs Home
Get Started
Deployment
Development
Management
MongoDB Atlas
Overview
Atlas Users
Organizations
Projects
Clusters
Backup, Restore, and Archive
Migrate or Import Data
Monitor Clusters
Manage Billing
Explore Your Data
Production Notes
Reference
APIs
Administration API
Get Started
Admin API Overview
API Authentication Methods
Rotate Service Account Secrets
API Rate Limits
Versioning Overview
Migrate to New API Version
v2.0 API Specification
V1.0 API Specification
Versioned API Changelog
API Error Codes
Atlas Go SDK
More API Resources
Embedding and Reranking API
MongoDB Cloud Status API
Atlas Kubernetes Operator
Atlas for Government
Release Notes
Enterprise Management Tools
Ops Manager
Controllers for Kubernetes Operator
Kubernetes Operator (Deprecated)
Cloud Manager
Self-Managed Deployments
Select a version
Installation
Clusters
Sharding
Storage
Backup and Restore
Monitor Clusters
Security
Search and Vector Search
Operations Checklist
Production Notes
Exit Codes & Statuses
Release Notes
FAQ
Infrastructure As Code
Overview
MongoDB Atlas Terraform Provider
Get Started with Terraform
Terraform Modules
MongoDB Atlas AWS CloudFormation Resources
GraphQL APIs on AWS
Migrate to Flex Clusters
Client Libraries
Tools
AI Models
Atlas Architecture Center
Docs Home
Get Started
Deployment
Development
Management
Client Libraries
Tools
AI Models
Atlas Architecture Center
MongoDB Atlas
Overview
Atlas Users
Organizations
Projects
Clusters
Backup, Restore, and Archive
Migrate or Import Data
Monitor Clusters
Manage Billing
Explore Your Data
Production Notes
Reference
APIs
Administration API
Get Started
Admin API Overview
API Authentication Methods
Rotate Service Account Secrets
API Rate Limits
Versioning Overview
Migrate to New API Version
v2.0 API Specification
V1.0 API Specification
Versioned API Changelog
API Error Codes
Atlas Go SDK
More API Resources
Embedding and Reranking API
MongoDB Cloud Status API
Atlas Kubernetes Operator
Atlas for Government
Release Notes
Enterprise Management Tools
Ops Manager
Controllers for Kubernetes Operator
Kubernetes Operator (Deprecated)
Cloud Manager
Self-Managed Deployments
Select a version
Installation
Clusters
Sharding
Storage
Backup and Restore
Monitor Clusters
Security
Search and Vector Search
Operations Checklist
Production Notes
Exit Codes & Statuses
Release Notes
FAQ
Infrastructure As Code
Overview
MongoDB Atlas Terraform Provider
Get Started with Terraform
Terraform Modules
MongoDB Atlas AWS CloudFormation Resources
GraphQL APIs on AWS
Migrate to Flex Clusters
English
English
Português
Español
한국어
日本語
简体中文
© 2026 MongoDB, Inc.
About
Careers
Investor Relations
Legal
Privacy Policy
GitHub
Security Information
Trust Center
Connect with Us
Support
Contact Us
Customer Portal
Atlas Status
Customer Support
Deployment Options
MongoDB Atlas
Enterprise Advanced
Community Edition
Data Basics
Vector Databases
NoSQL Databases
Document Databases
RAG Database
ACID Transactions
MERN Stack
MEAN Stack
© 2026 MongoDB, Inc.
