Retrieve information about an API key

GET /groups/{groupId}/apps/{appId}/api_keys/{apiKeyId}

Token auth

Retrieve information about an API key.

Path parameters

groupId string Required

An Atlas Project/Group ID.
appId string Required

The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
apiKeyId string Required

The unique _id value of an API key

Responses

200 application/json

The API key was successfully retrieved.
Hide response attributes Show response attributes object
- _id string
- name string
- disabled string

GET /groups/{groupId}/apps/{appId}/api_keys/{apiKeyId}

curl \
 --request GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/api_keys/{apiKeyId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "_id": "string",
  "name": "string",
  "disabled": "string"
}