API >
API Resources >
VPC >
Get One Specific Container

Get One Specific Container¶

On this page

Resource
Response Elements
Example Request
Example Response

Retrieve one cloud provider container 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¶

copy

GET /groups/{GROUP-ID}/containers/{CONTAINER-ID}

Request Path Parameters¶

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

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

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

status	HTTP response code
envelope	The expected response body

false

Request Body Parameters¶

This endpoint does not use HTTP request body parameters.

Response Elements¶

AWS
GCP

Field	Type	Description
`atlasCidrBlock`	string	CIDR block that Atlas uses for your clusters.
`id`	string	Unique identifier of the container.
`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.
`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¶

copy

curl --user "{USERNAME}:{APIKEY}" --digest \
  --header "Accept: application/json" \
  --request GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/5356823b3794dee37132bb7b/containers/1112222b3bf99403840e8934?pretty=true"

Example Response¶

copy

{
  "atlasCidrBlock" : "10.8.0.0/21",
  "id" : "1112269b3bf99403840e8934",
  "provisioned" : true,
  "regionName" : "US_EAST_1",
  "vpcId" : "vpc-zz0zzzzz"
}

copy

{
  "atlasCidrBlock" : "10.8.0.0/18",
  "id" : "1112269b3bf99403840e8934",
  "gcpProjectId" : "my-sample-project-191923",
  "networkName" : "test1",
  "provisioned" : true
}

← Get All Containers in One Project Create One New Container →