Navigation

Delete One Interface Endpoint

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.

Remove one interface endpoint from a private endpoint connection in an Atlas project.

The Atlas API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.

To learn how to configure API access for an Atlas project, see Configure Atlas API Access.

Required Roles

You must have one of the following roles to successfully call this resource:

Request

Base URL: https://cloud.mongodb.com/api/atlas/v1.0

DELETE /groups/{GROUP-ID}/privateEndpoint/{privateLinkId}/interfaceEndpoints/{interfaceEndpointId}

Request Path Parameters

Path Parameter Required/Optional Description
GROUP-ID Required Unique identifier for the project.
privateLinkId Required Unique identifier of the AWS PrivateLink connection.
interfaceEndpointId string Unique identifier of the interface endpoint.

Request Query Parameters

This endpoint might use any of the HTTP request query parameters available to all Atlas API resources. All of these are optional.

Name Type Necessity Description Default
pretty boolean Optional Flag indicating whether the response body should be in a prettyprint format. false
envelope boolean Optional

Flag indicating if Atlas should wrap the response in a JSON envelope.

This option may be needed for some API clients. These clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return one result, the response body includes:

status HTTP response code
envelope Expected response body
false

Request Body Parameters

This endpoint doesn’t use HTTP request body parameters.

Response Elements

This endpoint does not have response elements.

Example Request

1
2
3
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --request DELETE "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateEndpoint/{privateLinkId}/interfaceEndpoints/{interfaceEndpointId}

Example Response

This endpoint returns an empty JSON object.