Navigation

Get a List of Cloud Services Containers

Note

Groups and projects are synonymous terms. Your {GROUP-ID} is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

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

Syntax

GET /api/atlas/v1.0/groups/{GROUP-ID}/containers

Request Path Parameters

Path Element Required/Optional Description
GROUP-ID Required. The unique identifier for the project whose containers (AWS VPC) you want to retrieve.

Request Query Parameters

This endpoint may use any of the HTTP request query parameters available to all Atlas 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
envelope boolean Specifies whether or not to wrap the response in an envelope. false

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response Elements

The response includes a results array of container information. Each container information has the following fields:

Field Description
id The ID for the container.
providerName The Cloud Services provider name; i.e. AWS.
atlasCidrBlock The Atlas CIDR block.
regionName AWS region.
vpcId The ID of the project’s VPC.
isProvisioned Flag that indicates if the project has clusters deployed in the VPC.

Example Request

curl -X GET -u 'username:apiKey' --digest "https://cloud.mongodb.com/api/atlas/v1.0/groups/5356823b3794dee37132bb7b/containers"

Example Response

{
   "links":[ {
      "href" : "https://cloud.mongodb.com/api/atlas/v1.0/groups/5356823b3794dee37132bb7b/containers?pageNum=1&itemsPerPage=100",
      "rel" : "self"
   } ],
   "results":[ {
      "atlasCidrBlock" : "192.168.248.0/21",
      "id" : "1112222b3bf99403840e8934",
      "providerName" : "AWS",
      "provisioned" : true,
      "regionName" : "US_EAST_1",
      "vpcId" : "vpc-zz0zzzzz"
   } ],
   "totalCount":1
}