# Alert

An Alert, a set of Events, is the smallest unit to manage incidents.

> **Package : spaceone.api.monitoring.v1**

\
\


## Alert

**Alert Methods:**

| Method                                                                                                                          | Request                                                                                                                                          | Response                                                                                                               |
| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------- |
| [**create**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#create)              | [CreateAlertRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#createalertrequest)           | [AlertInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#alertinfo)   |
| [**update**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#update)              | [UpdateAlertRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#updatealertrequest)           | [AlertInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#alertinfo)   |
| [**assign\_user**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#assign_user)   | [AssignUserRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#assignuserrequest)             | [AlertInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#alertinfo)   |
| [**update\_state**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#update_state) | [UpdateAlertStateRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#updatealertstaterequest) | [AlertInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#alertinfo)   |
| [**delete**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#delete)              | [AlertRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#alertrequest)                       | [Empty](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#empty)           |
| [**get**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#get)                    | [AlertRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#alertrequest)                       | [AlertInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#alertinfo)   |
| [**list**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#list)                  | [AlertQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#alertquery)                           | [AlertsInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#alertsinfo) |
| [**stat**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#stat)                  | [AlertStatQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#alertstatquery)                   | [Struct](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#struct)         |

\


### create

Creates a new Alert. Alerts generated with `create` method are made in a manual way. Manually made Alerts can be used for Notifications.

> **POST** /monitoring/v1/alert/create

\{{< tabs " create " >\}}

\{{< tab "Request Example" >\}}

[CreateAlertRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#createalertrequest)

* **title** (string) `Required`
* **project\_id** (string) `Required`
* **description** (string)
* **assignee** (string)
* **urgency** (AlertUrgency)

\{{< highlight json >\}} { "title": "sample test", "description": "This is a description of sample.", "urgency": "HIGH", "project\_id": "project-123456789012", "domain\_id": "domain-123456789012" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< tab "Response Example" >\}}

[AlertInfo](#ALERTINFO)

* **alert\_number** (int32) `Required`
* **alert\_id** (string) `Required`
* **title** (string) `Required`
* **state** (AlertState) `Required`
* **description** (string) `Required`
* **assignee** (string) `Required`
* **responder** (string) `Required`
* **urgency** (AlertUrgency) `Required`
* **severity** (string) `Required`
* **rule** (string) `Required`
* **image\_url** (string) `Required`
* **resources** (AlertResource) `Repeated` `Required`
* **provider** (string) `Required`
* **account** (string) `Required`
* **additional\_info** (Struct) `Required`
* **escalation\_step** (int32) `Required`
* **escalation\_ttl** (int32) `Required`
* **triggered\_by** (string) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **project\_id** (string) `Required`
* **webhook\_id** (string) `Required`
* **escalation\_policy\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`
* **acknowledged\_at** (string) `Required`
* **resolved\_at** (string) `Required`
* **escalated\_at** (string) `Required`

\{{< highlight json >\}} { "alert\_number": 104053, "alert\_id": "alert-123456789012", "title": "sample test", "state": "TRIGGERED", "description": "This is a description of sample.", "urgency": "HIGH", "severity": "NONE", "escalation\_step": 1, "additional\_info": {}, "triggered\_by": "user1@email.com", "escalation\_policy\_id": "ep-123456789012", "project\_id": "project-123456789012", "domain\_id": "domain-123456789012", "created\_at": "2022-01-01T01:43:08.566Z", "updated\_at": "2022-01-01T01:43:08.566Z", "escalated\_at": "2022-01-01T01:43:54.464Z" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### update

Updates a specific Alert. You can make changes in Alert settings, including the `title`, `description`, `responder`, `state`, and `urgency`. The `responder` of the Alert is a User who is assigned to respond to the Alert.

> **POST** /monitoring/v1/alert/update

\{{< tabs " update " >\}}

\{{< tab "Request Example" >\}}

[UpdateAlertRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#updatealertrequest)

* **alert\_id** (string) `Required`
* **title** (string)
* **state** (string)
* **description** (string)
* **reset\_description** (bool)
* **urgency** (AlertUrgency)
* **project\_id** (string)

\{{< highlight json >\}} { "alert\_id": "alert-123456789012", "state": "ACKNOWLEDGED", "urgency": "LOW", "description": "\[updating]This is a description of sample.", "domain\_id": "domain-123456789012" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< tab "Response Example" >\}}

[AlertInfo](#ALERTINFO)

* **alert\_number** (int32) `Required`
* **alert\_id** (string) `Required`
* **title** (string) `Required`
* **state** (AlertState) `Required`
* **description** (string) `Required`
* **assignee** (string) `Required`
* **responder** (string) `Required`
* **urgency** (AlertUrgency) `Required`
* **severity** (string) `Required`
* **rule** (string) `Required`
* **image\_url** (string) `Required`
* **resources** (AlertResource) `Repeated` `Required`
* **provider** (string) `Required`
* **account** (string) `Required`
* **additional\_info** (Struct) `Required`
* **escalation\_step** (int32) `Required`
* **escalation\_ttl** (int32) `Required`
* **triggered\_by** (string) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **project\_id** (string) `Required`
* **webhook\_id** (string) `Required`
* **escalation\_policy\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`
* **acknowledged\_at** (string) `Required`
* **resolved\_at** (string) `Required`
* **escalated\_at** (string) `Required`

\{{< highlight json >\}} { "alert\_number": 104053, "alert\_id": "alert-123456789012", "title": "sample test", "state": "TRIGGERED", "description": "This is a description of sample.", "urgency": "HIGH", "severity": "NONE", "escalation\_step": 1, "additional\_info": {}, "triggered\_by": "user1@email.com", "escalation\_policy\_id": "ep-123456789012", "project\_id": "project-123456789012", "domain\_id": "domain-123456789012", "created\_at": "2022-01-01T01:43:08.566Z", "updated\_at": "2022-01-01T01:43:08.566Z", "escalated\_at": "2022-01-01T01:43:54.464Z" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### assign\_user

> **POST** /monitoring/v1/alert/assign-user

\{{< tabs " assign\_user " >\}}

\{{< tab "Response Example" >\}}

[AlertInfo](#ALERTINFO)

* **alert\_number** (int32) `Required`
* **alert\_id** (string) `Required`
* **title** (string) `Required`
* **state** (AlertState) `Required`
* **description** (string) `Required`
* **assignee** (string) `Required`
* **responder** (string) `Required`
* **urgency** (AlertUrgency) `Required`
* **severity** (string) `Required`
* **rule** (string) `Required`
* **image\_url** (string) `Required`
* **resources** (AlertResource) `Repeated` `Required`
* **provider** (string) `Required`
* **account** (string) `Required`
* **additional\_info** (Struct) `Required`
* **escalation\_step** (int32) `Required`
* **escalation\_ttl** (int32) `Required`
* **triggered\_by** (string) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **project\_id** (string) `Required`
* **webhook\_id** (string) `Required`
* **escalation\_policy\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`
* **acknowledged\_at** (string) `Required`
* **resolved\_at** (string) `Required`
* **escalated\_at** (string) `Required`

\{{< highlight json >\}} { "alert\_number": 104053, "alert\_id": "alert-123456789012", "title": "sample test", "state": "TRIGGERED", "description": "This is a description of sample.", "urgency": "HIGH", "severity": "NONE", "escalation\_step": 1, "additional\_info": {}, "triggered\_by": "user1@email.com", "escalation\_policy\_id": "ep-123456789012", "project\_id": "project-123456789012", "domain\_id": "domain-123456789012", "created\_at": "2022-01-01T01:43:08.566Z", "updated\_at": "2022-01-01T01:43:08.566Z", "escalated\_at": "2022-01-01T01:43:54.464Z" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### update\_state

Updates the state of an Alert via callback URL by creating a temporary `access_key` while generating a Notification about the Alert. +noauth

\{{< tabs " update\_state " >\}}

\{{< tab "Request Example" >\}}

[UpdateAlertStateRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#updatealertstaterequest)

* **alert\_id** (string) `Required`
* **access\_key** (string) `Required`
* **responder** (string)

\{{< highlight json >\}} { "alert\_id": "alert-123456789012", "access\_key": "1q2w3e4r5t6y7u8i9o0p", "domain\_id": "domain-123456789012" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< tab "Response Example" >\}}

[AlertInfo](#ALERTINFO)

* **alert\_number** (int32) `Required`
* **alert\_id** (string) `Required`
* **title** (string) `Required`
* **state** (AlertState) `Required`
* **description** (string) `Required`
* **assignee** (string) `Required`
* **responder** (string) `Required`
* **urgency** (AlertUrgency) `Required`
* **severity** (string) `Required`
* **rule** (string) `Required`
* **image\_url** (string) `Required`
* **resources** (AlertResource) `Repeated` `Required`
* **provider** (string) `Required`
* **account** (string) `Required`
* **additional\_info** (Struct) `Required`
* **escalation\_step** (int32) `Required`
* **escalation\_ttl** (int32) `Required`
* **triggered\_by** (string) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **project\_id** (string) `Required`
* **webhook\_id** (string) `Required`
* **escalation\_policy\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`
* **acknowledged\_at** (string) `Required`
* **resolved\_at** (string) `Required`
* **escalated\_at** (string) `Required`

\{{< highlight json >\}} { "alert\_number": 104053, "alert\_id": "alert-123456789012", "title": "sample test", "state": "TRIGGERED", "description": "This is a description of sample.", "urgency": "HIGH", "severity": "NONE", "escalation\_step": 1, "additional\_info": {}, "triggered\_by": "user1@email.com", "escalation\_policy\_id": "ep-123456789012", "project\_id": "project-123456789012", "domain\_id": "domain-123456789012", "created\_at": "2022-01-01T01:43:08.566Z", "updated\_at": "2022-01-01T01:43:08.566Z", "escalated\_at": "2022-01-01T01:43:54.464Z" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### delete

Deletes a specific Alert and remove it from the list of Alerts. You must specify the `alert_id` of the Alert to delete.

> **POST** /monitoring/v1/alert/delete

\{{< tabs " delete " >\}}

\{{< tab "Request Example" >\}}

[AlertRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#alertrequest)

* **alert\_id** (string) `Required`

\{{< highlight json >\}} { "alert\_id": "alert-123456789012", } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### get

Gets a specific Alert. Prints detailed information about the Alert.

> **POST** /monitoring/v1/alert/get

\{{< tabs " get " >\}}

\{{< tab "Request Example" >\}}

[AlertRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#alertrequest)

* **alert\_id** (string) `Required`

\{{< highlight json >\}} { "alert\_id": "alert-123456789012", } \{{< /highlight >\}} \{{< /tab >\}}

\{{< tab "Response Example" >\}}

[AlertInfo](#ALERTINFO)

* **alert\_number** (int32) `Required`
* **alert\_id** (string) `Required`
* **title** (string) `Required`
* **state** (AlertState) `Required`
* **description** (string) `Required`
* **assignee** (string) `Required`
* **responder** (string) `Required`
* **urgency** (AlertUrgency) `Required`
* **severity** (string) `Required`
* **rule** (string) `Required`
* **image\_url** (string) `Required`
* **resources** (AlertResource) `Repeated` `Required`
* **provider** (string) `Required`
* **account** (string) `Required`
* **additional\_info** (Struct) `Required`
* **escalation\_step** (int32) `Required`
* **escalation\_ttl** (int32) `Required`
* **triggered\_by** (string) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **project\_id** (string) `Required`
* **webhook\_id** (string) `Required`
* **escalation\_policy\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`
* **acknowledged\_at** (string) `Required`
* **resolved\_at** (string) `Required`
* **escalated\_at** (string) `Required`

\{{< highlight json >\}} { "alert\_number": 104053, "alert\_id": "alert-123456789012", "title": "sample test", "state": "TRIGGERED", "description": "This is a description of sample.", "urgency": "HIGH", "severity": "NONE", "escalation\_step": 1, "additional\_info": {}, "triggered\_by": "user1@email.com", "escalation\_policy\_id": "ep-123456789012", "project\_id": "project-123456789012", "domain\_id": "domain-123456789012", "created\_at": "2022-01-01T01:43:08.566Z", "updated\_at": "2022-01-01T01:43:08.566Z", "escalated\_at": "2022-01-01T01:43:54.464Z" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### list

Gets a list of all Alerts. You can use a query to get a filtered list of Alerts.

> **POST** /monitoring/v1/alert/list

\{{< tabs " list " >\}}

\{{< tab "Request Example" >\}}

[AlertQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/Alert/README.md#alertquery)

* **query** (Query)
* **alert\_number** (int32)
* **alert\_id** (string)
* **title** (string)
* **state** (AlertState)
* **assignee** (string)
* **responder** (string)
* **urgency** (AlertUrgency)
* **severity** (string)
* **resource** (string)
* **provider** (string)
* **account** (string)
* **triggered\_by** (string)
* **workspace\_id** (string)
* **project\_id** (string)
* **webhook\_id** (string)
* **escalation\_policy\_id** (string)

\{{< highlight json >\}} { "query": {}, "domain\_id": "domain-123456789012" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< tab "Response Example" >\}}

[AlertsInfo](#ALERTSINFO)

* **results** (AlertInfo) `Repeated` `Required`
* **total\_count** (int32) `Required`

\{{< highlight json >\}} { "results": \[ { "alert\_number": 104057, "alert\_id": "alert-987654321098", "title": "Notification of access to the bastion Host", "state": "TRIGGERED", "description": "SSH Access to stargate-dev from adm", "urgency": "LOW", "severity": "INFO", "resources": \[{ "resource\_id": "server-123456789012", "resource\_type": "inventory.Server", "name": "stargate-dev" }], "escalation\_step": 1, "escalation\_ttl": 1, "additional\_info": { "user": "user1" "host": "\['2.2.2.2']" }, "triggered\_by": "webhook-123456789012", "webhook\_id": "webhook-123456789012", "escalation\_policy\_id": "ep-123456789012", "project\_id": "project-123456789012", "domain\_id": "domain-123456789012", "created\_at": "2022-01-01T02:46:35.934Z", "updated\_at": "2022-01-01T02:46:35.934Z", "escalated\_at": "2022-01-01T02:46:35.979Z" }, { "alert\_number": 104056, "alert\_id": "alert-123456789999", "title": "Notification of access to the bastion Host", "state": "TRIGGERED", "description": "SSH Access to stargate-dev from user3@email.com", "urgency": "LOW", "severity": "INFO", "resource": \[{ "resource\_id": "server-123456789012", "resource\_type": "inventory.Server", "name": "stargate-dev" }], "escalation\_step": 1, "escalation\_ttl": 1, "additional\_info": { "user": "user3@email.com", "host": "\['1.1.1.1']" }, "triggered\_by": "webhook-123456789012", "webhook\_id": "webhook-123456789012", "escalation\_policy\_id": "ep-123456789012", "project\_id": "project-123456789012", "domain\_id": "domain-123456789012", "created\_at": "2022-01-01T02:46:31.391Z", "updated\_at": "2022-01-01T02:46:31.391Z", "escalated\_at": "2022-01-01T02:46:31.553Z" } ], "total\_count": 21283 } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### stat

> **POST** /monitoring/v1/alert/stat

\
\


## Message

### AlertInfo

* **alert\_number** (int32) `Required`
* **alert\_id** (string) `Required`
* **title** (string) `Required`
* **state** (AlertState) `Required`
* **description** (string) `Required`
* **assignee** (string) `Required`
* **responder** (string) `Required`
* **urgency** (AlertUrgency) `Required`
* **severity** (string) `Required`
* **rule** (string) `Required`
* **image\_url** (string) `Required`
* **resources** (AlertResource) `Repeated` `Required`
* **provider** (string) `Required`
* **account** (string) `Required`
* **additional\_info** (Struct) `Required`
* **escalation\_step** (int32) `Required`
* **escalation\_ttl** (int32) `Required`
* **triggered\_by** (string) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **project\_id** (string) `Required`
* **webhook\_id** (string) `Required`
* **escalation\_policy\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`
* **acknowledged\_at** (string) `Required`
* **resolved\_at** (string) `Required`
*   **escalated\_at** (string) `Required`

    \


### AlertQuery

* **query** (Query)
* **alert\_number** (int32)
* **alert\_id** (string)
* **title** (string)
* **state** (AlertState)
* **assignee** (string)
* **responder** (string)
* **urgency** (AlertUrgency)
* **severity** (string)
* **resource** (string)
* **provider** (string)
* **account** (string)
* **triggered\_by** (string)
* **workspace\_id** (string)
* **project\_id** (string)
* **webhook\_id** (string)
*   **escalation\_policy\_id** (string)

    \


### AlertRequest

*   **alert\_id** (string) `Required`

    \


### AlertResource

* **resource\_id** (string) `Required`
* **resource\_type** (string) `Required`
*   **name** (string) `Required`

    \


### AlertStatQuery

*   **query** (StatisticsQuery) `Required`

    \


### AlertsInfo

* **results** (AlertInfo) `Repeated` `Required`
*   **total\_count** (int32) `Required`

    \


### AssignUserRequest

* **alert\_id** (string) `Required`
*   **assignee** (string) `Required`

    \


### CreateAlertRequest

* **title** (string) `Required`
* **project\_id** (string) `Required`
* **description** (string)
* **assignee** (string)
*   **urgency** (AlertUrgency)

    \


### UpdateAlertRequest

* **alert\_id** (string) `Required`
* **title** (string)
* **state** (string)
* **description** (string)
* **reset\_description** (bool)
* **urgency** (AlertUrgency)
*   **project\_id** (string)

    \


### UpdateAlertStateRequest

* **alert\_id** (string) `Required`
* **access\_key** (string) `Required`
*   **responder** (string)

    \
