- API >
- Public API Resources >
- Agents >
- Get All Agent API Keys for One Project
Get All Agent API Keys for One Project¶
On this page
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource¶
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 For endpoints that return one result, the response body includes:
|
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:
|