1 つのエージェント API キーを作成

Cloud Manager は、 2024年8月30日でMongoDB 3.6と4.0のオートメーション、バックアップおよびモニタリングのサポートを終了します。 MongoDB の配置をアップグレードするか、Atlas に移行してください。

ベース URL: https://cloud.mongodb.com/api/public/v1.0

Resource

POST /groups/{PROJECT-ID}/agentapikeys

このエンドポイントは、 Project Ownerロールを持つユーザーに制限されています。

リクエストパスパラメーター

名前	タイプ	説明
プロジェクトID	string	エージェント API キーを所有するプロジェクトの一意の識別子。

リクエストクエリパラメータ

次のクエリパラメータは任意です。

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

false

envelope

ブール値

任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部の APIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリでenvelope=trueを設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前	説明
`status`	HTTPレスポンスコード
`content`	期待される応答本体

false

リクエストボディパラメータ

名前	タイプ	説明
desc	string	このエージェント API キーのラベル。

応答

名前	タイプ	説明
id	string	このエージェント API キーの一意の識別子。
キー	string	エージェント API キー。このエージェント API キーを作成すると、後続のリクエストによってエージェント API キーの最後の 4 文字が返されます。
desc	string	このエージェント API キーのラベル。 1,000 文字に制限されます。
createdTime	string	エージェントAPIキーが作成されたときの ISO 8601の日付と時刻形式の UTCのタイムスタンプ。
createdUserId	string	このエージェント API キーを作成したユーザーの一意の識別子。
createdIpAddr	string	このエージェント API キーを作成したIPアドレス。
createdBy	string	このエージェント API キーのソース。指定できる値は以下のとおりです。 `USER` `OLD_KEY` `PROVISIONING` `ATLAS` `PUBLIC_API`

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/agentapikeys?pretty=true" \
     --data '
       {
         "desc": "Agent API Key for this project"
       }'

応答例

応答ヘッダー

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

レスポンス本体

{
  "_id" : "{AGENT-API-KEY-ID}",
  "createdBy" : "PUBLIC_API",
  "createdIpAddr" : "{IP-ADDRESS}",
  "createdTime" : 1520458807291,
  "createdUserId" : "{USER-ID}",
  "desc" : "Agent API Key for this project",
  "key" : "{AGENT-API-KEY}"
}

戻る

タイプによる取得

すべての API キーを取得する