Navigation

Create an Organization

On this page

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

Important

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

Resource

copy 
POST /orgs

Request Parameters

Request Path Parameters

This endpoint does not use HTTP request path parameters.

Request Query Parameters

This endpoint may use any of the HTTP request query parameters available to all Cloud Manager API resources. These are all optional.

Name Type Description Default
pageNum integer Page number (1-based). 1
itemsPerPage integer Number of items to return per page, up to a maximum of 500. 100
pretty boolean Indicates whether the response body should be in a prettyprint format. false
envelope boolean

Indicates whether or not to wrap the response in an envelope.

Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return a list of results, the results object is an envelope. Cloud Manager adds the status field to the response body.

 false

Request Body Parameters

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

Response

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

Example Request

copy 
curl --user '{USERNAME}:{APIKEY}' --digest \
 --header 'Accept: application/json' \
 --header 'Content-Type: application/json' \
 --include \
 --request POST "https://cloud.mongodb.com/api/public/v1.0/orgs" \
 --data
   '{ "name" : "myNewOrganization" }'

Example Response

Response Header

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}

Response Body

copy 
{
  "id":"{ORG-ID}",
  "name":"myNewOrganization"
}

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.