Get VBR server identity: name, build/patch version, database info, and the negotiated REST API version. Call this first to confirm connectivity and to learn which VBR build you are operating against.

Escape hatch for ANY VBR Public REST API v1 endpoint not covered by a dedicated tool — failover plans, SureBackup, agents, cloud/SaaS, tape, tags, etc. Supply the HTTP method and path (e.g. GET "/api/v1/failoverPlans"). This is what makes the server work across every VBR build: if a newer version adds an endpoint, you can reach it here without a code change. In read-only mode, only GET is permitted.

List all configured jobs (backup, replication, backup copy, agent, etc.) with their IDs and settings. Use nameFilter to narrow by job name and typeFilter to narrow by job type. Job IDs returned here feed every other job tool.

Get the full configuration of a single job by its ID (schedule, virtual objects, storage, retention).

Return the live state of jobs: current status (running/idle), last result (Success/Warning/Failed), last run time, next scheduled run, and progress. This is the fastest way to answer "what is failing?" or "what is running right now?".

List the VMs / machines / objects that a given job protects.

Start a backup/replication job now. Returns the session that was created — pass its ID to get_session / get_session_logs to follow progress.

Gracefully stop a currently running job. Optionally set graceful=false to stop immediately.

Retry the failed objects of a job after a Failed/Warning result.

Enable a disabled job so it runs on its schedule again.

Disable a job so it no longer runs on schedule (does not delete it).

Create a new backup/replication job. Provide the full job specification object as documented by the VBR REST API for your build. Tip: call get_job on an existing similar job to obtain a template spec, edit it, and pass it here.

Replace a job configuration by ID. Fetch the current spec with get_job, modify the fields you need (schedule, retention, included objects, repository), and pass the whole object back here.

Permanently delete a job configuration by ID. Destructive — the job and its schedule are removed. Backups already created are retained unless removed separately. Requires a specific job ID; there is no bulk delete.

List job run sessions, newest first. Filter by jobId to see one job’s history, by stateFilter ("Working"/"Stopped") for live runs, or by typeFilter. Each session ID feeds get_session and get_session_logs.

Get one session: result, state, progress percentage, start/end time, and per-object results.

Return the detailed log records for a session — the individual steps and their status. This is the primary source for understanding WHY a run failed or warned (VDDK errors, snapshot failures, network timeouts, repository full, etc.).

Stop an in-progress session by ID (e.g. cancel a stuck run).

One-shot triage: given a job ID, find its most recent session, read the failure/warning log records, and return the job state, the latest session result, and the log entries flagged Failed/Warning so you can explain the root cause and propose a fix. Start here whenever the user asks "why is failing?".

List backup chains known to VBR (the stored result of jobs). Each backup groups the restore points for its protected objects. Filter by name where supported.

List the protected objects (VMs/machines) contained in a specific backup.

List recovery points available to restore from. Filter by nameFilter to find points for a specific VM/machine. Restore point IDs feed the restore tools.

Get details for a single restore point: creation time, type (full/incremental), and source object.

List restore operations (their sessions) so you can track progress of an in-flight recovery.

Launch Instant Recovery of a VMware VM directly from a backup restore point. Impactful — it publishes a running VM into your vSphere environment. Provide the restore point ID and the VMware restore specification (target host, resource pool, datastore, VM name, power-on, NIC mapping) per your VBR build’s schema. If your build’s field names differ, fetch the exact schema from https://:9419/swagger and submit via veeam_api_request instead.

Stop an in-progress restore session (e.g. cancel a mount / Instant Recovery publish).

List all backup repositories (their type, path, and configuration).

Return capacity, used space, and free space per repository. Use this to answer "is a repository full?" — a common root cause of Failed backups.

List backup proxies and their configuration (transport mode, max concurrent tasks).

List servers managed by VBR (vCenter/ESXi hosts, Windows/Linux servers). Host IDs here are needed when browsing inventory to build a job.

List credential records known to VBR (usernames/descriptions and their IDs — never secrets). Credential IDs are referenced when creating jobs or adding managed servers.

Browse the virtual infrastructure (hosts, folders, VMs) beneath a managed server so you can select objects to include when creating a job. Provide the hostId from list_managed_servers.

List malware-detection events raised by VBR — suspicious activity, infected restore points, encrypted-data and deleted-file anomalies. Requires VBR 12.1 or newer; on older builds this returns an error (that is expected). Feed these events into ransomware detection and incident response.

Return VBR’s malware-detection configuration (what is enabled, thresholds, exclusions). Requires VBR 12.1+.