Get One Global API Key¶

On this page

Resource
Required Roles
Request Parameters
Response
- Response Elements
Example Request
Example Response
- Response Header
- Response Body

Return one Global API Key for Ops Manager using the unique identifier for that Key.

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

Resource¶

GET /admin/apiKeys/{API-KEY-ID}

Required Roles¶

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

Request Parameters¶

Request Path Parameters¶

Name	Type	Description
`API-KEY-ID`	string	Unique identifier for the Global API Key you want to retrieve.

Request Query Parameters¶

The following query parameters are optional:

Name Type Necessity Description Default

pretty boolean Optional Flag indicating 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 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¶

Response Elements¶

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 Automation Admin`
`GLOBAL_BACKUP_ADMIN`	`Global Backup Admin`
`GLOBAL_MONITORING_ADMIN`	`Global Monitoring Admin`
`GLOBAL_OWNER`	`Global Owner`
`GLOBAL_READ_ONLY`	`Global Read Only`
`GLOBAL_USER_ADMIN`	`Global User Admin`

Example Request¶

copy

curl --user "{USERNAME}:{APIKEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/{API-KEY-ID}?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}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Response Body¶

{
  "desc" : "Test Global API Key 1",
  "id" : "{API-KEY-ID}",
  "links" : [ {
    "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/{API-KEY-ID}",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-54d9792d337d",
  "publicKey" : "zrefxaep",
  "roles" : [ {
    "roleName" : "GLOBAL_READ_ONLY"
  }, {
    "roleName" : "GLOBAL_BILLING_ADMIN"
  } ]
}

← Get All Roles for Global API Keys Create One Global API Key →