Retrieve an individual alert
Returns a representation of the specified individual alert.
Path Parameters
- individual_alert_id string required
Performs the operation on the individual alert with the specified ID.
Query Parameters
- embed string
Embeds the details of an associated resource. Set the parameter to one of the following embeddable links to include additional details associated with the resource.
For more information about embedded links, refer to the Embedding Referenced Resources section of this guide.Embeddable Link Description read-consolidated-alert Embeds the associated consolidated alert in the response. For example, ?embed=read-consolidated-alert
- 200
- default
Success
- application/api.clumio.individual-alerts=v1+json
- Schema
- Example (from schema)
Schema
_embedded object
- _etag string
The ETag value.
_links object
- cause string
The issue that generated the alert. Each cause belongs to an alert type.
- cleared_timestamp string
The timestamp of when the alert was cleared, either automatically by Clumio or manually by a Clumio user. Represented in RFC-3339 format. If this alert has not been cleared, then this field has a value of
null
. - consolidated_alert_id string
The Clumio-assigned ID of the consolidated alert associated with this individual alert. Alerts are consolidated based on matching parent entity, alert type, and alert cause.
details object
- id string
The Clumio-assigned ID of the individual alert.
- notes string
A record of user-provided information about the alert.
parent_entity object
primary_entity object
- raised_count uint64
The number of times the alert has recurred for this primary entity.
- raised_timestamp string
The timestamp of when the alert was raised. Represented in RFC-3339 format.
- severity string
The alert severity level. Values include "error" and "warning".
- status string
The individual alert status. An individual alert that is in "active" status is one that is still open and has yet to be addressed. An individual alert that is in "cleared" status is one that has been cleared, either automatically by Clumio or manually by a Clumio user.
tags object[]
- type string
The general alert category. Some alert types may be associated with multiple causes. Refer to the Alert Type table for a complete list of alert types.
- updated_timestamp string
The timestamp of when the alert was last updated. Represented in RFC-3339 format. The alert is updated whenever there is a new occurrence of the same alert within the same entity.
{
"_embedded": {},
"_etag": "string",
"_links": {
"_self": {
"href": "string",
"templated": true,
"type": "string"
},
"read-consolidated-alert": {
"href": "string",
"templated": true,
"type": "string"
},
"update-individual-alert": {
"href": "string",
"templated": true,
"type": "string"
}
},
"cause": "string",
"cleared_timestamp": "string",
"consolidated_alert_id": "string",
"details": {
"cause": "string",
"description": "string",
"type": "string",
"variables": {}
},
"id": "string",
"notes": "string",
"parent_entity": {
"id": "string",
"type": "string",
"value": "string"
},
"primary_entity": {
"id": "string",
"type": "string",
"value": "string"
},
"raised_count": 0,
"raised_timestamp": "string",
"severity": "string",
"status": "string",
"tags": [
{
"id": "string",
"type": "string",
"value": "string"
}
],
"type": "string",
"updated_timestamp": "string"
}
Error
- application/json
- Schema
- Example (from schema)
Schema
errors object[]
{
"errors": [
{
"error_code": 0,
"error_message": "string"
}
]
}
GET /alerts/individual/:individual_alert_id
Authorization
Request
Request
curl -L -X GET 'https://us-west-2.api.clumio.com/alerts/individual/:individual_alert_id' \
-H 'Accept: application/api.clumio.individual-alerts=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/alerts/individual/:individual_alert_id' \
-H 'Accept: application/api.clumio.individual-alerts=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/alerts/individual/:individual_alert_id' \
-H 'Accept: application/api.clumio.individual-alerts=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/alerts/individual/:individual_alert_id' \
-H 'Accept: application/api.clumio.individual-alerts=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/alerts/individual/:individual_alert_id' \
-H 'Accept: application/api.clumio.individual-alerts=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/alerts/individual/:individual_alert_id' \
-H 'Accept: application/api.clumio.individual-alerts=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/alerts/individual/:individual_alert_id' \
-H 'Accept: application/api.clumio.individual-alerts=v1+json' \
-H 'Authorization: Bearer <TOKEN>'