forked from nodester/newdesign
/
api.html
220 lines (193 loc) · 13.5 KB
/
api.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Nodester -> Open Source Node.JS PaaS</title>
<meta name="description" content="Open Source Node.JS Platform as a Service">
<!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
<!--[if lt IE 9]>
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<!-- Le styles -->
<link href="bootstrap.css" rel="stylesheet">
<style type="text/css">
body {
padding-top: 60px;
}
</style>
<!-- Le fav and touch icons -->
<link rel="shortcut icon" href="/images/nodester_favicon.ico">
<link rel="apple-touch-icon" href="images/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="images/apple-touch-icon-114x114.png">
<script src="http://code.jquery.com/jquery-1.7.1.min.js"></script>
<script src="http://twitter.github.com/bootstrap/1.4.0/bootstrap-tabs.js"></script>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-2483685-22']);
_gaq.push(['_setDomainName', 'nodester.com']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<script>
$(document).ready(function() {
var hash = window.location.hash.substring(1);
if (hash == "rest") {
$('#restli').addClass("active");
$('#clili').removeClass("active");
$('#cli').removeClass("active");
$('#rest').addClass("active");
}
});
</script>
<div class="topbar">
<div class="fill">
<div class="container">
<a class="brand" href="/"><img src="/images/rocket-md-right.png" width="20"> nodester</a>
<ul class="nav">
<li><a href="/">Home</a></li>
<li class="active"><a href="/api.html">Docs</a></li>
<li><a href="http://nodester.tumblr.com">Blog</a></li>
<li><a href="http://irc.nodester.com">IRC</a></li>
</ul>
<p class="pull-right"><a class="btn primary large" href="developer.html">Signin »</a></p>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="span16"><br/>
<h1>Nodester Docs</h1>
<p>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.
</p>
<ul class="tabs" data-tabs="tabs">
<li class="active" id="clili"><a href="#cli">Command Line Interface (CLI)</a></li>
<li id="restli"><a href="#rest">REST API</a></li>
</ul>
<div id="my-tab-content" class="tab-content">
<div class="active tab-pane" id="cli">
<p>
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.
</p>
<p>
<b>npm install nodester-cli -g</b>
</p>
<br/>
<table class="bordered-table zebra-striped">
<tr><td><b>coupon</b></td><td> </td></tr>
<tr><td> </td><td>nodester coupon <email address></td></tr>
<tr><td><b>user</b></td><td> </td></tr>
<tr><td> </td><td>nodester user create <username> <password> <email address> <file containing ssh public key> <coupon code></td></tr>
<tr><td> </td><td>nodester user setup <username> <password></td></tr>
<tr><td> </td><td>nodester user setkey <file containing ssh public key></td></tr>
<tr><td> </td><td>nodester user setpass sendtoken</td></tr>
<tr><td> </td><td>nodester user setpass <token> <new_password></td></tr>
<tr><td><b>apps</b></td><td> </td></tr>
<tr><td> </td><td>nodester apps list</td></tr>
<tr><td><b>app</b></td><td> </td></tr>
<tr><td> </td><td>nodester app create <appname> <initial js file></td></tr>
<tr><td> </td><td>nodester app info <appname></td></tr>
<tr><td> </td><td>nodester app logs <appname></td></tr>
<tr><td> </td><td>nodester app start <appname></td></tr>
<tr><td> </td><td>nodester app restart <appname></td></tr>
<tr><td> </td><td>nodester app stop <appname></td></tr>
<tr><td> </td><td>nodester app gitreset <appname></td></tr>
<tr><td><b>status</b></td><td> </td></tr>
<tr><td> </td><td>nodester status</td></tr>
</table>
<p>
If you would like to contribute to our open source Nodester CLI on <a href="https://github.com/nodester/nodester-cli">GitHub</a>, please send us pull requests :)
</p>
</div>
<div class="tab-pane" id="rest">
<p>
Our REST API is very powerful.
</p>
<p>
<b>Base URL is http://api.nodester.com</b>
</p>
<br/>
<table class="bordered-table zebra-striped">
<tr><td><b>coupon</b></td><td> </td><td> </td></tr>
<tr><td> </td><td><a class="btn disabled success">POST</a></td><td><b>/coupon</b> - Creates coupon request for early access (pass in email)<br/>
<code>curl -X POST -d "email=your_address@gmail.com" http://nodester.com/coupon</code></td></tr>
<tr><td><b>user</b></td><td> </td><td> </td></tr>
<tr><td> </td><td><a class="btn disabled success">POST</a></td><td><b>/user</b> - Creates user account (pass in user and password and email and id_rsa.pub string) <i>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/id_rsa.pub | sed s/'+'/'%2B'/g | pbcopy"</i><br/>
<code>curl -X POST -d "coupon=mycoupon&user=testuser&password=123&email=chris@nodester.com&rsakey=ssh-rsa AAAAB3NzaC1yc..." http://nodester.com/user</code></td></tr>
<tr><td> </td><td><a class="btn disabled">PUT</a></td><td><b>/user</b> - Updates user account (pass in password and/or RSA key - "cat ~/.ssh/id_rsa.pub | sed s/'+'/'%2B'/g | pbcopy")<br/>
<code>curl -X PUT -u "testuser:123" -d "password=test" http://api.nodester.com/user</code><br/>
<code>curl -X PUT -u "testuser:123" -d "rsakey=1234567" http://api.nodester.com/user</code></td></tr>
<tr><td> </td><td><a class="btn disabled danger">DELETE</a></td><td><b>/user</b> - Deletes user account (requires basic auth)<br/>
<code>curl -X DELETE -u "testuser:123" http://api.nodester.com/user</code></td></tr>
<tr><td><b>apps</b></td><td> </td><td> </td></tr>
<tr><td> </td><td><a class="btn disabled primary">GET</a></td><td><b>/apps</b> - Returns a list of all apps created by a user account (requires basic auth)<br/>
<code>curl -X GET -u "testuser:123" http://nodester.com/apps</code></td></tr>
<tr><td><b>app</b></td><td> </td><td> </td></tr>
<tr><td> </td><td><a class="btn disabled success">POST</a></td><td><b>/app</b> - Creates nodejs app for hosting (requires basic auth and returns the port address required for use along with a git repo to push to)<br/>
<code>curl -X POST -u "testuser:123" -d "appname=a&start=hello.js" http://api.nodester.com/app</code></td></tr>
<tr><td> </td><td><a class="btn disabled">PUT</a></td><td><b>/app</b> - 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)<br/>
<code>curl -X PUT -u "testuser:123" -d "appname=a&start=hello1.js" http://api.nodester.com/app</code></td></tr>
<tr><td> </td><td><a class="btn disabled">PUT</a></td><td><b>/app</b> - 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)<br/>
<code>curl -X PUT -u "testuser:123" -d "appname=a&running=true" http://api.nodester.com/app</code></td></tr>
<tr><td> </td><td><a class="btn disabled danger">DELETE</a></td><td><b>/app </b>- Deletes nodejs app (requires basic auth and appname)<br/>
<code>curl -X DELETE -u "testuser:123" -d "appname=test" http://api.nodester.com/app</code></td></tr>
<tr><td> </td><td><a class="btn disabled primary">GET</a></td><td><b>/app/<appname></b> - get nodejs app info (requires basic auth and appname)<br/>
<code>curl -u "testuser:123" http://api.nodester.com/app/appname</code></td></tr>
<tr><td><b>applogs</b></td><td> </td><td> </td></tr>
<tr><td> </td><td><a class="btn disabled primary">GET</a></td><td><b>/applogs/<appname></b> - Gets nodejs app logs (requires basic auth and appname)<br/>
<code>curl -u "testuser:123" http://api.nodester.com/applogs/appname</code></td></tr>
<tr><td><b>env</b></td><td> </td><td> </td></tr>
<tr><td> </td><td><a class="btn disabled">PUT</a></td><td><b>/env</b> - Create/update environment key/value pair (requires basic auth, appname, and environment key and value)<br/>
<code>curl -X PUT -u "testuser:123" -d "appname=a&key=color&value=blue" http://api.nodester.com/env</code></td></tr>
<tr><td> </td><td><a class="btn disabled danger">DELETE</a></td><td><b>/env</b> - Deletes environment key/value pair (requires basic auth, appname, and environment key)<br/>
<code>curl -X DELETE -u "testuser:123" -d "appname=test&key=color" http://api.nodester.com/env</code></td></tr>
<tr><td> </td><td><a class="btn disabled primary">GET</a></td><td><b>/env</b> - Gets environment info (requires basic auth, appname, and environment key)<br/>
<code>curl -u "testuser:123" -d "appname=test&key=color" http://api.nodester.com/env</code></td></tr>
<tr><td><b>status</b></td><td> </td><td> </td></tr>
<tr><td> </td><td><a class="btn disabled primary">GET</a></td><td><b>/status</b> - Returns platform status and number of apps hosted and running<br/>
<code>curl http://nodester.com/status</code></td></tr>
<tr><td><b>npm</b></td><td> </td><td> </td></tr>
<tr><td> </td><td><a class="btn disabled success">POST</a></td><td><b>/npm</b> - Allows you to manage the NPM packages for an application.<br/>
<code>curl -X POST -u "testuser:123" -d "appname=a&action=install&package=express" http://api.nodester.com/npm</code><br/>
<code>curl -X POST -u "testuser:123" -d "appname=a&action=update&package=express" http://api.nodester.com/npm</code><br/>
<code>curl -X POST -u "testuser:123" -d "appname=a&action=uninstall&package=express" http://api.nodester.com/npm</code></td></tr>
<tr><td><b>appdomains</b></td><td> </td><td> </td></tr>
<tr><td> </td><td><a class="btn disabled success">POST</a></td><td><b>/appdomains</b> - Creates app domain for hosting example.com (requires basic auth)<br/>
<code>curl -X POST -u "testuser:123" -d "appname=test&domain=example.com" http://api.nodester.com/appdomains</code></td></tr>
<tr><td> </td><td><a class="btn disabled danger">DELETE</a></td><td><b>/appdomains</b> - Deletes app domain for hosting example.com (requires basic auth)<br/>
<code<curl -X DELETE -u "testuser:123" -d "appname=test&domain=example.com" http://api.nodester.com/appdomains</code></td></tr>
<tr><td> </td><td><a class="btn disabled primary">GET</a></td><td><b>/appdomains</b> - Gets list of your domains (requires basic auth)<br/>
<code>curl -u "testuser:123" http://api.nodester.com/appdomains</code></td></tr>
<tr><td><b>reset_password</b></td><td> </td><td> </td></tr>
<tr><td> </td><td><a class="btn disabled success">POST</a></td><td><b>/reset_password</b> - Sends a e-mail with a token to reset your user password<br/>
<code>curl -X POST -d "user=your_username" http://nodester.com/reset_password</code></td></tr>
<tr><td> </td><td><a class="btn disabled">PUT</a></td><td><b>/reset_password/<token></b> - Updates your password using the provided token<br/>
<code>curl -X PUT -d "password=your_new_password" http://nodester.com/reset_password/<token></code></td></tr>
<tr><td><b>gitreset</b></td><td> </td><td> </td></tr>
<tr><td> </td><td><a class="btn disabled danger">DELETE</a></td><td><b>/gitreset</b> - Resets your Nodester git repository and npm list (pass in appname)<br/>
<code>curl -X DELETE -u "testuser:123" -d "appname=a" http://api.nodester.com/gitreset</code></td></tr>
</table>
</div>
</div>
</div>
</div>
<footer>
<p>©
<script type="text/javascript">
var theDate=new Date()
document.write(theDate.getFullYear())
</script>
Nodester, inc. | <a href="/about.html">about us</a> | <a href="http://twitter.com/nodester">twitter</a> | <a href="http://github.com/nodester">github</a></p>
</footer>
</div> <!-- /container -->
</body>
</html>