Nodester API Documentation

Our entire platform is built on a set of REST APIs. A subset of these APIs are implemented in our CLI (command line interface). We are also working on a web admin panel based on these APIs which will eventually allow you to provision, monitor, and control Node.JS applications running on the Nodester platform without going to the command line.

Our command line interface allows you to manage your user account and applications with simple commands. Before you can begin using these commands, you need to install the Nodester CLI using NPM.

npm install nodester-cli -g

  nodester coupon <email address>
  nodester user create <username> <password> <email address> <file containing ssh public key> <coupon code>
  nodester user setup <username> <password>
  nodester user setkey <file containing ssh public key>
  nodester user setpass sendtoken
  nodester user setpass <token> <new_password>
  nodester apps list
  nodester app create <appname> <initial js file>
  nodester app info <appname>
  nodester app logs <appname>
  nodester app start <appname>
  nodester app restart <appname>
  nodester app stop <appname>
  nodester app gitreset <appname>
  nodester npm list <appname>
  nodester npm install <appname> <packages>
  nodester npm update <appname> <packages>
  nodester npm uninstall <appname> <packages>
  nodester env get <appname>
  nodester env set <appname> <key> <value>
  nodester env delete <appname> <key>
  nodester domain
  nodester status

If you would like to contribute to our open source Nodester CLI on GitHub, please send us pull requests :)

The force is strong with our REST API.

Base URL:

  POST /coupon - Creates coupon request for early access (pass in email)
curl -X POST -d ""
  POST /user - Creates user account (pass in user and password and email and string) Ensure that all + in the ssh key are substituted for their %2B counter parts, else your key will break. Run this on your command line to copy your RSA string and swap out the plus signs: "cat ~/.ssh/ | sed s/'+'/'%2B'/g | pbcopy"
curl -X POST -d "coupon=mycoupon&user=testuser&password=123& AAAAB3NzaC1yc..."
  PUT /user - Updates user account (pass in password and/or RSA key - "cat ~/.ssh/ | sed s/'+'/'%2B'/g | pbcopy")
curl -X PUT -u "testuser:123" -d "password=test"
curl -X PUT -u "testuser:123" -d "rsakey=1234567"
  DELETE /user - Deletes user account (requires basic auth)
curl -X DELETE -u "testuser:123"
  GET /apps - Returns a list of all apps created by a user account (requires basic auth)
curl -X GET -u "testuser:123"
  POST /apps/<appname> - Creates nodejs app for hosting (requires basic auth and returns the port address required for use along with a git repo to push to)
curl -X POST -u "testuser:123" -d "start=hello.js"
  PUT /apps/<appname> - Updates starting app name (requires basic auth, appname, and starting page and returns the port address required for use along with a git repo to push to and running status of the app)
curl -X PUT -u "testuser:123" -d "start=hello1.js"
  PUT /apps/<appname> - Start and stop your hosted nodejs app (requires basic auth, appname, and running=true|false and returns the port address required for use along with a git repo to push to)
curl -X PUT -u "testuser:123" -d "running=true"
  DELETE /apps/<appname> - Deletes nodejs app (requires basic auth and appname)
curl -X DELETE -u "testuser:123"<appname>
  GET /apps/<appname> - get nodejs app info (requires basic auth and appname)
curl -X GET -u "testuser:123"<appname>
  GET /applogs/<appname> - Gets nodejs app logs (requires basic auth and appname)
curl -X GET -u "testuser:123"<appname>
  PUT /env - Create/update environment key/value pair (requires basic auth and environment key and value)
curl -X PUT -u "testuser:123" -d "key=color&value=blue"<appname>
  DELETE /env/<appname>/<key> - Deletes environment key/value pair (requires basic auth, appname, and environment key)
curl -X DELETE -u "testuser:123"<appname>/<key>
  GET /env - Gets environment info (requires basic auth, appname, and environment key)
curl -X GET -u "testuser:123"<appname>
  GET /status - Returns platform status and number of apps hosted and running
curl -X GET
  POST /npm - Allows you to manage the NPM packages for an application.
curl -X POST -u "testuser:123" -d "appname=a&action=install&package=express"
curl -X POST -u "testuser:123" -d "appname=a&action=update&package=express"
curl -X POST -u "testuser:123" -d "appname=a&action=uninstall&package=express"
  POST /appdomains - Creates app domain for hosting (requires basic auth)
curl -X POST -u "testuser:123" -d "appname=test&"
  DELETE /appdomains/<appname>/<domain> - Deletes app domain for hosting (requires basic auth)
curl -X DELETE -u "testuser:123"<appname>/<domain>
  GET /appdomains - Gets list of your domains (requires basic auth)
curl -X GET -u "testuser:123"
  POST /reset_password - Sends a e-mail with a token to reset your user password
curl -X POST -d "user=your_username"
  PUT /reset_password/<token> - Updates your password using the provided token
curl -X PUT -d "password=your_new_password"<token>
  DELETE /gitreset/<appname> - Resets your Nodester git repository and npm list (pass in appname)
curl -X DELETE -u "testuser:123"<appname>

Nodester has partnered with Apigee to provide this API Explorer interface for developers to experiment with our RESTful PaaS API. Follow these instructions to get started and have fun!

1. Click on the padlock (top left) to authenticate using your Nodester credentials
2. If necessary edit the {sample} parts of the URL with the right information such as your appname
3. If necessary click on the gear icon (top right) to change params
4. Click on the orange GET/POST/PUT/DELETE button to run the API request

Watch Video »