Delete a Realm App (Realm API)

On this page

Prerequisites

Procedure
Authenticate a MongoDB Atlas User
Get the Group ID
Get the Application ID
Delete the Realm App

You can use the Realm Admin API to delete a server-side Realm app.

Prerequisites

A MongoDB Atlas programmatic API key for the MongoDB Cloud account you wish to log in with. You must be a Project Owner of the Atlas project where you want to delete the Realm app.

Procedure

Authenticate a MongoDB Atlas User

Use your MongoDB Cloud API key pair to call the authentication endpoint:

curl --request POST \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{"username": "<Public API Key>", "apiKey": "<Private API Key>"}' \
  https://realm.mongodb.com/api/admin/v3.0/auth/providers/mongodb-cloud/login

If authentication succeeds, MongoDB Realm returns an access token as part of the JSON response document:

{
  "access_token": "<access_token>",
  "refresh_token": "<refresh_token>",
  "user_id": "<user_id>",
  "device_id": "<device_id>"
}

Save the access_token, which you'll use as the Bearer token to authenticate in the upcoming steps.

Tip

Get the Group ID

To delete a Realm app you will need to find the Group ID in Atlas.

Follow these steps and save the Group ID for the next steps.

Get the Application ID

To delete a Realm app you will need to find the Application ID of the app.

To find an Application ID, make a request to the Realm GET /groups/{groupid}/apps API endpoint.

This request has the following format, referencing the access_token and the Group ID:

curl --request GET \
  --header 'Authorization: Bearer <access_token>' \
  https://realm.mongodb.com/api/admin/v3.0/groups/{groupId}/apps

This will return a list of objects describing each Realm app in the provided group. For Admin API requests, your Application ID is the ObjectId value in the _id field, not the client_app_id.

Example

[
  {
      "_id": "5997529e46224c6e42gb6dd9",
      "group_id": "57879f6cc4b32dbe440bb8c5",
      "domain_id": "5886619e46124e4c42fb5dd8",
      "client_app_id": "myapp-abcde",
      "name": "myapp",
      "location": "US-VA",
      "deployment_model": "GLOBAL",
      "last_used": 1615153544,
      "last_modified": 0,
      "product": "standard",
      "environment": ""
  }
]

Find the app you want to delete and save the _id field for the last step.

Delete the Realm App

The API has an endpoint through which you can delete an Realm app. Your request should include:

The access_token from step 1 in a Bearer token Authorization header.
The Group ID/Project ID from step 2.
The Application ID from step 3.

curl --request DELETE 'https://realm.mongodb.com/api/admin/v3.0/groups/<GroupID>/apps/<ApplicationID>' \
  --header 'Authorization:  Bearer <access_token>' \
  --header 'Content-Type: application/json'

If your application deletes successfully, the MongoDB Realm returns a 204 response.

Tip