atlas api serverlessPrivateEndpoints getServerlessPrivateEndpoint
On this page
Public Preview: please provide feedback at: 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 feature does not work for Flex clusters. To continue using Private Endpoints once Serverless is replaced by Flex, please use a Dedicated cluster instead.
This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/getServerlessPrivateEndpoint.
For more information and examples, see the referenced API documentation linked above.
Syntax
atlas api serverlessPrivateEndpoints getServerlessPrivateEndpoint [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--endpointId | string | true | Unique 24-hexadecimal digit string that identifies the tenant endpoint. |
--envelope | envelope | false | 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. |
--groupId | string | true | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) 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. |
-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". |
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. |
Examples
atlas api serverlessPrivateEndpoints getServerlessPrivateEndpoint --version 2023-01-01 --endpointId [endpointId] --groupId 32b6e34b3d91647abb20e7b8 --instanceName [instanceName]