Update an individual alert

Manages an existing individual alert. Managing an individual alert includes clearing the alert and adding notes to the specified 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 Link Description
read-consolidated-alert Embeds 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.

Embeddable Link	Description
read-consolidated-alert	Embeds the associated consolidated alert in the response. For example, `?embed=read-consolidated-alert`

application/json

Request Body

notes string required
A record of information about the alert. The note must be less than 1024 characters in length. Adding a new note overwrites any existing notes.
status string
Possible values: [cleared]
Manually clears an active alert. To clear the alert, set to "cleared"`". Once an alert is cleared, the status of the alert changes from "active" to "cleared". If the alert is already in "cleared" status, this action is ignored. An alert that is in "cleared" status cannot be changed to "active" status.

Responses

200
default

Success

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

Schema
Example (from schema)

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.

{
  "_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[]
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"
    }
  ]
}

PATCH /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

Body

{
  "notes": "string",
  "status": "cleared"
}

curl -L -X PATCH 'https://us-west-2.api.clumio.com/alerts/individual/:individual_alert_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.individual-alerts=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "notes": "string",
  "status": "cleared"
}'

curl -L -X PATCH 'https://us-west-2.api.clumio.com/alerts/individual/:individual_alert_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.individual-alerts=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "notes": "string",
  "status": "cleared"
}'

curl -L -X PATCH 'https://us-west-2.api.clumio.com/alerts/individual/:individual_alert_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.individual-alerts=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "notes": "string",
  "status": "cleared"
}'

curl -L -X PATCH 'https://us-west-2.api.clumio.com/alerts/individual/:individual_alert_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.individual-alerts=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "notes": "string",
  "status": "cleared"
}'

curl -L -X PATCH 'https://us-west-2.api.clumio.com/alerts/individual/:individual_alert_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.individual-alerts=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "notes": "string",
  "status": "cleared"
}'

curl -L -X PATCH 'https://us-west-2.api.clumio.com/alerts/individual/:individual_alert_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.individual-alerts=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "notes": "string",
  "status": "cleared"
}'

curl -L -X PATCH 'https://us-west-2.api.clumio.com/alerts/individual/:individual_alert_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.individual-alerts=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "notes": "string",
  "status": "cleared"
}'

Update an individual alert​

Authorization

Request

Update an individual alert