forked from xcarpentier/developers.scalingo.com
-
Notifications
You must be signed in to change notification settings - Fork 0
/
addon_providers.html
295 lines (265 loc) · 18.1 KB
/
addon_providers.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
---
layout: default
title: Addon providers
---
<div class='row'><div class='col-xs-12 col-sm-6 sidebar-text'><h1 id="addon-providers">Addon providers</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>Addon provider 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</td>
</tr>
<tr>
<td>logo_url</td>
<td>string</td>
<td>URL of the addon logo</td>
</tr>
<tr>
<td>short_description</td>
<td>string</td>
<td>short description</td>
</tr>
<tr>
<td>description</td>
<td>string</td>
<td>description</td>
</tr>
<tr>
<td>category</td>
<td>object</td>
<td>embedded category object</td>
</tr>
<tr>
<td>provider_name</td>
<td>string</td>
<td>name of company offering this addon</td>
</tr>
<tr>
<td>provider_url</td>
<td>string</td>
<td>URL of company offering this addon</td>
</tr>
<tr>
<td>plans</td>
<td>array</td>
<td>embedded array of plans for this addon</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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Scalingo PostgreSQL"</span><span class="p">,</span><span class="w">
</span><span class="s2">"logo_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://lb1047.pcs.ovh.net/v1/AUTH_c91a9132e4f149809d23b20b6de57161/appsdeck/postgresql.png"</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">"scalingo-postgresql"</span><span class="p">,</span><span class="w">
</span><span class="s2">"short_description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Scalingo's PostgreSQL Database as a Service"</span><span class="p">,</span><span class="w">
</span><span class="s2">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"[HTML Description]"</span><span class="p">,</span><span class="w">
</span><span class="s2">"category"</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">"54c6909b61646d0001000000"</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">"Data stores"</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="s2">"provider_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Scalingo"</span><span class="p">,</span><span class="w">
</span><span class="s2">"provider_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://scalingo.com"</span><span class="p">,</span><span class="w">
</span><span class="s2">"plans"</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">"54071fa5646173000b010000"</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">"free"</span><span class="p">,</span><span class="w">
</span><span class="s2">"display_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"512MB Free Tier"</span><span class="p">,</span><span class="w">
</span><span class="s2">"price"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.0</span><span class="p">,</span><span class="w">
</span><span class="s2">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"[Markdown Description]"</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">"5474a6c66461730001010000"</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">"1g"</span><span class="p">,</span><span class="w">
</span><span class="s2">"display_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1G Database"</span><span class="p">,</span><span class="w">
</span><span class="s2">"price"</span><span class="p">:</span><span class="w"> </span><span class="mf">14.4</span><span class="p">,</span><span class="w">
</span><span class="s2">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"[Markdown Description]"</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'>
<p><strong>Addon plan 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 (internal reference)</td>
</tr>
<tr>
<td>display_name</td>
<td>string</td>
<td>user friendly name</td>
</tr>
<tr>
<td>price</td>
<td>float</td>
<td>in euros</td>
</tr>
<tr>
<td>description</td>
<td>string</td>
<td>description of this plan</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">"54071fa5646173000b010000"</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">"free"</span><span class="p">,</span><span class="w">
</span><span class="s2">"display_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"512MB Free Tier"</span><span class="p">,</span><span class="w">
</span><span class="s2">"price"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.0</span><span class="p">,</span><span class="w">
</span><span class="s2">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"[Markdown Description]"</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'>
<p><strong>Addon category 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>description</td>
<td>string</td>
<td>description of the category</td>
</tr>
<tr>
<td>name</td>
<td>string</td>
<td>name</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">"54c6909b61646d0001000000"</span><span class="p">,</span><span class="w">
</span><span class="s2">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"[Markdown description]"</span><span class="w">
</span><span class="s2">"name"</span><span class="err">:</span><span class="w"> </span><span class="s2">"Data stores"</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-addon-providers">List addon providers</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/addon_providers</code></p>
<p>The endpoint return the list of the addons you can provision for your app,
including the different available plans.</p>
<h3 id="parameters">Parameters</h3>
<ul>
<li><code class="highlighter-rouge">category_id</code>: Filter the addon providers per category</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> <span class="se">\</span>
-X GET https://api.scalingo.com/v1/addon_providers
curl -H <span class="s2">"Accept: application/json"</span> -H <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
-X GET https://api.scalingo.com/v1/addon_providers?category_id<span class="o">=</span>54c6909b61646d0001000000
</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">"addon_providers"</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">"Scalingo PostgreSQL"</span><span class="p">,</span><span class="w">
</span><span class="s2">"logo_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://lb1047.pcs.ovh.net/v1/AUTH_c91a9132e4f149809d23b20b6de57161/appsdeck/postgresql.png"</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">"scalingo-postgresql"</span><span class="p">,</span><span class="w">
</span><span class="s2">"short_description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Scalingo's PostgreSQL Database as a Service"</span><span class="p">,</span><span class="w">
</span><span class="s2">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"[HTML Description]"</span><span class="p">,</span><span class="w">
</span><span class="s2">"category"</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">"54c6909b61646d0001000000"</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">"Data stores"</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="s2">"provider_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Scalingo"</span><span class="p">,</span><span class="w">
</span><span class="s2">"provider_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://scalingo.com"</span><span class="p">,</span><span class="w">
</span><span class="s2">"plans"</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">"54071fa5646173000b010000"</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">"free"</span><span class="p">,</span><span class="w">
</span><span class="s2">"display_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"512MB Free Tier"</span><span class="p">,</span><span class="w">
</span><span class="s2">"price"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.0</span><span class="p">,</span><span class="w">
</span><span class="s2">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"[Markdown Description]"</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">"5474a6c66461730001010000"</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">"1g"</span><span class="p">,</span><span class="w">
</span><span class="s2">"display_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1G Database"</span><span class="p">,</span><span class="w">
</span><span class="s2">"price"</span><span class="p">:</span><span class="w"> </span><span class="mf">14.4</span><span class="p">,</span><span class="w">
</span><span class="s2">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"[Markdown Description]"</span><span class="w">
</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><span class="p">{</span><span class="w">
</span><span class="s2">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Scalingo MySQL"</span><span class="p">,</span><span class="w">
</span><span class="s2">"logo_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://lb1047.pcs.ovh.net/v1/AUTH_c91a9132e4f149809d23b20b6de57161/appsdeck/mysql.png"</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">"scalingo-mysql"</span><span class="p">,</span><span class="w">
</span><span class="s2">"short_description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Scalingo's MySQL Database as a Service"</span><span class="p">,</span><span class="w">
</span><span class="s2">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"[HTML Description]"</span><span class="p">,</span><span class="w">
</span><span class="s2">"category"</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">"54c6909b61646d0001000000"</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">"Data stores"</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="s2">"provider_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Scalingo"</span><span class="p">,</span><span class="w">
</span><span class="s2">"provider_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://scalingo.com"</span><span class="p">,</span><span class="w">
</span><span class="s2">"plans"</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="p">]</span><span class="w">
</span><span class="p">},</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></code></pre>
</div>
</div></div><div class='row'><div class='col-xs-12 col-sm-6 sidebar-text'>
<h2 id="list-addon-categories">List addon categories</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/addon_categories</code></p>
<p>Return the different categories of the available addons</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> <span class="se">\</span>
-X GET https://api.scalingo.com/v1/addon_categories
</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">"addon_categories"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
</span><span class="s2">"category"</span><span class="err">:</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">"54c6909b61646d0001000000"</span><span class="p">,</span><span class="w">
</span><span class="s2">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"[Markdown description]"</span><span class="w">
</span><span class="s2">"name"</span><span class="err">:</span><span class="w"> </span><span class="s2">"Data stores"</span><span class="w">
</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>