MongoDB Atlas App Services Admin API
3.0

ベース URL

https://services.cloud.mongodb.com/api/admin/v3.0

サポート終了（EOL）に関する通知

アプリサービスの有効期限（EOL） Atlas Device Sync、SDK、データAPI、 GraphQL、静的ホスティング、HTTPS エンドポイントは、30 、日で EOL2025 に達しました。データベース trigger は引き続き使用できます。

これにより、認証やユーザー管理、関数、ワイヤプロトコル、データアクセス権限など、追加の App Service 機能に影響します。これらの機能に関連するAPIエンドポイントは非推奨です。

詳細については、非推奨ページ（ https://www.mongodb.com/ja-jp/docs/atlas/app-services/deprecation/）を参照してください。

API Overview

App Services Admin API を使用すると、HTTPS 経由でプログラムによって管理タスクを実行できます。これには、次のような定義と構成が含まれます。

アプリの配置とセキュリティ
API とエンドポイント
認証とユーザー管理
データソース
デバイスの同期
環境
関数
ログ
ルール
Schemas
静的ホスティング
トリガー
使用状況と課金の指標
Values & Secrets

Admin APIは、アプリケーション開発、構成、および配置に使用されます。Admin APIで構成した機能を使用するには、クライアントアプリケーションはアプリ固有の HTTPS APIに接続します。

プロジェクト ID およびアプリケーション ID

注: 「プロジェクトID」と「グループID」という用語は同じ意味で使用されます。

Atlas App Services Admin API エンドポイントでは、URL に次の 2 つのパラメータを含めることが頻繁に必要になります。

Atlas のプロジェクトID（別名、グループID）
App Services アプリケーションID

プロジェクトID

プロジェクト ID は、MongoDB Atlas ダッシュボードまたは MongoDB Atlas CLI から見つけることができます。

アプリケーションID

アプリケーションIDを見つけるには、プロジェクトの List Apps エンドポイントにリクエストを送信します。このリクエストを行うには access_token が必要です。取得方法については、管理APIセッションアクセストークンを取得するを参照してください。

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

これにより、指定されたプロジェクト（グループ）内の各 App Services アプリを記述するオブジェクトのリストが返されます。管理 API リクエストの場合、アプリケーション ID は client_app_id ではなく、_id フィールドの ObjectId 値です。

[
  {
    "_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": ""
  }
]

Admin API セッションアクセストークンを取得する

App Services Admin API へのすべてのリクエストには、MongoDB Cloud API によって発行された有効で期限切れでないアクセストークンが含まれている必要があります。Bearer 認証スキームを使用して、各リクエストの Authorization ヘッダーにこのトークンを含めます。

MongoDB Atlas がトークンを取得するには、有効な MongoDB Atlas プログラム API キーが必要です。

API キーペアを取得したら、認証エンドポイントを呼び出します。

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

認証に成功すると、App Services は JSON 応答ドキュメントの一部としてアクセストークンを返します。

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

access_token は、 Admin APIと対話するための期間限定の認可を表します。リクエストを認証するには、Bearer トークン Authorization ヘッダーにトークンを含めます。

Authorization: Bearer <access_token>

Admin API セッションアクセストークンを更新する

セッションアクセストークンは発行後 30 分で期限切れになります。ログインすると、レスポンスには新しいアクセストークンを取得するために使用できる refresh_token も含まれます。認証情報を使用して一度だけログインするだけで済むので便利です。その後は、リフレッシュトークンが有効である限り、そのトークンを使用して再認証を行うことができます。

デフォルトでは、リフレッシュトークンは発行後 60 日で期限切れになります。リフレッシュトークンの有効期限は、最短 30 分から最長 5 年までカスタマイズできます。

認証を更新して新しい access_token を取得するには、Authorization ヘッダーに refresh_token を指定して認証セッションエンドポイントを呼び出します。

curl --request POST \
  --header 'Authorization: Bearer <refresh_token>' \
  https://services.cloud.mongodb.com/api/admin/v3.0/auth/session

更新トークンが有効な場合、レスポンス本文には今後 30 分間有効な新しい access_token が含まれます。

{
  "access_token": "<access_token>"
}

これは、このAPIドキュメントのバージョン 3.0 です。9 月 23、2025 の最終更新。

MongoDB Atlas App Services Admin API 3.0