Endpoints and Methods

Use this section to list operations available for a resource collection. To help users navigate through the section, add a child topic for each listed operation.

Endpoints and Methods Example 1 (Using endpoints to list operations)

The following method-implemented operations are supported for the failover plan entity in the Orchestrator REST API:

(GET)/v2/FailoverPlans — retrieves the /FailoverPlans collection representation.
(GET)/v2/FailoverPlans/{ID} — retrieves the /FailoverPlans/{id} resource representation.
(GET)/v2/Sites/{siteid}/Scopes/{siteScopeId}/FailoverPlans — retrieves the /FailoverPlans collection representation for a particular /Scopes/{siteScopeId} scope.
(POST)/v2/FailoverPlans/{id}/RunReadinessCheck — starts a readiness check for the /FailoverPlans/{id} failover plan.

Endpoints and Methods Example 2 (Using short descriptions to list operations)

The following method-implemented operations are supported for the backup repositories entity in the Veeam Availability Console REST API:

Get Backup Repositories — retrieves the /backupRepositories collection representation with the GET method.
Get a Backup Repository — retrieves properties of a specific backup repository with the GET method.