- API >
- Public API Resources >
- Measurements and Alerts >
- Global Events >
- Get All Global Events
Get All Global Events¶
On this page
Limited to Global Read Only Role
Only users with the Global Read Only
role can request
this endpoint.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource¶
Request Path Parameters¶
This endpoint does not use HTTP request path parameters.
Request Query Parameters¶
Unique Query Parameters¶
This endpoint accepts the following query parameters to filter returned events:
Name | Type | Description | Default |
---|---|---|---|
minDate | string | Return only events for which the created date is greater than or equal to the specified Timestamp in ISO 8601 date and time format. | |
maxDate | string | Return only events for which the created date is less than or equal to the specified Timestamp in ISO 8601 date and time format. | |
eventType | string | Return only events of the specified types. Accepted values include: To review the types of events that generate alerts, see Alert Types |
Common Query Parameters¶
This endpoint also accepts the query parameters common to all endpoints that return lists of values:
Name | Type | Description | Default | ||||
---|---|---|---|---|---|---|---|
pageNum | integer |
Page number (1-index based). | 1 |
||||
itemsPerPage |
integer | Maximum number of items to return, up to a maximum of 100. | 100 |
||||
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, response body includes:
For endpoints that return a list of results, the |
None |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response¶
Response Document¶
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 |
object array | This array includes one object for each item detailed in the results Embedded Document section. |
links |
object array | This 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 |
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. |
results Embedded Document¶
Each result is one alert.
Name | Type | Description |
---|---|---|
alertId | string | Unique identifier for the alert associated with this event. |
alertConfigId | string | Unique identifier for the alert configuration associated with
the alertId . |
clusterId | string | ID of the cluster to which this event applies. |
clusterName | string | Name of the cluster to which this event applies. |
created | string | Timestamp in ISO 8601 date and time format when this event was triggered. |
currentValue | object | Current value of the metric that triggered this event. |
currentValue.number | number | Value of the metric. |
currentValue.units | string | Relevant units for the value. Example A metric that measures memory consumption would have a byte measurement, while a metric that measures time would have a time unit. Accepted values are:
|
eventTypeName | string | Name of the circumstance that triggered this event. Accepted values are: To review the types of events that generate alerts, see Alert Types |
groupId | string | ID of the project in which this event occurred. |
hostId | string | ID of the host on which this event occurred. |
hostname | string | Hostname of the host on which this event occurred. |
id | string | Unique identifier for this event. |
isGlobalAdmin | boolean | Flag indicating whether the user who triggered this event has
the Global Monitoring Administrator role. |
links | object array | One or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification |
metricName | string | Name of the measurement whose value went outside the threshold. For possible values, see below. |
port | integer | Port of the host associated with this event. |
remoteAddress | string | IP address associated with the Ops Manager user (userId) who triggered the event. |
replicaSetName | string | Name of the replica set. |
shardName | string | The name of the shard associated with the event. |
targetUsername | string | Username for the Ops Manager user targeted by this event. |
teamId | string | Unique identifier for the Ops Manager team associated with this event. |
userId | string | Unique identifier for the Ops Manager user who triggered this event. |
username | string | Username for the Ops Manager user who triggered this event. |