ベース URL: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/agentapikeys
このエンドポイントは、 Project Read Onlyロールを持つユーザーに制限されています。
リクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
プロジェクトID | string | エージェント API キーを所有するプロジェクトの一意の識別子。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print形式にするかどうかを示すフラグ。 |
| ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
名前 | タイプ | 説明 |
|---|---|---|
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 キーのソース。 指定できる値は以下のとおりです。
|
リクエストの例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/agentapikeys?pretty=true"
応答例
応答ヘッダー
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
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-1}", "createdBy" : "PUBLIC_API", "createdIpAddr" : "{IP-ADDRESS-1}", "createdTime" : 1520458807291, "createdUserId" : "{USER-ID-1}", "desc" : "Agent API Key for this project", "key" : "****************************8b87" }, { "_id" : "{AGENT-API-KEY-ID-2}", "createdBy" : "PROVISIONING", "createdTime" : 1508871142864, "desc" : "Generated by Provisioning", "key" : "****************************39fe" }, { "_id" : "{AGENT-API-KEY-ID-3}", "createdBy" : "USER", "createdIpAddr" : "{IP-ADDRESS-2}", "createdTime" : 1507067499083, "createdUserId" : "{USER-ID-2}", "desc" : "Initial API Key", "key" : "****************************70d7" } ]