Return All Network Peering Containers in One Project

GET /api/atlas/v2/groups/{groupId}/containers/all

Copy endpoint

https://cloud.mongodb.com

Returns details about all network peering containers in the specified project. Network peering containers contain network peering connections. To use this resource, the requesting Service Account or API Key must have the Project Read Only role.

Parameters

path Path Parameters

Name Type

Name	Type
`groupId` required Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. 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.	string

groupId required

Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.

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.

string

query Query Parameters

Name	Type
`envelope` Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.	boolean
`includeCount` Flag that indicates whether the response returns the total number of items (totalCount) in the response.	boolean
`itemsPerPage` Number of items that the response returns per page.	number
`pageNum` Number of the page that displays the current set of the total objects that the response returns.	number
`pretty` Flag that indicates whether the response body should be in the prettyprint format.	boolean

Responses

200 application/vnd.atlas.2023-01-01+json

interface PaginatedCloudProviderContainerView {
links?: readonly

Link

interface Link {
href?: string;
rel?: string;
}

[];
results?: readonly

CloudProviderContainer

Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.

type CloudProviderContainer = never

[];
totalCount?: number;
}

Client Errors

401 application/json

Unauthorized.

interface ApiError {
badRequestDetail?:

BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}

;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}

403 application/json

Forbidden.

interface ApiError {
badRequestDetail?:

BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}

;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}

404 application/json

Not Found.

interface ApiError {
badRequestDetail?:

BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}

;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}

Server Errors

500 application/json

Internal Server Error.

interface ApiError {
badRequestDetail?:

BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}

;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}