List individual alerts
Returns a list of individual alerts.
Each alert is associated with a cause, which represents the issue that generated the alert, and each cause belongs to a general alert alert type. Some alert types may be associated with multiple causes.
The following table lists the Clumio alert types:
Alert Type | Description |
---|---|
policy_violated | An entity's scheduled backup failed. |
restore_failed | An entity restore failed. |
file_restore_failed | A file restore failed. |
tag_conflict | An EBS volume has multiple associated tags with different protection policies applied at the tag level. |
aws_account_disconnected | The connection between Clumio Cloud Connector and the user's AWS account failed. |
enc_key_inaccessible | An issue is blocking encryption key access. |
Query Parameters
- limit int64
Limits the size of the response on each page to the specified number of items.
- start string
Sets the page number used to browse the collection. Pages are indexed starting from 1 (i.e.,
?start=1
). - sort string
Returns the list of individual alerts in the order specified. Set
sort
to the name of the sort field by which to sort in ascending order. To sort the list in reverse order, prefix the field name with a minus sign (-
). Only one field may be sorted at a time.The following table lists the supported sort fields for this resource and the operations that can be performed on the field:
If a sort order is not specified, the individual alerts are sorted by "raised_timestamp" in chronological descending (newest first) order.Sort Field Description raised_timestamp Sorts the individual alerts in chronological ascending (oldest first) order by when the alert was raised. For example, ?sort=raised_timestamp
updated_timestamp Sorts the individual alerts in chronological ascending (oldest first) order by when the alert was last updated. For example, ?sort=updated_timestamp
cleared_timestamp Sorts the individual alerts in chronological ascending (oldest first) order by when the alert was cleared, either automatically by Clumio or manually by a Clumio user. For example, ?sort=cleared_timestamp
- filter string
Narrows down the results to only the items that satisfy the filter criteria. The following table lists the supported filter fields for this resource and the filter conditions that can be applied on those fields:
Field Filter Condition Description type $in The general alert category. Alert types are listed in the Alert Type table. For example, ?filter={"type":{"$in":["policy_violated"]}}
status $in The individual alert status. Set to "active" to display only the individual alerts that are in the active status. Set to "cleared" to display only the individual alerts that have been cleared, either automatically by Clumio or manually by a Clumio user. For example, ?filter={"status":{"$in":["cleared"]}}
severity $in The alert severity level. Values include "error". raised_timestamp $lte, $gte The timestamp value of when the alert was raised. Represented in RFC-3339 format. For example, ?filter={"raised_timestamp":{"$lte":"1985-04-12T23:20:50Z"}}
updated_timestamp $lte, $gte The timestamp value 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. For example, ?filter={"updated_timestamp":{"$lte":"1985-04-12T23:20:50Z"}}
cleared_timestamp $lte, $gte The timestamp value of when the alert was cleared, either automatically by Clumio or manually by a Clumio user. Represented in RFC-3339 format. For example, ?filter={"cleared_timestamp":{"$lte":"1985-04-12T23:20:50Z"}}
consolidated_alert_id $eq The Clumio-assigned ID of the consolidated alert associated with the individual alert. For example, ?filter={"consolidated_alert_id":{"$eq":"d78cd819-ab15-48e2-acea-3f94d3a9f2fb"}}
primary_entity.id $eq The system-generated ID of the primary entity affected by the alert. For example, ?filter={"primary_entity.id":{"eq":"503765b4-62af-536d-c7ab-c5850a123194"}}
primary_entity.type $eq The type of primary entity affected by the alert. Examples of primary entity types include "aws_ebs_volume", "aws_environment". For example, ?filter={"primary_entity.type":{"$eq":"aws_ebs_volume"}}
primary_entity.value $contains The value or name associated with the primary entity affected by the alert. For example, ?filter={"primary_entity.value":{"$contains":"prod"}}
parent_entity.id and parent_entity.type $eq The system-generated ID and type of the parent entity that is associated with the primary entity affected by the alert. Both filters must be used together. For example, ?filter={"parent_entity.id":{"$eq":"9c2934fc-ff4d-11e9-8e11-76706df7fe01"},"parent_entity.type":{"$eq":"aws_environment"}}
For more information about filtering, refer to the Filtering section of this guide. - embed string
Embeds the details of each 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
_links object
- current_count int64
The number of items listed on the current page.
- filter_applied string
The filter used in the request. The filter includes both manually-specified and system-generated filters.
- limit int64
The maximum number of items displayed per page in the response.
- sort_applied string
The sort order used in the request.
- start string
The page number used to get this response. Pages are indexed starting from 1 (i.e.,
"start": "1"
). - total_count int64
The total number of items, summed across all pages.
- total_pages_count int64
The total number of pages of results.
{
"_embedded": {
"items": [
{
"_etag": "string",
"_links": {
"_self": {
"href": "string",
"templated": true,
"type": "string"
},
"update-consolidated-alert": {
"href": "string",
"templated": true,
"type": "string"
}
},
"active_entity_count": 0,
"cause": "string",
"cleared_entity_count": 0,
"cleared_timestamp": "string",
"details": {
"cause": "string",
"type": "string"
},
"id": "string",
"notes": "string",
"parent_entity": {
"id": "string",
"type": "string",
"value": "string"
},
"raised_timestamp": "string",
"severity": "string",
"status": "string",
"type": "string",
"updated_timestamp": "string"
}
]
},
"_links": {
"_first": {
"href": "string",
"templated": true,
"type": "string"
},
"_last": {
"href": "string",
"templated": true,
"type": "string"
},
"_next": {
"href": "string",
"templated": true,
"type": "string"
},
"_prev": {
"href": "string",
"templated": true,
"type": "string"
},
"_self": {
"href": "string",
"templated": true,
"type": "string"
}
},
"current_count": 0,
"filter_applied": "string",
"limit": 0,
"sort_applied": "string",
"start": "string",
"total_count": 0,
"total_pages_count": 0
}
Error
- application/json
- Schema
- Example (from schema)
Schema
errors object[]
{
"errors": [
{
"error_code": 0,
"error_message": "string"
}
]
}
GET /alerts/individual
Authorization
Request
Request
curl -L -X GET 'https://us-west-2.api.clumio.com/alerts/individual' \
-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' \
-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' \
-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' \
-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' \
-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' \
-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' \
-H 'Accept: application/api.clumio.individual-alerts=v1+json' \
-H 'Authorization: Bearer <TOKEN>'