Docs Menu
Docs Home
/
MongoDB Ops Manager
/ / / /

Get All Global API Keys

On this page

  • Resource
  • Required Roles
  • Request Parameters
  • Request Path Parameters
  • Request Query Parameters
  • Response
  • Response Document
  • results Embedded Document
  • Example Request
  • Example Response
  • Response Header
  • Response Body

Return all Global API Keys for Ops Manager.

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

GET /admin/apiKeys

Requires that the API Key calling this endpoint have the Global Read Only role.

This endpoint doesn't use HTTP request path parameters.

The following query parameters are optional:

Name
Type
Necessity
Description
Default
pageNum
number
Optional
One-based integer that returns a subsection of results.
1
itemsPerPage
number
Optional
Number of items to return per page, up to a maximum of 500.
100
pretty
boolean
Optional
Flag that indicates whether the response body should be in a prettyprint format.
false
envelope
boolean
Optional

Flag that 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. Ops Manager adds the status field to the response body.

false
backupJobsEnabledOnly
boolean
Optional
Flag indicating whether to exclude daemons not enabled for backing up databases from the response. Set this to false to include daemon configurations with the backupJobsEnabled flag set to false.
true

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
array
Array includes one object for each item detailed in the results Embedded Document section.
links
array
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
Integer 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.

Each result is one API key.

Name
Type
Description
desc
string
Description of this Global API Key.
id
string
Unique identifier for this Global API Key.
links
string
An array of documents, representing a link to one or more sub-resources and/or related resources such as list pagination. See Linking for more information.
privateKey
string
Redacted Private key for this Global API Key.
publicKey
string
Public key for this Global API Key.
roles
object array
Roles that this Global API Key has. This array returns all the Global roles the user has in Ops Manager.
roles.roleName
string

Name of the role. This resource returns all the roles the user has in Ops Manager. Possible values are:

Role Value in API
Role
GLOBAL_AUTOMATION_ADMIN
GLOBAL_BACKUP_ADMIN
GLOBAL_MONITORING_ADMIN
GLOBAL_OWNER
GLOBAL_READ_ONLY
GLOBAL_USER_ADMIN

Note

The user who makes the request can be formatted either as {USERNAME}:{APIKEY} or {PUBLIC-KEY}:{PRIVATE-KEY}.

1curl --user "{USERNAME}:{APIKEY}" --digest \
2 --header "Accept: application/json" \
3 --include \
4 --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys?pretty=true"
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}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
1{
2 "links" : [ {
3 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys?pretty=true&pageNum=1&itemsPerPage=100",
4 "rel" : "self"
5 } ],
6 "results" : [ {
7 "desc" : "Test Global API Key 1",
8 "id" : "5d669ce780eef52a42cf0e1e",
9 "links" : [ {
10 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d669ce780eef52a42cf0e1e",
11 "rel" : "self"
12 } ],
13 "privateKey" : "********-****-****-54d9792d337d",
14 "publicKey" : "zrefxaep",
15 "roles" : [ {
16 "roleName" : "GLOBAL_READ_ONLY"
17 }, {
18 "roleName" : "GLOBAL_BILLING_ADMIN"
19 } ]
20 }, {
21 "desc" : "Test Global API Key 2",
22 "id" : "5d6fec4180eef54728814b14",
23 "links" : [ {
24 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d6fec4180eef54728814b14",
25 "rel" : "self"
26 } ],
27 "privateKey" : "********-****-****-fe646723a586",
28 "publicKey" : "qlgofmne",
29 "roles" : [ {
30 "roleName" : "GLOBAL_READ_ONLY"
31 } ]
32 }, {
33 "desc" : "Test Global API Key 3",
34 "id" : "5d6fecfc80eef547288207f3",
35 "links" : [ {
36 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d6fecfc80eef547288207f3",
37 "rel" : "self"
38 } ],
39 "privateKey" : "********-****-****-fe348ed1796f",
40 "publicKey" : "cfswjfck",
41 "roles" : [ {
42 "roleName" : "GLOBAL_READ_ONLY"
43 }, {
44 "roleName" : "GLOBAL_BILLING_ADMIN"
45 }, {
46 "roleName" : "GLOBAL_USER_ADMIN"
47 } ]
48 } ],
49 "totalCount" : 3
50}

Back

Global Programmatic API Keys

Next

Get All Roles for Global API Keys