Navigation

Create an Organization

The Atlas API uses HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.

For complete documentation on configuring API access for an Atlas project, see Configure Atlas API Access.

Important

To create an organization, you must authenticate as an Atlas user. If you attempt to create an organization using API Key credentials instead of Atlas user credentials, Atlas returns the API_KEY_CANNOT_CREATE_ORG error.

Base URL: https://cloud.mongodb.com/api/atlas/v1.0

Syntax

POST /api/atlas/v1.0/orgs

Request Body Parameters

Name Type Description
name string The name of the organization you want to create.

Request Query Parameters

Field Required/Optional Description
envelope Optional.

A boolean that specifies whether or not to wrap the response in an envelope.

Defaults to false.

pretty Optional.

A boolean that specifies whether or not to return a “pretty-printed” JSON document.

Defaults to false.

HTTP Response Elements

Name Description
id The unique identifier for the organization.
name The name of the organization.

Example

Request

curl -u "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest -H "Content-Type: application/json" -X POST "https://cloud.mongodb.com/api/atlas/v1.0/orgs" --data '{ "name" : "myNewOrganization" }'

Response

{"id":"5a38289880eef5072af2f1f1","name":"myNewOrganization"}