Help Center/ Cloud Eye/ API Reference/ API V2/ Alarm Templates/ Deleting Custom Alarm Templates in Batches

Updated on 2025-11-20 GMT+08:00

View PDF

Deleting Custom Alarm Templates in Batches

This API is used to delete custom alarm templates in batches.

POST /v2/{project_id}/alarm-templates/batch-delete

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Tenant token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
template_ids	Yes	Array of strings	IDs of alarm templates to be deleted in batches. Alarm templates that are not associated with alarm rules can be deleted in batches. For alarm templates that are associated with alarm rules, you can delete only one alarm template at a time. If you delete multiple ones, an exception will be returned.
delete_associate_alarm	Yes	Boolean	Whether alarm rules associated with an alarm template will be deleted when you delete the alarm template. true indicates that the alarm rules will be deleted. false indicates that only the alarm template will be deleted.

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
template_ids	Array of strings	IDs of alarm templates that were deleted successfully.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Status codes customized by each cloud service when a request error occurs.
error_msg	String	Request error message.
request_id	String	Request ID.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Status codes customized by each cloud service when a request error occurs.
error_msg	String	Request error message.
request_id	String	Request ID.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Status codes customized by each cloud service when a request error occurs.
error_msg	String	Request error message.
request_id	String	Request ID.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Status codes customized by each cloud service when a request error occurs.
error_msg	String	Request error message.
request_id	String	Request ID.

Deleting custom alarm templates in batches.

{
  "template_ids" : [ "at1628592157541dB1klWgY6" ],
  "delete_associate_alarm" : false
}

Status code: 200

IDs of alarm templates successfully deleted.

{
  "template_ids" : [ "at1628592157541dB1klWgY6" ]
}

Status Code	Description
200	IDs of alarm templates successfully deleted.
400	Parameter verification failed.
401	Not authenticated.
403	Authentication failed.
500	Internal system error.