atlas api privateEndpointServices getPrivateEndpoint

On this page

experimental: Returns the connection state of the specified private endpoint.

The private endpoint service manages this private endpoint which belongs to one project hosted from one cloud service provider. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'getPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getPrivateEndpoint

Syntax

Command Syntax

atlas api privateEndpointServices getPrivateEndpoint [options]

Name	Type	Required	Description
--cloudProvider	string	true	cloud service provider that manages this private endpoint
--endpointId	string	true	unique string that identifies the private endpoint you want to return
--endpointServiceId	string	true	unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to return a private endpoint
--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 getPrivateEndpoint
--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)
--pretty		false	flag that indicates whether the response body should be in the prettyprint format
--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	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.

Back

deletePrivateEndpointService

getPrivateEndpointService