-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathapps.html
502 lines (405 loc) · 28.7 KB
/
apps.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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
---
layout: default
title: Applications
---
<div class='row'><div class='col-xs-12 col-sm-6 sidebar-text'><h1 id="applications">Applications</h1>
</div><div class='hidden-xs col-xs-12 col-sm-6 sidebar-code'></div></div><div class='row'><div class='col-xs-12 col-sm-6 sidebar-text'>
<p><strong>Application attributes</strong></p>
<table class="table">
<thead>
<tr>
<th>field</th>
<th>type</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>string</td>
<td>unique ID</td>
</tr>
<tr>
<td>name</td>
<td>string</td>
<td>name of the application, can substitute the ID</td>
</tr>
<tr>
<td>created_at</td>
<td>date</td>
<td>creation date of the application</td>
</tr>
<tr>
<td>updated_at</td>
<td>date</td>
<td>last time the application has been updated</td>
</tr>
<tr>
<td>git_url</td>
<td>string</td>
<td>URL to the GIT remote to access your application</td>
</tr>
<tr>
<td>owner</td>
<td>object</td>
<td>information about the owner of the application</td>
</tr>
<tr>
<td>urls</td>
<td>array</td>
<td>list of custom domains to access to your project</td>
</tr>
</tbody>
</table>
</div><div class='col-xs-12 col-sm-6 sidebar-code'>
<p>Example object:</p>
<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="s2">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"54100930736f7563d5030000"</span><span class="p">,</span><span class="w">
</span><span class="s2">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"example-app"</span><span class="p">,</span><span class="w">
</span><span class="s2">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2014-09-10T10:17:52.690+02:00"</span><span class="p">,</span><span class="w">
</span><span class="s2">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2014-09-10T10:17:52.690+02:00"</span><span class="p">,</span><span class="w">
</span><span class="s2">"git_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"[email protected]:example-app.git"</span><span class="p">,</span><span class="w">
</span><span class="s2">"owner"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="s2">"username"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john"</span><span class="p">,</span><span class="w">
</span><span class="s2">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"[email protected]"</span><span class="p">,</span><span class="w">
</span><span class="s2">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"54100245736f7563d5000000"</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="s2">"urls"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
</span><span class="s2">"example-app.scalingo.io"</span><span class="w">
</span><span class="p">]</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
</div></div><div class='row'><div class='col-xs-12 col-sm-6 sidebar-text'>
<h2 id="create-an-application">Create an application</h2>
</div><div class='hidden-xs col-xs-12 col-sm-6 sidebar-code'></div></div><div class='row'><div class='col-xs-12 col-sm-6 sidebar-text'>
<p><code class="highlighter-rouge">POST https://api.scalingo.com/apps</code></p>
<h3 id="parameters">Parameters</h3>
<ul>
<li><code class="highlighter-rouge">app.name</code>: Should have between 6 and 32 lower case alphanumerical characters
and hyphens, it can’t have an hyphen at the beginning or at the end, nor two
hyphens in a row.</li>
</ul>
<h3 id="free-usage-limit">Free usage limit</h3>
<p>You can only have 3 applications without having defined <a href="https://my.scalingo.com/apps/billing">a payment
method</a>.</p>
</div><div class='col-xs-12 col-sm-6 sidebar-code'>
<p>Example</p>
<div class="highlighter-rouge"><pre class="highlight"><code>curl -H <span class="s2">"Accept: application/json"</span> -H <span class="s2">"Content-Type: application/json"</span> -u :<span class="nv">$AUTH_TOKEN</span> <span class="se">\</span>
-X POST https://api.scalingo.com/v1/apps -d <span class="se">\</span>
<span class="s1">'{
"app": {
"name": "example-app"
}
}'</span>
</code></pre>
</div>
<p>Returns 201 Created</p>
<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="s2">"app"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="s2">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2014-09-10T10:17:52.690+02:00"</span><span class="p">,</span><span class="w">
</span><span class="s2">"git_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"[email protected]:example-app.git"</span><span class="p">,</span><span class="w">
</span><span class="s2">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"54100930736f7563d5030000"</span><span class="p">,</span><span class="w">
</span><span class="s2">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"example-app"</span><span class="p">,</span><span class="w">
</span><span class="s2">"owner"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="s2">"username"</span><span class="p">:</span><span class="w"> </span><span class="s2">"john"</span><span class="p">,</span><span class="w">
</span><span class="s2">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"[email protected]"</span><span class="p">,</span><span class="w">
</span><span class="s2">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"54100245736f7563d5000000"</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="s2">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2014-09-10T10:17:52.690+02:00"</span><span class="p">,</span><span class="w">
</span><span class="s2">"urls"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
</span><span class="s2">"example-app.scalingo.io"</span><span class="w">
</span><span class="p">]</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
</div></div><div class='row'><div class='col-xs-12 col-sm-6 sidebar-text'>
<h2 id="list-your-applications">List your applications</h2>
<p><code class="highlighter-rouge">GET https://api.scalingo.com/apps</code></p>
<p>List all your applications and the one your are collaborator for.</p>
</div><div class='col-xs-12 col-sm-6 sidebar-code'>
<p>Example</p>
<div class="highlighter-rouge"><pre class="highlight"><code>curl -H <span class="s2">"Accept: application/json"</span> -H <span class="s2">"Content-Type: application/json"</span> -u :<span class="nv">$AUTH_TOKEN</span> <span class="se">\</span>
-X GET https://api.scalingo.com/v1/apps
</code></pre>
</div>
<p>Returns 200 OK</p>
<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="s2">"apps"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
</span><span class="p">{</span><span class="w">
</span><span class="s2">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"example-app"</span><span class="p">,</span><span class="w">
</span><span class="err">…</span><span class="w">
</span><span class="err">}</span><span class="p">,</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="s2">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"another-app"</span><span class="p">,</span><span class="w">
</span><span class="err">…</span><span class="w">
</span><span class="err">}</span><span class="p">,</span><span class="w"> </span><span class="err">…</span><span class="w">
</span><span class="p">]</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
</div></div><div class='row'><div class='col-xs-12 col-sm-6 sidebar-text'>
<h2 id="get-a-precise-application">Get a precise application</h2>
</div><div class='hidden-xs col-xs-12 col-sm-6 sidebar-code'></div></div><div class='row'><div class='col-xs-12 col-sm-6 sidebar-text'>
<p><code class="highlighter-rouge">GET https://api.scalingo.com/v1/apps/[:app]</code></p>
<p>Display a precise application</p>
</div><div class='col-xs-12 col-sm-6 sidebar-code'>
<p>Example request</p>
<div class="highlighter-rouge"><pre class="highlight"><code>curl -H <span class="s2">"Accept: application/json"</span> -H <span class="s2">"Content-Type: application/json"</span> -u :<span class="nv">$AUTH_TOKEN</span> <span class="se">\</span>
-X GET https://api.scalingo.com/v1/apps/example-app
</code></pre>
</div>
<p>Returns 200 OK</p>
<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="s2">"app"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="s2">"id"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"51e938266edff4fac9100005"</span><span class="p">,</span><span class="w">
</span><span class="s2">"name"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"example-app"</span><span class="p">,</span><span class="w">
</span><span class="s2">"owner"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="s2">"email"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"[email protected]"</span><span class="p">,</span><span class="w">
</span><span class="s2">"id"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"51d73c1e6edfeab537000001"</span><span class="p">,</span><span class="w">
</span><span class="s2">"username"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"example-user"</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="s2">"git_url"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"[email protected]:example-app.git"</span><span class="p">,</span><span class="w">
</span><span class="s2">"last_deployed_at"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"2014-11-16T12:17:16.137+01:00"</span><span class="p">,</span><span class="w">
</span><span class="s2">"status"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"running"</span><span class="p">,</span><span class="w">
</span><span class="s2">"updated_at"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-02-02T18:00:18.041+01:00"</span><span class="p">,</span><span class="w">
</span><span class="s2">"created_at"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"2013-07-19T14:59:18.329+02:00"</span><span class="p">,</span><span class="w">
</span><span class="s2">"last_deployed_by"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"example-user"</span><span class="p">,</span><span class="w">
</span><span class="s2">"domains"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
</span><span class="p">{</span><span class="w">
</span><span class="s2">"id"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"53e4a2ef7f784210ea000123"</span><span class="p">,</span><span class="w">
</span><span class="s2">"name"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"www.example.com"</span><span class="p">,</span><span class="w">
</span><span class="s2">"ssl"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">]</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
</div></div><div class='row'><div class='col-xs-12 col-sm-6 sidebar-text'>
<h2 id="scale-an-application">Scale an application</h2>
</div><div class='hidden-xs col-xs-12 col-sm-6 sidebar-code'></div></div><div class='row'><div class='col-xs-12 col-sm-6 sidebar-text'>
<p><code class="highlighter-rouge">POST https://api.scalingo.com/v1/apps/[:app]/scale</code></p>
<p>Send a scaling request, the status of the application will be changed to
‘scaling’ for the scaling duration. No other operation is doable until the app
status has switched to “running” again. </p>
<p>You can follow the operation progress by following the <code class="highlighter-rouge">Location</code> header,
pointing to an <code class="highlighter-rouge">operation</code> resource.</p>
<p>The request returns the complete formation of containers event those which are
not currently scaled.</p>
<h3 id="parameters">Parameters</h3>
<ul>
<li><code class="highlighter-rouge">containers</code>: Array of the containers you want to scale.
Each <code class="highlighter-rouge">containers</code>:
<ul>
<li><code class="highlighter-rouge">container.name</code>: Name of the container you want to scale</li>
<li><code class="highlighter-rouge">container.amount</code>: Final amount of container of this type</li>
</ul>
</li>
</ul>
<h3 id="free-usage-limit">Free usage limit</h3>
<p>You can only have 1 ‘web’ container without having defined <a href="https://my.scalingo.com/apps/billing">a payment
method</a>.</p>
<h3 id="limit">Limit</h3>
<p>There is a hard limit of 10 containers of a given type per application, if you need more:
<a href="mailto:support@scalingo.com">contact us</a></p>
</div><div class='col-xs-12 col-sm-6 sidebar-code'>
<p>Example request</p>
<div class="highlighter-rouge"><pre class="highlight"><code>curl -H <span class="s2">"Accept: application/json"</span> -H <span class="s2">"Content-Type: application/json"</span> -u :<span class="nv">$AUTH_TOKEN</span> <span class="se">\</span>
-X POST <span class="s1">'https://api.scalingo.com/v1/apps/example-app/scale'</span> -d <span class="se">\</span>
<span class="s1">'{
"containers": [
{
"name": "web",
"amount": 2
}
]
}'</span>
</code></pre>
</div>
<p>Returns 202 Accepted (Asynchronous task)
Headers:
* <code class="highlighter-rouge">Location</code>: ‘https://api.scalingo.com/v1/apps/example-app/operations/52fd2357356330032b080000’</p>
<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="s2">"containers"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
</span><span class="p">{</span><span class="w">
</span><span class="s2">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"52fd2457356330032b020000"</span><span class="p">,</span><span class="w">
</span><span class="s2">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"web"</span><span class="p">,</span><span class="w">
</span><span class="s2">"amount"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="w">
</span><span class="p">},</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="s2">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"52fd235735633003210a0001"</span><span class="p">,</span><span class="w">
</span><span class="s2">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"worker"</span><span class="p">,</span><span class="w">
</span><span class="s2">"amount"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">]</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
</div></div><div class='row'><div class='col-xs-12 col-sm-6 sidebar-text'>
<h2 id="restart-an-application">Restart an application</h2>
</div><div class='hidden-xs col-xs-12 col-sm-6 sidebar-code'></div></div><div class='row'><div class='col-xs-12 col-sm-6 sidebar-text'>
<p><code class="highlighter-rouge">POST https://api.scalingo.com/v1/apps/[:app]/restart</code></p>
<p>In the same spirit than the ‘scale’ operation, the restart is an asynchronous
operation</p>
<p>Send a restart request, the status of the application will be changed to
‘restarting’ for the operation duration. No other operation is doable until the
app status has switched to “running” again.</p>
<p>You can follow the operation progress by following the <code class="highlighter-rouge">Location</code> header,
pointing to an <code class="highlighter-rouge">operation</code> resource.</p>
<h3 id="parameters">Parameters</h3>
<ul>
<li><code class="highlighter-rouge">scope</code>: Array of containers you want to restart.
<ul>
<li>If empty or nil: restart everything</li>
<li>Should fit the container types of the application: <code class="highlighter-rouge">["web", "worker"]</code> or <code class="highlighter-rouge">["web-1"]</code></li>
</ul>
</li>
</ul>
</div><div class='col-xs-12 col-sm-6 sidebar-code'>
<p>Example request</p>
<div class="highlighter-rouge"><pre class="highlight"><code>curl -H <span class="s2">"Accept: application/json"</span> -H <span class="s2">"Content-Type: application/json"</span> -u :<span class="nv">$AUTH_TOKEN</span> <span class="se">\</span>
-X POST <span class="s1">'https://api.scalingo.com/v1/apps/example-app/restart'</span> -d <span class="se">\</span>
<span class="s1">'{
"scope": ["web"]
}'</span>
</code></pre>
</div>
<p>Return 202 Accepted (Asynchronous task) - Empty body</p>
</div></div><div class='row'><div class='col-xs-12 col-sm-6 sidebar-text'>
<h2 id="delete-an-application">Delete an application</h2>
<p><code class="highlighter-rouge">DELETE https://api.scalingo.com/v1/apps/[:app]</code></p>
<p>Parameters:</p>
<ul>
<li><code class="highlighter-rouge">current_name</code>: As validation, should equal the name of the app</li>
</ul>
</div><div class='col-xs-12 col-sm-6 sidebar-code'>
<p>Example request</p>
<div class="highlighter-rouge"><pre class="highlight"><code>curl -H <span class="s2">"Accept: application/json"</span> -H <span class="s2">"Content-Type: application/json"</span> -u :<span class="nv">$AUTH_TOKEN</span> <span class="se">\</span>
-X DELETE <span class="s1">'https://api.scalingo.com/v1/apps/example-app?current_name=example-app'</span>
</code></pre>
</div>
<p>Returns 204 No Content</p>
</div></div><div class='row'><div class='col-xs-12 col-sm-6 sidebar-text'>
<h2 id="rename-an-application">Rename an application</h2>
<p><code class="highlighter-rouge">POST https://api.scalingo.com/v1/apps/[:app]/rename</code></p>
<h3 id="parameters">Parameters</h3>
<ul>
<li><code class="highlighter-rouge">current_name</code>: As validation, should equal the name of the app</li>
<li><code class="highlighter-rouge">new_name</code>: Target name of rename operation</li>
</ul>
</div><div class='col-xs-12 col-sm-6 sidebar-code'>
<p>Example request</p>
<div class="highlighter-rouge"><pre class="highlight"><code>curl -H <span class="s2">"Accept: application/json"</span> -H <span class="s2">"Content-Type: application/json"</span> -u :<span class="nv">$AUTH_TOKEN</span> <span class="se">\</span>
-X POST <span class="s1">'https://api.scalingo.com/v1/apps/example-app'</span> -d <span class="se">\</span>
<span class="s1">'{
"current_name": "example-app",
"new_name": "renamed-example-app"
}'</span>
</code></pre>
</div>
<p>Returns 200 OK</p>
<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="s2">"app"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="s2">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"renamed_example-app"</span><span class="p">,</span><span class="w">
</span><span class="err">...</span><span class="w">
</span><span class="err">}</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
</div></div><div class='row'><div class='col-xs-12 col-sm-6 sidebar-text'>
<h2 id="transfer-ownership-of-an-application">Transfer ownership of an application</h2>
<p><code class="highlighter-rouge">PATCH https://api.scalingo.com/v1/apps/[:app]</code></p>
<h3 id="parameters">Parameters</h3>
<ul>
<li><code class="highlighter-rouge">app.owner.email</code>: email of the new owner of the app, should be part of the
collaborators</li>
</ul>
</div><div class='col-xs-12 col-sm-6 sidebar-code'>
<p>Example request</p>
<div class="highlighter-rouge"><pre class="highlight"><code>curl -H <span class="s2">"Accept: application/json"</span> -H <span class="s2">"Content-Type: application/json"</span> -u :<span class="nv">$AUTH_TOKEN</span> <span class="se">\</span>
-X PATCH <span class="s1">'https://api.scalingo.com/v1/apps/example-app'</span> -d <span class="se">\</span>
<span class="s1">'{
"app": {
"owner": {
"email": "[email protected]"
}
}
}'</span>
</code></pre>
</div>
<p>Returns 200 OK</p>
<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="s2">"app"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="s2">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"example-app"</span><span class="p">,</span><span class="w">
</span><span class="err">...</span><span class="w">
</span><span class="err">}</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
</div></div><div class='row'><div class='col-xs-12 col-sm-6 sidebar-text'>
<h2 id="access-to-the-application-logs">Access to the application logs</h2>
</div><div class='hidden-xs col-xs-12 col-sm-6 sidebar-code'></div></div><div class='row'><div class='col-xs-12 col-sm-6 sidebar-text'>
<p><code class="highlighter-rouge">POST https://api.scalingo.com/v1/apps/[:app]/logs</code></p>
<p>The request will generate an URL you can use to access the logs of your application.</p>
<p>How to use this endpoint: <a href="/logs.html">more information here</a></p>
</div><div class='col-xs-12 col-sm-6 sidebar-code'>
<p>Example request:</p>
<div class="highlighter-rouge"><pre class="highlight"><code>curl -H <span class="s2">"Accept: application/json"</span> -H <span class="s2">"Content-Type: application/json"</span> -u :<span class="nv">$AUTH_TOKEN</span> <span class="se">\</span>
-X POST <span class="s1">'https://api.scalingo.com/v1/apps/example-app/logs'</span>
</code></pre>
</div>
<p>Returns 200 OK</p>
<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="s2">"app"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="err">…</span><span class="w"> </span><span class="err">}</span><span class="p">,</span><span class="w">
</span><span class="s2">"logs_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://logs.scalingo.com/apps/example-app/logs?token=0123456789"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
</div></div><div class='row'><div class='col-xs-12 col-sm-6 sidebar-text'>
<h2 id="run-a-one-off-container">Run a one-off container</h2>
<p>Similar to <code class="highlighter-rouge">scalingo run</code></p>
</div><div class='hidden-xs col-xs-12 col-sm-6 sidebar-code'></div></div><div class='row'><div class='col-xs-12 col-sm-6 sidebar-text'>
<p><code class="highlighter-rouge">POST https://api.scalingo.com/v1/apps/[:app]/run</code></p>
<p>To run an interactive task, you have to start a one-off container. As its name
mean it’s a container you will start for a given task and which will be
destroyed after it. It can be any command which will be executed in the
environment your application.</p>
<blockquote>
We do not handle detached commands yet, each one-off container has to be
attached to be executed, it will be canceled after 5 without action have been
waited.
</blockquote>
<p>See <a href="/one-off.html">how to handle the returned <code class="highlighter-rouge">attach_url</code></a></p>
<h3 id="parameters">Parameters</h3>
<ul>
<li><code class="highlighter-rouge">command</code>: Command line which has to be run (example: “bash”)</li>
<li><code class="highlighter-rouge">env</code>: Environment variables to inject into the container (additionaly to those of your apps)</li>
</ul>
</div><div class='col-xs-12 col-sm-6 sidebar-code'>
<p>Example request:</p>
<div class="highlighter-rouge"><pre class="highlight"><code>curl -H <span class="s2">"Accept: application/json"</span> -H <span class="s2">"Content-Type: application/json"</span> -u :<span class="nv">$AUTH_TOKEN</span> <span class="se">\</span>
-X POST <span class="s1">'https://api.scalingo.com/v1/apps/example-app/run -d \
'</span><span class="o">{</span>
<span class="s2">"command"</span>: <span class="s2">"bundle exec rails console"</span>,
<span class="s2">"env"</span>: <span class="o">{</span>
<span class="s2">"VAR1"</span> <span class="o">=</span>> <span class="s2">"VAL1"</span>
<span class="o">}</span>
<span class="o">}</span><span class="s1">'
</span></code></pre>
</div>
<p>Returns 200 OK</p>
<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="s2">"container"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="s2">"id"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"5250424112dba4edf0000024"</span><span class="p">,</span><span class="w">
</span><span class="s2">"type"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"job"</span><span class="p">,</span><span class="w">
</span><span class="s2">"type_index"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
</span><span class="s2">"created_at"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-02-17T22:10:32.692+01:00"</span><span class="p">,</span><span class="w">
</span><span class="s2">"memory"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="mf">5.36870912e+08</span><span class="p">,</span><span class="w">
</span><span class="s2">"state"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"booting"</span><span class="p">,</span><span class="w">
</span><span class="s2">"app"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"example-app"</span><span class="p">,</span><span class="w"> </span><span class="err">...</span><span class="w"> </span><span class="err">}</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="s2">"attach_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://run-1.scalingo.com:5000/f15d8c7fb4170c4ef14b63b2b265c8fa3dbf4a5882de19682a21f6243ae332c6"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
</div></div>