This is an archive version of the document. To get the most up-to-date information, see the current version.Resource URLs
Each Orchestrator REST API-exposed entity has a resource representing it. To get a resource representation, request its URL.
Orchestrator REST API v5 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 Orchestrator server runs.
- <port> is the Web UI port number specified during Orchestrator installation.
The default port number is 9898.
- <version> is an API version.
The current version is v5.
Note |
Only the v3, v4 and v5 versions of the Orchestrator REST API are supported. |
To get a collection of Orchestrator REST API resources, request the base URL followed by a resource collection endpoint. For example:
https://uwin2012r2lt.n.local:9898/api/v5/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/v5/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", ... } ] |