Note: Please go to to access the current RightScale documentation set. Also, feel free to Chat with us!
Home > Guides > RightScale API 1.5 > Examples > QUICK Start for using Examples

QUICK Start for using Examples

Table of Contents


Some who wish to explore and learn more about the RightScale API by taking advantage of the API Examples section of the guide may not have immediate access to a Linux server.  Because the bulk of the examples use curl to issue HTTP requests from a basic Linux box, the outline below can help you get started in the cloud using the RightScale API.

API examples are designed to be used in parallel with the API 1.5 online reference information.  We strongly recommend you use the online reference information at all phases of your learning curve.

Note:  If you have little to no experience with Linux, Ruby or Windows PowerShell, see the RS APEye Tool documentation that uses the Postman plugin to Google Chrome for an easy to use, more visual interface to our API.

API Quick Start Outline

  • Log into the  RightScale Dashboard. (
  • Create a deployment
  • Add a server to your deployment (a basic Linux server is all that is needed)
  • Launch the server
  • SSH into your server
  • Read over the TIPS to using the API Examples
  • Use the Examples
    • Authenticate (do this one first!)
    • Run/use whatever examples are of interest to you...
    • Tip:  Listing cloud assets is easier when getting started than creating or modifying them.  You can create assets in the Dashboard then list them via the API to help verify operations are behaving as expected.
  • Terminate your server.  If you are charged for server/resources used (such is the case with public clouds), when done terminate your server to avoid extra charges.  (Warning:  If you create shell scripts to test the API on your server, when you terminate the server the scripts will be lost.  That is not a permanent storage solution, but only exists for the life of the server.  Because the sample scripts are so short, if you do need to terminate your server you can simply copy/paste them into files stored on your local hard drive for future use.)

You must to post a comment.
Last modified
09:45, 14 Oct 2014



This page has no classifications.



© 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.