Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Python API to the MongoDB Atlas REST Interface

Project description

MongoDB Atlas - A Python API for MongoDB Atlas

The MongoDB database as a service offering Atlas provides a complete and well documented REST API.


The easiest way to install the mongodbatlas is with pip.

$ pip install mongodbatlas

Once the installation completes you can confirm it has worked by running

$ atlascli -h
usage: atlascli [-h] [--publickey PUBLICKEY] [--privatekey PRIVATEKEY] [--org]
                [--pause PAUSE_CLUSTER] [--resume RESUME_CLUSTER]
                [--list {projects,clusters}] [--cluster CLUSTER]
                [--project_id PROJECT_DETAIL] [--format {summary,full}]
                [--debug] [--resource RESOURCE] [--itemsperpage ITEMSPERPAGE]
                [--pagenum PAGENUM]

optional arguments:
  -h, --help            show this help message and exit
  --publickey PUBLICKEY
                        MongoDB Atlas public API key
  --privatekey PRIVATEKEY
                        MongoDB Atlas private API key

The Python Atlas API wraps the REST API in a more Pythonic API based around an AtlasAPI class.

The library assumes the existence of two environment variables:

  • ATLAS_PUBLIC_KEY : The public key value defined by the Atlas programmatic API key
  • ATLAS_PRIVATE_KEY : The private key defined by the Atlas programmatic API key.

See the section below on how to create a programmatic Atlas API key.


from mongodbatlas.api import AtlasAPI


How to create an Atlas API Key

You can create keys at the Organization level by selecting the access menu item on the left hand side menu:

API Start Screen

Once you create a key you then need to assign it permissions. If you pick the default youwill have to add this key explicitly to every project that you want to manage via the API.

API Permissions Screen

On the next screen you can collect your API key. You will only get to see it once so please make sure to take a copy.

API Create Key Screen

Not on this screen we obliterate part of the key so it can't been seen.

Finally you need to whitelist any nodes that are going to originate API requests.

API Create Key Screen

You are now ready to start using your API key.

Using your keys

Both parts of the key required to acc

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mongodbatlas, version 0.2.2
Filename, size File type Python version Upload date Hashes
Filename, size mongodbatlas-0.2.2.tar.gz (11.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page