REST API Reference

Use this section to provide a quick overview for the REST API Reference and to list resource collections of the product REST API. To help users navigate through the section, add a child topic for each listed resource collection.

REST API ReferenceExample

This REST API Reference lists types of Orchestrator entities, and contains the descriptions of collections and resources that stand for these entities. Every resource has a JSON object model, and includes application data and REST API metadata.

Application data is represented by properties associated with Orchestrator entities. REST API metadata is represented by properties specific to the REST API, such as resource IDs, URLs and relationships. The reference also includes methods that represent operations available for a resource or collection.

In This Section

  • Sites
  • Scopes
  • Licenses
  • Recovery Locations
  • Failover Plans
  • Restore Plans