Get All Network Peering Containers in One Project¶
Retrieve a list of Network Peering containers in one project. You must
have the Project Read Only
or a more permissive role to
successfully call this endpoint.
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/{PROJECT-ID}/containers/all
Request Path Parameters¶
Parameter | Type | Necessity | Description |
---|---|---|---|
PROJECT-ID | string | Required | Unique identifier for the project whose list of Network Peering containers you want to retrieve. |
Request Query Parameters¶
Name | Type | Necessity | Description | Default |
---|---|---|---|---|
pageNum | integer | Optional | Page number, starting with one, that Atlas returns of the total number of objects. | 1 |
itemsPerPage | integer | Optional | Number of items that Atlas returns per page, up to a maximum of 500. | 100 |
includeCount | boolean | Optional | Flag that indicates whether Atlas returns the totalCount parameter in the response body. | true |
pretty | boolean | Optional | Flag that indicates whether Atlas returns the JSON response in the prettyprint format. | false |
envelope | boolean | Optional | Flag that indicates whether Atlas wraps the response in an envelope. Some API clients cannot access the HTTP response headers or
status code. To remediate this, set Endpoints that return a list of results use the results object as an envelope. Atlas adds the status parameter to the response body. | false |
Request Body Parameters¶
This endpoint doesn't 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 | array of objects | One object for each item detailed in the results Embedded Document section. |
links | array of objects | One or more links to sub-resources and/or related resources. The relations between URL |