Navigation

API >
Public API Resources >
Groups and Users >
Groups >
Create One Group

Create One Group¶

On this page

Syntax
Request Parameters
Response Elements
- Response Links
Examples
- Example Request
- Example Response

Base URL: `https://cloud.mongodb.com/`¶

Syntax¶

POST /api/public/v1.0/groups

Request Parameters¶

Request Path 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	Maximum number of items to return, up to a maximum of 100.	`100`
`pretty`	boolean	Display response in a prettyprint format.	`false`

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	Maximum number of items to return, up to a maximum of 100.	`100`
`pretty`	boolean	Display response in a prettyprint format.	`false`

Request Body Parameters¶

This endpoint does not use HTTP request body parameters.

Response Elements¶

Name	Type	Description
`id`	string	The unique identifier for the group.
`name`	string	The display name for the group.
`hostCounts`	object	The total number of hosts by type. The embedded fields should be self-explanatory.
`lastActiveAgent`	date	The time Cloud Manager last updated the `activeAgentCount` total for the group. Cloud Manager runs a job every 30 minutes to record the number of active agents of any type (Monitoring, Backup, Automation).
`activeAgentCount`	number	The number of active agents of any type (Monitoring, Backup, Automation) sending regular pings to Cloud Manager. The value is refreshed every 30 minutes. If you start a new agent or stop an existing one, the change can take up to 30 minutes to show up in the `activeAgentCount` field.
`replicaSetCount`	number	The total number of replica sets for this group.
`shardCount`	number	The total number of shards for this group.
`publicApiEnabled`	boolean	The indicator that the Public API is enabled for this group. This is a read-only field that is always `true`.
`agentApiKey`	string	The agent API key for the group. You must have the Owner role to view this field.
`links`	string array	See Response Links.

Response Links¶

Relation	Description
`self`	Me
`http://cloud.mongodb.com/hosts`	All hosts in the group.
`http://cloud.mongodb.com/users`	All users in the group.
`http://cloud.mongodb.com/clusters`	All clusters in the group.
`http://cloud.mongodb.com/alerts`	All open alerts for the group.
`http://cloud.mongodb.com/alertConfigs`	All alert configurations for the group.
`http://cloud.mongodb.com/backupConfigs`	All backup configurations for the group.
`http://cloud.mongodb.com/agents`	All agents for the group.

Examples¶

Example Request¶

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/groups?pretty=true" \
 --data '
 {
   "name": "Create Group API Example"
 }'

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 201 Created
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}

Response Body¶

{
  "activeAgentCount" : 0,
  "agentApiKey" : "{GROUP-API-KEY}",
  "hostCounts" : {
    "arbiter" : 0,
    "config" : 0,
    "master" : 0,
    "mongos" : 0,
    "primary" : 0,
    "secondary" : 0,
    "slave" : 0
  },
  "id" : "{GROUP-ID}",
  "links" : [ ... ],
  "name" : "Create Group API Test",
  "publicApiEnabled" : true,
  "replicaSetCount" : 0,
  "shardCount" : 0,
  "tags" : [ ]
}

← Get All Users in a Group Add Existing Users to One Group →