Delete One Global API Key¶

On this page

Resource
Required Roles
Request Parameters
Response
Example Request
Example Response
- Response Header
- Response Body

Delete one Global API Key from Ops Manager using the unique identifier for that Key.

Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource¶

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

Required Roles¶

Requires that the API Key calling this endpoint have the Global Owner role.

Request Parameters¶

Request Path Parameters¶

All request path parameters are required.

Name	Type	Description
`API-KEY-ID`	string	Unique identifier for the API key you want to delete. Use the /admin/apiKeys endpoint to retrieve all API keys to which the authenticated user has access.

Request Query Parameters¶

The following query parameters are optional:

Name Type Necessity Description Default

pretty boolean Optional Flag indicating whether the response body should be in a prettyprint format. false

envelope

boolean

Optional

Flag that indicates whether or not to wrap the response in an envelope.

Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return one result, the response body includes:

Name	Description
status	HTTP response code
envelope	Expected response body

false

Request Body Parameters¶

This endpoint does not use HTTP request body parameters.

Response¶

This endpoint does not have response elements.

Example Request¶

copy

curl --user "{USERNAME}:{APIKEY}" --digest \
 --header "Accept: application/json" \
 --header "Content-Type: application/json" \
 --include \
 --request DELETE "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/{API-KEY-ID}?pretty=true"

Example Response¶

Response Header¶

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}

Response Body¶

This endpoint does not return a response body.

← Update One Global API Key Global Programmatic API Key Access List →