Navigation

Delete a User API Key

Important With Circle IconCreated with Sketch.Important
Atlas deprecated Personal API keys
  • You can't create new Personal API Keys.
  • You can't access the API using your existing Personal API Keys starting March 1, 2021.
  • You must update any existing scripts or tools to use Programmatic API Keys instead.

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

To learn how to configure API access for an Atlas project, see Configure Atlas API Access.

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.

DELETE /users/{USER-ID}/keys/{KEY-ID}
Path ElementRequired/OptionalDescription
USER-IDRequired.The unique identifier for your database user. Specify the value of the id field for the desired user in the response body of the /orgs/{ORG-ID}/users endpoint.
KEY-IDRequiredThe 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.

The following query parameters are optional:

Query ParameterTypeDescriptionDefault
prettybooleanDisplays response in a prettyprint format.false
envelopebooleanSpecifies whether or not to wrap the response in an envelope.false

This endpoint does not use HTTP request body parameters.

This endpoint returns an empty JSON document.

The following example disables a user API key:

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

This endpoint does not return a response body.

Give Feedback