atlas api serverlessPrivateEndpoints getServerlessPrivateEndpoint

On this page

experimental: Return one private endpoint for one serverless instance.

Identify this endpoint using its unique ID. You must have at least the Project Read Only role for the project to successfully call this resource. This command is invoking the endpoint with OperationID: 'getServerlessPrivateEndpoint'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/getServerlessPrivateEndpoint

Syntax

Command Syntax

atlas api serverlessPrivateEndpoints getServerlessPrivateEndpoint [options]

Name	Type	Required	Description
--endpointId	string	true	unique 24-hexadecimal digit string that identifies the tenant 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 getServerlessPrivateEndpoint
--instanceName	string	true	human-readable label that identifies the serverless instance associated with the tenant endpoint
--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)
--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

deleteServerlessPrivateEndpoint

listServerlessPrivateEndpoints