- API >
- Public API Resources >
- Projects and Users >
- Personal API Keys (Deprecated) >
- Delete a User API Key
Delete a User API Key¶
On this page
Important
Personal API Keys are deprecated; use Programmatic API Keys instead.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/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¶
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-index 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 For endpoints that return one result, response body includes:
For endpoints that return a list of results, the |
None |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.