Veeam List
CertifiedEnterprise EditionList Veeam Backup & Replication jobs
Veeam List
List Veeam Backup & Replication jobs
Fetches jobs configured on the Veeam Backup & Replication server, with optional filters and pagination.
Defaults to a page size of 100 and fetchType=FETCH; STORE writes results to internal storage and returns
a URI, while NONE only reports counts.
type: io.kestra.plugin.ee.veeam.jobs.ListExamples
List all backup jobs.
id: list_veeam_jobs
namespace: company.team
tasks:
- id: list_jobs
type: io.kestra.plugin.ee.veeam.jobs.List
host: "{{ secret('VEEAM_HOST') }}"
username: "{{ secret('VEEAM_USERNAME') }}"
password: "{{ secret('VEEAM_PASSWORD') }}"
filters:
typeFilter: "Backup"
fetchType: FETCH
Properties
host *string
Veeam Backup & Replication server host
Hostname or IP address of the Veeam Backup & Replication server exposing the REST API.
password *string
Password
Password for username. Treat it as a secret, e.g. {{ secret('VEEAM_PASSWORD') }}.
username *string
Username
Veeam Backup & Replication account used for the OAuth 2.0 password grant.
apiVersion string
1.3-rev1API version
Value sent as the mandatory x-api-version header on every request, including authentication. Must match a version
supported by the target server; a missing or unsupported value causes VBR to reject the request with HTTP 400.
Defaults to 1.3-rev1 (VBR 12.1 and later).
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150fetchType string
FETCHSTOREFETCHFETCH_ONENONEFetch type
FETCH_ONE outputs the first row, FETCH outputs all rows, STORE saves rows to internal storage and
returns a URI, NONE returns only counts.
filters object
Filters
Query filters passed as-is to the Veeam /jobs endpoint (for example: typeFilter, nameFilter).
Empty map fetches all jobs.
limit integerstring
100Page size
Number of jobs requested per page while paginating through the Veeam API. Defaults to 100.
options
HTTP client configuration
Optional HTTP client overrides (timeouts, proxy, TLS). Veeam Backup & Replication servers ship a self-signed
certificate by default: set options.ssl.insecureTrustAllCertificates: true, or provide a trust store, otherwise
the first request fails with a TLS handshake error rather than a clear authentication error.
io.kestra.core.http.client.configurations.HttpConfiguration
falseIf true, allow a failed response code (response code >= 400)
List of response code allowed for this request
The authentication to use.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
The password for HTTP basic authentication.
The username for HTTP basic authentication.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
The token for bearer token authentication.
io.kestra.core.http.client.configurations.DigestAuthConfiguration
The password for HTTP Digest authentication.
The username for HTTP Digest authentication.
UTF-8The default charset for the request.
java.nio.charset.Charset
trueWhether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).
Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.
trueWhether redirects should be followed automatically.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The proxy configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTDIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
The SSL request options
io.kestra.core.http.client.configurations.SslOptions
Whether to disable checking of the remote SSL certificate.
Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.
The timeout configuration.
io.kestra.core.http.client.configurations.TimeoutConfiguration
The time allowed to establish a connection to the server before failing.
PT5MThe time allowed for a read connection to remain idle before closing it.
port integerstring
9419REST API port
TCP port of the Veeam Backup & Replication REST API. Defaults to 9419.
Outputs
row object
First row
Populated only when fetchType=FETCH_ONE.
rows array
Fetched rows
Populated only when fetchType=FETCH.
size integer
Rows fetched
Size of the fetched result set.
total integer
Total rows available
Total number of rows available on the Veeam server, ignoring pagination.
uri string
uriStored data URI
Internal storage URI containing all fetched rows serialized as ION. Populated only when fetchType=STORE.
