atlas api networkPeering listPeeringConnections
On this page
experimental: Returns details about all network peering connections in the specified project.
Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listPeeringConnections'. 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/listPeeringConnections
Syntax
atlas api networkPeering listPeeringConnections [options]
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 listPeeringConnections | |
--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 | false | cloud service provider to use for this VPC peering connection |
--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". |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |