awe.sm Administration API

These endpoints are used to manage domains, projects, and users.

These endpoints require a valid subscription_key and an authorized application's application_key. JSON is returned with request and response objects.

In the event of an error, an error object will be returned instead of a response object. Errors will also be sent with a different HTTP response code as appropriate: objects that are not found will be 404, actions you do not have permission to do will result in a 403. Any other types of errors (e.g. validation) will be HTTP 400.

Creating and Authorizing Applications

Applications can be created and managed through application settings. Applications can be authorized for a subscription by copying the application's key and pasting it into the subscription application settings.

Projects

Create a project

projects/new

Retrieve projects

projects/list

Retrieve a project

projects/{api_key}/show

Update a project

projects/{api_key}/update

Delete a project

projects/{api_key}/destroy

Domains

Connect a domain to a subscription

domains/new

Retrieve a subscription's connected domains

domains/list

Retrieve a connected domain

domains/{hostname}/new

Update a connected domain

domains/{hostname}/update

Remove a connected domain

domains/{hostname}/destroy

Last updated 2011-10-24