Skip to main content

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.

Installation

The easiest way to install the A 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.

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.

Source Distribution

mongodbatlas-0.1.3.tar.gz (3.9 kB view details)

Uploaded Source

File details

Details for the file mongodbatlas-0.1.3.tar.gz.

File metadata

  • Download URL: mongodbatlas-0.1.3.tar.gz
  • Upload date:
  • Size: 3.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for mongodbatlas-0.1.3.tar.gz
Algorithm Hash digest
SHA256 3d9d003b74365f4841193ddd3e881b7ad139d9d022c2d4b9e0cd7ac2848b902a
MD5 925acc6e6ad9eb47288889253ae5256e
BLAKE2b-256 526ab5693312c3a56067dbd8497a6c28895e932c0af286c9bbf28872e1baa7e1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page