Skip to content

Commit b441b5f

Browse files
paulczarpaulczar
committed
fix(reference-guide/controller-api): v1->v2
The API is now v2, but docs still reference v1. example: ``` $ curl -H "Content-Type: application/json" -X POST \ -d '{"username": "admin","password": "admin","email": "admin@example.com"}' http://deis.10.233.62.119.nip.io/v2/auth/register/ ```
1 parent 9ca6363 commit b441b5f

1 file changed

Lines changed: 43 additions & 43 deletions

File tree

  • src/reference-guide/controller-api

‎src/reference-guide/controller-api/v2.0.md‎

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This is the v2.0 REST API for the Controller.
1313
Example Request:
1414

1515
```
16-
POST /v1/auth/register/ HTTP/1.1
16+
POST /v2/auth/register/ HTTP/1.1
1717
Host: deis.example.com
1818
Content-Type: application/json
1919
@@ -62,7 +62,7 @@ Content-Type: application/json
6262
Example Request:
6363

6464
```
65-
POST /v1/auth/login/ HTTP/1.1
65+
POST /v2/auth/login/ HTTP/1.1
6666
Host: deis.example.com
6767
Content-Type: application/json
6868
@@ -85,7 +85,7 @@ Content-Type: application/json
8585
Example Request:
8686

8787
```
88-
DELETE /v1/auth/cancel/ HTTP/1.1
88+
DELETE /v2/auth/cancel/ HTTP/1.1
8989
Host: deis.example.com
9090
Authorization: token abc123
9191
```
@@ -107,7 +107,7 @@ DEIS_PLATFORM_VERSION: 2.0.0
107107
Example Request:
108108

109109
```
110-
POST /v1/auth/tokens/ HTTP/1.1
110+
POST /v2/auth/tokens/ HTTP/1.1
111111
Host: deis.example.com
112112
Authorization: token abc123
113113
```
@@ -137,7 +137,7 @@ Content-Type: application/json
137137
Example Request:
138138

139139
```
140-
POST /v1/auth/passwd/ HTTP/1.1
140+
POST /v2/auth/passwd/ HTTP/1.1
141141
Host: deis.example.com
142142
Authorization: token abc123
143143
@@ -172,7 +172,7 @@ DEIS_PLATFORM_VERSION: 2.0.0
172172
Example Request:
173173

174174
```
175-
GET /v1/apps HTTP/1.1
175+
GET /v2/apps HTTP/1.1
176176
Host: deis.example.com
177177
Authorization: token abc123
178178
```
@@ -208,7 +208,7 @@ Content-Type: application/json
208208
Example Request:
209209

210210
```
211-
POST /v1/apps/ HTTP/1.1
211+
POST /v2/apps/ HTTP/1.1
212212
Host: deis.example.com
213213
Content-Type: application/json
214214
Authorization: token abc123
@@ -244,7 +244,7 @@ Content-Type: application/json
244244
Example Request:
245245

246246
```
247-
DELETE /v1/apps/example-go/ HTTP/1.1
247+
DELETE /v2/apps/example-go/ HTTP/1.1
248248
Host: deis.example.com
249249
Authorization: token abc123
250250
```
@@ -262,7 +262,7 @@ DEIS_PLATFORM_VERSION: 2.0.0
262262
Example Request:
263263

264264
```
265-
GET /v1/apps/example-go/ HTTP/1.1
265+
GET /v2/apps/example-go/ HTTP/1.1
266266
Host: deis.example.com
267267
Authorization: token abc123
268268
```
@@ -291,7 +291,7 @@ Content-Type: application/json
291291
Example Request:
292292

293293
```
294-
POST /v1/apps/example-go/ HTTP/1.1
294+
POST /v2/apps/example-go/ HTTP/1.1
295295
Host: deis.example.com
296296
Authorization: token abc123
297297
```
@@ -318,7 +318,7 @@ Content-Type: application/json
318318
Example Request:
319319

320320
```
321-
GET /v1/apps/example-go/logs/ HTTP/1.1
321+
GET /v2/apps/example-go/logs/ HTTP/1.1
322322
Host: deis.example.com
323323
Authorization: token abc123
324324
```
@@ -343,7 +343,7 @@ Content-Type: text/plain
343343
### Run one-off Commands
344344

345345
```
346-
POST /v1/apps/example-go/run/ HTTP/1.1
346+
POST /v2/apps/example-go/run/ HTTP/1.1
347347
Host: deis.example.com
348348
Content-Type: application/json
349349
Authorization: token abc123
@@ -369,7 +369,7 @@ Content-Type: application/json
369369
Example Request:
370370

371371
```
372-
GET /v1/certs HTTP/1.1
372+
GET /v2/certs HTTP/1.1
373373
Host: deis.example.com
374374
Authorization: token abc123
375375
```
@@ -400,7 +400,7 @@ Content-Type: application/json
400400
Example Request:
401401

402402
```
403-
GET /v1/certs/test.example.com HTTP/1.1
403+
GET /v2/certs/test.example.com HTTP/1.1
404404
Host: deis.example.com
405405
Authorization: token abc123
406406
```
@@ -428,7 +428,7 @@ Content-Type: application/json
428428
Example Request:
429429

430430
```
431-
POST /v1/certs/ HTTP/1.1
431+
POST /v2/certs/ HTTP/1.1
432432
Host: deis.example.com
433433
Content-Type: application/json
434434
Authorization: token abc123
@@ -470,7 +470,7 @@ Content-Type: application/json
470470
Example Request:
471471

472472
```
473-
DELETE /v1/certs/test.example.com HTTP/1.1
473+
DELETE /v2/certs/test.example.com HTTP/1.1
474474
Host: deis.example.com
475475
Authorization: token abc123
476476
```
@@ -490,7 +490,7 @@ DEIS_PLATFORM_VERSION: 2.0.0
490490
Example Request:
491491

492492
```
493-
GET /v1/apps/example-go/pods/ HTTP/1.1
493+
GET /v2/apps/example-go/pods/ HTTP/1.1
494494
Host: deis.example.com
495495
Authorization: token abc123
496496
```
@@ -522,7 +522,7 @@ Content-Type: application/json
522522
Example Request:
523523

524524
```
525-
GET /v1/apps/example-go/pods/web/ HTTP/1.1
525+
GET /v2/apps/example-go/pods/web/ HTTP/1.1
526526
Host: deis.example.com
527527
Authorization: token abc123
528528
```
@@ -554,7 +554,7 @@ Content-Type: application/json
554554
Example Request:
555555

556556
```
557-
POST /v1/apps/example-go/pods/restart/ HTTP/1.1
557+
POST /v2/apps/example-go/pods/restart/ HTTP/1.1
558558
Host: deis.example.com
559559
Authorization: token abc123
560560
```
@@ -583,7 +583,7 @@ Content-Type: application/json
583583
Example Request:
584584

585585
```
586-
POST /v1/apps/example-go/pods/web/restart/ HTTP/1.1
586+
POST /v2/apps/example-go/pods/web/restart/ HTTP/1.1
587587
Host: deis.example.com
588588
Authorization: token abc123
589589
```
@@ -612,7 +612,7 @@ Content-Type: application/json
612612
Example Request:
613613

614614
```
615-
POST /v1/apps/example-go/pods/go-v2-web-atots/restart/ HTTP/1.1
615+
POST /v2/apps/example-go/pods/go-v2-web-atots/restart/ HTTP/1.1
616616
Host: deis.example.com
617617
Authorization: token abc123
618618
```
@@ -641,7 +641,7 @@ Content-Type: application/json
641641
Example Request:
642642

643643
```
644-
POST /v1/apps/example-go/scale/ HTTP/1.1
644+
POST /v2/apps/example-go/scale/ HTTP/1.1
645645
Host: deis.example.com
646646
Content-Type: application/json
647647
Authorization: token abc123
@@ -664,7 +664,7 @@ DEIS_PLATFORM_VERSION: 2.0.0
664664
Example Request:
665665

666666
```
667-
GET /v1/apps/example-go/config/ HTTP/1.1
667+
GET /v2/apps/example-go/config/ HTTP/1.1
668668
Host: deis.example.com
669669
Authorization: token abc123
670670
```
@@ -697,7 +697,7 @@ Content-Type: application/json
697697
Example Request:
698698

699699
```
700-
POST /v1/apps/example-go/config/ HTTP/1.1
700+
POST /v2/apps/example-go/config/ HTTP/1.1
701701
Host: deis.example.com
702702
Content-Type: application/json
703703
Authorization: token abc123
@@ -738,7 +738,7 @@ X-Deis-Release: 3
738738
Example Request:
739739

740740
```
741-
POST /v1/apps/example-go/config/ HTTP/1.1
741+
POST /v2/apps/example-go/config/ HTTP/1.1
742742
Host: deis.example.com
743743
Content-Type: application/json
744744
Authorization: token abc123
@@ -779,7 +779,7 @@ X-Deis-Release: 4
779779
Example Request:
780780

781781
```
782-
GET /v1/apps/example-go/domains/ HTTP/1.1
782+
GET /v2/apps/example-go/domains/ HTTP/1.1
783783
Host: deis.example.com
784784
Authorization: token abc123
785785
```
@@ -813,7 +813,7 @@ Content-Type: application/json
813813
Example Request:
814814

815815
```
816-
POST /v1/apps/example-go/domains/ HTTP/1.1
816+
POST /v2/apps/example-go/domains/ HTTP/1.1
817817
Host: deis.example.com
818818
Authorization: token abc123
819819
@@ -842,7 +842,7 @@ Content-Type: application/json
842842
Example Request:
843843

844844
```
845-
DELETE /v1/apps/example-go/domains/example.example.com HTTP/1.1
845+
DELETE /v2/apps/example-go/domains/example.example.com HTTP/1.1
846846
Host: deis.example.com
847847
Authorization: token abc123
848848
```
@@ -862,7 +862,7 @@ DEIS_PLATFORM_VERSION: 2.0.0
862862
Example Request:
863863

864864
```
865-
GET /v1/apps/example-go/builds/ HTTP/1.1
865+
GET /v2/apps/example-go/builds/ HTTP/1.1
866866
Host: deis.example.com
867867
Authorization: token abc123
868868
```
@@ -902,7 +902,7 @@ Content-Type: application/json
902902
Example Request:
903903

904904
```
905-
POST /v1/apps/example-go/builds/ HTTP/1.1
905+
POST /v2/apps/example-go/builds/ HTTP/1.1
906906
Host: deis.example.com
907907
Content-Type: application/json
908908
Authorization: token abc123
@@ -949,7 +949,7 @@ X-Deis-Release: 4
949949
Example Request:
950950

951951
```
952-
GET /v1/apps/example-go/releases/ HTTP/1.1
952+
GET /v2/apps/example-go/releases/ HTTP/1.1
953953
Host: deis.example.com
954954
Authorization: token abc123
955955
```
@@ -1009,7 +1009,7 @@ Content-Type: application/json
10091009
Example Request:
10101010

10111011
```
1012-
GET /v1/apps/example-go/releases/v1/ HTTP/1.1
1012+
GET /v2/apps/example-go/releases/v2/ HTTP/1.1
10131013
Host: deis.example.com
10141014
Authorization: token abc123
10151015
```
@@ -1040,7 +1040,7 @@ Content-Type: application/json
10401040
Example Request:
10411041

10421042
```
1043-
POST /v1/apps/example-go/releases/rollback/ HTTP/1.1
1043+
POST /v2/apps/example-go/releases/rollback/ HTTP/1.1
10441044
Host: deis.example.com
10451045
Content-Type: application/json
10461046
Authorization: token abc123
@@ -1066,7 +1066,7 @@ Content-Type: application/json
10661066
Example Request:
10671067

10681068
```
1069-
GET /v1/keys/ HTTP/1.1
1069+
GET /v2/keys/ HTTP/1.1
10701070
Host: deis.example.com
10711071
Authorization: token abc123
10721072
```
@@ -1101,7 +1101,7 @@ Content-Type: application/json
11011101
Example Request:
11021102

11031103
```
1104-
POST /v1/keys/ HTTP/1.1
1104+
POST /v2/keys/ HTTP/1.1
11051105
Host: deis.example.com
11061106
Authorization: token abc123
11071107
@@ -1134,7 +1134,7 @@ Content-Type: application/json
11341134
Example Request:
11351135

11361136
```
1137-
DELETE /v1/keys/example HTTP/1.1
1137+
DELETE /v2/keys/example HTTP/1.1
11381138
Host: deis.example.com
11391139
Authorization: token abc123
11401140
```
@@ -1158,7 +1158,7 @@ DEIS_PLATFORM_VERSION: 2.0.0
11581158
Example Request:
11591159

11601160
```
1161-
GET /v1/apps/example-go/perms/ HTTP/1.1
1161+
GET /v2/apps/example-go/perms/ HTTP/1.1
11621162
Host: deis.example.com
11631163
Authorization: token abc123
11641164
```
@@ -1184,7 +1184,7 @@ Content-Type: application/json
11841184
Example Request:
11851185

11861186
```
1187-
POST /v1/apps/example-go/perms/ HTTP/1.1
1187+
POST /v2/apps/example-go/perms/ HTTP/1.1
11881188
Host: deis.example.com
11891189
Authorization: token abc123
11901190
@@ -1204,7 +1204,7 @@ DEIS_PLATFORM_VERSION: 2.0.0
12041204
Example Request:
12051205

12061206
```
1207-
DELETE /v1/apps/example-go/perms/example HTTP/1.1
1207+
DELETE /v2/apps/example-go/perms/example HTTP/1.1
12081208
Host: deis.example.com
12091209
Authorization: token abc123
12101210
```
@@ -1222,7 +1222,7 @@ DEIS_PLATFORM_VERSION: 2.0.0
12221222
Example Request:
12231223

12241224
```
1225-
GET /v1/admin/perms/ HTTP/1.1
1225+
GET /v2/admin/perms/ HTTP/1.1
12261226
Host: deis.example.com
12271227
Authorization: token abc123
12281228
```
@@ -1261,7 +1261,7 @@ Content-Type: application/json
12611261
Example Request:
12621262

12631263
```
1264-
POST /v1/admin/perms HTTP/1.1
1264+
POST /v2/admin/perms HTTP/1.1
12651265
Host: deis.example.com
12661266
Authorization: token abc123
12671267
@@ -1285,7 +1285,7 @@ DEIS_PLATFORM_VERSION: 2.0.0
12851285
Example Request:
12861286

12871287
```
1288-
DELETE /v1/admin/perms/example HTTP/1.1
1288+
DELETE /v2/admin/perms/example HTTP/1.1
12891289
Host: deis.example.com
12901290
Authorization: token abc123
12911291
```
@@ -1309,7 +1309,7 @@ DEIS_PLATFORM_VERSION: 2.0.0
13091309
Example Request:
13101310

13111311
```
1312-
GET /v1/users HTTP/1.1
1312+
GET /v2/users HTTP/1.1
13131313
Host: deis.example.com
13141314
Authorization: token abc123
13151315
```

0 commit comments

Comments
 (0)