- About Veeam Recovery Orchestrator REST API
- Overview
- Changelog
- Token
- Mfa
- Clients
- Plans
- getGet Collection of Plans
- getGet Plan Data
- getGet VMs Added to Inventory Group in Plan
- getGet All Groups in Plan
- getGet Parameters Configured for Step in Plan
- getGet Steps Added for VM in Plan
- getGet Steps Added to Virtual Group in Plan
- postEnable Plan
- postDisable Plan
- postHalt Plan
- postRun Permanent Failover
- postFail Back to Source VMs
- postPrepare for Failback
- postSwitchover to Production
- postCommit Failback
- postUndo Plan
- postReset Plan State
- postClear Change Log History for Plan
- postRun Failover
- postRun Restore Plan
- postContinue Plan Execution
- postRun Readiness Check
- delDelete Plan Schedule
- putSchedule Plan to Run at Specific Time
- putSchedule Plan to Run After Another Plan
- postClone Plan
- RecoveryLocations
- RuntimeDetails
- Scopes
- LicenseUsage
The /LicenseUsage
resource collection represents all license instances consumed by all plans on the Orchestrator server.
Get License Usage for Server
The HTTP GET request to the /License/Usage/Server
endpoint retrieves a list of license instances consumed by all plans on the Orchestrator Server.
SecurityuserAuth or clientAuth
Responses
200
OK
401
Unauthorized request. The authorization header has been expected but not found (or found but expired).
500
Internal server error.
get/api/v7.21/License/Usage/Server
Request samples
- curl
- Python
- JavaScript
- C#
- Go
Response samples
- 200
{- "newInstances": 0,
- "managedInstances": 1
}
Get License Usage for Scope
The HTTP GET request to the /License/Usage/Scopes/{scopeId}
endpoint retrieves a list of license instances consumed by a scope selected for plans.
SecurityuserAuth or clientAuth
Request
path Parameters
scopeId required | string <uuid> System ID assigned to an Orchestrator scope. |
Responses
200
OK
401
Unauthorized request. The authorization header has been expected but not found (or found but expired).
500
Internal server error.
get/api/v7.21/License/Usage/Scopes/{scopeId}
Request samples
- curl
- Python
- JavaScript
- C#
- Go
Response samples
- 200
{- "newInstances": 0,
- "managedInstances": 1
}