1 つのエージェント API キーを削除
MongoDB Ops Manager v6.0 は 1 月 2025 で EOL になります。 可能な限りすぐに MongoDB Ops Manager の上位バージョンにアップグレードしてください。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
DELETE /groups/{PROJECT-ID}/agentapikeys/{API-AGENT-KEY-ID}
このエンドポイントは、 Project Ownerロールを持つユーザーに制限されています。
リクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
プロジェクトID | string | エージェント API キーを所有するプロジェクトの一意の識別子。 |
API-エージェントキー ID | string | エージェント API キーの一意の識別子です。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print にするかどうかを示すフラグ 形式。 | false | ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
| false |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
このエンドポイントには、応答要素がありません。
リクエストの例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --include \ --request DELETE "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/agentapikeys/{API-AGENT-KEY-ID}?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}
レスポンス本体
このエンドポイントは、レスポンス本体を返しません。