Navigation
You were redirected from a different version of the documentation. Click here to go back.

Create a Team

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

Syntax

POST /orgs/{ORG-ID}/teams

Request Path Parameters

Path Element Required/Optional Description
ORG-ID Required. The unique identifier for the organization with which you want to associate the team.

Request Query Parameters

The following query parameters are optional:

Name Type Necessity Description Default
pretty boolean Optional Flag indicating whether the response body should be in a prettyprint format. false
envelope boolean Optional

Flag that 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 one result, the response body includes:

Name Description
status HTTP response code
envelope Expected response body
false

Request Body Parameters

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

Response

Name Type Description
id string The unique identifier for the team.
name string The name of the organization associated with the team.
links array One or more links to sub-resources and/or related resources. All links arrays in responses include at least one link called self. The relationships between URLs are explained in the Web Linking Specification.

Example Request

curl -u "username:apiKey" --digest \
 --header "Accept: application/json" \
 --header "Content-Type: application/json" \
 --request POST "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/teams/" \
 --data '{ "name" : "myNewTeam" }'

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}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Response Body

{
 "id": "{TEAM-ID}",
 "links": [
     {
         "href": "https://cloud.mongodb.com/api/pubic/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}",
         "rel": "self"
     }
 ],
 "name": "myNewTeam"
}