# MongoDB Atlas App Services Admin API ## Description This is version `3.0` of this API documentation. Last update on Sep 23, 2025. # End-of-Life (EOL) Notice **APP SERVICES HAVE REACHED END-OF-LIFE (EOL)** Atlas Device Sync, SDKs, Data API, GraphQL, Static Hosting, and HTTPS Endpoints have reached EOL on September 30, 2025. Database triggers remain available. This impacts additional App Service capabilities, including authentication and user management, functions, Wire Protocol, and data access permissions. API endpoints related to these features are deprecated. For more information, refer to the Deprecation page: https://www.mongodb.com/docs/atlas/app-services/deprecation/. # API Overview The App Services Admin API lets you programmatically perform administrative tasks over HTTPS. This includes defining & configuring things like: - App Deployment & Security - APIs & Endpoints - Authentication & User Management - Data Sources - Device Sync - Environments - Functions - Logs - Rules - Schemas - Static Hosting - Triggers - Usage & Billing Metrics - Values & Secrets The Admin API is for application development, configuration, and deployment. To use the features you configure with the Admin API, client applications connect with an HTTPS API specific to your App. ## Project & Application IDs **Note**: The terms _Project ID_ and _Group ID_ are interchangeable. Atlas App Services Admin API endpoints frequently require you to include two parameters in the URL: - Your Atlas _Project ID_ (also sometimes called a _Group ID_) - Your App Services _Application ID_ ### Project ID You can find your Project ID from the MongoDB Atlas dashboard or with the MongoDB Atlas CLI. ### Application ID To find an Application ID, make a request to the [List Apps](#operation/adminListApplications) endpoint for your project. You'll need an `access_token` to make this request. To learn how to get one, see [Get an Admin API Session Access Token](#get-an-admin-api-session-access-token). ```sh curl --request GET \ --header 'Authorization: Bearer ' \ https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps ``` This will return a list of objects describing each App Services App in the provided project/group. For Admin API requests, your Application ID is the ObjectId value in the `_id` field, _not_ the `client_app_id`. ```json [ { "_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": "" } ] ``` ## Get an Admin API Session Access Token Every request to the App Services Admin API must include a valid, unexpired access token issued by the MongoDB Cloud API. You include this token in the `Authorization` header of each request using the bearer auth scheme. You need a valid [MongoDB Atlas programmatic API key](https://docs.atlas.mongodb.com/configure-api-access) for MongoDB Atlas to get a token. Once you have an API key pair, call the authentication endpoint: ```shell curl --request POST \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --data '{"username": "", "apiKey": ""}' \ https://services.cloud.mongodb.com/api/admin/v3.0/auth/providers/mongodb-cloud/login ``` If authentication succeeds, App Services returns an access token as part of the JSON response document: ```json { "access_token": "", "refresh_token": "", "user_id": "", "device_id": "" } ``` The `access_token` represents a limited-time authorization to interact with the Admin API. To authenticate a request, include the token in a [Bearer token](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) `Authorization` header. ```http Authorization: Bearer ``` ## Refresh an Admin API Session Access Token Session access tokens expire 30 minutes after they are issued. When you login, the response also includes a `refresh_token` that you can use to get a new access token. This is useful because you only need to log in with credentials one time. After that you can use the refresh token to re-authenticate for as long as its valid. By default, refresh tokens expire 60 days after being issued. You can customize refresh token expiration for a minimum of 30 minutes or a maximum of 5 years. To refresh your authentication and get a new `access_token`, call the auth session endpoint with your `refresh_token` in the `Authorization` header: ```shell curl --request POST \ --header 'Authorization: Bearer ' \ https://services.cloud.mongodb.com/api/admin/v3.0/auth/session ``` If the refresh token is valid, the response body includes a new `access_token` that's valid for the next 30 minutes: ```json { "access_token": "" } ``` ## Servers - The root API resource and starting point for the App Services API.: https://services.cloud.mongodb.com/api/admin/v3.0 (The root API resource and starting point for the App Services API.) ## Authentication The API accepts 2 different authentication methods: - Token auth (http) - Refresh auth (http) ## Endpoints - [Administrator](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-admin.md) - [[Deprecated] API Keys](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-apikeys.md) - [Applications](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-apps.md) - [[Deprecated] Authentication Providers](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-authproviders.md) - [Billing](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-billing.md) - [Custom User Data](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-custom-user-data.md) - [Deployment](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-deploy.md) - [[Deprecated] Data API](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-data-api.md) - [Dependencies](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-dependencies.md) - [Endpoints](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-endpoints.md) - [Event Subscriptions](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-event-subscriptions.md) - [Environments](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-environments.md) - [Functions](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-functions.md) - [[Deprecated] GraphQL API](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-graphql.md) - [Hosting](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-hosting.md) - [Logs](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-logs.md) - [Log Forwarding](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-log_forwarders.md) - [Metrics](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-metrics.md) - [Rules](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-rules.md) - [[Deprecated] Schemas](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-schemas.md) - [Secrets](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-secrets.md) - [Security](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-security.md) - [Data Sources & [Deprecated] Services](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-services.md) - [[Deprecated] Sync](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-sync.md) - [Triggers](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-triggers.md) - [[Deprecated] Users](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-users.md) - [[Deprecated] User Confirmation](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-email.md) - [Values](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-values.md) - [[Deprecated] Push Notifications](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-notifications.md) - [[Deprecated] Webhooks](https://www.mongodb.com/docs/api/doc/atlas-app-services-admin-api-v3/group/endpoint-webhooks.md) [Powered by Bump.sh](https://bump.sh)