Navigation
This version of the documentation is archived and no longer supported. It will be removed on EOL_DATE. To learn how to upgrade your version of MongoDB Ops Manager, refer to the upgrade documentation.
You were redirected from a different version of the documentation. Click here to go back.
This version of the manual is no longer supported. It will be removed on EOL_DATE.

Get All Agent API Keys for One Project

Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

GET /groups/{GROUP-ID}/agentapikeys

This endpoint is restricted to users with the Project Read Only role.

Request Path Parameters

Name Type Description
GROUP-ID string Unique identifier of the project that owns the Agent API Key.

Request Query Parameters

This endpoint may use any of the HTTP request query parameters available to all Ops Manager API resources. These are all optional.

Name Type Description Default
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 one result, the response body includes:

Name Description
status HTTP response code
envelope Expected response body
false

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response

Name Type Description
id string Unique identifier of this Agent API Key.
key string

Agent API Key.

Note

After creating this Agent API Key, subsequent requests return the last four characters of Agent API Keys.

desc string Label for this Agent API Key. Limited to 1,000 characters.
createdTime string Timestamp in ISO 8601 date and time format when the Agent API Key was created.
createdUserId string Unique identifier of user who created this Agent API Key.
createdIpAddr string IP address that created this Agent API Key.
createdBy string

Source of this Agent API Key. Accepted values are:

  • USER
  • OLD_KEY
  • PROVISIONING
  • ATLAS
  • SERVER_POOLS
  • PUBLIC_API

Example Request

curl --user "{USERNAME}:{APIKEY}" --digest \
 --header "Content-Type: application/json" \
 --include \
 --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{GROUP-ID}/agentapikeys?pretty=true"

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

[ {
  "_id" : "{AGENT-API-KEY-ID-1}",
  "createdBy" : "PUBLIC_API",
  "createdIpAddr" : "{IP-ADDRESS-1}",
  "createdTime" : 1520458807291,
  "createdUserId" : "{USER-ID-1}",
  "desc" : "Agent API Key for this project",
  "key" : "****************************8b87"
}, {
  "_id" : "{AGENT-API-KEY-ID-2}",
  "createdBy" : "PROVISIONING",
  "createdTime" : 1508871142864,
  "desc" : "Generated by Provisioning",
  "key" : "****************************39fe"
}, {
  "_id" : "{AGENT-API-KEY-ID-3}",
  "createdBy" : "USER",
  "createdIpAddr" : "{IP-ADDRESS-2}",
  "createdTime" : 1507067499083,
  "createdUserId" : "{USER-ID-2}",
  "desc" : "Initial API Key",
  "key" : "****************************70d7"
} ]