Docs Menu
Docs Home
/
MongoDB Ops Manager
/ / / /

1 つのグローバル API キーを削除

項目一覧

  • Resource
  • 必須のロール
  • Request Parameters
  • リクエスト パス パラメーター
  • リクエスト クエリ パラメータ
  • リクエスト ボディ パラメータ
  • 応答
  • リクエストの例
  • 応答例
  • 応答ヘッダー
  • レスポンス本体

1 つのグローバル APIキーを、そのキーの一意の識別子を使用して MongoDB Ops Manager から削除します。

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

DELETE /admin/apiKeys/{API-KEY-ID}

このエンドポイントを呼び出すAPIキーに Global Ownerロールが必要です。

すべてのリクエスト パス パラメータが必要です。

名前
タイプ
説明
API-KEY-ID
string
削除するAPIキーの一意の識別子。 /admin/apiKeysエンドポイントを使用して、認証済みユーザーがアクセスできるすべてのAPIキーを取得します。

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

名前
タイプ
必要性
説明
default
pretty
ブール値
任意
レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。
false
envelope
ブール値
任意

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

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

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

名前
説明
状態
HTTPレスポンス コード
envelope
期待される応答本体
false

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

このエンドポイントには、応答要素がありません。

1curl --user "{USERNAME}:{APIKEY}" --digest \
2 --header "Accept: application/json" \
3 --header "Content-Type: application/json" \
4 --include \
5 --request DELETE "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/{API-KEY-ID}?pretty=true"
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 204 No Content
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}

このエンドポイントは、レスポンス本体を返しません。

戻る

1 つのグローバル API キーを更新