Operation Reference

v2 Operation

v3 Operation

POST /accounts/logout

DELETE /users/{userUid}/tokens

Access token is disabled and cannot be used again.

POST /token

POST /token

v2 Operation

v3 Operation

GET /notifications/alarmTemplates

GET /alarms/templates

GET /notifications/alarmTemplates/{id}

GET /alarms/templates/{alarmUid}

GET /notifications/alarmTemplates/{id}/events

GET /alarms/templates/{alarmUid}/events

GET /notifications/events

GET /alarms/active

GET /notifications/events/{id}

GET /alarms/active/{activeAlarmUid}

v2 Operation

v3 Operation

GET /backupAgents

GET /infrastructure/backupAgents

GET /infrastructure/backupAgents/windows/settings

Response schema contains the scheduleDisabled property of the Veeam Agent for Microsoft Windows resources.

GET /infrastructure/managementAgents

Response schema contains the locationUID property of the management agent resources including resources of the management agents installed on the agent computers.

GET backupAgents/{id}

GET /infrastructure/backupAgents/{backupAgentUid}

GET /infrastructure/backupAgents/windows/{backupAgentUid}/settings

Response schema contains the scheduleDisabled property of the Veeam Agent for Microsoft Windows resource.

GET /infrastructure/managementAgents/{managementAgentUid}

Response schema contains the locationUID property of the resource of the specific management agent installed on the agent computer.

v2 Operation

v3 Operation

POST /backupAgents/{id}/assignPolicy

POST /infrastructure/backupAgents/windows/{backupAgentUid}/assignedPolicies

POST /infrastructure/backupAgents/linux/{backupAgentUid}/assignedPolicies

POST /infrastructure/backupAgents/mac/{backupAgentUid}/assignedPolicies

GET /backupPolicies

GET /configuration/backupPolicies

POST /backupPolicies

POST /configuration/backupPolicies/windows

POST /configuration/backupPolicies/linux

GET /backupPolicies/{id}

GET /configuration/backupPolicies/{policyUid}

v2 Operation

v3 Operation

GET /backupAgents/{agentId}/jobs

GET /infrastructure/backupAgents/windows/{backupAgentUid}/jobs

GET /infrastructure/backupAgents/linux/{backupAgentUid}/jobs

GET /infrastructure/backupAgents/mac/{backupAgentUid}/jobs

DELETE /backupAgents/{agentId}/jobs/{jobId}

DELETE /infrastructure/backupAgents/windows/{backupAgentUid}/jobs/{backupAgentJobUid}

DELETE /infrastructure/backupAgents/linux/{backupAgentUid}/jobs/{backupAgentJobUid}

DELETE /infrastructure/backupAgents/mac/{backupAgentUid}/jobs/{backupAgentJobUid}

GET /backupAgents/{agentId}/jobs/{jobId}

GET /infrastructure/backupAgents/windows/{backupAgentUid}/jobs/{backupAgentJobUid}

GET /infrastructure/backupAgents/linux/{backupAgentUid}/jobs/{backupAgentJobUid}

GET /infrastructure/backupAgents/mac/{backupAgentUid}/jobs/{backupAgentJobUid}

POST /backupAgents/{agentId}/jobs/{jobId}/start

POST /infrastructure/backupAgents/{backupAgentUid}/jobs/{backupAgentJobUid}/start

PATCH /infrastructure/backupAgents/windows/{backupAgentUid}/jobs/{backupAgentJobUid}

PATCH /infrastructure/backupAgents/linux/{backupAgentUid}/jobs/{backupAgentJobUid}

PATCH /infrastructure/backupAgents/mac/{backupAgentUid}/jobs/{backupAgentJobUid}

For Veeam Agent for Microsoft Windows, you can start a job by changing the value of the status property to Starting.

POST /backupAgents/{agentId}/jobs/{jobId}/stop

POST /infrastructure/backupAgents/{backupAgentUid}/jobs/{backupAgentJobUid}/stop

PATCH /infrastructure/backupAgents/windows/{backupAgentUid}/jobs/{backupAgentJobUid}

PATCH /infrastructure/backupAgents/linux/{backupAgentUid}/jobs/{backupAgentJobUid}

PATCH /infrastructure/backupAgents/mac/{backupAgentUid}/jobs/{backupAgentJobUid}

You can stop a job by changing the value of the status property to Stopping.

POST /backupAgents/{agentId}/jobs/{jobId}/update

POST /infrastructure/backupAgents/windows/{backupAgentUid}/assignedPolicies

POST /infrastructure/backupAgents/linux/{backupAgentUid}/assignedPolicies

POST /infrastructure/backupAgents/mac/{backupAgentUid}/assignedPolicies

Reassigning the policy is equally effective as agent job update.

v2 Operation

v3 Operation

GET /licensing/backupserverLicenses

GET /licensing/backupServers

DELETE /licensing/backupserverLicenses/{serverUid}

DELETE /licensing/backupServers/{backupServerUid}

GET /licensing/backupserverLicenses/{serverUid}

GET /licensing/backupServers/{backupServerUid}

PATCH /licensing/backupserverLicenses/{serverUid}

PATCH /licensing/backupServers/{backupServerUid}

PUT /licensing/backupserverLicenses/{serverUid}

PUT /licensing/backupServers/{backupServerUid}

POST /licensing/backupserverLicenses/{serverUid}/update

POST /licensing/backupServers/{backupServerUid}/update

v2 Operation

v3 Operation

GET /backupRepositories

GET /infrastructure/backupServers/repositories

GET /organizations/companies/sites/backupResources

Response schema contains the companyUid property of the repository resource.

GET /backupRepositories/{id}

GET /infrastructure/backupServers/{backupServerUid}/repositories/{repositoryUid}

GET /organizations/companies/{companyUid}/sites/{siteUid}/backupResources

Response schema contains the companyUid property of the repository resource.

v2 Operation

v3 Operation

GET /tenants/{tenantId}/backupResources

GET /organizations/companies/{companyUid}/sites/{siteUid}/backupResources

POST /tenants/{tenantId}/backupResources

POST /organizations/companies/{companyUid}/sites/{siteUid}/backupResources

DELETE /tenants/{tenantId}/backupResources/{id}

DELETE /organizations/companies/{companyUid}/sites/{siteUid}/backupResources/{resourceUid}

PUT /tenants/{tenantId}/backupResources/{id}

PATCH /organizations/companies/{companyUid}/sites/{siteUid}/backupResources/{resourceUid}

GET /resellers/{resellerId}/backupResources

GET /organizations/resellers/{resellerUid}/sites/{siteUid}/backupResources

POST /resellers/{resellerId}/backupResources

POST /organizations/resellers/{resellerUid}/sites/{siteUid}/backupResources

DELETE /resellers/{resellerId}/backupResources/{id}

DELETE /organizations/resellers/{resellerUid}/sites/{siteUid}

GET /resellers/{resellerId}/backupResources/{id}

GET /organizations/resellers/{resellerUid}/sites/{siteUid}/backupResources/{resourceUid}

PUT /resellers/{resellerId}/backupResources/{id}

PATCH /organizations/resellers/{resellerUid}/sites/{siteUid}/backupResources/{resourceUid}

v2 Operation

v3 Operation

GET /backupServers

GET /infrastructure/backupServers

GET /backupServers/{id}

GET /infrastructure/backupServers/{backupServerUid}

GET /tenants/{id}/backupServers

No direct counterpart.

v2 Operation

v3 Operation

GET /cloudGatewayPools

GET /infrastructure/sites/cloudgatewaypools

GET /cloudGatewayPools/{instanceUid} 

GET /infrastructure/sites/cloudgatewaypools/{instanceUid}

v2 Operation

v3 Operation

GET /licensing/cloudconnectLicenses

GET /licensing/sites

DELETE /licensing/cloudconnectLicenses/{serverUid}

DELETE /licensing/sites/{siteUid}

GET /licensing/cloudconnectLicenses/{serverUid}

GET /licensing/sites/{siteUid}

PATCH /licensing/cloudconnectLicenses/{serverUid}

PATCH /licensing/sites/{siteUid}

PUT /licensing/cloudconnectLicenses/{serverUid}

PUT /licensing/sites/{siteUid}

POST /licensing/cloudconnectLicenses/{serverUid}/update

POST /licensing/sites/{siteUid}/update

v2 Operation

v3 Operation

GET /computers

GET /discovery/computers

GET /infrastructure/backupAgents

Returns information on the Veeam backup agents installed on the discovered computers.

GET /infrastructure/backupAgents/jobs

Returns information on jobs protecting the discovered computers.

GET /computers/{id}

GET /discovery/computers/{computerUid}

GET /infrastructure/backupAgents/{backupAgentUid}

Returns information on the Veeam backup agent installed on the discovered computer.

GET /infrastructure/backupAgents/windows/{backupAgentUid}/jobs

GET /infrastructure/backupAgents/linux/{backupAgentUid}/jobs

GET /infrastructure/backupAgents/mac/{backupAgentUid}/jobs

Returns information on jobs protecting the discovered computer.

POST /computers/{id}/action

POST /infrastructure/backupAgents/{backupAgentUid}/activate

Performs the activate action.

POST /infrastructure/backupAgents/{backupAgentUid}/deactivate

Performs the deactivate action.

PATCH /infrastructure/backupAgents/{backupAgentUid}

To perform the activate action, replace the value of the managementMode property with ManagedByConsole.

To perform the deactivate action, replace the value of the managementMode property with UnManaged.

v2 Operation

v3 Operation

GET /discoveryRules

GET /discovery/rules

GET /discoveryRules/{id}

GET /discovery/rules/{ruleUid}

GET /discoveryRules/{id}/networks

GET /discovery/rules/windows/networkBased/{ruleUid}

GET /discovery/rules/linux/networkBased/{ruleUid}

GET /discoveryRules/{id}/notificationSettings

GET /discovery/rules/{ruleUid}

Response schema contains notification settings in the notificationSettings property.

GET /discoveryRules/{id}/filters

GET /discovery/rules/{ruleUid}

Response schema contains discovery filters in the filter property.

v2 Operation

v3 Operation

GET /failoverPlans

GET /infrastructure/backupServers/failoverplans

GET /failoverPlans/{id}

GET /infrastructure/backupServers/failoverplans/{planUid}

POST /failoverPlans/{id}/action

POST /infrastructure/backupServers/failoverplans/{planUid}/start

Performs the start action.

POST /infrastructure/backupServers/failoverplans/{planUid}/undo

Performs the undo action.

v2 Operation

v3 Operation

GET /hardwarePlans

GET /infrastructure/sites/hardwarePlans

GET /hardwarePlans/{id}

GET /infrastructure/sites/hardwarePlans/{instanceUid}

v2 Operation

v3 Operation

GET /jobs

GET /infrastructure/backupServers/jobs

GET /jobs/{id}

GET /infrastructure/backupServers/jobs/{jobUid}

POST /jobs/{id}/action

PATCH /infrastructure/backupServers/jobs/{jobUid}

To perform the start action, replace the value of the status property with Starting.

To perform the stop action, replace the value of the status property with Stopping.

To perform the retry action, replace the value of the status property with Starting.

To perform the disable action, replace the value of the isEnabled property with false.

To perform the enable action, replace the value of the isEnabled property with true.

POST /jobs/{id}/enable

PATCH /infrastructure/backupServers/jobs/{jobUid}

Replace the value of the isEnabled property with true.

POST /jobs/{id}/disable

PATCH /infrastructure/backupServers/jobs/{jobUid}

Replace the value of the isEnabled property with false.

POST /jobs/{id}/retry

POST /infrastructure/backupServers/jobs/{jobUid}/retry

PATCH /infrastructure/backupServers/jobs/{jobUid}

Replace the value of the status property with Starting.

POST /jobs/{id}/start

POST /infrastructure/backupServers/jobs/{jobUid}/start

PATCH /infrastructure/backupServers/jobs/{jobUid}

Replace the value of the status property with Starting.

POST /jobs/{id}/stop

POST/infrastructure/backupServers/jobs/{jobUid}/stop

PATCH /infrastructure/backupServers/jobs/{jobUid}

Replace the value of the status property with Stopping.

v2 Operation

v3 Operation

GET /licenseSettings

GET /licensing/console

PATCH /licenseSettings

No direct counterpart.

POST /licenseSettings/action

POST /licensing/console/update

v2 Operation

v3 Operation

GET /tenants/{tenantId}/locations

GET /organizations/{organizationUid}/locations

Does not contain information on repository space usage.

GET /tenants/{tenantId}/locations/{id}

GET /organizations/locations/{locationUid}

Does not contain information on repository space usage.

v2 Operation

v3 Operation

GET /misc/usaStates

GET /misc/usaStates

GET /misc/countries

GET /misc/countries

v2 Operation

v3 Operation

GET /resellers 

GET /organizations/companies/{companyUid}/sites/{siteUid}/replicationResources

GET /organizations/resellers/sites

Returns information on managed company quotas.

GET /organizations

Returns reseller profiles.

GET /organizations/resellers/usage

Returns information on service usage.

GET /organizations/resellers/sites/backupResources/usage

Returns information on site backup resource usage.

GET /organizations/resellers/sites/replicationResources/usage

Returns information on site replication resource usage.

POST /resellers 

POST /organizations/resellers

DELETE /resellers/{id} 

DELETE /organizations/resellers/{resellerUid}

GET /resellers/{id} 

GET /organizations/resellers/{resellerUid}

GET /users/{userUid}

Returns information on a reseller contact person.

GET /organizations/{organizationUid}

Returns information on an organization profile of a reseller.

PUT /resellers/{id} 

PATCH /organizations/resellers/{resellerUid}

PATCH /users/{userUid}

Allows you to modify a reseller contact person data.

PATCH /organizations/{organizationUid}

Allows you to modify an organization profile of a reseller and contact person credentials.

POST /resellers/{id}/enable 

PATCH /organizations/resellers/{resellerUid}

To enable a reseller, replace the status property value to Active.

POST /resellers/{id}/disable 

PATCH /organizations/resellers/{resellerUid}

To disable a reseller, replace the status property value to Disabled.

POST /resellers/{id}/sendWelcomeEmail 

POST /organizations/resellers/{resellerUid}/welcomeEmail

GET /resellers/{id}/siteScopes 

GET /organizations/resellers/{resellerUid}/sites

POST /resellers/{id}/siteScopes

POST /organizations/resellers/{resellerUid}/sites

DELETE /resellers/{id}/siteScopes/{cloudConnectAgentUid} 

DELETE /organizations/resellers/{resellerUid}/sites/{siteUid}

GET /resellers/{id}/siteScopes/{cloudConnectAgentUid} 

GET /organizations/resellers/{resellerUid}/sites/{siteUid}

PUT /resellers/{id}/siteScopes/{cloudConnectAgentUid} 

PATCH /organizations/resellers/{resellerUid}/sites/{siteUid}

GET /resellers/{id}/availableClients 

GET /organizations/companies

To return companies available for management to a reseller, apply the following query to a request:

filter=[{"property":"resellerUid","operation":"equals","value":"null"}]

GET /resellers/{id}/managedClients 

GET /organizations/resellers/{resellerUid}/companies

POST /resellers/{id}/managedClients 

POST /organizations/resellers/{resellerUid}/companies

DELETE /resellers/{id}/managedClients/{tenantId} 

DELETE /organizations/resellers/{resellerUid}/companies

v2 Operation

v3 Operation

GET /subscriptionPlans 

GET /subscriptionPlans

GET /subscriptionPlans/{id} 

GET /subscriptionPlans/{subscriptionPlanUid}

GET /tenants/{tenantId}/subscriptionPlan 

GET /organizations/companies/{companyUid}/subscriptionPlan

PUT /tenants/{tenantId}/subscriptionPlan/{planId} 

PATCH /organizations/companies/{companyUid}

Replace the subscriptionPlanUid property value to the subscription plan UID.

v2 Operation

v3 Operation

GET /tenants 

GET /organizations/companies

GET /organizations/companies/sites

Returns information on site resources.

GET /organizations

Returns company profiles.

GET /users

Returns information on company owners.

GET /organizations/companies/usage

Returns information on used services.

GET /infrastructure/sites/tenants

Returns information on Veeam Cloud Connect tenants associated with companies.

POST /tenants 

POST /organizations/companies

POST /organizations/companies/{companyUid}/sites

Allows you to allocate site resources to a company.

DELETE /tenants/{id} 

DELETE /organizations/companies/{companyUid}

GET /tenants/{id} 

GET /organizations/companies/{companyUid}

GET /organizations/companies/{companyUid}/sites

Returns information on company site resources.

GET /organizations/companies/{companyUid}/usage

Returns information on used services.

GET /organizations/{organizationUid}

Returns a company profile.

GET /organizations/{organizationUid}/users

Returns information on a company owner.

GET /infrastructure/sites/tenants/{tenantUid}

Returns information on Veeam Cloud Connect tenants associated with a company.

PUT /tenants/{id} 

PATCH /organizations/companies/{companyUid}

PATCH /organizations/{organizationUid}

Allows you to modify a company profile.

PATCH /organizations/companies/{companyUid}/sites/{siteUid}

Allows you to modify a company site resource and company owner credentials.

PATCH /users/{userUid}

Allows you to modify company owner.

DELETE /tenants/{instanceUid} 

DELETE /organizations/companies/{companyUid}

GET /tenants/{instanceUid} 

GET /organizations/companies/{companyUid}

GET /organizations/companies/{companyUid}/sites

Returns information on company site resources.

GET /organizations/companies/{companyUid}/usage

Returns information on used services.

GET /organizations/{organizationUid}/users

Returns information on a company owner.

GET /infrastructure/sites/tenants/{tenantUid}

Returns information on Veeam Cloud Connect tenants associated with a company.

POST /tenants/{id}/action 

PATCH /organizations/companies/{companyUid}

To perform the disable action, replace the value of the status property with Disabled.

To perform the enable action, replace the value of the status property with Active.

POST /tenants/{id}/sendWelcomeEmail 

POST /organizations/companies/{companyUid}/welcomeEmail

POST /tenants/{id}/enable 

PATCH /organizations/companies/{companyUid}

To enable a company, replace the value of the status property with Active.

POST /tenants/{id}/disable 

PATCH /organizations/companies/{companyUid}

To disable a company, replace the value of the status property with Disabled.

POST /tenants/{instanceUid}/action 

PATCH /organizations/companies/{companyUid}

To perform the disable action, replace the value of the status property with Disabled.

To perform the enable action, replace the value of the status property with Active.

v2 Operation

v3 Operation

GET /tenants/licensing/reports 

GET /licensing/reports

GET /tenants/licensing/reports/latest 

GET /licensing/reports/latest

GET /tenants/licensing/reports/{date} 

GET /licensing/reports/{date}

POST /tenants/licensing/reports/finalization 

POST /licensing/reports/finalization

v2 Operation

v3 Operation

GET /tenants/{tenantId}/licensing/cloudConnectUsage 

GET /licensing/sites/usage/companies/{companyUid}

GET /tenants/{tenantId}/licensing/backupServerUsage 

GET /licensing/backupServers/usage/companies/{companyUid}

GET /tenants/{tenantId}/licensing/availabilityConsoleUsage 

GET /licensing/console/usage/companies/{companyUid}

GET /tenants/{tenantUid}/licensing/cloudConnectUsage/byVCCTenantUid 

GET /licensing/sites/usage/companies/vcc/{tenantUid}

GET /tenants/{tenantUid}/licensing/backupServerUsage/byVCCTenantUid 

GET /licensing/backupServers/usage/companies/vcc/{tenantUid}

GET /tenants/{tenantUid}/licensing/availabilityConsoleUsage/byVCCTenantUid

GET /licensing/console/usage/companies/vcc/{tenantUid}

v2 Operation

v3 Operation

POST /upload/license 

PUT /licensing/console

v2 Operation

v3 Operation

GET /users 

GET /users

GET /users/{id} 

GET /users/{userUid}

v2 Operation

v3 Operation

GET /users/{userId}/backupresources 

GET /users/{userUid}/backupResource

v2 Operation

v3 Operation

GET /vcd/organizations 

GET /infrastructure/sites/{siteUid}/vcdServers/vcdOrganizations

GET /vcd/organizations/{organizationGuid} 

GET /infrastructure/sites/{siteUid}/vcdServers/vcdOrganizations/{vcdOrganizationUid}

GET /vcd/organizations/{organizationGuid}/dataCenters 

GET /infrastructure/sites/{siteUid}/vcdServers/vcdOrganizations/vDCs

GET /vcd/organizations/{organizationGuid}/dataCenters/{dataCenterGuid} 

GET /infrastructure/sites/{siteUid}/vcdServers/vcdOrganizations/vDCs/{vdcUid}

v2 Operation

v3 Operation

GET /wanAccelerators 

GET /infrastructure/backupServers/wanaccelerators

GET /wanAccelerators/{id} 

GET /infrastructure/backupServers/{backupServerUid}/wanaccelerators/{wanAcceleratorUid}