This is an archive version of the document. To get the most up-to-date information, see the current version.Operations and Methods
The following method-implemented operations are supported for the backup agent entities in Veeam Service Provider Console RESTful API:
- Get All Backup Agents — retrieve a collection resource representation of all Veeam backup agents installed on computers.
- Get Backup Agent — retrieve a resource representation of a Veeam Agent with the specified UID.
- Modify Backup Agent — modify Veeam backup agent with the specified UID.
- Activate Backup Agent — change management mode of a Veeam backup agent with the specified UID to ManagedByConsole.
- Deactivate Backup Agent — change management mode of a Veeam backup agent with the specified UID to UnManaged and delete management agent from the agent computer.
- Restart Backup Agent Service — restart a Veeam backup agent with the specified UID.
- Force Data Collection from Backup Agent — force data collection from a Veeam backup agent with the specified UID.
- Get All Veeam Agents for Microsoft Windows — retrieve a collection resource representation of all Veeam backup agents installed on Windows computers.
- Get Veeam Agent for Microsoft Windows — retrieve a resource representation of a Veeam Agent for Microsoft Windows with the specified UID.
- Update Veeam Agent for Microsoft Windows — update a Veeam Agent for Microsoft Windows with the specified UID.
- Install CBT Driver — install the Veeam CBT driver on a Windows computer that runs a Veeam backup agent with the specified UID.
- Uninstall CBT Driver — uninstall the Veeam CBT driver from a Windows computer that runs a Veeam backup agent with the specified UID.
- Get All Veeam Agents for Microsoft Windows Settings — retrieve a collection resource representation of settings configured for all Veeam backup agents installed on Windows computers.
- Get Veeam Agent for Microsoft Windows Settings — retrieve a resource representation of settings configured for a Veeam Agent for Microsoft Windows with the specified UID.
- Replace Veeam Agent for Microsoft Windows Settings — replace settings configured for a Veeam Agent for Microsoft Windows with the specified UID.
- Get All Policies Assigned to Veeam Agents for Microsoft Windows — retrieve a collection resource representation of all backup policies assigned to Veeam Agents for Microsoft Windows.
- Get Policies Assigned to Veeam Agent for Microsoft Windows — retrieve a collection resource representation of all backup policies assigned to a Veeam Agent for Microsoft Windows with the specified UID.
- Assign Policy to Veeam Agent for Microsoft Windows — assign a backup policy to a Veeam Agent for Microsoft Windows with the specified UID.
- Get All Veeam Agents for Microsoft Windows Jobs — retrieve a collection resource representation of all Veeam backup agent jobs protecting Windows computers.
- Get Jobs Configured for Veeam Agent for Microsoft Windows — retrieve a collection resource representation of all jobs configured for a Veeam Agent for Microsoft Windows with the specified UID.
- Get Job Configured for Veeam Agent for Microsoft Windows — retrieve a resource representation of a Veeam Agent for Microsoft Windows job with the specified UID.
- Delete Job Configured for Veeam Agent for Microsoft Windows — delete a Veeam Agent for Microsoft Windows job with the specified UID.
- Start Job Configured for Veeam Agent for Microsoft Windows — start a Veeam Agent for Microsoft Windows job with the specified UID.
- Stop Job Configured for Veeam Agent for Microsoft Windows — stop a Veeam Agent for Microsoft Windows job with the specified UID.