- API >
- Public API Resources >
- Programmatic API Keys >
- Global Programmatic API Keys >
- Get One Global API Key
Get One Global API Key¶
On this page
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¶
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 | Description | Default | ||||||
---|---|---|---|---|---|---|---|---|---|
pretty |
boolean | Flag indicating whether the response body should be in a prettyprint format. | false |
||||||
envelope |
boolean | Flag indicating 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 For endpoints that return one result, the response body includes:
|
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:
|