> For the complete documentation index, see [llms.txt](https://cloudforet.gitbook.io/cloudforet-apis/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cloudforet.gitbook.io/cloudforet-apis/content/en/monitoring/v1/projectalertconfig.md).

# ProjectAlertConfig

A ProjectAlertConfig is a resource to set the alert policies for a Project.

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

\ <br>

## ProjectAlertConfig

**ProjectAlertConfig Methods:**

| Method                                                                                                                          | Request                                                                                                                                                                       | Response                                                                                                                                                      |
| ------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [**create**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/ProjectAlertConfig/README.md#create) | [CreateProjectAlertConfigRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/ProjectAlertConfig/README.md#createprojectalertconfigrequest) | [ProjectAlertConfigInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/ProjectAlertConfig/README.md#projectalertconfiginfo)   |
| [**update**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/ProjectAlertConfig/README.md#update) | [UpdateProjectAlertConfigRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/ProjectAlertConfig/README.md#updateprojectalertconfigrequest) | [ProjectAlertConfigInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/ProjectAlertConfig/README.md#projectalertconfiginfo)   |
| [**delete**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/ProjectAlertConfig/README.md#delete) | [ProjectAlertConfigRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/ProjectAlertConfig/README.md#projectalertconfigrequest)             | [Empty](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/ProjectAlertConfig/README.md#empty)                                     |
| [**get**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/ProjectAlertConfig/README.md#get)       | [ProjectAlertConfigRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/ProjectAlertConfig/README.md#projectalertconfigrequest)             | [ProjectAlertConfigInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/ProjectAlertConfig/README.md#projectalertconfiginfo)   |
| [**list**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/ProjectAlertConfig/README.md#list)     | [ProjectAlertConfigQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/ProjectAlertConfig/README.md#projectalertconfigquery)                 | [ProjectAlertConfigsInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/ProjectAlertConfig/README.md#projectalertconfigsinfo) |
| [**stat**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/ProjectAlertConfig/README.md#stat)     | [ProjectAlertConfigStatQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/ProjectAlertConfig/README.md#projectalertconfigstatquery)         | [Struct](https://github.com/cloudforet-io/api-doc/blob/master/content/en/monitoring/v1/ProjectAlertConfig/README.md#struct)                                   |

<br>

### create

Creates a new ProjectAlertConfig in a specific Project. When creating a ProjectAlertConfig, validation of the Project is preceded. After the validation is done, ProjectAlertConfig enables EscalationPolicy to be set in the Project, or enables `enum` type `recovery_mode` and `notification_urgency` to be set through the `options` parameter. The parameter `recovery_mode` is for changing the state of the Alert to `resolved` if the external monitoring solution sends the resolved Alert. The parameter `notification_urgency` is used to choose whether you will get all Alerts or only urgent ones.

> **POST** /monitoring/v1/project-alert-config/create

{{< tabs " create " >}}

{{< tab "Request Example" >}}

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

* **project\_id** (string) `Required`
* **escalation\_policy\_id** (string)
* **options** (AlertOptions)

{{< highlight json >}} { "project\_id": "project-dee2a81d4859", "escalation\_policy\_id": "ep-b441abe04ca9", "options": { "notification\_urgency": "ALL", "recovery\_mode": "AUTO" }, "domain\_id": "domain-58010aa2e451" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[ProjectAlertConfigInfo](#PROJECTALERTCONFIGINFO)

* **project\_id** (string) `Required`
* **options** (AlertOptions) `Required`
* **escalation\_policy\_info** (EscalationPolicyInfo) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **created\_at** (string) `Required`

{{< highlight json >}} { "project\_id": "project-dee2a81d4859", "options": { "notification\_urgency": "ALL", "recovery\_mode": "AUTO" }, "escalation\_policy\_info": { "escalation\_policy\_id": "ep-b441abe04ca9", "name": "Global New Policy" }, "domain\_id": "domain-58010aa2e451", "created\_at": "2022-06-27T05:12:22.998Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### update

Updates a specific ProjectAlertConfig. You can make changes in ProjectAlertConfig settings, including the EscalationPolicy to apply. You can also change `notification_urgency` and `recovery_mode` by modifying the `options` parameter.

> **POST** /monitoring/v1/project-alert-config/update

{{< tabs " update " >}}

{{< tab "Request Example" >}}

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

* **project\_id** (string) `Required`
* **escalation\_policy\_id** (string)
* **options** (AlertOptions)

{{< highlight json >}} { "project\_id": "project-dee2a81d4859", "escalation\_policy\_id": "ep-4ee42a9b2d96", "options": { "notification\_urgency": "ALL", "recovery\_mode": "MANUAL" }, "domain\_id": "domain-58010aa2e451" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[ProjectAlertConfigInfo](#PROJECTALERTCONFIGINFO)

* **project\_id** (string) `Required`
* **options** (AlertOptions) `Required`
* **escalation\_policy\_info** (EscalationPolicyInfo) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **created\_at** (string) `Required`

{{< highlight json >}} { "project\_id": "project-dee2a81d4859", "options": { "notification\_urgency": "ALL", "recovery\_mode": "AUTO" }, "escalation\_policy\_info": { "escalation\_policy\_id": "ep-b441abe04ca9", "name": "Global New Policy" }, "domain\_id": "domain-58010aa2e451", "created\_at": "2022-06-27T05:12:22.998Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### delete

Deletes a specific ProjectAlertConfig. Deletes alert configuration data in a Project.

> **POST** /monitoring/v1/project-alert-config/delete

{{< tabs " delete " >}}

{{< tab "Request Example" >}}

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

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

{{< highlight json >}} { "project\_id": "project-dee2a81d4859", "domain\_id": "domain-58010aa2e451" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### get

Gets a specific ProjectAlertConfig. Prints detailed information about the ProjectAlertConfig, including EscalationPolicy, recovery mode, and notification urgency.

> **POST** /monitoring/v1/project-alert-config/get

{{< tabs " get " >}}

{{< tab "Request Example" >}}

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

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

{{< highlight json >}} { "project\_id": "project-dee2a81d4859", "domain\_id": "domain-58010aa2e451" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[ProjectAlertConfigInfo](#PROJECTALERTCONFIGINFO)

* **project\_id** (string) `Required`
* **options** (AlertOptions) `Required`
* **escalation\_policy\_info** (EscalationPolicyInfo) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **created\_at** (string) `Required`

{{< highlight json >}} { "project\_id": "project-dee2a81d4859", "options": { "notification\_urgency": "ALL", "recovery\_mode": "AUTO" }, "escalation\_policy\_info": { "escalation\_policy\_id": "ep-b441abe04ca9", "name": "Global New Policy" }, "domain\_id": "domain-58010aa2e451", "created\_at": "2022-06-27T05:12:22.998Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### list

Gets a list of all ProjectAlertConfigs from all projects configured in the same domain. You can use a query to get a filtered list of ProjectAlertConfigs.

> **POST** /monitoring/v1/project-alert-config/list

{{< tabs " list " >}}

{{< tab "Request Example" >}}

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

* **query** (Query)
* **project\_id** (string)
* **escalation\_policy\_id** (string)

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

{{< tab "Response Example" >}}

[ProjectAlertConfigsInfo](#PROJECTALERTCONFIGSINFO)

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

{{< highlight json >}} { "results": \[ { "project\_id": "project-18655561c535", "options": { "notification\_urgency": "ALL", "recovery\_mode": "MANUAL" }, "escalation\_policy\_info": { "escalation\_policy\_id": "ep-4ee42a9b2d96", "name": "HAHA", "is\_default": true }, "domain\_id": "domain-58010aa2e451", "created\_at": "2022-05-17T02:09:19.839Z" }, { "project\_id": "project-9074eea97d7e", "options": { "notification\_urgency": "ALL", "recovery\_mode": "MANUAL" }, "escalation\_policy\_info": { "escalation\_policy\_id": "ep-b441abe04ca9", "name": "Global New Policy" }, "domain\_id": "domain-58010aa2e451", "created\_at": "2021-06-24T02:50:50.535Z" } ], "total\_count": 2 } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### stat

> **POST** /monitoring/v1/project-alert-config/stat

\ <br>

## Message

### AlertOptions

* **notification\_urgency** (UrgencyOption) `Required`
* **recovery\_mode** (RecoveryOption) `Required`

  <br>

### CreateProjectAlertConfigRequest

* **project\_id** (string) `Required`
* **escalation\_policy\_id** (string)
* **options** (AlertOptions)

  <br>

### ProjectAlertConfigInfo

* **project\_id** (string) `Required`
* **options** (AlertOptions) `Required`
* **escalation\_policy\_info** (EscalationPolicyInfo) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **created\_at** (string) `Required`

  <br>

### ProjectAlertConfigQuery

* **query** (Query)
* **project\_id** (string)
* **escalation\_policy\_id** (string)

  <br>

### ProjectAlertConfigRequest

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

  <br>

### ProjectAlertConfigStatQuery

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

  <br>

### ProjectAlertConfigsInfo

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

  <br>

### UpdateProjectAlertConfigRequest

* **project\_id** (string) `Required`
* **escalation\_policy\_id** (string)
* **options** (AlertOptions)

  <br>