List consolidated alerts

Returns a list of consolidated alerts.

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).

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
status	$in	The consolidated alert status. Set to "active" to display only the consolidated alerts that have one or more of its associated individual alerts in "active" status. Set to "cleared" to display only the consolidated alerts that have all individual alerts in "cleared" status. For example, `?filter={"status":{"$in":["cleared"]}}`
raised_timestamp	$lte, $gte	The timestamp value of when the consolidated alert was initially raised. Represented in RFC-3339 format. For example, `?filter={"raised_timestamp":{"$lte":"1985-04-12T23:20:50Z"}}`
parent_entity.id and parent_entity.type	$eq	The system-generated ID and value (name) of the parent entity that is associated with the primary entity affected by the alert. These two fields must be set 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.

Responses

200
default

Success

application/api.clumio.consolidated-alerts=v1+json

Schema
Example (from schema)

Schema

_embedded object
Embedded responses related to the resource.
items object[]
A collection of requested items.
_etag string
The ETag value.
_links object
URLs to pages related to the resource.
_self object
The HATEOAS link to this resource.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
update-consolidated-alert object
A resource-specific HATEOAS link.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
active_entity_count int64
The number of currently active individual alerts associated with the consolidated alert.
cause string
The issue that generated the alert. Each alert cause is associated with an alert type.
cleared_entity_count int64
The number of cleared individual alerts associated with the consolidated alert.
cleared_timestamp string
The timestamp of when the consolidated alert was cleared, if ever. Represented in RFC-3339 format. If this alert has not been cleared, this field will have a value of null. A consolidated alert goes into "cleared" status when all of its associated individual alerts are in "cleared" status or when a Clumio user manually clears it.
details object
Additional information about the consolidated alert.
cause string
A brief description of the condition that caused the alert. Examples include "Size Limit Exceeded" and "Insufficient Cloud Connector Capacity".
type string
The general alert category. Examples include "Policy Violated" and "Restore Failed".
id string
The Clumio-assigned ID of the consolidated alert.
notes string
A record of user-provided information about the alert.
parent_entity object
The entity associated with or affected by the alert.
id string
A system-generated ID assigned to this entity.
type string
Type is mostly an asset type or the type of Entity. Some examples are "restored_file", "aws_ebs_volume", etc.
value string
A system-generated value assigned to the entity. For example, if the primary entity type is "aws_ebs_volume", then the value is the name of the EBS.
raised_timestamp string
The timestamp of when the consolidated alert was initially raised. Represented in RFC-3339 format.
severity string
The alert severity level. Values include "error" and "warning".
status string
The consolidated alert status. A consolidated alert is in "active" status if one or more of its associated individual alerts is in "active" status. A consolidated alert goes into "cleared" status when all of its associated individual alerts are in "cleared" status or when a Clumio user manually clears it.
type string
The general alert category. An alert type may be associated with multiple alert causes. Examples of alert types include "tag_conflict" and "policy_violated". Refer to the Alert Type table for a complete list of alert types.
updated_timestamp string
The timestamp of when the consolidated alert was last updated. Represented in RFC-3339 format. Raising a new individual alert will update its associated consolidated alert.
_links object
URLs to pages related to the resource.
_first object
The HATEOAS link to the first page of results.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
_last object
The HATEOAS link to the last page of results.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
_next object
The HATEOAS link to the next page of results.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
_prev object
The HATEOAS link to the previous page of results.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
_self object
The HATEOAS link to this resource.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
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.
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,
  "start": "string",
  "total_count": 0,
  "total_pages_count": 0
}

Error

application/json

Schema
Example (from schema)

Schema

errors object[]
A list of errors encountered during runtime.
error_code uint32
error_message string
The reason for the error.

{
  "errors": [
    {
      "error_code": 0,
      "error_message": "string"
    }
  ]
}

GET /alerts/consolidated

Authorization

Request

Click Edit to configure Base URL

https://us-west-2.api.clumio.com

Bearer Token

limit — query

start — query

filter — query

curl -L -X GET 'https://us-west-2.api.clumio.com/alerts/consolidated' \
-H 'Accept: application/api.clumio.consolidated-alerts=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/alerts/consolidated' \
-H 'Accept: application/api.clumio.consolidated-alerts=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/alerts/consolidated' \
-H 'Accept: application/api.clumio.consolidated-alerts=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/alerts/consolidated' \
-H 'Accept: application/api.clumio.consolidated-alerts=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/alerts/consolidated' \
-H 'Accept: application/api.clumio.consolidated-alerts=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/alerts/consolidated' \
-H 'Accept: application/api.clumio.consolidated-alerts=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/alerts/consolidated' \
-H 'Accept: application/api.clumio.consolidated-alerts=v1+json' \
-H 'Authorization: Bearer <TOKEN>'