Delete Private Endpoint for Encryption at Rest Using Customer Key Management

DELETE /api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}

Digest auth

Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management.

Path parameters

groupId string Required

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.

Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
cloudProvider string Required

Human-readable label that identifies the cloud provider of the private endpoint to delete.

Value is AZURE.
endpointId string Required

Unique 24-hexadecimal digit string that identifies the private endpoint to delete.

Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.

Query parameters

envelope boolean

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.
pretty boolean

Flag that indicates whether the response body should be in the prettyprint format.

Default value is false.

application/vnd.atlas.2023-01-01+json

Body Required

Cloud provider of the private endpoints to delete and the list of cloud provider regions in which to delete the private endpoints.

cloudProvider string Required

Cloud service provider name.

Value is AZURE.
regions array[string]

List of regions.

Responses

204 application/vnd.atlas.2023-01-01+json

This endpoint does not return a response body.

Endpoint does not return a response body.
403 application/json

Forbidden.
Hide response attributes Show response attributes object
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32)
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string
  
  Application error message returned with this error.
500 application/json

Internal Server Error.
Hide response attributes Show response attributes object
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32)
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string
  
  Application error message returned with this error.

DELETE /api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}

atlas api encryptionAtRestUsingCustomerKeyManagement requestEncryptionAtRestPrivateEndpointDeletion --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20230101001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.RequestEncryptionAtRestPrivateEndpointDeletionApiParams{}
	httpResp, err := client.EncryptionatRestusingCustomerKeyManagementApi.
		RequestEncryptionAtRestPrivateEndpointDeletionWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}"

Request examples

{
  "cloudProvider": "AZURE",
  "regions": [
    "string"
  ]
}

Response examples (204)

{}

Response examples (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}