Ephemeric cloud REST API is a collection of HTTP requests designed to manage your cloud. Requests work with
JSON format to respond your calls.
The REST API objects are:
Objects are grouped in tree structure:
User object is identified by
userID which is given to your account after registration process. Ephemeric instance is identified by hostname (eg.:
The following endpoint is used to access root object of a user:
Authentification can be done by basic HTTP authentification header or by adding
auth query parameter to URL request.
The list of REST API calls are as follows:
POST /api/ephemerics/user/<userID>creates a new Ephemeric application using Image Archive File which is attached to the query. Post query must be binary data of the archived image, content-type must be set to "application/zip". To specify an Image name property add "X-Name" header to the request (see example below).
GET /api/ephemerics/user/<userID>gets information about all Ephemerics owned by a userID.
GET /api/ephemerics/user/<userID>/<ephemericHost>gets information about an Ephemeric application which associated with "ephemericHost".
DELETE /api/ephemerics/user/<userID>/<ephemericHost>delete Ephemeric with host "ephemericHost" from the cloud.
PUT /api/ephemerics/user/<userID>/<ephemericHost>/isRunningchange the running state of the ephemeric. Accepts "true" or "false" values.
PUT /api/ephemerics/user/<userID>/<ephemericHost>/aliaschange alias value of the instance.
PUT /api/ephemerics/user/<userID>/<ephemericHost>/imageNamechange image name description of the ephemeric.
PUT /api/ephemerics/user/<userID>/<ephemericHost>/customPortsset integer array (JSON) with custom port list which to be exposed.
Video Sceencast: Ephemeric cloud: publishing StoryBoard application with CURL