atlas api serverlessPrivateEndpoints createServerlessPrivateEndpoint
On this page
experimental: Creates one private endpoint for one serverless instance.
To use this resource, the requesting API Key must have the Project Owner role. A new endpoint won't be immediately available after creation. Read the steps in the linked tutorial for detailed guidance. This command is invoking the endpoint with OperationID: 'createServerlessPrivateEndpoint'. 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/createServerlessPrivateEndpoint
Syntax
atlas api serverlessPrivateEndpoints createServerlessPrivateEndpoint [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--envelope | false | flag that indicates whether Application wraps the response in an envelope JSON object | |
--file | string | false | path to the file which contains the api request contents |
--groupId | string | true | unique 24-hexadecimal digit string that identifies your project |
-h, --help | false | help for createServerlessPrivateEndpoint | |
--instanceName | string | true | human-readable label that identifies the serverless instance for which the tenant endpoint will be created |
--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. |