Using the REST API

The iON REST API provides a way for you to programmatically access much of iON's functionality. It allows you to: Create applications Change application properties, including the number of workers and environment variables Deploy a new version of your application Delete your application Get statistics about your application Get logs for your application

Already familiar with the API? Jump straight to the operations: Operations for Applications Operations for Logs (coming soon) Operations for Statistics (coming soon)

Before getting started with specific operations, be sure you're familiar with:

• Getting Started and Authenticating with the API
• Status Codes and Error Handling

Data Format

All resources or methods that return or accept a type use the JSON as the data format. As an example, here's data you might receive, in JSON format, in response to a request to get an application:

{
  "domain":"hello",
  "fullDomain":"hello.muleion.com",
  "workers":1,
  "hasFile":false,
  "muleVersion", "3.1.2"
  "properties": {
    "foo":"bar"
  },
  "status":"STARTED",
  "workerStatuses":[
     {
       "id":"",
       "host":"xxx.xxx.xxx.xxx",
       "port":8081,
       "status":"STARTED"
     }
   ]
}

Getting Started and Authenticating with the API

To use the API, you can use any HTTP client. All APIs use JSON as the data format. If you use Java, we recommend you use the Jersey client or HttpClient with Jackson for JSON support.

All APIs require HTTP basic authentication using your iON username and password.

Status Codes and Error Handling

When you call the REST APIs, the following status codes are returned:

When errors occur (for example, a 500 status code), the HTTP response contains a JSON response with an error message. For example:

500
Content-Type: application/json
Server: Apache-Coyote/1.1
Date: Sun, 08 Nov 2009 00:12:55 GMT

{
  message : "Some error message."
}