Unassign One Organization API Key from One Project¶
Base URL: https://cloud.mongodb.com/api/atlas/v1.0
Resource¶
DELETE /orgs/{GROUP-ID}/apiKeys/{API-KEY-ID}
Request Path Parameters¶
| Name | Type | Description |
|---|---|---|
GROUP-ID | string | Unique identifier for the Project you wish to unassign from the API key. Use the /groups endpoint to retrieve all organizations to which the authenticated user has access. |
API-KEY-ID | string | Unique identifier for the API key you want to update. Use the /groups/{GROUP-ID}/apiKeys endpoint to retrieve all API keys to which the authenticated user has access for the specified organization. |
Request Query Parameters¶
This endpoint may use any of the HTTP request query parameters available to all Atlas API resources. These are all optional.
| Name | Type | Necessity | Description | Default | ||||
|---|---|---|---|---|---|---|---|---|
| pageNum | integer | Optional | Page number (1-based). | 1 | ||||
| itemsPerPage | integer | Optional | Maximum number of items to return, up to a maximum of 100. | 100 | ||||
includeCount | boolean | Optional | Specifies whether the response returns the totalCount field. | true | ||||
| pretty | boolean | Optional | Indicates whether the response body should be in a prettyprint format. | false | ||||
| envelope | boolean | Optional | Flag indicating if Atlas should wrap the response in a JSON envelope. Some API clients cannot access the HTTP response headers or
status code. To remediate this, set For endpoints that return one result, the response body includes:
For endpoints that return a list of results, the results object is an envelope. Atlas adds the status field to the response body. | false |
Request Body Parameters¶
This endpoint doesn't use HTTP request body parameters.
Response¶
Example Request¶
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include \ 5 --request DELETE "https://cloud.mongodb.com/api/atlas/v1.0/groups/5953c5f380eef53887615f9a/apiKeys/5d1d12c087d9d63e6d682438"
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 200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes}
Response Body¶
This endpoint does not return a response body.
Give Feedback