Navigation

Get All API Keys for User

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.

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

This endpoint retrieves a list of obfuscated API keys for the specified Atlas user. The specified Atlas user must correspond to the Atlas user in the digest authentication component to successfully use this endpoint.

Info With Circle IconCreated with Sketch.Note

You must have access to an API key that your administrator has generated from the UI before you can successfully use this endpoint. To learn how to get an API Key, see generate an API key.

GET /users/{USER-ID}/keys
Path ElementRequired/OptionalDescription
USER-IDRequired.

The unique identifier for your Atlas 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.

The following query parameters are optional:

NameTypeNecessityDescriptionDefault
pageNumintegerOptionalPage number, starting with one, that Atlas returns of the total number of objects.1
itemsPerPageintegerOptionalNumber of items that Atlas returns per page, up to a maximum of 500.100
includeCountbooleanOptionalFlag that indicates whether Atlas returns the totalCount parameter in the response body.true
prettybooleanOptionalFlag that indicates whether Atlas returns the JSON response in the prettyprint format.false
envelopebooleanOptional

Flag that indicates whether Atlas wraps 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.

Endpoints that return a list of results use the results object as an envelope. Atlas adds the status parameter to the response body.

false

This endpoint does not use HTTP request body parameters.

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.

NameTypeDescription
resultsobject arrayIncludes one object for each item detailed in the results array section.
linksobject arrayIncludes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
totalCountnumberCount 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.

Each element in the results array is one API key.

NameTypeDescription
createdAttimestampThe time the API key was created.
descriptionstringDescription of the API key.
enabledbooleanIndicates whether the API key is enabled.
idstringThe unique identifier of the API key.
lastUsedstringThe ISO8601 timestamp representing the date and time the API key was last used.
obfuscatedKeystringThe obfuscated API key. Atlas only displays the full API key immediately after key creation.
usedCountnumberThe number of times that the API key has been used by the associated user.
userIdstringThe user ID associated with the API key.
curl --digest --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--request GET "https://cloud.mongodb.com/api/atlas/v1.0/users/{USER-ID}/keys"
{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas/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
}
Give Feedback