Veeam Service Provider Console 6.0
REST API Reference
Related documents
Deployment GuideGuide for Service ProvidersGuide for End UsersGuide for ResellersUsage Scenarios for Service Providers
Veeam Cloud Connect GuideVeeam Agent for Microsoft Windows DocumentationVeeam Agent for Linux DocumentationVeeam Agent for Mac Documentation
Search
Veeam Service Provider Console 6.0
REST API Reference
  • About Veeam Service Provider Console REST API
  • REST API v2
    • Overview
      • Resource URLs
      • Authorization and Security
      • Methods
        • GET Method
        • POST Method
        • PATCH Method
        • PUT Method
        • DELETE Method
      • Query String Options
        • Filter System Query Option ($filter)
        • Orderby System Query Option ($orderby)
        • Top System Query Option ($top)
        • Skip System Query Option ($skip)
        • Select System Query Option ($select)
        • Format System Query Option ($format)
        • SetLinks Custom Query Option (setLinks)
    • Evaluation with Swagger UI
      • Getting Authorization Tokens
      • Sending Requests
    • Veeam Service Provider Console REST API Reference
      • Alarms
        • Properties
        • Operations and Methods
          • Get Alarm Templates
          • Get an Alarm Template
          • Get Alarm Status Changes
          • Get Triggered Alarms
          • Get a Triggered Alarm
      • Backup Agents
        • Properties
        • Operations and Methods
          • Get Backup Agents
          • Get a Backup Agent
          • Assign Backup Policy
      • Backup Agent Jobs
        • Properties
        • Operations and Methods
          • Get Veeam backup agent Jobs
          • Get a Veeam backup agent Job
          • Start a Veeam backup agent Job
          • Stop a Veeam backup agent Job
          • Update a Veeam backup agent Job
          • Delete a Veeam backup agent Job
      • Backup Policies
        • Properties
          • General
          • Server Operation Mode
            • Guest Indexing
            • Guest Processing
            • Schedule Settings
          • Workstation Operation Mode
          • Backup Mode
          • Destination Type
          • Advanced Settings
        • Operations and Methods
          • Get Backup Policies
          • Create a Backup Policy (Experimental)
          • Get a Backup Policy
      • Backup Repositories
        • Properties
        • Operations and Methods
          • Get Backup Repositories
          • Get a Backup Repository
      • Backup Servers
        • Properties
        • Operations and Methods
          • Get Backup Servers
          • Get a Backup Server
          • Get Company Backup Servers
      • Cloud Gateway Pools
        • Properties
        • Operations and Methods
          • Get Cloud Gateway Pools
          • Get a Cloud Gateway Pool
      • Computers
        • Properties
        • Operations and Methods
          • Get Computers
          • Get a Computer
          • Activate Agent
          • Deactivate Agent
      • Discovery Rules
        • Properties
          • General
          • Discovery types
          • Notification Settings
          • Filters
        • Operations and Methods
          • Get Discovery Rules
          • Get a Discovery Rule
          • Get Network Settings
          • Get Notification Settings
          • Get Filters
      • Failover Plans
        • Properties
        • Operations and Methods
          • Get Failover Plans
          • Get a Failover Plan
          • Start a Failover Plan
          • Undo a Failover Plan
      • Hardware Plans
        • Properties
        • Operations and Methods
          • Get Hardware Plans
          • Get a Hardware Plan
      • Jobs
        • Properties
        • Operations and Methods
          • Get Jobs
          • Get a Job
          • Start a Job
          • Stop a Job
          • Retry a Job
          • Disable a Job
          • Enable a Job
      • Veeam Service Provider Console License
        • Properties
        • Operations and Methods
          • Get License Settings
          • Update License
          • Enable License Auto Update
          • Disable License Auto Update
          • Upload License
      • Veeam Backup & Replication Licenses
        • Properties
        • Operations and Methods
          • Get Veeam Backup & Replication Licenses
          • Get a Veeam Backup & Replication License
          • Delete a Veeam Backup & Replication License
          • Install a Veeam Backup & Replication License
          • Update a Veeam Backup & Replication License
          • Enable Veeam Backup & Replication License Auto Update
          • Disable Veeam Backup & Replication License Auto Update
      • Veeam Cloud Connect Licenses
        • Properties
        • Operations and Methods
          • Get Veeam Cloud Connect Licenses
          • Get a Veeam Cloud Connect License
          • Delete a Veeam Cloud Connect License
          • Install a Veeam Cloud Connect License
          • Update a Veeam Cloud Connect License
          • Enable Veeam Cloud Connect License Auto Update
          • Disable Veeam Cloud Connect License Auto Update
      • Company Locations
        • Properties
        • Operations and Methods
          • Get Company Locations
          • Get a Company Location
      • Miscellaneous
        • Properties
        • Operations and Methods
          • Get USA States
          • Get Countries
      • Company Replication Resources
        • Properties
        • Operations and Methods
          • Get Company Replication Resources
          • Get a Company Replication Resource
          • Create a Company Replication Resource
          • Replace a Company Replication Resource
          • Delete a Company Replication Resource
          • Get Company Network Extension Appliances
          • Get a Company Network Extension Appliance
          • Replace a Company Network Extension Alliance
      • Reseller Replication Resources
        • Properties
        • Operations and Methods
          • Get Reseller Replication Resources
          • Get a Reseller Replication Resource
          • Create a Reseller Replication Resource
          • Replace a Reseller Replication Resource
          • Delete a Reseller Replication Resource
      • Resellers
        • Properties
        • Operations and Methods
          • Get Resellers
          • Create a Reseller
          • Get a Reseller
          • Replace a Reseller
          • Delete a Reseller
          • Enable a Reseller
          • Disable a Reseller
          • Send Welcome Letter to a Reseller
      • Reseller Site Scopes
        • Properties
        • Operations and Methods
          • Get Site Scopes
          • Create a Site Scope
          • Get a Site Scope
          • Replace a Site Scope
          • Delete a Site Scope
      • Reseller Clients
        • Properties
        • Operations and Methods
          • Get Available Clients
          • Get Managed Clients
          • Create a Managed Client
          • Delete a Managed Client
      • Reseller vCD Resources
        • Properties
        • Operation and Methods
          • Get vCD Resources
          • Create a vCD Resource
          • Get a vCD Resource
          • Delete a vCD Resource
      • Company vCD Resources
        • Properties
        • Operations and Methods
          • Get vCD Resources
          • Create a vCD Resource
          • Get a vCD Resource
          • Replace a vCD Resource
          • Delete a vCD Resource
          • Get vCD Network Extension Appliances
          • Get a vCD Network Extension Appliance
          • Replace a vCD Network Extension Appliance
      • Subscription Plans
        • Properties
        • Operations and Methods
          • Get Subscription Plans
          • Get a Subscription Plan
          • Get a Company Subscription Plan
          • Assign Subscription Plan to Company
      • Companies
        • Properties
          • General
          • Gateway Pools
        • Operations and Methods
          • Get Companies
          • Create a Company
          • Get a Company
          • Replace a Company
          • Delete a Company
          • Disable a Company
          • Enable a Company
          • Send Welcome Letter to a Company or Department
      • Company Backup Resources
        • Properties
        • Operations and Methods
          • Get Company Backup Resources
          • Get a Company Backup Resource
          • Create a Company Backup Resource
          • Replace a Company Backup Resource
          • Delete a Company Backup Resource
      • Reseller Backup Resources
        • Properties
        • Operations and Methods
          • Get Reseller Backup Resources
          • Get a Reseller Backup Resource
          • Create a Reseller Backup Resource
          • Replace a Reseller Backup Resource
          • Delete a Reseller Backup Resource
      • Company License Usage
        • Properties
        • Operations and Methods
          • Get Veeam Cloud Connect License Usage
          • Get Veeam Backup & Replication License Usage
          • Get Veeam Service Provider Console License Usage
      • Tenant License Usage
        • Properties
        • Operations and Methods
          • Get Veeam Cloud Connect License Usage
          • Get Veeam Backup & Replication License Usage
          • Get Veeam Service Provider Console License Usage
      • Tenant License Usage Reports
        • Properties
        • Operations and Methods
          • Get Tenant License Usage Reports
          • Get Latest Tenant License Usage Report
          • Get Tenant License Usage Report for Specific Date
          • Finalize Tenant License Usage Report
      • Users
        • Properties
        • Operations and Methods
          • Get Users
          • Get a User
          • Get User Backup Resources
      • WAN Accelerators
        • Properties
        • Operations and Methods
          • Get WAN Accelerators
          • Get a WAN Accelerator
      • vCD Organizations
        • Properties
        • Operations and Methods
          • Get vCD Organizations
          • Get a vCD Organization
          • Get Organization vDCs
          • Get an Organization vDC
  • REST API v3
    • Overview
      • Resource URLs
      • Authorization and Security
        • OAuth 2.0 Authentication
          • User Impersonation
        • User Name and Password Authentication
        • API Key-Based Authorization
        • Asymmetric Authentication
      • Methods
        • GET Method
        • POST Method
        • PATCH Method
        • PUT Method
        • DELETE Method
      • Errors
      • Extensions
      • Multi-Factor Authentication
      • Asynchronous Processing
        • Async Action Settings
      • Backward Compatibility
      • Throttling
        • Throttling Settings
      • Query Parameters
        • Limit Parameter
        • Offset Parameter
        • Filter Parameter
        • Sort Parameter
        • Select Parameter
        • Expand Parameter
      • Pagination
      • Integration with Grafana
        • Configuring Integration
        • Viewing Dashboard
      • REST API Client
    • Evaluation with Swagger UI
      • Getting Authorization Tokens
      • Sending Requests
    • Veeam Service Provider Console REST API Reference
  • Appendix A. REST API v3.2 Changelog
    • Global Changes
    • Resource Changes
    • New Operations
  • Appendix B. REST API v2 to v3 Migration
    • Operation Reference
    • Global Differences
>REST API Reference>REST API v2

REST API v2

In this article

    REST API v2 is the deprecated version for Veeam Service Provider Console 6.0. It allows you to perform most of the operations that are available with Web UI but lacks number of new features.

    In This Section

    • Overview
    • Evaluation with Swagger UI
    • Veeam Service Provider Console REST API Reference

    Page updated 11/16/2021

    Send feedback
    Home | Products | Forums | Support | Contact Sales | EULA

    ©{%YEAR%} Veeam® Software Privacy Notice | Cookie Notice | Cookie Settings

    View all results across Veeam
    Back to document search
    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.

    Submit report