Applications API

« API Overview

The Application resources allow you create, view and modify the applications associated with the authorized AppHarbor account.

Contents

• List Applications
• Get Application Detail
• Create an Application
• Edit Existing Application
• Remove an Application

List Applications

Returns a list of all applications for the authorized user.

Request

GET /applications

Response

The resource returns a JSON representation of the list. The item properties are the same as the Application detail with the addition of the URL for the detail resource for each item.

[
    {
        "name" : "Hello World",
        "slug" : "helloworld",
        "url" : "https://appharbor.com/applications/helloworld"
    },
    {
        "name" : "Fizz Buzz",
        "slug" : "fizzbuzz",
        "url" : "https://appharbor.com/applications/fizzbuzz"
    }
]

Get Application Detail

Retrieve the information associated with the specified application slug.

Request

GET /applications/:slug

Response

The response returns a JSON representation of the application requested.

{
    "name" : "Hello World",
    "slug" : "helloworld"
}

Response Properties

Create an Application

Create an application on the authorized user's account with the specified name. The slug is auto-generated based on the name.

Request

POST /applications

{
    "name" : "Hello World",
    "region_identifier" : "amazon-web-services::us-east-1"
}

Request Parameters

Response

Status: 201 Created
Location: https://appharbor.com/applications/:slug

Edit Existing Application

Update the information for an existing application.

Request

PUT /applications/:slug

{
    "name" : "Hello World"
}

Request Parameters

Response

Status: 200 OK

Remove an application

Remove an application from the authorized user's account.

Warning: this will irreversibly remove the application and the associated web site and add-ons.

Request

DELETE /applications/:slug

Response

Status: 204 No Content

Back to overview