This is an archive version of the document. To get the most up-to-date information, see the current version.Resource URLs
Each VAO REST API-exposed entity has a resource representing it. To get a resource representation, request its URL.
VAO REST API v3 requests use the following new base URL format:
https://<hostname>:<port>/api/<version> |
where:
- <hostname> is a DNS name or IP address of the machine where the VAO server runs.
- <port> is the Web UI port number specified during VAO installation.
The default port number is 9898.
- <version> is an API version.
The current version is v3.
Note |
For backward compatibility purposes, Veeam Availability Orchestrator 3.0 still supports the VAO REST API v2. For more information on how to work with the VAO REST API v2, see the Veeam Availability Orchestrator 2.0 REST API Reference. |
To get a collection of VAO REST API resources, request the base URL followed by a resource collection endpoint. For example:
https://uwin2012r2lt.n.local:9898/api/v3/Plans |
To get a representation of an individual resource, enter a resource identifier after the resource collection endpoint. For example:
https://uwin2012r2.n.local:9898/api/v3/Plans/b063f440-2f15-45aa-a8f7-196be6f652ba |
The resource identifier is represented by the id property of the resource from the collection. For example:
[ { "name": "Columbus", "id": "12f39f64-245e-4430-a82e-126497007641", ... , { "name": "Ontario", "id": "b063f440-2f15-45aa-a8f7-196be6f652ba", ... } ] |