Navigation

Delete a User API Key

Important

Cloud Manager deprecated Personal API Keys. Use Programmatic API Keys instead. Though you can’t create new Personal API Keys, existing Personal API Keys continue to function.

Base URL: https://cloud.mongodb.com/api/public/v1.0

Use this endpoint to delete a user’s personal API key. You must be the user specified in the digest authentication to successfully use this endpoint.

Resource

DELETE /users/{USER-ID}/keys/{KEY-ID}

Request Parameters

Request Path Parameters

Path Element Necessity Description
USER-ID Required Unique identifier for your MongoDB database user. Specify the value of the id field for the desired user in the response body of the Get all Personal API Keys endpoint.
KEY-ID Required Unique identifier for the personal API key that you want to delete. Specify the value of the id field for the desired key in the response body of the Get all Personal API Keys endpoint.

Request Query Parameters

The following query parameters are optional:

Name Type Description Default
pageNum integer Page number (1-based). 1
itemsPerPage integer Number of items to return per page, up to a maximum of 500. 100
pretty boolean Indicates whether the response body should be in a prettyprint format. false
envelope boolean

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, response body includes:

status HTTP response code
envelope Expected response body

For endpoints that return a list of results, the results object is an envelope. Cloud Manager adds the status field to the response body.

None

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Example Request

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request DELETE "https://cloud.mongodb.com/api/public/v1.0/users/{USER-ID}/keys/{KEY-ID}"

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.