Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

atlas api networkPeering listPeeringContainerByCloudProvider

On this page

  • Syntax
  • Options
  • Inherited Options

experimental: Returns details about all network peering containers in the specified project for the specified cloud provider.

If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listPeeringContainerByCloudProvider'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringContainerByCloudProvider

Command Syntax
atlas api networkPeering listPeeringContainerByCloudProvider [options]
Name
Type
Required
Description

--envelope

false

flag that indicates whether Application wraps the response in an envelope JSON object

--groupId

string

true

unique 24-hexadecimal digit string that identifies your project

-h, --help

false

help for listPeeringContainerByCloudProvider

--includeCount

false

flag that indicates whether the response returns the total number of items (totalCount) in the response

--itemsPerPage

int

false

number of items that the response returns per page

--output

string

false

preferred api format, can be ["json", go-template] This value defaults to "json".

--output-file

string

false

file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)

--pageNum

int

false

number of the page that displays the current set of the total objects that the response returns

--pretty

false

flag that indicates whether the response body should be in the prettyprint format

--providerName

string

true

cloud service provider that serves the desired network peering containers

--version

string

false

api version to use when calling the api call [options: "2023-01-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-01-01".

Name
Type
Required
Description

-P, --profile

string

false

Back

listPeeringConnections