-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yaml
More file actions
5796 lines (5795 loc) · 191 KB
/
openapi.yaml
File metadata and controls
5796 lines (5795 loc) · 191 KB
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
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: Render Public API
description: |-
[https://render.com/docs/api](https://render.com/docs/api)
Contact Support:
Name: Render API
Email: [support@render.com](mailto:support@render.com)
version: 1.0.0
contact: { }
servers:
- url: https://api.render.com/v1
paths:
/owners:
get:
tags:
- Owners
summary: List authorized users and teams
description: >-
[https://api-docs.render.com/reference/get-owners](https://api-docs.render.com/reference/get-owners)
operationId: listAuthorizedUsersAndTeams
parameters:
- name: name
in: query
schema:
type: string
example: sed aliqua qui anim
- name: email
in: query
schema:
type: string
example: sed aliqua qui anim
- name: cursor
in: query
schema:
type: string
example: Lorem amet sin
description: Cursor to begin retrieving entries for this query
- name: limit
in: query
schema:
type: string
example: '20'
description: Max number of items that can be returned
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/OwnerCursor'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string
example: sunt Excepteur deserunt dolor
examples:
Authorization information is missing or invalid.:
value:
id: dolor
message: sunt Excepteur deserunt dolor
'406':
description: >-
Unable to generate preferred media types as specified by Accept
request header.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string
example: sunt Excepteur deserunt dolor
examples:
Unable to generate preferred media types as specified by Accept request header.:
value:
id: dolor
message: sunt Excepteur deserunt dolor
'429':
description: Rate limit has been surpassed.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string
example: sunt Excepteur deserunt dolor
examples:
Rate limit has been surpassed.:
value:
id: dolor
message: sunt Excepteur deserunt dolor
'500':
description: An unexpected server error has occurred.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string
example: sunt Excepteur deserunt dolor
examples:
An unexpected server error has occurred.:
value:
id: dolor
message: sunt Excepteur deserunt dolor
'503':
description: Server currently unavailable.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string
example: sunt Excepteur deserunt dolor
examples:
Server currently unavailable.:
value:
id: dolor
message: sunt Excepteur deserunt dolor
/owners/{ownerId}:
get:
tags:
- Owners
summary: Retrieve user or team
description: >-
[https://api-docs.render.com/reference/get-owner](https://api-docs.render.com/reference/get-owner)
operationId: retrieveUserOrTeam
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
email:
type: string
example: id adipisicing Excepteur
id:
type: string
example: nisi aute veniam elit
name:
type: string
example: labore
type:
type: string
example: user
examples:
OK:
value:
email: id adipisicing Excepteur
id: nisi aute veniam elit
name: labore
type: user
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string
example: sunt Excepteur deserunt dolor
examples:
Authorization information is missing or invalid.:
value:
id: dolor
message: sunt Excepteur deserunt dolor
'404':
description: Unable to find the requested resource.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string
example: sunt Excepteur deserunt dolor
examples:
Unable to find the requested resource.:
value:
id: dolor
message: sunt Excepteur deserunt dolor
'406':
description: >-
Unable to generate preferred media types as specified by Accept
request header.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string
example: sunt Excepteur deserunt dolor
examples:
Unable to generate preferred media types as specified by Accept request header.:
value:
id: dolor
message: sunt Excepteur deserunt dolor
'410':
description: The requested resource is no longer available.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string
example: sunt Excepteur deserunt dolor
examples:
The requested resource is no longer available.:
value:
id: dolor
message: sunt Excepteur deserunt dolor
'429':
description: Rate limit has been surpassed.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string
example: sunt Excepteur deserunt dolor
examples:
Rate limit has been surpassed.:
value:
id: dolor
message: sunt Excepteur deserunt dolor
'500':
description: An unexpected server error has occurred.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string
example: sunt Excepteur deserunt dolor
examples:
An unexpected server error has occurred.:
value:
id: dolor
message: sunt Excepteur deserunt dolor
'503':
description: Server currently unavailable.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string
example: sunt Excepteur deserunt dolor
examples:
Server currently unavailable.:
value:
id: dolor
message: sunt Excepteur deserunt dolor
parameters:
- name: ownerId
in: path
required: true
schema:
type: string
example: Lorem amet sin
description: (Required) The ID of the user or team
/services:
get:
tags:
- Services
summary: List services
description: >-
[https://api-docs.render.com/reference/get-services](https://api-docs.render.com/reference/get-services)
operationId: listServices
parameters:
- name: name
in: query
schema:
type: string
example: sed aliqua qui anim,do
description: Filter for the names of services
- name: type
in: query
schema:
type: string
example: web_service,cron_job
description: Filter for types of services
- name: env
in: query
schema:
type: string
example: rust,node
description: Filter for environments of services
- name: region
in: query
schema:
type: string
example: frankfurt,frankfurt
description: Filter for regions of services
- name: suspended
in: query
schema:
type: string
example: suspended,not_suspended
description: Filter services based on whether they're suspended or not suspended
- name: createdBefore
in: query
schema:
type: string
example: '2021-06-17T08:15:30Z'
description: >-
Filter for services created before a certain time (specified as an
ISO 8601 timestamp)
- name: createdAfter
in: query
schema:
type: string
example: '2021-02-17T08:15:30Z'
description: >-
Filter for services created after a certain time (specified as an
ISO 8601 timestamp)
- name: updatedBefore
in: query
schema:
type: string
example: '2021-06-17T08:15:30Z'
description: >-
Filter for services updated before a certain time (specified as an
ISO 8601 timestamp)
- name: updatedAfter
in: query
schema:
type: string
example: '2021-02-17T08:15:30Z'
description: >-
Filter for services updated after a certain time (specified as an
ISO 8601 timestamp)
- name: ownerId
in: query
schema:
type: string
example: sed aliqua qui anim,do
description: >-
The ID of the owner (team or personal user) whose resources should
be returned
- name: cursor
in: query
schema:
type: string
example: Lorem amet sin
description: Cursor to begin retrieving entries for this query
- name: limit
in: query
schema:
type: integer
example: 20
description: Max number of items that can be returned
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ServiceCursor'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string
example: sunt Excepteur deserunt dolor
examples:
Authorization information is missing or invalid.:
value:
id: dolor
message: sunt Excepteur deserunt dolor
'406':
description: >-
Unable to generate preferred media types as specified by Accept
request header.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string
example: sunt Excepteur deserunt dolor
examples:
Unable to generate preferred media types as specified by Accept request header.:
value:
id: dolor
message: sunt Excepteur deserunt dolor
'429':
description: Rate limit has been surpassed.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string
example: sunt Excepteur deserunt dolor
examples:
Rate limit has been surpassed.:
value:
id: dolor
message: sunt Excepteur deserunt dolor
'500':
description: An unexpected server error has occurred.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string
example: sunt Excepteur deserunt dolor
examples:
An unexpected server error has occurred.:
value:
id: dolor
message: sunt Excepteur deserunt dolor
'503':
description: Server currently unavailable.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string
example: sunt Excepteur deserunt dolor
examples:
Server currently unavailable.:
value:
id: dolor
message: sunt Excepteur deserunt dolor
post:
tags:
- Services
summary: Create service
description: >-
[https://api-docs.render.com/reference/create-service](https://api-docs.render.com/reference/create-service)
operationId: createService
requestBody:
content:
application/json:
schema:
type: object
properties:
autoDeploy:
type: string
example: 'yes'
branch:
type: string
example: Excepteur mollit in
envVars:
type: array
items:
type: object
properties:
key:
type: string
example: eu
value:
type: string
example: dolor
example:
- key: eu
value: dolor
- key: minim nisi voluptate non
value: vol
name:
type: string
example: cillum ipsum
ownerId:
type: string
example: iru
repo:
type: string
example: https://github.com/render-examples/flask-hello-world
secretFiles:
type: array
items:
type: object
properties:
contents:
type: string
example: ipsum consequat dolor dolor
name:
type: string
example: ad ex Duis
example:
- contents: ipsum consequat dolor dolor
name: ad ex Duis
- contents: exercitation ut Duis ex
name: sunt paria
serviceDetails:
type: object
properties:
buildCommand:
type: string
example: dolore ex
headers:
type: array
items:
type: object
properties:
name:
type: string
example: deserunt
path:
type: string
example: enim Excepteur p
value:
type: string
example: commodo nisi proident ad velit
example:
- name: deserunt
path: enim Excepteur p
value: commodo nisi proident ad velit
- name: exercitation dolor minim nostrud esse
path: labore vel
value: Lorem occaecat tempor
publishPath:
type: string
example: public
pullRequestPreviewsEnabled:
type: string
example: 'no'
routes:
type: array
items:
type: object
properties:
destination:
type: string
example: dolor
source:
type: string
example: sed
type:
type: string
example: redirect
example:
- destination: dolor
source: sed
type: redirect
- destination: sit culpa a
source: proident aute irure veniam occaecat
type: redirect
type:
type: string
example: web_service
example:
autoDeploy: 'yes'
branch: Excepteur mollit in
envVars:
- key: eu
value: dolor
- key: minim nisi voluptate non
value: vol
name: cillum ipsum
ownerId: iru
repo: https://github.com/render-examples/flask-hello-world
secretFiles:
- contents: ipsum consequat dolor dolor
name: ad ex Duis
- contents: exercitation ut Duis ex
name: sunt paria
serviceDetails:
buildCommand: dolore ex
headers:
- name: deserunt
path: enim Excepteur p
value: commodo nisi proident ad velit
- name: exercitation dolor minim nostrud esse
path: labore vel
value: Lorem occaecat tempor
publishPath: public
pullRequestPreviewsEnabled: 'no'
routes:
- destination: dolor
source: sed
type: redirect
- destination: sit culpa a
source: proident aute irure veniam occaecat
type: redirect
type: web_service
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
properties:
deployId:
type: string
example: nostrud qui Excepteur commodo
service:
type: object
properties:
autoDeploy:
type: string
example: 'yes'
branch:
type: string
example: Excepteur
createdAt:
type: string
example: '1999-10-21T15:43:09.576Z'
id:
type: string
example: ea veniam
name:
type: string
example: e
notifyOnFail:
type: string
example: default
ownerId:
type: string
example: laborum mollit
repo:
type: string
example: https://github.com/render-examples/flask-hello-world
serviceDetails:
type: object
properties:
buildCommand:
type: string
example: ut
parentServer:
type: object
properties:
id:
type: string
example: es
name:
type: string
example: 'sunt eu do amet '
publishPath:
type: string
example: ipsum ut
pullRequestPreviewsEnabled:
type: string
example: 'no'
url:
type: string
example: officia ut Excepteur culpa
slug:
type: string
example: nisi tempor dolore
suspended:
type: string
example: not_suspended
suspenders:
type: array
items:
type: string
example: admin
example:
- admin
- unknown
type:
type: string
example: private_service
updatedAt:
type: string
example: '1988-04-27T23:28:54.313Z'
examples:
Created:
value:
deployId: nostrud qui Excepteur commodo
service:
autoDeploy: 'yes'
branch: Excepteur
createdAt: '1999-10-21T15:43:09.576Z'
id: ea veniam
name: e
notifyOnFail: default
ownerId: laborum mollit
repo: https://github.com/render-examples/flask-hello-world
serviceDetails:
buildCommand: ut
parentServer:
id: es
name: 'sunt eu do amet '
publishPath: ipsum ut
pullRequestPreviewsEnabled: 'no'
url: officia ut Excepteur culpa
slug: nisi tempor dolore
suspended: not_suspended
suspenders:
- admin
- unknown
type: private_service
updatedAt: '1988-04-27T23:28:54.313Z'
'400':
description: The request could not be understood by the server.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string
example: sunt Excepteur deserunt dolor
examples:
The request could not be understood by the server.:
value:
id: dolor
message: sunt Excepteur deserunt dolor
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string
example: sunt Excepteur deserunt dolor
examples:
Authorization information is missing or invalid.:
value:
id: dolor
message: sunt Excepteur deserunt dolor
'402':
description: You must enter payment information to perform this request.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string
example: sunt Excepteur deserunt dolor
examples:
You must enter payment information to perform this request.:
value:
id: dolor
message: sunt Excepteur deserunt dolor
'406':
description: >-
Unable to generate preferred media types as specified by Accept
request header.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string
example: sunt Excepteur deserunt dolor
examples:
Unable to generate preferred media types as specified by Accept request header.:
value:
id: dolor
message: sunt Excepteur deserunt dolor
'409':
description: The current state of the resource conflicts with this request.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string
example: sunt Excepteur deserunt dolor
examples:
The current state of the resource conflicts with this request.:
value:
id: dolor
message: sunt Excepteur deserunt dolor
'429':
description: Rate limit has been surpassed.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string
example: sunt Excepteur deserunt dolor
examples:
Rate limit has been surpassed.:
value:
id: dolor
message: sunt Excepteur deserunt dolor
'500':
description: An unexpected server error has occurred.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string
example: sunt Excepteur deserunt dolor
examples:
An unexpected server error has occurred.:
value:
id: dolor
message: sunt Excepteur deserunt dolor
'503':
description: Server currently unavailable.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string
example: sunt Excepteur deserunt dolor
examples:
Server currently unavailable.:
value:
id: dolor
message: sunt Excepteur deserunt dolor
/services/{serviceId}:
get:
tags:
- Services
summary: Retrieve service
description: >-
[https://api-docs.render.com/reference/get-service](https://api-docs.render.com/reference/get-service)
operationId: retrieveService
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Service'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string
example: sunt Excepteur deserunt dolor
examples:
Authorization information is missing or invalid.:
value:
id: dolor
message: sunt Excepteur deserunt dolor
'403':
description: You do not have permissions for the requested resource.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string
example: sunt Excepteur deserunt dolor
examples:
You do not have permissions for the requested resource.:
value:
id: dolor
message: sunt Excepteur deserunt dolor
'404':
description: Unable to find the requested resource.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string
example: sunt Excepteur deserunt dolor
examples:
Unable to find the requested resource.:
value:
id: dolor
message: sunt Excepteur deserunt dolor
'406':
description: >-
Unable to generate preferred media types as specified by Accept
request header.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: dolor
message:
type: string