The Rightscale API follows the REST (REpresentational State Transfer) paradigm, and all its common verbs and actions. The API places great importance on consistency and organization of requests and response types. Emphasis has been placed on making resource relationships and available actions discoverable on the fly.
Every resource response includes three sections of information:
A list of actions to execute - These actions are contextual, for example, there can be a "launch" action for an instance that is stopped, but there will not be one if the instance is already running. For the moment, these actions are limited to a list of well-known names, but expect to provide more information (metadata) about them later (verb to use, URL, etc.).
Each response will return a specific RightScale "Content-Type" header specifying a MediaType structure. For example: servers will return "application/vnd.rightscale.server". The format of each resource media type is documented in the API Online Reference documentation. A MediaType is a human-readable schema definition for a given resource . There is no validator or similar concept like there could be in some XML formats. In other words a media type will define everything that could appear in a response of that type of resource. For calls that return a collection of items of a given MediaType, the content type will include a "type=collection" parameter (i.e., "application/vnd.rightscale.server; type=collection").
© 2006-2014 RightScale, Inc. All rights reserved.
RightScale is a registered trademark of RightScale, Inc. All other products and services may be trademarks or servicemarks of their respective owners.