Docs Menu

Delete an App (App Services API)

On this page

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

You can use the App Services Admin API to delete a server-side App.

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 App.

1

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, Atlas App Services 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
See also:
2

To delete a App you need the Project ID (sometimes referred to as the Group ID) of the MongoDB Atlas project that contains the app. You will include this ID in the URL of API requests.

3

To delete an App you will need to find the Application ID of the app.

To find an Application ID, make a request to the App Services 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 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.

4

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

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 Atlas App Services returns a 204 response.

←  Delete an App with Realm CLIAtlas Device Sync Overview →
Give Feedback
© 2022 MongoDB, Inc.

About

  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2022 MongoDB, Inc.