Navigation

Get All Containers in One Project

Retrieve a list of all cloud provider containers in one project.

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

Resource

GET /groups/{GROUP-ID}/containers

Request Path Parameters

Parameter Type Necessity Description
GROUP-ID string Required Unique identifier for the project whose container you want to retrieve.

Request Query Parameters

Parameter Type Necessity Description
providerName string Optional Cloud provider for this VPC peering connection. Accepted values are AWS and GCP. If omitted, Atlas set this parameter to AWS.

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response Elements

Response Document

The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.

Name Type Description
results object array This array includes one object for each item detailed in the results Embedded Document section.
links object array This array includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
totalCount number The count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

results Embedded Document

Field Type Description
atlasCidrBlock string CIDR block that Atlas uses for your clusters.
id string Unique identifier of the container.
providerName string Cloud provider for this VPC peering connection.
provisioned boolean Flag that indicates if the project has clusters deployed in the VPC.
regionName string Region. Provided for AWS VPCs only.
vpcId string Unique identifier of the project’s VPC.
Field Type Description
atlasCidrBlock string CIDR block that Atlas uses for your clusters.
gcpProjectId string Unique identifier of the GCP project in which the VPC resides.
id string Unique identifier of the container.
providerName string Cloud provider for this VPC peering connection.
provisioned boolean Flag that indicates if the project has clusters deployed in the VPC.
networkName string Name of the VPC of the Atlas project.

Example Request

1
2
3
curl --user "{USERNAME}:{APIKEY}" --digest \
  --header "Accept: application/json" \
  --request GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/5356823b3794dee37132bb7b/containers?providerName=AWS&pretty=true"
1
2
3
curl --user "{USERNAME}:{APIKEY}" --digest \
  --header "Accept: application/json" \
  --request GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/5356823b3794dee37132bb7b/containers?providerName=GCP&pretty=true"

Example Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
   "links":[ {
      "href" : "https://cloud.mongodb.com/api/atlas/v1.0/groups/5356823b3794dee37132bb7b/containers?pageNum=1&itemsPerPage=100",
      "rel" : "self"
   } ],
   "results":[ {
     "atlasCidrBlock" : "10.8.0.0/21",
     "id" : "1112269b3bf99403840e8934",
     "providerName" : "AWS",
     "provisioned" : true,
     "regionName" : "US_EAST_1",
     "vpcId" : "vpc-zz0zzzzz"
   } ],
   "totalCount":1
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
   "links":[ {
      "href" : "https://cloud.mongodb.com/api/atlas/v1.0/groups/5356823b3794dee37132bb7b/containers?pageNum=1&itemsPerPage=100",
      "rel" : "self"
   } ],
   "results":[ {
     "atlasCidrBlock" : "10.8.0.0/18",
     "id" : "1112269b3bf99403840e8934",
     "gcpProjectId" : "my-sample-project-191923",
     "networkName" : "test1",
     "providerName" : "GCP",
     "provisioned" : true
   } ],
   "totalCount":1
}