Veeam Service Provider Console REST API

https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/
Admin
Veeam Service Provider Console REST API allows developers and service providers to manage, monitor,...
Tokens:319,700
Snippets:1,473
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Certificate Response Example

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Configuration

Example JSON response returned upon successfully installing a certificate.

```json
{
  "data": {
    "issuedTo": "CN=Veeam Backup Server Certificate",
    "issuedBy": "CN=Veeam Backup Server Certificate",
    "friendlyName": "Veeam Backup Server Certificate",
    "thumbprint": "EB49EE71DF6E2862DE49D0A297B221E652B07EF9",
    "serialNumber": "1669DC0F033F43BA432014B45FFA204C",
    "expirationDate": "2029-05-15T13:50:01.0000000+02:00"
  }
}
```

--------------------------------

### 200 OK Response for Installed Plugins

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Plugins

Example JSON response body returned when successfully retrieving the list of installed plugins.

```json
{
  "data": [
    {
      "pluginId": "acfa09fe-1286-45f0-9cd5-b794d9d183d0",
      "name": "Veeam Intelligence",
      "icon": "content\\any\\any\\ui-content\\favicon.svg",
      "description": "Veeam Intelligence provides AI-powered insights and guidance to help you monitor, analyze and optimize your data protection environment using technical documentation and your infrastructure data.",
      "version": "1.0.0.131",
      "availableVersions": [ ],
      "enabled": true,
      "hasApiKey": false,
      "supportedFeatures": [
        "HealthMonitoring",
        "ReadinessCheck",
        "DataPurge",
        "LogsDownload"
],
      "agentPermissionRules": {
        "rules": [ ],
        "agentsAreAllowedByDefault": true
},
      "organizationPermissionRules": {
        "rules": [ ],
        "organizationsAreAllowedByDefault": true
}
},
    {
      "pluginId": "b343ccc4-de5a-42e1-9351-57906464752e",
      "name": "Company List",
      "icon": "content\\any\\any\\ui-content\\favicon.png",
      "description": "Monitor managed companies",
      "version": "1.0.16",
      "availableVersions": [ ],
      "enabled": true,
      "hasApiKey": true,
      "supportedFeatures": [
        "RestApiKey",
        "DataPurge",
        "LogsDownload"
],
      "agentPermissionRules": {
        "rules": [ ],
        "agentsAreAllowedByDefault": true
},
      "organizationPermissionRules": {
        "rules": [
          {
            "id": "9430969a-0ac1-4c65-9286-ca8fa79a5d18",
            "allowed": true
}
],
        "organizationsAreAllowedByDefault": false
}
}
],
  "meta": {
    "pagingInfo": {
      "total": 2,
      "count": 2,
      "offset": 0
}
}
}
```

--------------------------------

### Get Example for Veeam ONE Server Deployment Configuration

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Veeam-ONE-Server

Retrieves an example configuration for deploying a Veeam ONE server.

```APIDOC
## GET /Get Example for Veeam ONE Server Deployment Configuration

### Description
Retrieves an example configuration for Veeam ONE server deployment.

### Method
GET
```

--------------------------------

### GET /managementAgents/setup/windows

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Management-Agents

Downloads the Management Agent setup file for Windows.

```APIDOC
## GET /managementAgents/setup/windows

### Description
Downloads the Management Agent setup file for Windows.

### Method
GET

### Endpoint
/managementAgents/setup/windows
```

--------------------------------

### GET /managementAgents/setup/linux

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Management-Agents

Downloads the Management Agent setup file for Linux.

```APIDOC
## GET /managementAgents/setup/linux

### Description
Downloads the Management Agent setup file for Linux.

### Method
GET

### Endpoint
/managementAgents/setup/linux
```

--------------------------------

### GET /managementAgents/setup/macos

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Management-Agents

Downloads the Management Agent setup file for macOS.

```APIDOC
## GET /managementAgents/setup/macos

### Description
Downloads the Management Agent setup file for macOS.

### Method
GET

### Endpoint
/managementAgents/setup/macos
```

--------------------------------

### Install Linux Backup Agent Response Sample

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Deployment

Example response body returning the deployment task UID.

```json
{
  "data": "b6293d84-cbb0-4ab1-a222-453fe60c07ef"
}
```

--------------------------------

### GET /deployment/deploy/backupServers/configuration/xml

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Deployment

Retrieves an example of the Veeam Backup & Replication server deployment configuration.

```APIDOC
## GET /deployment/deploy/backupServers/configuration/xml

### Description
Returns a resource representation of an example for Veeam Backup & Replication server deployment configuration in the XML format.

### Method
GET

### Endpoint
/deployment/deploy/backupServers/configuration/xml

### Parameters
#### Query Parameters
- **backupServerDeploymentType** (string) - Required - Deployment type. Enum: "installation", "upgrade"
- **managementAgentUid** (string) - Optional - UID assigned to a management agent installed on a server on which Veeam Backup & Replication must be deployed.
- **escapeCharacters** (boolean) - Optional - Defines whether escape characters are enabled. Default: false

#### Header Parameters
- **X-Request-id** (string) - Optional - Random UID that you can assign to a request for idempotence and async action progress tracking.
- **X-Client-Version** (string) - Optional - Version of Veeam Service Provider Console RESTful API supported by client.

### Request Example
curl -i -X GET \
  'https://server:1280/api/v3/deployment/deploy/backupServers/configuration/xml?backupServerDeploymentType=installation&managementAgentUid=497f6eca-6276-4993-bfeb-53cbbbba6f08&escapeCharacters=false' \
  -H 'X-Client-Version: string' \
  -H 'X-Request-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'

### Response
#### Success Response (200)
- Returns the configuration in XML format.

#### Success Response (202)
- Request has been queued for execution.
```

--------------------------------

### Get All Backup Policies Request

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Backup-Policies

Example of a GET request to retrieve backup policies with query parameters for filtering, sorting, and pagination.

```bash
curl -i -X GET \
  'https://server:1280/api/v3/configuration/backupPolicies?availableToAssignForCompanyUid=497f6eca-6276-4993-bfeb-53cbbbba6f08&filter=%5B{%22property%22%3A%22string%22%2C%22items%22%3A%5B{}%5D%2C%22operation%22%3A%22in%22%2C%22collation%22%3A%22ordinal%22%2C%22value%22%3A{}}%5D&sort=%5B{%22property%22%3A%22string%22%2C%22direction%22%3A%22ascending%22%2C%22collation%22%3A%22ordinal%22}%5D&limit=100&offset=0&select=%5B{%22propertyPath%22%3A%22string%22}%5D' \
  -H 'X-Client-Version: string' \
  -H 'X-Request-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'
```

--------------------------------

### macOS Management Agent Response Example

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Management-Agents

The response body contains a blob URL pointing to the requested management agent setup file.

```json
"blob:https://lrsw10.tech.local:1280/1fa695d3-bc57-4f80-b838-7d7155973602"
```

--------------------------------

### GET /infrastructure/managementAgents/packages/windows

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Management-Agents

Returns a download link to a management agent setup file in the EXE or MSI format for Microsoft Windows computers.

```APIDOC
## GET /infrastructure/managementAgents/packages/windows

### Description
Returns a download link to a management agent setup file in the EXE or MSI format for Microsoft Windows computers.

### Method
GET

### Endpoint
/infrastructure/managementAgents/packages/windows

### Parameters
#### Query Parameters
- **organizationUid** (string <uuid>) - Required - UID of an organization to which a management agent will be assigned.
- **locationUid** (string <uuid>) - Required - UID of a location to which a management agent will be assigned.
- **cloudTenantUid** (string <uuid>) - Required - UID of a cloud tenant to which a management agent will be assigned.
- **tokenExpiryPeriodDays** (integer <int32>) - Optional - Time period for which you want to verify the management agent, in days. Default: 365.
- **packageType** (string) - Optional - Setup file extension. Enum: "msi", "exe". Default: "exe".

#### Header Parameters
- **X-Request-id** (string <uuid>) - Optional - Random UID that you can assign to a request for idempotence and async action progress tracking.
- **X-Client-Version** (string) - Required - Version of Veeam Service Provider Console RESTful API supported by client.

### Response
#### Success Response (200)
- **Body** (byte stream) - Management agent setup file in the byte stream format.

#### Response Example
"blob:https://lrsw10.tech.local:1280/b64d2863-97c5-49b6-a64a-fadc339c5804"
```

--------------------------------

### GET /deployment/deploy/voneServers/configuration/xml

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Deployment

Returns a resource representation of an example for Veeam ONE server deployment configuration in the XML format.

```APIDOC
## GET /deployment/deploy/voneServers/configuration/xml

### Description
Returns a resource representation of an example for Veeam ONE server deployment configuration in the XML format.

### Method
GET

### Endpoint
/deployment/deploy/voneServers/configuration/xml

### Parameters
#### Query Parameters
- **voneServerDeploymentType** (string) - Required - Deployment type. Enum: "installation", "upgrade"
- **managementAgentUid** (string) - Optional - UID assigned to a management agent installed on a server on which Veeam ONE must be deployed.
- **escapeCharacters** (boolean) - Optional - Defines whether escape characters are enabled. Default: false

#### Header Parameters
- **X-Request-id** (string) - Optional - Random UID that you can assign to a request for idempotence and async action progress tracking.
- **X-Client-Version** (string) - Optional - Version of Veeam Service Provider Console RESTful API supported by client.

### Response
#### Success Response (200)
- Returns the configuration in XML format.

#### Success Response (202)
- Request has been queued for execution.

#### Error Response (default)
- All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code.
```

--------------------------------

### GET /about

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/About

Returns general information about the currently installed version of Veeam Service Provider Console.

```APIDOC
## GET /about

### Description
Returns general information about the currently installed version of Veeam Service Provider Console.

### Method
GET

### Endpoint
/about

### Parameters
#### Query Parameters
- **select** (Array of objects or null) - Optional - Returns explicitly requested properties.

#### Header Parameters
- **X-Request-id** (string <uuid>) - Optional - Random UID that you can assign to a request for idempotence and async action progress tracking.
- **X-Client-Version** (string) - Optional - Version of Veeam Service Provider Console RESTful API supported by client.

### Request Example
curl -i -X GET \
  'https://server:1280/api/v3/about?select=%5B{%22propertyPath%22%3A%22string%22}%5D' \
  -H 'X-Client-Version: string' \
  -H 'X-Request-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'

### Response
#### Success Response (200)
- **data** (object) - Contains installation details including installationId, installationDate, and various component versions.

#### Response Example
{
  "data": {
    "installationId": "0b47bb94-fd6c-4dda-8143-0f5c0bd65405",
    "installationDate": "2023-11-19T03:54:58.8470000+01:00",
    "actualVawVersion": "6.1.0.314",
    "actualValVersion": "6.1.0.1466",
    "actualVamVersion": "2.1.0.229",
    "serverVersion": "8.0.0.16330",
    "windowsManagementAgentVersion": "8.0.0.16330",
    "linuxManagementAgentVersion": "8.0.0.16330",
    "macManagementAgentVersion": "8.0.0.16330"
  }
}
```

--------------------------------

### GET /infrastructure/managementAgents/packages/linux

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Management-Agents

Returns a download link to a management agent setup file in the shell script format for Linux computers.

```APIDOC
## GET /infrastructure/managementAgents/packages/linux

### Description
Returns a download link to a management agent setup file in the shell script format for Linux computers.

### Method
GET

### Endpoint
/infrastructure/managementAgents/packages/linux

### Parameters
#### Query Parameters
- **organizationUid** (string <uuid>) - Required - UID of an organization to which a management agent will be assigned.
- **locationUid** (string <uuid>) - Required - UID of a location to which a management agent will be assigned.
- **cloudTenantUid** (string <uuid>) - Required - UID of a cloud tenant to which a management agent will be assigned.
- **tokenExpiryPeriodDays** (integer <int32>) - Optional - Time period for which you want to verify the management agent, in days. Default: 365.

#### Header Parameters
- **X-Request-id** (string <uuid>) - Optional - Random UID that you can assign to a request for idempotence and async action progress tracking.
- **X-Client-Version** (string) - Required - Version of Veeam Service Provider Console RESTful API supported by client.

### Request Example
curl -i -X GET \
  'https://server:1280/api/v3/infrastructure/managementAgents/packages/linux?organizationUid=497f6eca-6276-4993-bfeb-53cbbbba6f08&locationUid=497f6eca-6276-4993-bfeb-53cbbbba6f08&cloudTenantUid=497f6eca-6276-4993-bfeb-53cbbbba6f08&tokenExpiryPeriodDays=365' \
  -H 'X-Client-Version: string' \
  -H 'X-Request-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'

### Response
#### Success Response (200)
- **Body** (string) - Management agent setup file in the byte stream format (download link).

#### Response Example
"blob:https://lrsw10.tech.local:1280/562b5b52-c3d4-4ab4-bdf2-c450e220b38c"
```

--------------------------------

### Download macOS Management Agent via cURL

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Management-Agents

Retrieves the setup file download link by sending a GET request with required organization, location, and tenant UIDs.

```bash
curl -i -X GET \
  'https://server:1280/api/v3/infrastructure/managementAgents/packages/mac?organizationUid=497f6eca-6276-4993-bfeb-53cbbbba6f08&locationUid=497f6eca-6276-4993-bfeb-53cbbbba6f08&cloudTenantUid=497f6eca-6276-4993-bfeb-53cbbbba6f08&tokenExpiryPeriodDays=365&packageType=sh' \
  -H 'X-Client-Version: string' \
  -H 'X-Request-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'
```

--------------------------------

### GET /infrastructure/managementAgents/packages/mac

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Management-Agents

Returns a download link to a management agent setup file in the shell script or zip format for macOS computers.

```APIDOC
## GET /infrastructure/managementAgents/packages/mac

### Description
Returns a download link to a management agent setup file in the shell script format for macOS computers.

### Method
GET

### Endpoint
/infrastructure/managementAgents/packages/mac

### Parameters
#### Query Parameters
- **organizationUid** (string <uuid>) - Required - UID of an organization to which a management agent will be assigned.
- **locationUid** (string <uuid>) - Required - UID of a location to which a management agent will be assigned.
- **cloudTenantUid** (string <uuid>) - Required - UID of a cloud tenant to which a management agent will be assigned.
- **tokenExpiryPeriodDays** (integer <int32>) - Optional - Time period for which you want to verify the management agent, in days. Default: 365.
- **packageType** (string) - Optional - Setup file extension. Enum: "sh", "zip". Default: "zip".

#### Header Parameters
- **X-Request-id** (string <uuid>) - Optional - Random UID that you can assign to a request for idempotence and async action progress tracking.
- **X-Client-Version** (string) - Required - Version of Veeam Service Provider Console RESTful API supported by client.

### Request Example
curl -i -X GET \
  'https://server:1280/api/v3/infrastructure/managementAgents/packages/mac?organizationUid=497f6eca-6276-4993-bfeb-53cbbbba6f08&locationUid=497f6eca-6276-4993-bfeb-53cbbbba6f08&cloudTenantUid=497f6eca-6276-4993-bfeb-53cbbbba6f08&tokenExpiryPeriodDays=365&packageType=sh' \
  -H 'X-Client-Version: string' \
  -H 'X-Request-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'

### Response
#### Success Response (200)
- **Body** (string) - Management agent setup file in the byte stream format (download link).

#### Response Example
"blob:https://lrsw10.tech.local:1280/1fa695d3-bc57-4f80-b838-7d7155973602"
```

--------------------------------

### Retrieve All Users Request

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Accounts

Example of a GET request to fetch users with filter, sort, limit, and select parameters.

```bash
curl -i -X GET \
  'https://server:1280/api/v3/users?filter=%5B{%22property%22%3A%22string%22%2C%22items%22%3A%5B{}%5D%2C%22operation%22%3A%22in%22%2C%22collation%22%3A%22ordinal%22%2C%22value%22%3A{}}%5D&sort=%5B{%22property%22%3A%22string%22%2C%22direction%22%3A%22ascending%22%2C%22collation%22%3A%22ordinal%22}%5D&limit=100&offset=0&select=%5B{%22propertyPath%22%3A%22string%22}%5D' \
  -H 'X-Client-Version: string' \
  -H 'X-Request-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'
```

--------------------------------

### POST /Download Veeam ONE Upgrade Setup File

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Veeam-ONE-Server

Downloads the Veeam ONE upgrade setup file.

```APIDOC
## POST /Download Veeam ONE Upgrade Setup File

### Description
Downloads the Veeam ONE upgrade setup file.

### Method
POST
```

--------------------------------

### Download Management Agent Setup File

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Backup-Agents

Endpoints to download the management agent setup files for different operating systems.

```APIDOC
## GET /managementAgents/setup/windows

### Description
Download the Management Agent setup file for Windows.

### Method
GET

## GET /managementAgents/setup/linux

### Description
Download the Management Agent setup file for Linux.

### Method
GET

## GET /managementAgents/setup/macos

### Description
Download the Management Agent setup file for macOS.

### Method
GET
```

--------------------------------

### Start Veeam Backup for Public Clouds Policy

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Protected-Public-Cloud-Workloads

Starts the execution of a specific Veeam Backup for Public Clouds policy.

```APIDOC
## POST /publicCloudPolicies/{id}/start

### Description
Starts the specified Veeam Backup for Public Clouds policy.

### Method
POST

### Endpoint
/publicCloudPolicies/{id}/start
```

--------------------------------

### Get All Installed Plugins

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Plugins

Retrieves a list of all installed plugins.

```APIDOC
## GET /Plugins

### Description
Retrieves a list of all plugins currently installed.

### Method
GET

### Endpoint
/Plugins
```

--------------------------------

### Get All Protected Cloud VMs Request

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Protected-Public-Cloud-Workloads

Example of a GET request to retrieve protected cloud virtual machines with filtering, sorting, and pagination parameters.

```bash
curl -i -X GET \
  'https://server:1280/api/v3/protectedWorkloads/publicCloud/virtualMachines?filter=%5B{%22property%22%3A%22string%22%2C%22items%22%3A%5B{}%5D%2C%22operation%22%3A%22in%22%2C%22collation%22%3A%22ordinal%22%2C%22value%22%3A{}}%5D&sort=%5B{%22property%22%3A%22string%22%2C%22direction%22%3A%22ascending%22%2C%22collation%22%3A%22ordinal%22}%5D&limit=100&offset=0&select=%5B{%22propertyPath%22%3A%22string%22}%5D' \
  -H 'X-Client-Version: string' \
  -H 'X-Request-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'
```

--------------------------------

### POST /deployment/install-vbr

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Management-Agents

Installs Veeam Backup & Replication on a discovered computer.

```APIDOC
## POST /deployment/install-vbr

### Description
Installs Veeam Backup & Replication on a discovered computer.

### Method
POST

### Endpoint
/deployment/install-vbr
```

--------------------------------

### POST /deployment/installVeeamONE

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Deployment

Installs Veeam ONE on a discovered computer.

```APIDOC
## POST /deployment/installVeeamONE

### Description
Installs Veeam ONE on a discovered computer.

### Method
POST

### Endpoint
/deployment/installVeeamONE
```

--------------------------------

### Get Charges for All Plugins

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Billing

Retrieves the billing charges associated with all installed plugins.

```APIDOC
## GET /plugins/charges

### Description
Retrieves the billing charges for all plugins currently installed in the system.

### Method
GET

### Endpoint
/plugins/charges
```

--------------------------------

### Management Agent Download Response

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Management-Agents

The API returns a blob URL representing the byte stream of the requested setup file.

```json
"blob:https://lrsw10.tech.local:1280/b64d2863-97c5-49b6-a64a-fadc339c5804"
```

--------------------------------

### Install Veeam Backup & Replication Request Samples

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Deployment

Request samples for the installBackupServer operation, including JSON payload structure and curl command.

```json
{
  "configuration": {},
  "licenseSettings": {},
  "credentials": {}
}
```

```bash
curl -X POST "https://api-server/api/v3/discovery/computers/{computerUid}/installBackupServer" \
     -H "accept: application/json" \
     -H "X-Request-id: ba547d14-c556-42bb-b85c-eeeb16e2f5e7" \
     -H "X-Client-Version: 3.6.1" \
     -H "Content-Type: application/json" \
     -d "{\"configuration\":{},\"licenseSettings\":{},\"credentials\":{}}"
```

--------------------------------

### GET /plugins/{pluginId}

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Plugins

Retrieves a resource representation of a currently installed plugin with the specified ID.

```APIDOC
## GET /plugins/{pluginId}

### Description
Returns a resource representation of a currently installed plugin with the specified ID.

### Method
GET

### Endpoint
/plugins/{pluginId}

### Parameters
#### Path Parameters
- **pluginId** (string <uuid>) - Required - ID assigned to a plugin.

#### Query Parameters
- **select** (Array of objects) - Optional - Returns explicitly requested properties.

#### Header Parameters
- **X-Request-id** (string <uuid>) - Optional - Random UID that you can assign to a request for idempotence and async action progress tracking.
- **X-Client-Version** (string) - Optional - Version of Veeam Service Provider Console RESTful API supported by client.

### Response
#### Success Response (200)
- **data** (object) - The plugin resource details.

#### Response Example
{
  "data": {
    "pluginId": "acfa09fe-1286-45f0-9cd5-b794d9d183d0",
    "name": "Veeam Intelligence",
    "icon": "content\\any\\any\\ui-content\\favicon.svg",
    "description": "Veeam Intelligence provides AI-powered insights and guidance to help you monitor, analyze and optimize your data protection environment using technical documentation and your infrastructure data.",
    "version": "1.0.0.131",
    "availableVersions": [ ],
    "enabled": true,
    "hasApiKey": false,
    "supportedFeatures": [ "HealthMonitoring", "ReadinessCheck", "DataPurge", "LogsDownload" ],
    "agentPermissionRules": { "rules": [ ], "agentsAreAllowedByDefault": true },
    "organizationPermissionRules": { "rules": [ ], "organizationsAreAllowedByDefault": true }
  }
}
```

--------------------------------

### POST /deployment/veeamOneInstallations

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Veeam-ONE-Server

Installs Veeam ONE on a discovered computer.

```APIDOC
## POST /deployment/veeamOneInstallations

### Description
Installs Veeam ONE on a discovered computer.

### Method
POST

### Endpoint
/deployment/veeamOneInstallations
```

--------------------------------

### GET /infrastructure/backupAgents/windows

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Backup-Agents

Returns a collection resource representation of all Veeam backup agents installed on Windows computers.

```APIDOC
## GET /infrastructure/backupAgents/windows

### Description
Returns a collection resource representation of all Veeam backup agents installed on Windows computers.

### Method
GET

### Endpoint
/infrastructure/backupAgents/windows

### Parameters
#### Query Parameters
- **filter** (Array of objects or null) - Optional - Specifies the conditions that a resource must meet to be returned in the output.
- **sort** (Array of objects or null) - Optional - Specifies the order in which resources are returned from the collection.
- **limit** (integer) - Optional - Specifies the first N resources that must be returned in the output (Range: 1-500, Default: 100).
- **offset** (integer) - Optional - Excludes the first N resources from the query output (Default: 0).
- **select** (Array of objects or null) - Optional - Returns explicitly requested properties.

#### Header Parameters
- **X-Request-id** (string) - Optional - Random UID that you can assign to a request for idempotence and async action progress tracking.
- **X-Client-Version** (string) - Required - Version of Veeam Service Provider Console RESTful API supported by client.

### Response
#### Success Response (200)
- **data** (array) - Collection of backup agent objects.
- **meta** (object) - Paging information for the collection.

#### Response Example
{
  "data": [
    {
      "instanceUid": "861d3b42-f46f-b0c7-4f6f-4e8c507e7b5c",
      "managementAgentUid": "44db72c8-bf6a-4b0c-8ad0-54a303660484",
      "cbtDriverStatus": "Unknown"
    }
  ],
  "meta": {
    "pagingInfo": {
      "total": 4,
      "count": 4,
      "offset": 0
    }
  }
}
```

--------------------------------

### POST /discovery/computers/{computerUid}/installVOneServer

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Deployment

Installs Veeam ONE and the management agent on a discovered computer identified by its UID. This operation is idempotent for a 5-minute interval and supports tracking via the returned task UID.

```APIDOC
## POST /discovery/computers/{computerUid}/installVOneServer

### Description
Installs Veeam ONE and management agent on a discovered computer with the specified UID. Deploys only the missing component if the other one is already installed.

### Method
POST

### Endpoint
/discovery/computers/{computerUid}/installVOneServer

### Parameters
#### Path Parameters
- **computerUid** (string <uuid>) - Required - Discovered computer UID.

#### Query Parameters
- **select** (Array of objects or null) - Optional - Returns explicitly requested properties.

#### Header Parameters
- **X-Request-id** (string <uuid>) - Optional - Random UID for idempotence and async action progress tracking.
- **X-Client-Version** (string) - Optional - Version of Veeam Service Provider Console RESTful API supported by client.

#### Request Body
- **configuration** (object) - Required - Deployment configuration.
- **licenseSettings** (object) - Required - License settings.

### Response
#### Success Response (200)
- **scheduledTaskUid** (string) - The UID of the scheduled task.
- **taskUid** (string) - The UID of the task.

#### Success Response (202)
- Request has been queued for execution.

#### Error Response (default)
- All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code.
```

--------------------------------

### POST /deployment/install-backup-agent

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Management-Agents

Installs a backup agent on a discovered computer.

```APIDOC
## POST /deployment/install-backup-agent

### Description
Installs a backup agent on a discovered computer.

### Method
POST

### Endpoint
/deployment/install-backup-agent
```

--------------------------------

### GET /certificates

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Configuration

Retrieves a list of all certificates currently installed on the Veeam Service Provider Console server.

```APIDOC
## GET /certificates

### Description
Retrieves a list of all certificates on the Veeam Service Provider Console server.

### Method
GET

### Endpoint
/certificates
```

--------------------------------

### Create User Response Sample

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Accounts

Example of a successful 200 OK response returned after creating a user.

```json
{
  "data": {
    "instanceUid": "a1c384f6-4809-45ca-b2db-5c0d99c8c21a",
    "organizationUid": "0a093973-274b-4df8-83e2-2316dee0c9a9",
    "userName": "subtenant",
    "status": "Enabled",
    "mfaPolicyStatus": "Enabled",
    "mfaPolicyConfigurationStatus": "NotConfigured",
    "role": "CompanyLocationAdministrator",
    "profile": {
      "firstName": "John",
      "lastName": "Brown",
      "title": "Mr",
      "email": "j.brown@exon.com",
      "address": null,
      "phone": "301 329 9338"
},
    "credentials": {
      "userName": "subtenant",
      "password": null
}
}

}
```

--------------------------------

### Response body for Get All Countries

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Misc

Example JSON response containing the list of countries and associated metadata.

```json
{
  "data": [
    {
      "id": 3,
      "name": "Afghanistan",
      "code": "AF"
    },
    {
      "id": 4,
      "name": "Albania",
      "code": "AL"
    },
    {
      "id": 5,
      "name": "Algeria",
      "code": "DZ"
    },
    {
      "id": 6,
      "name": "American Samoa",
      "code": "DS"
    }
  ],
  "meta": {
    "pagingInfo": {
      "total": 4,
      "count": 4,
      "offset": 0
    }
  }
}
```

--------------------------------

### POST /deployment/install-linux-backup-agent

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Management-Agents

Installs a backup agent on a discovered Linux computer.

```APIDOC
## POST /deployment/install-linux-backup-agent

### Description
Installs a backup agent on a discovered Linux computer.

### Method
POST

### Endpoint
/deployment/install-linux-backup-agent
```

--------------------------------

### GET /configuration/certificates

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Configuration

Retrieves a collection of security certificates available for installation on the Veeam Service Provider Console server.

```APIDOC
## GET /configuration/certificates

### Description
Returns a collection resource representation of security certificates on the Veeam Service Provider Console server that are available for installation.

### Method
GET

### Endpoint
/configuration/certificates

### Parameters
#### Query Parameters
- **filter** (Array of objects) - Optional - Specifies the conditions that a resource must meet to be returned in the output.
- **sort** (Array of objects) - Optional - Specifies the order in which resources are returned from the collection.
- **limit** (integer) - Optional - Specifies the first N resources that must be returned in the output (1-500, default: 100).
- **offset** (integer) - Optional - Excludes the first N resources from the query output (default: 0).
- **select** (Array of objects) - Optional - Returns explicitly requested properties.

#### Header Parameters
- **X-Request-id** (string) - Optional - Random UID for idempotence and async action tracking.
- **X-Client-Version** (string) - Optional - Version of the API supported by the client.

### Response
#### Success Response (200)
- **data** (array) - List of certificate objects.
- **meta** (object) - Paging information.

#### Response Example
{
  "data": [
    {
      "issuedTo": "CN=Veeam Backup Server Certificate",
      "issuedBy": "CN=Veeam Backup Server Certificate",
      "friendlyName": "Veeam Backup Server Certificate",
      "thumbprint": "EA52EE71DE5E286DBE49C9A307B210E732A95FF9",
      "serialNumber": "5668BB0F033E34AA431915C34FFF324C",
      "expirationDate": "2029-05-15T13:50:01.0000000+02:00"
    }
  ],
  "meta": {
    "pagingInfo": {
      "total": 4,
      "count": 4,
      "offset": 0
    }
  }
}
```

--------------------------------

### POST /deployment/installBackupAgent

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Deployment

Installs a backup agent on a discovered computer.

```APIDOC
## POST /deployment/installBackupAgent

### Description
Installs the backup agent on a specified discovered computer.

### Method
POST

### Endpoint
/deployment/installBackupAgent
```

--------------------------------

### POST /deployment/install-veeam-one

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Management-Agents

Installs Veeam ONE on a discovered computer.

```APIDOC
## POST /deployment/install-veeam-one

### Description
Installs Veeam ONE on a discovered computer.

### Method
POST

### Endpoint
/deployment/install-veeam-one
```

--------------------------------

### POST /discovery/computers/{computerUid}/installBackupServer

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Deployment

Installs Veeam Backup & Replication and the management agent on a discovered computer with the specified UID.

```APIDOC
## POST /discovery/computers/{computerUid}/installBackupServer

### Description
Installs Veeam Backup & Replication and management agent on a discovered computer with the specified UID. Deploys only the missing component if the other one is already installed.

### Method
POST

### Endpoint
/discovery/computers/{computerUid}/installBackupServer

### Parameters
#### Path Parameters
- **computerUid** (string <uuid>) - Required - Discovered computer UID.

#### Query Parameters
- **select** (Array of objects or null) - Optional - Returns explicitly requested properties.

#### Header Parameters
- **X-Request-id** (string <uuid>) - Optional - Random UID for idempotence and async action progress tracking.
- **X-Client-Version** (string) - Optional - Version of Veeam Service Provider Console RESTful API supported by client.

#### Request Body
- **configuration** (object) - Required - Deployment configuration.
- **licenseSettings** (object) - Required - License settings.
- **credentials** (object or null) - Optional - Credentials required to access the target server.

### Response
#### Success Response (200)
- **Deployment task UID** (string) - The UID of the deployment task.

#### Success Response (202)
- Request has been queued for execution.

#### Error Response (default)
- All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code.
```

--------------------------------

### Get All Containers Request

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Containers

Example cURL request to retrieve all organization containers with filtering, sorting, and pagination parameters.

```bash
curl -i -X GET \
  'https://server:1280/api/v3/organizations/containers?filter=%5B{%22property%22%3A%22string%22%2C%22items%22%3A%5B{}%5D%2C%22operation%22%3A%22in%22%2C%22collation%22%3A%22ordinal%22%2C%22value%22%3A{}}%5D&sort=%5B{%22property%22%3A%22string%22%2C%22direction%22%3A%22ascending%22%2C%22collation%22%3A%22ordinal%22}%5D&limit=100&offset=0&select=%5B{%22propertyPath%22%3A%22string%22}%5D' \
  -H 'X-Client-Version: string' \
  -H 'X-Request-id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'
```

--------------------------------

### POST /discovery/computers/{computerUid}/scheduledTasks/installVOneServer

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Deployment

Creates a scheduled task that installs Veeam ONE and management agent on a discovered computer with the specified UID.

```APIDOC
## POST /discovery/computers/{computerUid}/scheduledTasks/installVOneServer

### Description
Creates a scheduled task that installs Veeam ONE and management agent on a discovered computer with the specified UID. Deploys only the missing component if the other one is already installed.

### Method
POST

### Endpoint
/discovery/computers/{computerUid}/scheduledTasks/installVOneServer

### Parameters
#### Path Parameters
- **computerUid** (string <uuid>) - Required - Discovered computer UID.

#### Query Parameters
- **select** (Array of objects or null) - Optional - Returns explicitly requested properties.

#### Header Parameters
- **X-Request-id** (string <uuid>) - Optional - Random UID for idempotence and async action progress tracking.
- **X-Client-Version** (string) - Optional - Version of Veeam Service Provider Console RESTful API supported by client.

#### Request Body
- **configuration** (object) - Required - Deployment configuration.
- **schedule** (object) - Required - Deployment scheduling settings.

### Response
#### Success Response (200)
- Resource representation of a scheduled task.

#### Success Response (202)
- Request has been queued for execution.
```

--------------------------------

### GET /infrastructure/backupAgents/windows/settings

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Backup-Agents

Returns a collection resource representation of settings configured for all Veeam backup agents installed on Windows computers.

```APIDOC
## GET /infrastructure/backupAgents/windows/settings

### Description
Returns a collection resource representation of settings configured for all Veeam backup agents installed on Windows computers.

### Method
GET

### Endpoint
/infrastructure/backupAgents/windows/settings

### Parameters
#### Query Parameters
- **filter** (Array of objects) - Optional - Specifies the conditions that a resource must meet to be returned in the output.
- **sort** (Array of objects) - Optional - Specifies the order in which resources are returned from the collection.
- **limit** (integer) - Optional - Specifies the first N resources that must be returned in the output (Range: 1-500, Default: 100).
- **offset** (integer) - Optional - Excludes the first N resources from the query output (Default: 0).
- **select** (Array of objects) - Optional - Returns explicitly requested properties.

#### Header Parameters
- **X-Request-id** (string) - Optional - Random UID that you can assign to a request for idempotence and async action progress tracking.
- **X-Client-Version** (string) - Optional - Version of Veeam Service Provider Console RESTful API supported by client.

### Response
#### Success Response (200)
- **data** (array) - Collection of backup agent settings.
- **meta** (object) - Paging information.
```

--------------------------------

### Response Body for Get Jobs Request

Source: https://helpcenter.veeam.com/references/vac/9.1/rest/3.6.1/tag/Protected-Workloads

Example JSON response containing a list of backup jobs and associated metadata.

```json
{
  "data": [
    {
      "backupAgentUid": "19873b42-88ea-bbc5-e764-74d8f6ebd698",
      "jobUid": "1043a564-1170-4d39-8cdc-36631900a99d",
      "jobName": "Windows workstation - Personal files_r2vawServ1",
      "sourceSize": null,
      "totalRestorePointSize": 23158784,
      "latestRestorePointSize": 23158784,
      "restorePoints": 1,
      "latestRestorePointDate": "2023-11-19T09:30:19.0000000+01:00",
      "targetType": "Cloud"
    },
    {
      "backupAgentUid": "19873b42-88ea-bbc5-e764-74d8f6ebd698",
      "jobUid": "983d0be8-c488-4da0-b018-f6e277ddc799",
      "jobName": "WServerVolumeCloud_r2vawServ1",
      "sourceSize": 26451713190,
      "totalRestorePointSize": 15172886528,
      "latestRestorePointSize": 345497600,
      "restorePoints": 2,
      "latestRestorePointDate": "2023-11-19T09:30:26.0000000+01:00",
      "targetType": "Cloud"
    },
    {
      "backupAgentUid": "19873b42-88ea-bbc5-e764-74d8f6ebd698",
      "jobUid": "0359f6b8-7275-4feb-b056-285bb0155750",
      "jobName": "WWrkstEntireCloud_r2vawServ1",
      "sourceSize": 26449878026,
      "totalRestorePointSize": 14841733120,
      "latestRestorePointSize": 14841733120,
      "restorePoints": 1,
      "latestRestorePointDate": "2023-11-19T09:30:23.0000000+01:00",
      "targetType": "Cloud"
    },
    {
      "backupAgentUid": "19873b42-88ea-bbc5-e764-74d8f6ebd698",
      "jobUid": "99d5d4a2-81a1-4a19-b8a6-4642769d6b70",
      "jobName": "Windows server - Entire computer_r2vawServ1",
      "sourceSize": 26451715079,
      "totalRestorePointSize": 14720708608,
      "latestRestorePointSize": 14720708608,
      "restorePoints": 1,
      "latestRestorePointDate": "2023-11-19T09:30:19.0000000+01:00",
      "targetType": "Cloud"
    }
  ],
  "meta": {
    "pagingInfo": {
      "total": 4,
      "count": 4,
      "offset": 0
    }
  }
}
```
Tokens:
Raw