Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateEndpointsForCloudProvider

On this page

  • Syntax
  • Options
  • Inherited Options

experimental: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management.

This command is invoking the endpoint with OperationID: 'getEncryptionAtRestPrivateEndpointsForCloudProvider'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRestPrivateEndpointsForCloudProvider

Command Syntax
atlas api encryptionAtRestUsingCustomerKeyManagement getEncryptionAtRestPrivateEndpointsForCloudProvider [options]
Name
Type
Required
Description

--cloudProvider

string

true

human-readable label that identifies the cloud provider for the private endpoints to return

--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 getEncryptionAtRestPrivateEndpointsForCloudProvider

--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

--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

Back

getEncryptionAtRestPrivateEndpoint