Create One Private Endpoint in a Specified Region for Encryption at Rest Using Customer Key Management
Creates a private endpoint in the specified region for encryption at rest using customer key management.
Path parameters
-
Unique 24-hexadecimal digit string that identifies your project. Use the /groups 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.
Format should match the following pattern:
^([a-f0-9]{24})$
. -
Human-readable label that identifies the cloud provider for the private endpoint to create.
Values are
AZURE
orAWS
.
Query parameters
-
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.Default value is
false
. -
Flag that indicates whether the response body should be in the prettyprint format.
Default value is
false
.Prettyprint
Body
object
Required
Creates a private endpoint in the specified region.
Azure Key Vault Encryption At Rest Private Endpoint.
regionName
string Cloud provider region in which the Encryption At Rest private endpoint is located.
One of: Microsoft Azure Regions.
Values are
US_CENTRAL
,US_EAST
,US_EAST_2
,US_NORTH_CENTRAL
,US_WEST
,US_SOUTH_CENTRAL
,EUROPE_NORTH
,EUROPE_WEST
,US_WEST_CENTRAL
,US_WEST_2
,US_WEST_3
,CANADA_EAST
,CANADA_CENTRAL
,BRAZIL_SOUTH
,BRAZIL_SOUTHEAST
,AUSTRALIA_CENTRAL
,AUSTRALIA_CENTRAL_2
,AUSTRALIA_EAST
,AUSTRALIA_SOUTH_EAST
,GERMANY_WEST_CENTRAL
,GERMANY_NORTH
,SWEDEN_CENTRAL
,SWEDEN_SOUTH
,SWITZERLAND_NORTH
,SWITZERLAND_WEST
,UK_SOUTH
,UK_WEST
,NORWAY_EAST
,NORWAY_WEST
,INDIA_CENTRAL
,INDIA_SOUTH
,INDIA_WEST
,CHINA_EAST
,CHINA_NORTH
,ASIA_EAST
,JAPAN_EAST
,JAPAN_WEST
,ASIA_SOUTH_EAST
,KOREA_CENTRAL
,KOREA_SOUTH
,FRANCE_CENTRAL
,FRANCE_SOUTH
,SOUTH_AFRICA_NORTH
,SOUTH_AFRICA_WEST
,UAE_CENTRAL
,UAE_NORTH
, orQATAR_CENTRAL
.regionName
string Cloud provider region in which the Encryption At Rest private endpoint is located.
One of: Microsoft Azure Regions.
Values are
US_CENTRAL
,US_EAST
,US_EAST_2
,US_NORTH_CENTRAL
,US_WEST
,US_SOUTH_CENTRAL
,EUROPE_NORTH
,EUROPE_WEST
,US_WEST_CENTRAL
,US_WEST_2
,US_WEST_3
,CANADA_EAST
,CANADA_CENTRAL
,BRAZIL_SOUTH
,BRAZIL_SOUTHEAST
,AUSTRALIA_CENTRAL
,AUSTRALIA_CENTRAL_2
,AUSTRALIA_EAST
,AUSTRALIA_SOUTH_EAST
,GERMANY_WEST_CENTRAL
,GERMANY_NORTH
,SWEDEN_CENTRAL
,SWEDEN_SOUTH
,SWITZERLAND_NORTH
,SWITZERLAND_WEST
,UK_SOUTH
,UK_WEST
,NORWAY_EAST
,NORWAY_WEST
,INDIA_CENTRAL
,INDIA_SOUTH
,INDIA_WEST
,CHINA_EAST
,CHINA_NORTH
,ASIA_EAST
,JAPAN_EAST
,JAPAN_WEST
,ASIA_SOUTH_EAST
,KOREA_CENTRAL
,KOREA_SOUTH
,FRANCE_CENTRAL
,FRANCE_SOUTH
,SOUTH_AFRICA_NORTH
,SOUTH_AFRICA_WEST
,UAE_CENTRAL
,UAE_NORTH
, orQATAR_CENTRAL
.
atlas api createEncryptionAtRestPrivateEndpoint --help
import (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
client, err := sdk.NewClient(
sdk.UseOAuthAuth(clientID, clientSecret),
sdk.UseBaseURL(url))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.CreateEncryptionAtRestPrivateEndpointApiParams{}
sdkResp, httpResp, err := client.EncryptionatRestusingCustomerKeyManagementApi.
CreateEncryptionAtRestPrivateEndpointWithParams(ctx, params).
Execute()
}
curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints" \
-d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints" \
-d '{ <Payload> }'
{
"regionName": "US_CENTRAL"
}
{
"regionName": "US_CENTRAL"
}
{
"cloudProvider": "AZURE",
"errorMessage": "string",
"id": "32b6e34b3d91647abb20e7b8",
"regionName": "US_CENTRAL",
"status": "INITIATING",
"privateEndpointConnectionName": "string"
}
{
"cloudProvider": "AZURE",
"errorMessage": "string",
"id": "32b6e34b3d91647abb20e7b8",
"regionName": "US_CENTRAL",
"status": "INITIATING",
"privateEndpointConnectionName": "string"
}
{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}
{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}
{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}