Alarms

This resource collection represents Veeam ONE alarms.

Get All Alarms

Returns a collection resource representation of all alarms.

SecurityBearer

Request

query Parameters

Offset	integer <int32> Default: 0
Limit	integer <int32> Default: 100
Filter	string
Sort	string
Select	string

Responses

200

Success

403

Forbidden

get/api/v2.3/alarms/templates

Request samples

curl

Response samples

application/json

{"items": [{"alarmTemplateId": 114,
"name": "Topology collection failure",
"type": "Internal",
"predefinedAlarmId": 114,
"knowledgeSummary": "Veeam ONE Monitoring Server failed to collect infrastructure topology",
"knowledgeCause": "Virtual Server might not be accessible",
"knowledgeResolution": "Make sure Virtual Server is accessible",
"knowledgeCustom": null,
"knowledgeExternal": "See a corresponding event description for more information",
"isEnabled": true,
"isPredefined": true,
"assignments": [{"objectId": 0,
"objectName": "Virtual Infrastructure",
"objectType": "VirtualInfrastructure"
},
{"objectId": 3,
"objectName": "VMware Cloud Director",
"objectType": "CloudDirectorInfrastructure"
},
{"objectId": 2,
"objectName": "Veeam Backup & Replication",
"objectType": "VbrInfrastructure"
}
],
"exclusions": [ ]
},
{"alarmTemplateId": 115,
"name": "Performance data collection failure",
"type": "Internal",
"predefinedAlarmId": 115,
"knowledgeSummary": "Veeam ONE Monitoring Server failed to collect performance data from the objects specified",
"knowledgeCause": "There might be multiple reasons for this:Virtual Server might not be accessibleVirtual Server is under heavy load",
"knowledgeResolution": "Verify that Virtual Server is availableMake sure firewall on Virtual Server allows incoming connectionsCheck account permissions used to connect to Virtual Server specifiedUse native tools to test connection to specified server",
"knowledgeCustom": null,
"knowledgeExternal": "See a corresponding event description for more information",
"isEnabled": true,
"isPredefined": true,
"assignments": [{"objectId": 0,
"objectName": "Virtual Infrastructure",
"objectType": "VirtualInfrastructure"
},
{"objectId": 3,
"objectName": "VMware Cloud Director",
"objectType": "CloudDirectorInfrastructure"
},
{"objectId": 2,
"objectName": "Veeam Backup & Replication",
"objectType": "VbrInfrastructure"
}
],
"exclusions": [ ]
},
{"alarmTemplateId": 116,
"name": "Events data collection failure",
"type": "Internal",
"predefinedAlarmId": 116,
"knowledgeSummary": "Veeam ONE Monitoring Server failed to collect events data from the objects specified",
"knowledgeCause": "There might be multiple reasons for this:Virtual Server might not be accessibleVirtual Server is under heavy load",
"knowledgeResolution": "Verify that Virtual Server is availableMake sure firewall on Virtual Server allows incoming connectionsCheck account permissions used to connect to Virtual Server specifiedUse native tools to test connection to specified server",
"knowledgeCustom": null,
"knowledgeExternal": "See a corresponding event description for more information",
"isEnabled": true,
"isPredefined": true,
"assignments": [{"objectId": 0,
"objectName": "Virtual Infrastructure",
"objectType": "VirtualInfrastructure"
},
{"objectId": 3,
"objectName": "VMware Cloud Director",
"objectType": "CloudDirectorInfrastructure"
},
{"objectId": 2,
"objectName": "Veeam Backup & Replication",
"objectType": "VbrInfrastructure"
}
],
"exclusions": [ ]
},
{"alarmTemplateId": 349,
"name": "Veeam ONE license exceeded",
"type": "Internal",
"predefinedAlarmId": 349,
"knowledgeSummary": "You have exceeded your license limit, and are no longer compliant with your Veeam licensing agreement.",
"knowledgeCause": "The number of monitored workloads from Veeam Backup & Replication or virtual infrastructure or the number of monitored server sockets does not match the value specified in the license file.",
"knowledgeResolution": "To avoid service interruptions from future growth, we recommend you deploy an updated license key to cover the newly monitored workloads.",
"knowledgeCustom": null,
"knowledgeExternal": "",
"isEnabled": true,
"isPredefined": true,
"assignments": [{"objectId": 0,
"objectName": "Virtual Infrastructure",
"objectType": "VirtualInfrastructure"
},
{"objectId": 2,
"objectName": "Veeam Backup & Replication",
"objectType": "VbrInfrastructure"
},
{"objectId": 4,
"objectName": "Veeam Backup for Microsoft 365",
"objectType": "Vbm365Infrastructure"
}
],
"exclusions": [ ]
}
],
"totalCount": 4
}

Get Alarm

Returns a resource representation of an alarm with the specified ID.

SecurityBearer

Request

path Parameters

alarmTemplateId

required

integer <int64>

Responses

200

Success

403

Forbidden

get/api/v2.3/alarms/templates/{alarmTemplateId}

Request samples

curl

Response samples

application/json

{"alarmTemplateId": 349,
"name": "Veeam ONE license exceeded",
"type": "Internal",
"predefinedAlarmId": 349,
"knowledgeSummary": "You have exceeded your license limit, and are no longer compliant with your Veeam licensing agreement.",
"knowledgeCause": "The number of monitored workloads from Veeam Backup & Replication or virtual infrastructure or the number of monitored server sockets does not match the value specified in the license file.",
"knowledgeResolution": "To avoid service interruptions from future growth, we recommend you deploy an updated license key to cover the newly monitored workloads.",
"knowledgeCustom": null,
"knowledgeExternal": "",
"isEnabled": true,
"isPredefined": true,
"assignments": [{"objectId": 0,
"objectName": "Virtual Infrastructure",
"objectType": "VirtualInfrastructure"
},
{"objectId": 2,
"objectName": "Veeam Backup & Replication",
"objectType": "VbrInfrastructure"
},
{"objectId": 4,
"objectName": "Veeam Backup for Microsoft 365",
"objectType": "Vbm365Infrastructure"
}
],
"exclusions": [ ]
}

Get All Triggered Alarms

Returns a collection resource representation of all triggered alarms.

SecurityBearer

Request

query Parameters

Offset	integer <int32> Default: 0
Limit	integer <int32> Default: 100
Filter	string
Sort	string
Select	string

Responses

200

Success

403

Forbidden

get/api/v2.3/alarms/triggeredAlarms

Request samples

curl

Response samples

application/json

{"items": [{"triggeredAlarmId": 1,
"name": "Latest snapshot age",
"alarmTemplateId": 112,
"predefinedAlarmId": 112,
"triggeredTime": "2025-07-06T04:59:34.77Z",
"status": "Warning",
"description": "VM snapshot (VM Snapshot 02.02.2023, 13:20:27s) age (3 days) is older than a defined threshold (2 days)",
"comment": "",
"repeatCount": 1,
"alarmSource": {"objectId": 40,
"objectName": "avonr4_YK",
"objectType": "VSphereVm"
},
"childAlarmsCount": 0,
"remediation": [{"description": "Delete snapshot",
"mode": "Manual"
}
]
},
{"triggeredAlarmId": 27,
"name": "Too many snapshots on the VM",
"alarmTemplateId": 248,
"predefinedAlarmId": 248,
"triggeredTime": "2025-07-06T05:21:37.143Z",
"status": "Warning",
"description": "VM snapshots number (3) has breached the configured threshold (3)",
"comment": "",
"repeatCount": 1,
"alarmSource": {"objectId": 1013,
"objectName": "amg-deb9-en",
"objectType": "VSphereVm"
},
"childAlarmsCount": 0,
"remediation": [{"description": "Delete snapshot",
"mode": "Manual"
}
]
},
{"triggeredAlarmId": 26,
"name": "Latest snapshot age",
"alarmTemplateId": 112,
"predefinedAlarmId": 112,
"triggeredTime": "2025-07-06T05:21:37.143Z",
"status": "Warning",
"description": "VM snapshot (v6) age (3 weeks) is older than a defined threshold (2 days)",
"comment": "Low priority",
"repeatCount": 1,
"alarmSource": {"objectId": 1013,
"objectName": "amg-deb9-en",
"objectType": "VSphereVm"
},
"childAlarmsCount": 0,
"remediation": [{"description": "Delete snapshot",
"mode": "Manual"
}
]
},
{"triggeredAlarmId": 28,
"name": "Latest snapshot age",
"alarmTemplateId": 112,
"predefinedAlarmId": 112,
"triggeredTime": "2025-07-06T05:21:37.143Z",
"status": "Warning",
"description": "VM snapshot (v6) age (3 weeks) is older than a defined threshold (2 days)",
"comment": "High priority",
"repeatCount": 1,
"alarmSource": {"objectId": 1014,
"objectName": "amg-deb10-jp",
"objectType": "VSphereVm"
},
"childAlarmsCount": 0,
"remediation": [{"description": "Delete snapshot",
"mode": "Manual"
}
]
}
],
"totalCount": 4
}

Get Triggered Alarm

Returns a resource representation of a triggered alarm with the specified UID.

SecurityBearer

Request

path Parameters

triggeredAlarmId

required

integer <int64>

Responses

200

Success

403

Forbidden

get/api/v2.3/alarms/triggeredAlarms/{triggeredAlarmId}

Request samples

curl

Response samples

application/json

{"triggeredAlarmId": 28,
"name": "Latest snapshot age",
"alarmTemplateId": 112,
"predefinedAlarmId": 112,
"triggeredTime": "2025-07-06T05:21:37.143Z",
"status": "Warning",
"description": "VM snapshot (v6) age (3 weeks) is older than a defined threshold (2 days)",
"comment": "Low priority",
"repeatCount": 1,
"alarmSource": {"objectId": 1014,
"objectName": "amg-deb10-jp",
"objectType": "VSphereVm"
},
"childAlarmsCount": 0,
"remediation": [{"description": "Delete snapshot",
"mode": "Manual"
}
]
}

Get All Triggered Alarms for Child Objects

Returns a collection resource representation of all triggered alarms for child objects.

SecurityBearer

Request

path Parameters

triggeredAlarmId

required

integer <int64>

query Parameters

Offset	integer <int32> Default: 0
Limit	integer <int32> Default: 100
Filter	string
Sort	string
Select	string

Responses

200

Success

403

Forbidden

get/api/v2.3/alarms/triggeredAlarms/{triggeredAlarmId}/triggeredChildAlarms

Request samples

curl

Response samples

application/json

{"items": [{"childAlarmId": 1,
"triggeredAlarmId": 1,
"triggeredTime": "2023-01-19T17:51:45.633Z",
"status": "Warning",
"source": "Job \"Backup Job 6\"",
"description": "Job \"Backup Job 6\" has ended with warning\nThis backup server is using debug module, make sure this is intentional",
"repeatCount": 1,
"comment": ""
},
{"childAlarmId": 2,
"triggeredAlarmId": 1,
"triggeredTime": "2025-07-12T12:36:22.09Z",
"status": "Error",
"source": "Job \"FF Job will be deleted\"",
"description": "Job \"FF Job will be deleted\" has ended with error\nFF - Task failed. Error: SSH credentials are not set for the host '172.24.186.59'\nProcessing finished with errors at 2/12/2023 4:34:28 AM",
"repeatCount": 5,
"comment": ""
}
],
"totalCount": 2
}

Resolve Triggered Alarms

Resolves triggered alarms with the specified IDs.

SecurityBearer

Request

Request Body schema: application/json

comment required	string Additional information.
triggeredAlarmIds required	Array of integers <int64> List of IDs assigned to triggered alarms that you want to resolve.
resolveType	string [ 1 .. 3 ] Type of alarm resolution. Enum: "Resolve" "Acknowledge" "Action"

Responses

200

Success

403

Forbidden

post/api/v2.3/alarms/triggeredAlarms/resolve

Request samples

Payload
curl

application/json

{"triggeredAlarmIds": [1253
],
"comment": "Resolved",
"resolveType": "Resolve"
}

Response samples

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Resolve Child Triggered Alarms of Parent Triggered Alarm

Resolves all child triggered alarms of a parent triggered alarm with the specified ID.

SecurityBearer

Request

path Parameters

triggeredAlarmId

required

integer <int64>

Request Body schema: application/json

comment required	string Additional information.
triggeredChildAlarmIds required	Array of integers <int64> List of IDs assigned to triggered child alarms that you want to resolve.
resolveType	string [ 1 .. 3 ] Type of alarm resolution. Enum: "Resolve" "Acknowledge" "Action"

Responses

200

Success

403

Forbidden

post/api/v2.3/alarms/triggeredAlarms/{triggeredAlarmId}/triggeredChildAlarms/resolve

Request samples

Payload
curl

application/json

{"triggeredChildAlarmIds": [1253
],
"comment": "Resolved",
"resolveType": "Resolve"
}

Response samples

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Resolve All Child Triggered Alarms

Resolves all triggered alarms for child objects.

SecurityBearer

Request

Request Body schema: application/json

comment required	string Additional information.
triggeredChildAlarmIds required	Array of integers <int64> List of IDs assigned to triggered child alarms that you want to resolve.
resolveType	string [ 1 .. 3 ] Type of alarm resolution. Enum: "Resolve" "Acknowledge" "Action"

Responses

200

Success

403

Forbidden

post/api/v2.3/alarms/triggeredChildAlarms/resolve

Request samples

Payload
curl

application/json

{"triggeredChildAlarmIds": [1253
],
"comment": "Resolved",
"resolveType": "Resolve"
}

Response samples

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}