- API >
- Public API Resources >
- Measurements and Alerts >
- Events >
- Get One Organization Event
Get One Organization Event¶
On this page
Limited to Organization Member Role
Only users with the Organization Member
can request
this endpoint.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource¶
Request Path Parameters¶
Name | Type | Description |
---|---|---|
ORG-ID | string | Unique identifier of the organization associated with the desired event. |
EVENT-ID | string | Unique identifier of the desired event. |
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 |
---|---|---|
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. |