Once you have learned about the RightScale API and know how to look things up (Reference section), seeing practical examples can help solidify precisely how to construct calls for various API Resources. Examples bring the learning experience full circle. Each example provided pertains to an often used API Resource. Each example includes a curl (bash/sh) example and often a Ruby (right_api_client) example.1
API examples are really 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.
- QUICK Start for using Examples
- Tips for Using API Examples
- Audit Entries
- Instance Types
- Security Groups
- Server Array
- End-to-End Examples
1 The Examples section is a work in progress. It is our plan to not only add to the number of examples, but to add to the curl examples with a REST API client (right_api_client) examples. The curl examples have the advantage of ease of use when exploring, whereas the REST API client is likely preferred by more seasoned developers. Although Ruby experience is helpful, the right_api_client examples do their best to minimize the complexity of Ruby used. Some examples also contain a Supplemental section. (Usually this includes a filter or view.)
- RightScale right_api_client (On github) - Developed by RightScale engineering
- RightScale API 1.5 PHP library (On github) - This PHP library is under construction, but has many helpful examples that PHP developers will find useful. Skilled developers may find the github examples more compelling than the Examples section of this guide.
- RSC - A Generic RightScale API Client (On github) - Provides both a command line tool and a go package for interacting with the RightScale APIs. Developed by RightScale engineering.