Delete a User API Key¶

On this page

Resource
Request Parameters
Response
Example Request
Example Response

Important

Personal API keys are deprecated, use Programmatic API Keys instead.

The Atlas API uses HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.

For complete documentation on configuring API access for an Atlas project, see Configure Atlas API Access.

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

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

Resource¶

copy

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

Request Parameters¶

Request Path Parameters¶

Path Element	Required/Optional	Description
`USER-ID`	Required.	The unique identifier for your MongoDB user. Specify the value of the `id` field for the desired user in the response body of the /orgs/{ORG-ID}/users endpoint.
`KEY-ID`	Required	The unique identifier for the user API key that you want to delete. Specify the value of the `id` field for the desired key in the response body of the users/{USER-ID}/keys endpoint.

Request Query Parameters¶

The following query parameters are optional:

Query Parameter	Type	Description	Default
`pretty`	boolean	Displays response in a prettyprint format.	`false`
`envelope`	boolean	Specifies whether or not to wrap the response in an envelope.	`false`

Request Body Parameters¶

This endpoint does not use HTTP request body parameters.

Response¶

This endpoint returns an empty JSON document.

Example Request¶

The following example disables a user API key:

copy

curl -X DELETE --digest -i -u "{PUBLIC-KEY}:{PRIVATE-KEY}" \
  "https://cloud.mongodb.com/api/atlas/v1.0/users/{USER-ID}/keys/{KEY-ID}"

Example Response¶

This endpoint does not return a response body.

← Enable/Disable a User API Key Personal API Key Whitelist →