### Quick Backup Response Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Jobs Example response body returned after successfully starting a quick backup session. ```json { "sessionType": "BackupJob", "state": "Stopped", "platformName": "VMware", "id": "9ff48f05-3367-42a8-af03-d875a5969295", "name": "Backup Job 1", "jobId": "6bf39221-c79b-49ff-8537-26a37b0a9080", "creationTime": "2024-10-29T11:11:49.839619+01:00", "endTime": "2024-10-29T11:25:33.456789+01:00", "progressPercent": 100, "result": { "result": "Success", "message": "Success", "isCanceled": false }, "resourceId": "6bf39221-c79b-49ff-8537-26a37b0a9080", "usn": 149421, "platformId": "00000000-0000-0000-0000-000000000000" } ``` -------------------------------- ### Example: Requesting a Collection of Resources Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/SectionOverview Append a resource collection endpoint to the base URL to retrieve a list of resources. This example shows how to get a list of sessions. ```text https://enterprise01.tech.local:9419/api/v1/sessions ``` -------------------------------- ### License - Get Installed License Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Service Retrieves information about the currently installed license. ```APIDOC ## GET /api/v1/license ### Description Retrieves details about the currently installed license on the Veeam Backup & Replication server, including license type, expiration date, and features. ### Method GET ### Endpoint /api/v1/license ### Response #### Success Response (200) - **licenseType** (string) - The type of the installed license (e.g., Perpetual, Subscription). - **expirationDate** (string) - The expiration date of the license in ISO 8601 format. - **features** (array) - A list of features enabled by the license. #### Response Example ```json { "licenseType": "Perpetual", "expirationDate": "2099-12-31T23:59:59Z", "features": ["Backup", "Replication", "Deduplication"] } ``` ``` -------------------------------- ### License - Get Installed License Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Automation Retrieves information about the currently installed license. ```APIDOC ## GET /api/v1/license ### Description Get Installed License ### Method GET ### Endpoint /api/v1/license ``` -------------------------------- ### WAN Accelerator Response Example Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/WAN-Accelerators An example JSON response for a GET request to retrieve WAN accelerator details. Includes server and cache configurations. ```json { "data": [ { "id": "d8ecb099-ca8e-4cd3-b12f-10f36508942b", "name": "enterprise03.tech.local", "server": { "hostId": "b29b8591-bf31-4174-b69b-25ac296a20b2", "description": "Created by TECH\sheila.d.cory", "trafficPort": 6165, "streamsCount": 5, "highBandwidthModeEnabled": true }, "cache": { "cacheSizeUnit": "GB", "cacheFolder": "C:\\VeeamWAN", "cacheSize": 100 } }, { "id": "bbd849d3-226e-470c-804c-fdd2b09da683", "name": "enterprise05.tech.local", "server": { "hostId": "612af0b0-ce61-4315-a82c-b056669e48ae", "description": "Created by TECH\sheila.d.cory", "trafficPort": 6165, "streamsCount": 5, "highBandwidthModeEnabled": false }, "cache": { "cacheSizeUnit": "GB", "cacheFolder": "C:\\VeeamWAN", "cacheSize": 50 } } ], "pagination": { "total": 2, "count": 2, "skip": 0, "limit": 200 } } ``` -------------------------------- ### Job Session Response Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Jobs Example response body returned upon successfully starting a job session. ```json { "sessionType": "BackupJob", "state": "Starting", "id": "b1380736-18a9-4fac-adfe-20abc570e8de", "name": "Oracle Backup", "jobId": "75fc491a-d158-4380-a433-ebc42a28e4df", "creationTime": "2024-02-04T18:46:49.067+01:00", "endTime": "2024-02-04T18:50:15.123+01:00", "progressPercent": 0, "result": { "result": "None", "message": "", "isCanceled": false }, "usn": 0 } ``` -------------------------------- ### Start Configuration Backup Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Backups Manually start a configuration backup. ```APIDOC ## POST /configurationBackup/start ### Description Manually starts a configuration backup. ### Method POST ### Endpoint /configurationBackup/start ``` -------------------------------- ### Start Configuration Backup Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Replicas Manually start a configuration backup. ```APIDOC ## POST /api/v1/config/backup/start ### Description Manually start a configuration backup. ### Method POST ### Endpoint /api/v1/config/backup/start ``` -------------------------------- ### Get Installed License Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Tasks Retrieves information about the currently installed license. ```APIDOC ## GET /api/v1/license ### Description Retrieves information about the currently installed license. ### Method GET ### Endpoint /api/v1/license ``` -------------------------------- ### Start Configuration Backup (cURL) Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Configuration-Backup Use this cURL command to initiate a configuration backup. Ensure you replace `` with your actual API token and specify the correct `x-api-version`. ```curl curl -i -X POST \ https://api.example.com:9419/api/v1/configBackup/backup \ -H 'Authorization: Bearer ' \ -H 'x-api-version: 1.3-rev1' ``` -------------------------------- ### Start Configuration Backup Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Failback Initiates a manual configuration backup. ```APIDOC ## POST /configuration-backup/start ### Description Starts a configuration backup. ### Method POST ### Endpoint /configuration-backup/start ``` -------------------------------- ### Get Installed License Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/SectionHowTo Retrieves information about the currently installed license. ```APIDOC ## GET /api/v1/license ### Description Retrieves information about the currently installed license. ### Method GET ### Endpoint /api/v1/license ### Response #### Success Response (200) - **licenseType** (string) - The type of the license (e.g., "Perpetual", "Subscription"). - **edition** (string) - The edition of the license (e.g., "Enterprise Plus"). - **expirationDate** (string) - The expiration date of the license in ISO 8601 format. - **supportExpirationDate** (string) - The support expiration date in ISO 8601 format. #### Response Example ```json { "licenseType": "Subscription", "edition": "Enterprise Plus", "expirationDate": "2024-12-31T23:59:59Z", "supportExpirationDate": "2025-12-31T23:59:59Z" } ``` ``` -------------------------------- ### Get Installed License Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/SectionAbout Retrieves information about the currently installed license. ```APIDOC ## GET /api/v1/license ### Description Retrieves information about the currently installed license. ### Method GET ### Endpoint /api/v1/license ### Response #### Success Response (200) - **licenseType** (string) - The type of the installed license (e.g., 'Perpetual', 'Subscription'). - **expirationDate** (string) - The expiration date of the license (ISO 8601 format). - **edition** (string) - The edition of the license (e.g., 'Enterprise Plus'). #### Response Example { "licenseType": "Subscription", "expirationDate": "2024-12-31T23:59:59Z", "edition": "Enterprise Plus" } ``` -------------------------------- ### Start Configuration Backup Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Encryption Initiates a manual configuration backup. ```APIDOC ## POST /api/v1/configuration/backup/start ### Description Initiates a manual configuration backup. ### Method POST ### Endpoint /api/v1/configuration/backup/start ``` -------------------------------- ### Get Installed License Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/License Retrieves information about the currently installed license. ```APIDOC ## GET /api/license ### Description Retrieves information about the currently installed license. ### Method GET ### Endpoint /api/license ### Response #### Success Response (200) - **licenseInfo** (object) - Information about the installed license. ``` -------------------------------- ### Start Configuration Backup Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Deployment Initiates a manual configuration backup. ```APIDOC ## POST /configuration-backup/start ### Description Initiates a manual configuration backup. ### Method POST ### Endpoint /configuration-backup/start ``` -------------------------------- ### Start Configuration Backup Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Failover Initiates a manual configuration backup. ```APIDOC ## POST /api/v1/configuration-backup/start ### Description Initiates a manual configuration backup. ### Method POST ### Endpoint /api/v1/configuration-backup/start ``` -------------------------------- ### Get Installed License Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Agents Retrieves information about the currently installed license. ```APIDOC ## GET /api/license ### Description Retrieves information about the currently installed license on the Veeam Backup & Replication server. ### Method GET ### Endpoint /api/license ### Response #### Success Response (200 OK) - **licenseType** (string) - The type of the license (e.g., 'Perpetual', 'Subscription'). - **expirationDate** (string) - The expiration date of the license (ISO 8601 format). - **edition** (string) - The edition of the license (e.g., 'Standard', 'Enterprise Plus'). - **sockets** (integer) - The number of sockets licensed (if applicable). #### Response Example ```json { "licenseType": "Subscription", "expirationDate": "2024-12-31T23:59:59Z", "edition": "Enterprise Plus", "sockets": 100 } ``` ``` -------------------------------- ### Start Configuration Backup Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Log-export Initiates a manual configuration backup. ```APIDOC ## Start Configuration Backup ### Description Initiates a manual backup of the system configuration. ### Method POST ### Endpoint /api/configurationBackup/start ``` -------------------------------- ### Start Configuration Backup Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/SectionOverview Initiates a manual configuration backup. ```APIDOC ## POST /configurationBackup/start ### Description Initiates a manual configuration backup. ### Method POST ### Endpoint /configurationBackup/start ``` -------------------------------- ### License - Get Installed License Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Repositories Retrieves information about the currently installed license. ```APIDOC ## GET /api/v1/license ### Description Retrieves information about the currently installed license. ### Method GET ### Endpoint /api/v1/license ### Response #### Success Response (200 OK) - **licenseType** (string) - The type of the installed license (e.g., "Perpetual", "Subscription"). - **expirationDate** (string) - The expiration date of the license in ISO 8601 format. - **edition** (string) - The edition of the license (e.g., "Enterprise Plus"). ``` -------------------------------- ### Start Configuration Backup Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Sessions Initiates a manual configuration backup. ```APIDOC ## POST /api/sessions/configbackup/start ### Description Starts a configuration backup. ### Method POST ### Endpoint /api/sessions/configbackup/start ``` -------------------------------- ### Get Installed License Instances Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/License Retrieves a list of installed license instances with optional filtering and sorting. ```APIDOC ## GET /api/v1/license/instances ### Description Getting instance licenses consumption. ### Method GET ### Endpoint /api/v1/license/instances ### Parameters #### Query Parameters - **skip** (integer) - Optional - The number of records to skip. - **limit** (integer) - Optional - The maximum number of records to return. - **orderColumn** (string) - Optional - The column to order the results by. - **orderAsc** (boolean) - Optional - Whether to order in ascending order. - **nameFilter** (string) - Optional - Filter by instance name. - **hostNameFilter** (string) - Optional - Filter by host name. - **usedInstancesNumberFilter** (integer) - Optional - Filter by the number of used instances. - **typeFilter** (string) - Optional - Filter by instance type. - **instanceIdFilter** (string) - Optional - Filter by instance ID. #### Header Parameters - **x-api-version** (string) - Required - Default: 1.3-rev1 - Version and revision of the client REST API. Must be in the following format: `-`. ### Response #### Success Response (200) - **data** (array) - List of license instances. - **platformType** (string) - The platform type of the instance. - **name** (string) - The name of the instance. - **hostName** (string) - The host name of the instance. - **usedInstancesNumber** (integer) - The number of used instances. - **type** (string) - The type of the instance. - **instanceId** (string) - The ID of the instance. - **canBeRevoked** (boolean) - Whether the license can be revoked. - **pagination** (object) - Pagination details. - **total** (integer) - Total number of records. - **count** (integer) - Number of records returned. - **skip** (integer) - Number of records skipped. - **limit** (integer) - The limit of records per page. ### Response Example ```json { "data": [ { "platformType": "VMware", "name": "linbase01", "hostName": "vcenter01.tech.local", "usedInstancesNumber": 1, "type": "VM", "instanceId": "d8175a8b-942c-4ddb-a36d-0690f1b875d7", "canBeRevoked": true }, { "platformType": "Application", "name": "WINORCL01", "hostName": "WINORCL01", "usedInstancesNumber": 1, "type": "Application", "instanceId": "71c41142-888b-bc72-c46d-74322c9b32eb", "canBeRevoked": true } ], "pagination": { "total": 2, "count": 2, "skip": 0, "limit": 100 } } ``` ``` -------------------------------- ### Start Configuration Backup Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Backup-Objects Manually initiates a configuration backup. ```APIDOC ## POST /configuration-backup/start ### Description Manually initiates a configuration backup. ### Method POST ### Endpoint /configuration-backup/start ### Response #### Success Response (202) Indicates that the configuration backup has been initiated. ``` -------------------------------- ### Start Configuration Backup Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Inventory-Browser Initiates a configuration backup. ```APIDOC ## POST /api/v1/inventory/browser/configuration-backup/start ### Description Initiates a configuration backup. ### Method POST ### Endpoint /api/v1/inventory/browser/configuration-backup/start ``` -------------------------------- ### Get Installed License Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/License Retrieves the currently installed license details on the backup server. This endpoint is available to Veeam Backup Administrators and requires Bearer authentication. ```APIDOC ## Get Installed License ### Description The HTTP GET request to the `/api/v1/license` endpoint gets the installed license on the backup server. ### Method GET ### Endpoint /api/v1/license ### Parameters #### Header Parameters - **x-api-version** (string) - Required - Version and revision of the client REST API. Must be in the following format: `-`. ### Request Example ```curl curl -i -X GET \ https://api.example.com:9419/api/v1/license \ -H 'Authorization: Bearer ' \ -H 'x-api-version: 1.3-rev1' ``` ### Response #### Success Response (200 OK) - **status** (string) - The status of the license (e.g., "Valid"). - **type** (string) - The type of license (e.g., "Subscription"). - **edition** (string) - The edition of the license (e.g., "EnterprisePlus"). - **cloudConnect** (string) - Indicates if Cloud Connect is enabled (e.g., "Disabled"). - **expirationDate** (string) - The expiration date of the license in ISO 8601 format. - **licensedTo** (string) - The name of the entity the license is issued to. - **instanceLicenseSummary** (object) - Summary of instance license usage. - **package** (string) - The license package name. - **licensedInstancesNumber** (integer) - The total number of licensed instances. - **usedInstancesNumber** (integer) - The number of instances currently in use. - **newInstancesNumber** (integer) - The number of new instances available. - **rentalInstancesNumber** (integer) - The number of rental instances. - **objects** (array) - Details about licensed objects. - **type** (string) - The type of object (e.g., "Virtual Machines"). - **count** (integer) - The count of this object type. - **multiplier** (integer) - The multiplier for instance calculation. - **usedInstancesNumber** (integer) - The number of instances used for this object type. - **workload** (array) - Details about licensed workloads. - **platformType** (string) - The platform type of the workload (e.g., "VMware"). - **name** (string) - The name of the workload. - **displayName** (string) - A display name for the workload. - **hostName** (string) - The hostname of the workload. - **usedInstancesNumber** (integer) - The number of instances used for this workload. - **type** (string) - The type of workload. - **instanceId** (string) - The unique instance ID of the workload. - **canBeRevoked** (boolean) - Indicates if the instance can be revoked. - **supportId** (string) - The support ID associated with the license. - **autoUpdateEnabled** (boolean) - Indicates if auto-update is enabled. - **freeAgentInstanceConsumptionEnabled** (boolean) - Indicates if free agent instance consumption is enabled. - **IsMultiSection** (boolean) - Indicates if the license is multi-section. - **proactiveSupportEnabled** (boolean) - Indicates if proactive support is enabled. #### Response Example (200 OK) ```json { "status": "Valid", "type": "Subscription", "edition": "EnterprisePlus", "cloudConnect": "Disabled", "expirationDate": "2026-12-12T00:00:00Z", "licensedTo": "Veeam Software Group GmbH", "instanceLicenseSummary": { "package": "Backup", "licensedInstancesNumber": 100, "usedInstancesNumber": 4, "newInstancesNumber": 0, "rentalInstancesNumber": 0, "objects": [ { "type": "Virtual Machines", "count": 1, "multiplier": 1, "usedInstancesNumber": 1 }, { "type": "Applications", "count": 3, "multiplier": 1, "usedInstancesNumber": 3 } ], "workload": [ { "platformType": "VMware", "name": "rhel01", "displayName": "VM", "hostName": "vcenter01.tech.local", "usedInstancesNumber": 1, "type": "VM", "instanceId": "f28a0b09-8a24-4e8c-9e85-f4612beaa274", "canBeRevoked": true }, { "platformType": "MongoDB", "name": "mongodb01", "displayName": "Application", "hostName": "productionReplicaSet", "usedInstancesNumber": 1, "type": "Application", "instanceId": "4225b02c-df08-430f-d775-c71dba95d628", "canBeRevoked": true }, { "platformType": "MongoDB", "name": "mongodb02", "displayName": "Application", "hostName": "productionReplicaSet", "usedInstancesNumber": 1, "type": "Application", "instanceId": "422562ce-80c5-ac19-8659-30ac0c9c3550", "canBeRevoked": true }, { "platformType": "MongoDB", "name": "mongodb03", "displayName": "Application", "hostName": "productionReplicaSet", "usedInstancesNumber": 1, "type": "Application", "instanceId": "42250c5d-ca3d-fa07-8623-6fb79d8b2896", "canBeRevoked": true } ] }, "supportId": "02067762", "autoUpdateEnabled": true, "freeAgentInstanceConsumptionEnabled": true, "IsMultiSection": false, "proactiveSupportEnabled": true } ``` #### Error Responses - **401 Unauthorized**: The authorization header has been expected but not found (or found but is expired). - **403 Forbidden**: The user sending the request does not have adequate privileges to access one or more objects specified in the request. - **500 Internal server error**: The request has been received but could not be completed because of an internal error at the server side. ``` -------------------------------- ### Start Configuration Backup Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Replica-Restore-Points Initiates a configuration backup. ```APIDOC ## POST /configuration-backup/start ### Description Initiates a configuration backup. ### Method POST ### Endpoint /configuration-backup/start ``` -------------------------------- ### Start Configuration Backup Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Restore-Points Initiates a configuration backup. ```APIDOC ## POST /api/v1/configuration-backup/start ### Description Initiates a configuration backup. ### Method POST ### Endpoint /api/v1/configuration-backup/start ``` -------------------------------- ### Server Time Request Example Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/SectionOverview This example demonstrates how to request the current server time using the REST API. It includes the GET request and the required 'x-api-version' header. ```http GET https://enterprise01.tech.local:9419/api/v1/serverTime Request Header x-api-version:1.3-rev1 ``` -------------------------------- ### Start Configuration Backup Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Agents Initiates a configuration backup. ```APIDOC ## POST /agents/configuration-backup/start ### Description Initiates a configuration backup. ### Method POST ### Endpoint /agents/configuration-backup/start ``` -------------------------------- ### Start Configuration Backup Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/License Initiates a configuration backup. ```APIDOC ## POST /configurationBackup/start ### Description Initiates a configuration backup. ### Method POST ### Endpoint /configurationBackup/start ``` -------------------------------- ### Get Credentials Record using cURL Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Credentials Example of how to retrieve a specific credentials record using a GET request with cURL. Replace `{id}` with the actual credentials ID. ```bash curl -i -X GET \ 'https://api.example.com:9419/api/v1/credentials/{id}' \ -H 'Authorization: Bearer ' \ -H 'x-api-version: 1.3-rev1' ``` -------------------------------- ### Get Scale-Out Backup Repository Request Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Repositories Example of a GET request to retrieve a specific scale-out backup repository by its ID. Requires the repository's unique identifier in the path. ```http GET /api/v1/backupInfrastructure/scaleOutRepositories/{id} HTTP/1.1 Host: {vbr_server} Accept: application/json Authorization: Bearer {access_token} ``` -------------------------------- ### Start Configuration Backup Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Login Initiates a configuration backup. ```APIDOC ## POST /configurationBackup/start ### Description Starts a configuration backup. ### Method POST ### Endpoint /configurationBackup/start ``` -------------------------------- ### Installed License JSON Response Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/License This is an example of the JSON response received when successfully querying the installed license. It provides details on license status, type, expiration, and instance usage. ```json { "status": "Valid", "type": "Subscription", "edition": "EnterprisePlus", "cloudConnect": "Disabled", "expirationDate": "2026-12-12T00:00:00Z", "licensedTo": "Veeam Software Group GmbH", "instanceLicenseSummary": { "package": "Backup", "licensedInstancesNumber": 100, "usedInstancesNumber": 4, "newInstancesNumber": 0, "rentalInstancesNumber": 0, "objects": [ { "type": "Virtual Machines", "count": 1, "multiplier": 1, "usedInstancesNumber": 1 }, { "type": "Applications", "count": 3, "multiplier": 1, "usedInstancesNumber": 3 } ], "workload": [ { "platformType": "VMware", "name": "rhel01", "displayName": "VM", "hostName": "vcenter01.tech.local", "usedInstancesNumber": 1, "type": "VM", "instanceId": "f28a0b09-8a24-4e8c-9e85-f4612beaa274", "canBeRevoked": true }, { "platformType": "MongoDB", "name": "mongodb01", "displayName": "Application", "hostName": "productionReplicaSet", "usedInstancesNumber": 1, "type": "Application", "instanceId": "4225b02c-df08-430f-d775-c71dba95d628", "canBeRevoked": true }, { "platformType": "MongoDB", "name": "mongodb02", "displayName": "Application", "hostName": "productionReplicaSet", "usedInstancesNumber": 1, "type": "Application", "instanceId": "422562ce-80c5-ac19-8659-30ac0c9c3550", "canBeRevoked": true }, { "platformType": "MongoDB", "name": "mongodb03", "displayName": "Application", "hostName": "productionReplicaSet", "usedInstancesNumber": 1, "type": "Application", "instanceId": "42250c5d-ca3d-fa07-8623-6fb79d8b2896", "canBeRevoked": true } ] }, "supportId": "02067762", "autoUpdateEnabled": true, "freeAgentInstanceConsumptionEnabled": true, "IsMultiSection": false, "proactiveSupportEnabled": true } ``` -------------------------------- ### Get Installed License via cURL Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/License Use this cURL command to retrieve the installed license details from the backup server. Ensure you include the correct Authorization token and API version in the headers. ```bash curl -i -X GET \ https://api.example.com:9419/api/v1/license \ -H 'Authorization: Bearer ' \ -H 'x-api-version: 1.3-rev1' ``` -------------------------------- ### Configuration Backup Operations Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Tasks Operations for managing configuration backups, including getting, editing, and starting backups. ```APIDOC ## GET /configurationBackup ### Description Retrieves the current configuration backup settings. ### Method GET ### Endpoint /configurationBackup ``` ```APIDOC ## PUT /configurationBackup ### Description Edits the configuration backup settings. ### Method PUT ### Endpoint /configurationBackup ``` ```APIDOC ## POST /configurationBackup/start ### Description Starts a configuration backup. ### Method POST ### Endpoint /configurationBackup/start ``` -------------------------------- ### Install License Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Tasks Installs a new license file on the backup server. ```APIDOC ## POST /api/v1/license/install ### Description Installs a new license file on the backup server. ### Method POST ### Endpoint /api/v1/license/install ``` -------------------------------- ### Install License Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Agents Installs a new license file on the backup server. ```APIDOC ## POST /api/license/install ### Description Installs a new license file on the Veeam Backup & Replication server. ### Method POST ### Endpoint /api/license/install ### Request Body - **licenseFile** (string) - Required - The content of the license file (base64 encoded). ### Response #### Success Response (204 No Content) Indicates that the license has been successfully installed. #### Response Example (No content) ``` -------------------------------- ### Failback Response Sample Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Failback Example response when starting a failback operation, indicating the session details and status. ```json { "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39", "sessionType": "Infrastructure", "creationTime": "2019-08-24T14:15:22Z", "endTime": "2019-08-24T14:15:22Z", "state": "Stopped", "progressPercent": 0, "result": { "result": "None", "message": "string", "isCanceled": true }, "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6", "resourceReference": "string", "parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344", "usn": 0, "platformName": "VMware", "platformId": "32a6e381-64f4-4911-86b6-3bf681b64d23", "initiatedBy": "string", "relatedSessionId": "f3a08375-4fc2-4154-a968-538c1da6dd56" } ], "pagination": { "total": 0, "count": 0, "skip": 0, "limit": 0 } } ``` -------------------------------- ### Install License Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/SectionAbout Installs a new license file on the backup server. ```APIDOC ## POST /api/v1/license/install ### Description Installs a new license file on the backup server. ### Method POST ### Endpoint /api/v1/license/install ### Request Body - **licenseFile** (string) - Required - The content of the license file (base64 encoded). ### Request Example { "licenseFile": "BASE64_ENCODED_LICENSE_CONTENT" } ### Response #### Success Response (200) Indicates successful license installation. #### Response Example (No specific response body documented) ``` -------------------------------- ### License Instance Response Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/License Example JSON response for getting license instances, showing details of assigned licenses. ```json { "data": [ { "platformType": "VMware", "name": "linbase01", "hostName": "vcenter01.tech.local", "usedInstancesNumber": 1, "type": "VM", "instanceId": "d8175a8b-942c-4ddb-a36d-0690f1b875d7", "canBeRevoked": true }, { "platformType": "Application", "name": "WINORCL01", "hostName": "WINORCL01", "usedInstancesNumber": 1, "type": "Application", "instanceId": "71c41142-888b-bc72-c46d-74322c9b32eb", "canBeRevoked": true } ], "pagination": { "total": 2, "count": 2, "skip": 0, "limit": 100 } } ``` -------------------------------- ### Install License Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/SectionHowTo Installs a new license file on the backup server. ```APIDOC ## POST /api/v1/license/install ### Description Installs a new license file on the backup server. ### Method POST ### Endpoint /api/v1/license/install ### Parameters #### Request Body - **licenseFile** (string) - Required - The content of the license file in base64 encoded format. ### Response #### Success Response (204) No content is returned upon successful license installation. ``` -------------------------------- ### Get License Instances Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/License Use this endpoint to retrieve a list of installed license instances. Supports filtering, sorting, and pagination. ```curl curl -i -X GET \ 'https://api.example.com:9419/api/v1/license/instances?skip=0&limit=200&orderColumn=Name&orderAsc=true&nameFilter=string&hostNameFilter=string&usedInstancesNumberFilter=0&typeFilter=string&instanceIdFilter=497f6eca-6276-4993-bfeb-53cbbbba6f08' \ -H 'Authorization: Bearer ' \ -H 'x-api-version: 1.3-rev1' ``` -------------------------------- ### POST /jobs/{id}/quickBackup Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Jobs Starts a quick backup for a job. ```APIDOC ## POST /jobs/{id}/quickBackup ### Description Starts a quick backup for a job. ### Method POST ### Endpoint /jobs/{id}/quickBackup ``` -------------------------------- ### Get Backup Server Information Source: https://helpcenter.veeam.com/references/vbr/13/rest/1.3-rev1/tag/Service Retrieves details about the Veeam Backup & Replication installation, including ID, name, build number, and patches. ```APIDOC ## GET /api/v1/serverInfo ### Description Gets the Veeam Backup & Replication installation ID, backup server name (or IP address), build number and cumulative patches installed on the backup server. ### Method GET ### Endpoint /api/v1/serverInfo ### Parameters #### Header Parameters - **x-api-version** (string) - Required - Version and revision of the client REST API. Must be in the following format: `-`. ### Security **Bearer** ### Responses #### Success Response (200) OK - **platform** (string) - The operating system platform of the backup server. - **vbrId** (string) - The unique installation ID of Veeam Backup & Replication. - **name** (string) - The name or IP address of the backup server. - **buildVersion** (string) - The build version of Veeam Backup & Replication. - **patches** (array) - A list of cumulative patches installed on the backup server. - **databaseVendor** (string) - The vendor of the database used by Veeam Backup & Replication. - **sqlServerEdition** (string) - The edition of the SQL Server (if applicable). - **sqlServerVersion** (string) - The version of the SQL Server (if applicable). - **databaseSchemaVersion** (string) - The schema version of the database. - **databaseContentVersion** (string) - The content version of the database. - **veeamRegistration** (object) - Information about Veeam registration. - **isRegistered** (boolean) - Indicates if the backup server is registered. - **expirationDate** (string) - The expiration date of the Veeam registration. - **thumprint** (string) - The thumbprint of the Veeam registration certificate. #### Error Responses - **401** Unauthorized. The authorization header has been expected but not found (or found but is expired). - **403** Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request. - **500** Internal server error. The request has been received but could not be completed because of an internal error at the server side. ### Request Example ```curl curl -i -X GET \ https://api.example.com:9419/api/v1/serverInfo \ -H 'Authorization: Bearer ' \ -H 'x-api-version: 1.3-rev1' ``` ### Response Example (200) ```json { "platform": "Linux", "vbrId": "f2ef2bfd-e8e6-418a-8725-472e2e2d1efc", "name": "srv88.tech.local", "buildVersion": "13.0.0.4883", "patches": [], "databaseVendor": "PostgreSQL", "sqlServerEdition": "", "sqlServerVersion": "PostgreSQL 17.5 on x86_64-pc-linux-gnu, compiled by gcc (GCC) 11.5.0 20240719 (Red Hat 11.5.0-5), 64-bit", "databaseSchemaVersion": "9688", "databaseContentVersion": "9688", "veeamRegistration": { "isRegistered": true, "expirationDate": "2026-08-17T13:07:16Z", "thumprint": "BC7F6108B16884C70E6F6C2CC714463777FE65C0" } } ``` ```