This is an archive version of the document. To get the most up-to-date information, see the current version.

Resource URLs

Each VAO RESTful API-exposed entity has a resource representing it. To get a resource representation, request its URL. All VAO RESTful API URLs have the following base:

https://<hostname>:<port>/<version>

where:

<hostname> is the DNS name or IP address of the machine where the DR VAO server runs.
<port> is the RESTful API port number you specified during VAO installation.

The default port number is 9899.

<version> is an API version.

Current version is v1.

To get a collection of VAO RESTful API resources, request a base URL followed by resource collection path. For example:

https://uwin2012r2lt.n.local:9899/v1/FailoverPlans

To get a representation of an individual resource, enter a resource identifier after the resource collection path. For example:

https://uwin2012r2.n.local:9899/v1/FailoverPlans/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",

...

}

]