Navigation

Delete an Online Archive

Beta

Online archive is available as a Beta feature. The feature and the corresponding documentation may change at any time during the Beta stage.

You can delete an online archive from the API or the Atlas UI. You must have the GROUP_DATA_ACCESS_ADMIN (Project Data Access Admin) role to delete an online archive.

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.

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.

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

Syntax

DELETE /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/onlineArchives/{ARCHIVE-ID}

Request Parameters

Request Path Parameters

Path Element Necessity Description
GROUP-ID Required Unique identifier of the project that contains the specified cluster.
CLUSTER-NAME Required Name of the cluster that contains the collection.
ARCHIVE-ID Required Unique identifier of the online archive to delete.

Request Query Parameters

The following query parameters are optional:

Query Parameter Type Description Default
pretty boolean Displays response in a prettyprint format. false
envelope boolean Specifies whether or not to wrap the response in an envelope. false

Response Elements

The HTTP response returns an empty JSON document.

Examples

The following example request deletes the online archive by its ID.

Example Request

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header "Content-Type: application/json" \
--include \
--request DELETE "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/onlineArchives/{ARCHIVE-ID}"

Error Codes

If the request fails, it returns the following error:

Error Code Description
RESOURCE_NOT_FOUND The specified archive ID is not valid.