Veeam ONE REST API

Veeam ONE REST API allows you to query information about Veeam ONE entities and perform operations with these entities using HTTP requests and standard HTTP methods.

Vulnerability Management · Veeam App

Details

IDVeeam ONE REST API
ProviderVeeam
CategoryVulnerability Management
From Version6.10.0
Docker Imagedemisto/python3:3.12.13.10116658
Supported ModulesAgentix XSIAM

README

Veeam ONE REST API allows you to query information about Veeam ONE entities and perform operations with these entities using HTTP requests and standard HTTP methods.
This integration was integrated and tested with version 12.2.0 of Veeam ONE.

Configure Veeam ONE REST API in Cortex

Parameter Description Required
Username   True
Password   True
Resource URL   True
Trust any certificate (not secure)   False
Use system proxy settings   False
Fetch incidents   False
First fetch time   False
Triggered Alarms Per Request The maximum number of triggered alarms that can be fetched during command execution. False
API Request Timeout (Seconds)   False
Incidents Fetch Interval   False
Incident type   False

Commands

You can execute these commands from the CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

veeam-vone-get-triggered-alarms

Get All Triggered Alarms.

Base Command

veeam-vone-get-triggered-alarms

Input

Argument Name Description Required
Offset Number of first resources in the output that are excluded. Optional
Limit Number of first resources in the output that are returned. Default is 100. Optional
Filter Conditions that a resource must meet to be included in the output. Optional
Sort Order in which resources are returned. Optional
Select Property that must be explicitly returned in a response. Optional

Context Output

Path Type Description
Veeam.VONE.TriggeredAlarmInfoPage.items.triggeredAlarmId Number ID assigned to a triggered alarm.
Veeam.VONE.TriggeredAlarmInfoPage.items.name String Name of an alarm template.
Veeam.VONE.TriggeredAlarmInfoPage.items.alarmTemplateId Number ID assigned to an alarm template.
Veeam.VONE.TriggeredAlarmInfoPage.items.predefinedAlarmId Number ID assigned to an alarm.
Veeam.VONE.TriggeredAlarmInfoPage.items.triggeredTime String Date and time when an alarm triggered.
Veeam.VONE.TriggeredAlarmInfoPage.items.description String Message containing alarm details.
Veeam.VONE.TriggeredAlarmInfoPage.items.comment String Comment on a triggered alarm.
Veeam.VONE.TriggeredAlarmInfoPage.items.repeatCount Number Number of times an alarm was triggered.
Veeam.VONE.TriggeredAlarmInfoPage.items.childAlarmsCount Number Number of alarm child objects.
Veeam.VONE.TriggeredAlarmInfoPage.items.remediation.description String  
Veeam.VONE.TriggeredAlarmInfoPage.totalCount Number  

veeam-vone-resolve-triggered-alarms

Resolve Triggered Alarms.

Base Command

veeam-vone-resolve-triggered-alarms

Input

Argument Name Description Required
triggeredAlarmIds List of IDs assigned to triggered alarms that you want to resolve. Required
comment Additional information. Required
resolveType Type of alarm resolution. Required

Context Output

There is no context output for this command.

Configuration parameters

  • credentials — Username (required)
  • url — Resource URL (required)
  • insecure — Trust any certificate (not secure)
  • proxy — Use system proxy settings
  • http_request_timeout_sec — API Request Timeout (Seconds)
  • isFetch — Fetch incidents
  • first_fetch — First fetch time
  • max_fetch — Triggered Alarms Per Request
  • incidentFetchInterval — Incidents Fetch Interval
  • incidentType — Incident type

Commands (2)

  • veeam-vone-get-triggered-alarms

    Get All Triggered Alarms.

  • veeam-vone-resolve-triggered-alarms

    Resolve Triggered Alarms.

Source

VeeamONERESTAPI.py VeeamONERESTAPI_test.py VeeamONERESTAPI.yml VeeamONERESTAPI_description.md
Download History Raw 
Veeam ONE REST API allows you to query information about Veeam ONE entities and perform operations with these entities using HTTP requests and standard HTTP methods.
For more details, see [Veeam ONE REST API Reference.](https://helpcenter.veeam.com/docs/one/rest/overview.html?ver=120)

## Prerequisites

To add a Veeam ONE instance, you need the following information:
- Credentials with administrator privileges you use to connect to the Veeam ONE server. These credentials are used by the integration to obtain an access token and get to Veeam ONE REST API resources.
- The FQDN of the Veeam ONE server.
- Port used to connect to the Veeam ONE REST API on the Veeam ONE server.

## Instance Settings

Specify the following settings:
- **Name** — Name of the Veeam ONE instance. Select the **Fetches incidents** setting to start fetching incidents from the instance and view data on the Veeam Incident Dashboard.
- **Credentials** — Credentials you use to connect to the Veeam ONE server. Must have administrator privileges.
- **Resource URL** — URL that you use to connect to the Veeam ONE REST API:
  - Format — *\<hostname>:\<port>*
  - Default port number — *1239*
- **First fetch time** — Time period for which incidents will be fetched for the first time. The default value is *3 days*.
- **Triggered Alarms Per Request** — Maximum number of triggered alarms that can be fetched per each execution of the **Get All Triggered Alarms** command. The default value is *200*.
- **API Request Timeout (Seconds)** — Timeout for Veeam ONE REST API requests. The default value is *120*.
- **Incidents Fetch Interval** — Time interval for fetching incidents. The default value is *10 minutes*.

Other settings should be specified according to your infrastructure.

## Links
[View Integration Documentation](https://helpcenter.veeam.com/docs/security_plugins_xsoar/guide/)