Endpoint overview

Authentication

Method Endpoint Comments
POST /register Registers new user
POST /auth Authenticates user

Blueprints

Method Endpoint Comments
GET /blueprints Retrieves list of blueprints
GET /blueprints/<_id> Retrieves single blueprint
DELETE /blueprints/<_id> Deletes a single blueprint
POST /blueprints/create Creates a new blueprint
PUT /blueprints/create Creates or updates a blueprint

Services

Method Endpoint Comments
GET /services Retrieves list of services
GET /services/<_id> Retrieves single services
DELETE /services/<_id> Deletes a single service
POST /services/create Creates a new service
PUT /services/create Creates or updates a service

Stacks

Basic Operations

Method Endpoint Comments
GET /stacks Retrieves list of stacks
GET /stacks/<_id> Retrieves single stacks
DELETE /stacks/<_id> Deletes single service
POST /stacks/<_id>/apply Applies a stack and saves config files to disk
DELETE /stacks/<_id>/apply Deletes or purges the stack's config files
POST /stacks/create Creates a new stack
PUT /stacks/create Creates or updates a stack

Container management

Method Endpoint Comments
POST /stacks/<_id>/manage/up Starts a specific stack
POST /stacks/<_id>/manage/down Shuts down a specific stack if it's running
GET /stacks/<_id>/manage/status Retrieves status information about running or exited containers of a specific stack
GET /stacks/<_id>/manage/logs Retrieves logs for specific stack
DELETE /stacks/<_id>/manage/delete Removes and deletes containers for a specific stack