Skip to main content

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.

    Embeddable LinkDescription
    read-consolidated-alertEmbeds the associated consolidated alert in the response. For example, ?embed=read-consolidated-alert
    For more information about embedded links, refer to the Embedding Referenced Resources section of this guide.
Responses

Success

Schema
  • _embedded object

    Embedded responses related to the resource.

  • read-consolidated-alert

    Embeds the associated consolidated alert in the response.

  • _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.

  • read-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.

  • update-individual-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.

  • 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

    Additional information about the alert.

  • cause string

    A brief description of the condition that caused the alert. Examples include "Size Limit Exceeded" and "Insufficient Cloud Connector Capacity".

  • description string

    A detailed description of the alert, including the reason why the alert occurred and the steps you must take to resolve the issue.

  • type string

    The general alert category. Examples include "Policy Violated" and "Restore Failed".

  • variables object

    Data specific to the alert generated. If the alert has no variables, then this field has a value of null.

  • property name* string
  • id string

    The Clumio-assigned ID of the individual alert.

  • notes string

    A record of user-provided information about the alert.

  • parent_entity object

    The parent object of the primary entity associated with or affected by the alert. For example, "aws_environment" is the parent entity of primary entity "aws_ebs_volume".

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

  • primary_entity object

    The primary object associated with or affected by the alert. Examples of primary entities include "aws_connection", "aws_ebs_volume".

  • 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_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[]

    A list of associated objects for 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.

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

GET /alerts/individual/:individual_alert_id

Authorization

Request

Click Edit to configure Base URL
https://us-west-2.api.clumio.com
Bearer Token
individual_alert_id — path required
embed — query
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>'