Delete One Interface Endpoint

Important With Circle IconCreated with Sketch.Important
Info With Circle IconCreated with Sketch.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.

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

DELETE /groups/{GROUP-ID}/privateEndpoint/{privateLinkId}/interfaceEndpoints/{interfaceEndpointId}
Path ParameterRequired/OptionalDescription
GROUP-IDRequiredUnique identifier for the project.
privateLinkIdRequiredUnique identifier of the AWS PrivateLink connection.
interfaceEndpointIdstringUnique identifier of the interface endpoint.

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

prettybooleanOptionalFlag indicating whether the response body should be in a prettyprint format.false

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:

statusHTTP response code
envelopeExpected response body

This endpoint doesn't use HTTP request body parameters.

This endpoint does not have response elements.

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2 --header "Accept: application/json" \
3 --request DELETE "{GROUP-ID}/privateEndpoint/{privateLinkId}/interfaceEndpoints/{interfaceEndpointId}

This endpoint returns an empty JSON object.

Give Feedback