Navigation

Get All API Keys for User

Important

Personal API Keys are deprecated; use Programmatic API Keys instead. You cannot create new Personal API Keys, but existing Personal API Keys continue to function.

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

This endpoint retrieves the API keys for a specific Cloud Manager user. You must be the Cloud Manager user specified in the digest authentication to successfully use this endpoint.

Note

You must have access to an a public API key generated from the GUI by your administrator before you can successfully use this endpoint. See Limit API Operations to Whitelisted IPv4 Addresses for instructions.

Resource

GET /users/{USER-ID}/keys

Request Parameters

Request Path Parameters

Path Element Required/Optional Description
USER-ID Required.

The unique identifier for your Cloud Manager user.

Use the /users/byName/{USER-NAME} endpoint to retrieve your user ID. Your user ID corresponds to the id field returned in the response from that 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 a list of results, the results object is an envelope. Cloud Manager adds the status field to the response body.

false

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response

Response Document

The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.

Name Type Description
results object array This array includes one object for each item detailed in the results Embedded Document section.
links object array This array includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
totalCount number The count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

results Embedded Document

Each element in the results array is one API key.

Name Type Description
createdAt timestamp The time the API key was created.
description string Description of the API key.
enabled boolean Indicates whether the API key is enabled.
id string The unique identifier of the API key.
lastUsed string The ISO8601 timestamp representing the date and time the API key was last used.
obfuscatedKey string The obfuscated API key. Cloud Manager only displays the full API key immediately after key creation.
usedCount number The number of times that the API key has been used by the associated user.
userId string The user ID associated with the API key.

Example Request

curl --digest --user "{username}:{apiKey}" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --request GET "https://cloud.mongodb.com/api/public/v1.0/users/5af9a1d29cc0cdb6ac0bf3f8/keys/"

Example Response

{
    "links": [
        {
            "href": "https://cloud.mongodb.com/api/public/v1.0/users/5af9a1d29cc0cdb6ac0bf3f8/keys?pageNum=1&itemsPerPage=100",
            "rel": "self"
        }
    ],
    "results": [
        {
            "createdAt": "2018-05-14T14:45:22Z",
            "description": "Staging Application",
            "enabled": true,
            "id": "5af9a1d29cc0cdb6acdca6d5",
            "lastUsed": "2018-05-14T14:45:23Z",
            "obfuscatedKey": "********-****-****-92732876eeae",
            "usedCount": 7,
            "userId": "5af9a1d29cc0cdb6ac0bf3f8"
        },
        {
            "createdAt": "2017-02-02T21:35:06Z",
            "description": "Production Application",
            "enabled": true,
            "id": "5af9a1d29cc0cdb6acce1c30",
            "lastUsed": "2018-05-14T14:45:47Z",
            "obfuscatedKey": "********-****-****-4c5d3fc98d30",
            "usedCount": 69,
            "userId": "5af9a1d29cc0cdb6ac0bf3f8"
        }
    ],
    "totalCount": 2
}