Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
tree: 1470fb23d2
Fetching contributors…

Cannot retrieve contributors at this time

146 lines (86 sloc) 3.777 kB

Using The API

Nodejitsu provides a web API for users who want to interact with the Nodejitsu platform programatically. This API is built to be RESTful and communicates via JSON.

Authentication

Most of the calls to the API will require that you authenticate using your Nodejitsu account. If you do not have an account it is possible to create one using the User API, the Jitsu CLI, or just by visiting http://nodejitsu.com. Currently, we support Basic Authentication. If you haven't used Basic Auth before don't fret, it's easy!

Here is an example using the command line utility, Curl.

 // get all applications for User "Marak"
 curl --user Marak:password http://nodejitsu.com/apps/marak

Applications

Applications are the core of the Nodejitsu API. Each application represents a set Node.js code plus a package.json which contains meta-data about the application such as it's dependencies, database connections, configuration settings, authors, etc. For more information about the package.json format see: LINKTO: package.json docs

Get all applications for a User

 GET /apps/:user-id

Create a new Application

 POST /apps/:user-id
 { package.json }

Start an Application

 POST /apps/:user-id/:app-id/restart

Stop an Application

 POST /apps/:user-id/:app-id/start

Restart an Application

 POST /apps/:user-id/:app-id/stop

Update an Application

 PUT /apps/:user-id
 { package.json }

Delete an Application

 DELETE /apps/:user-id/:app-id/remove

Snapshots

Snapshots are an easy way to capture the current state of your application. Once a Snapshot of your application is created you can roll back and activate that Snapshot at any time.

Make an existing snapshot the active app

PUT /apps/:user-id/:app-id/snapshots/:id/active

Activate / Deploy a snapshot

POST /apps/:user-id/:snapshots/:id

Show a catalog of all Snapshot for an Application

GET /apps/:user-id/:app-id/snapshots

Show the contents of a Snapshot

GET /apps/:user-id/:app-id/snapshots/:id

Users

Create a new User / Sign-up for a free Nodejitsu account

Email address is the only required field.

 POST /users/:user-id
 {
   email: "youremail@theinternet.com"
 }

Confirm a User account

All User accounts must be confirmed. When a new User is created, a confirmation email will be sent to the email address associated with that user. In this email address, you will receive an invite code. This code must be sent to the API to confirm the account.

POST /users/:user-id
{
  inviteCode: "SecretCode"
}

Update User

PUT /users/:user-id
{
  password: "new_password"
}

Databases

Create a new Database

 POST /databases/:user-id/:id

 {
   type: "Couch || Redis || Mongo"
 }

Get information about a Database

GET /databases/:user-id/:id

Delete a Database

DELETE /databases/:user-id/:id

Marketplace

Get all Marketplace Applications

GET /marketplace

Get a specific Marketplace Application

GET /databases/:user-id/:id

Logging

Get all logs for a user

 GET /logs/:user-id/

Get logs for a specific application

 GET /logs/:user-id/:app-id
Jump to Line
Something went wrong with that request. Please try again.