Overview

Follow the steps described in this guide to use the Rackspace Cloud Orchestration API to create and access your stacks.

The simple exercises in this guide help you get started with the API by showing you how to access the API through either heat client commands or cURL commands.

For each exercise in this guide, you choose one of the following methods to make API calls:

  • The heat client commands. The heat client provides easy command line access to the orchestration API operations. We recommend that you use the heat client to run simple commands that make API calls. You can specify a --debug parameter on any heat command to show the underlying cURL request for the API command. This is a good way to become familiar with the API requests. See the section called “How the Heat Client Works” for details.

  • cURL commands. If you are familiar with or want to learn cURL commands, choose this method. With cURL, you send HTTP requests with embedded API calls from the command line. The cURL examples in this guide include request bodies in JSON format. See the section called “How cURL Commands Work” for details.

If you like, you can use cURL in one example and switch to the heat client in the next example. If you choose to use a cURL command for any example, you must export the environment variables required to run the cURL examples. See the section called “Step 5. Export Environment Variables to Run cURL Commands” for details.

To use the API, it helps to be familiar with HTTP 1.1, RESTful web services, the Rackspace Cloud Servers service, and JSON data serialization format.