Navigation

Delete One Data Lake

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.

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

For complete documentation on configuring API access for an Atlas project, see Configure Atlas API Access.

Base URL

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

Use this endpoint to delete a specific Atlas Data Lake associated with an Atlas project.

Syntax

DELETE /groups/{GROUP-ID}/dataLakes/{NAME}

Request Path Parameters

Path ElementRequired/OptionalDescription
GROUP-IDRequired.The unique identifier for the project.
NAMERequire

The name of the Data Lake that you want to delete.

You can use the Get All Data Lakes endpoint to retrieve all Atlas Data Lakes associated with the project. The name field in the response of that endpoint corresponds to the NAME parameter here.

Request Query Parameters

The following query parameters are optional:

Query ParameterTypeDescriptionDefault
prettybooleanDisplays response in a prettyprint format.false
envelopebooleanSpecifies whether or not to wrap the response in an envelope.false

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response

This endpoint returns an empty JSON document.

Example

Request

curl -u "username:apiKey" --digest \
 --header "Accept: application/json" \
 --header "Content-Type: application/json" \
 --request DELETE "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/dataLakes/{NAME}?pretty=true"

Response

{}