-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yml
5395 lines (5158 loc) · 182 KB
/
openapi.yml
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.2
info:
title: BrowserStack Client
version: 5.0.0
description: >-
BrowserStack is a cloud web and mobile testing platform that provides developers with the ability to test
their websites and mobile applications across on-demand browsers, operating systems and real mobile devices.
This document is an (unofficial) OpenAPI reference for BrowserStack products: Automate, App Automate,
JavaScript Testing, Screenshots, and others. For more information, visit https://www.browserstack.com/docs/
license:
name: MIT License
url: https://opensource.org/license/mit/
externalDocs:
description: Find out more about BrowserStack
url: https://www.browserstack.com/docs/
servers:
- url: "{scheme}://{host}{basePath}"
variables:
scheme:
default: https
host:
default: api.browserstack.com
basePath:
default: "/5"
- url: "{scheme}://{host}"
variables:
scheme:
default: https
host:
default: api-cloud.browserstack.com
security:
- basicAuth: []
paths:
# JS APIs
/browsers:
get:
tags: [JSTesting]
parameters:
- name: flat
in: query
description: >-
If true, returns a flat list of all available browsers. If false, returns a nested
list of browsers grouped by OS and OS version.
required: false
schema:
type: boolean
default: true
summary: Fetches all available browsers.
description: Fetches all available browsers.
operationId: getBrowsers
responses:
"200":
description: Successful operation
content:
application/json:
schema:
title: GetBrowsersResponse
oneOf:
- $ref: '#/components/schemas/BrowserList'
- $ref: '#/components/schemas/BrowserMap'
"400":
$ref: '#/components/schemas/400.BadRequest'
"401":
$ref: '#/components/schemas/401.Unauthorized'
"404":
$ref: '#/components/schemas/404.NotFound'
"422":
$ref: '#/components/schemas/422.UnprocessableEntity'
"500":
$ref: '#/components/schemas/5xx.InternalServerError'
/status:
get:
tags: [JSTesting]
summary: Fetches status.
description: Fetches status.
operationId: getStatus
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
"400":
$ref: '#/components/schemas/400.BadRequest'
"401":
$ref: '#/components/schemas/401.Unauthorized'
"404":
$ref: '#/components/schemas/404.NotFound'
"422":
$ref: '#/components/schemas/422.UnprocessableEntity'
"500":
$ref: '#/components/schemas/5xx.InternalServerError'
/worker:
post:
tags: [JSTesting]
summary: Create a browser worker.
description: >-
Create a browser worker. A browser worker is simply a new browser instance. A user can start multiple
browser workers at a time. All browser workers when created are pushed in a queue and they run when
their turn comes. We make sure that your browser worker starts running as soon as possible.
Your testing time is calculated from the time when browser worker starts running.
operationId: createWorker
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NewWorker'
responses:
"200":
description: Successful operation
content:
application/json:
schema:
title: CreateWorkerResponse
type: object
required: [id]
properties:
id:
type: number
description: "ID of the worker"
example: 122326697
url:
type: string
description: "URL of the worker"
example: "https://www.google.com/ncr"
"400":
$ref: '#/components/schemas/400.BadRequest'
"401":
$ref: '#/components/schemas/401.Unauthorized'
"404":
$ref: '#/components/schemas/404.NotFound'
"422":
$ref: '#/components/schemas/422.UnprocessableEntity'
"500":
$ref: '#/components/schemas/5xx.InternalServerError'
/workers:
get:
tags: [JSTesting]
summary: Fetches all workers.
description: Fetches all workers.
operationId: getWorkers
responses:
"200":
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Worker'
"400":
$ref: '#/components/schemas/400.BadRequest'
"401":
$ref: '#/components/schemas/401.Unauthorized'
"404":
$ref: '#/components/schemas/404.NotFound'
"422":
$ref: '#/components/schemas/422.UnprocessableEntity'
"500":
$ref: '#/components/schemas/5xx.InternalServerError'
/worker/{workerId}:
get:
tags: [JSTesting]
summary: Fetch details of a worker.
description: Fetch details a worker.
operationId: getWorker
parameters:
- name: workerId
in: path
required: true
description: "ID of the worker"
schema:
type: number
example: 122326697
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Worker'
"400":
$ref: '#/components/schemas/400.BadRequest'
"401":
$ref: '#/components/schemas/401.Unauthorized'
"403":
$ref: '#/components/schemas/403.Forbidden'
"404":
$ref: '#/components/schemas/404.NotFound'
"422":
$ref: '#/components/schemas/422.UnprocessableEntity'
"500":
$ref: '#/components/schemas/5xx.InternalServerError'
delete:
tags: [JSTesting]
summary: Terminate a worker.
description: Terminate a worker.
operationId: deleteWorker
parameters:
- name: workerId
in: path
required: true
description: "ID of the worker"
schema:
type: number
example: 122326697
responses:
"200":
description: Successful operation
content:
application/json:
schema:
title: DeleteWorkerResponse
type: object
required: [message]
properties:
message:
type: string
description: "Status of the termination operation"
example: "worker is running for 19.405956957 secs, minimum life is 30 sec"
time:
type: number
description: "Duration of the worker"
example: 45.786373558
"400":
$ref: '#/components/schemas/400.BadRequest'
"401":
$ref: '#/components/schemas/401.Unauthorized'
"404":
$ref: '#/components/schemas/404.NotFound'
"422":
$ref: '#/components/schemas/422.UnprocessableEntity'
"500":
$ref: '#/components/schemas/5xx.InternalServerError'
/worker/{workerId}/url.json:
put:
tags: [JSTesting]
summary: Set a new URL for a worker-browser instance to navigate to
description: Set a new URL for a worker-browser instance to navigate to
operationId: updateWorkerURL
parameters:
- name: workerId
in: path
required: true
description: "ID of the worker"
schema:
type: number
example: 122326697
requestBody:
required: true
content:
application/json:
schema:
title: UpdateWorkerURLRequest
type: object
required: [url]
properties:
url:
type: string
description: "New URL for the worker"
example: "https://www.google.com/ncr"
responses:
"200":
description: Successful operation
content:
application/json:
schema:
title: UpdateWorkerURLResponse
type: object
required: [message]
properties:
message:
type: string
description: "Status of the update URL operation"
example: "Browser updated with new url"
"400":
$ref: '#/components/schemas/400.BadRequest'
"401":
$ref: '#/components/schemas/401.Unauthorized'
"403":
$ref: '#/components/schemas/403.Forbidden'
"404":
$ref: '#/components/schemas/404.NotFound'
"422":
$ref: '#/components/schemas/422.UnprocessableEntity'
"500":
$ref: '#/components/schemas/5xx.InternalServerError'
/worker/{workerId}/screenshot.{format}:
get:
tags: [JSTesting]
summary: Fetch a screenshot of the specified worker.
description: Fetch a screenshot of the current state of the worker.
operationId: getWorkerScreenshot
parameters:
- name: workerId
in: path
required: true
description: "ID of the worker"
schema:
type: number
example: 122326697
- name: format
in: path
required: true
description: "Format of the screenshot"
schema:
type: string
enum: ["png", "json", "xml"]
example: "png"
responses:
"200":
description: Successful operation
content:
image/png:
schema:
type: string
format: binary
application/json:
schema:
type: object
required: [url]
properties:
url:
type: string
description: "Link to the captured screenshot"
example: "https://s3.amazonaws.com/testautomation/efe4b6a63529d2b8ff64909db1a60fa473f1d8bf/js-screenshot-1708342782.png"
application/xml:
schema:
type: string
"400":
$ref: '#/components/schemas/400.BadRequest'
"401":
$ref: '#/components/schemas/401.Unauthorized'
"403":
$ref: '#/components/schemas/403.Forbidden'
"404":
$ref: '#/components/schemas/404.NotFound'
"422":
$ref: '#/components/schemas/422.UnprocessableEntity'
"500":
$ref: '#/components/schemas/5xx.InternalServerError'
# Automate APIs
/automate/plan.json:
get:
tags: [Automate]
summary: Get Automate plan details
description: Fetches Automate plan details
operationId: getAutomatePlan
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/AutomatePlan'
"400":
$ref: '#/components/schemas/400.BadRequest'
"401":
$ref: '#/components/schemas/401.Unauthorized'
"404":
$ref: '#/components/schemas/404.NotFound'
"422":
$ref: '#/components/schemas/422.UnprocessableEntity'
"500":
$ref: '#/components/schemas/5xx.InternalServerError'
/automate/recycle_key.json:
put:
tags: [Automate]
summary: Reset Automate access key
description: Reset Automate access key
operationId: recycleAutomateKey
requestBody:
content:
application/json:
schema:
type: object
responses:
"200":
description: Successful operation
content:
application/json:
schema:
title: RecycleAutomateKeyResponse
type: object
required: [old_key, new_key]
properties:
old_key:
type: string
example: "mkALWJIMwtzJOqyqONyq"
new_key:
type: string
example: "OQMCfsukIHWoNSOWAqkv"
"400":
$ref: '#/components/schemas/400.BadRequest'
"401":
$ref: '#/components/schemas/401.Unauthorized'
"404":
$ref: '#/components/schemas/404.NotFound'
"422":
$ref: '#/components/schemas/422.UnprocessableEntity'
"500":
$ref: '#/components/schemas/5xx.InternalServerError'
/automate/browsers.json:
get:
tags: [Automate]
summary: Fetches all automate browsers.
description: Fetches all automate browsers.
operationId: getAutomateBrowsers
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/BrowserList'
"400":
$ref: '#/components/schemas/400.BadRequest'
"401":
$ref: '#/components/schemas/401.Unauthorized'
"404":
$ref: '#/components/schemas/404.NotFound'
"422":
$ref: '#/components/schemas/422.UnprocessableEntity'
"500":
$ref: '#/components/schemas/5xx.InternalServerError'
/automate/projects.json:
get:
tags: [Automate]
summary: Fetches list of projects
description: >-
Fetches list of projects associated with your username and access key. You will need
the id of the project for invoking any other Project API that follows in this document
operationId: getAutomateProjects
responses:
"200":
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AutomateProject'
"400":
$ref: '#/components/schemas/400.BadRequest'
"401":
$ref: '#/components/schemas/401.Unauthorized'
"404":
$ref: '#/components/schemas/404.NotFound'
"422":
$ref: '#/components/schemas/422.UnprocessableEntity'
"500":
$ref: '#/components/schemas/5xx.InternalServerError'
/automate/projects/{projectId}.json:
get:
tags: [Automate]
summary: Fetches a project
description: Specific information about a particular project can be queried using the project ID
operationId: getAutomateProject
parameters:
- name: projectId
in: path
description: "ID of your project"
required: true
schema:
type: number
example: 966019
responses:
"200":
description: Successful operation
content:
application/json:
schema:
title: GetAutomateProjectResponse
type: object
required: [project]
properties:
project:
allOf:
- $ref: '#/components/schemas/AutomateProject'
- type: object
required: [builds]
properties:
builds:
type: array
items:
$ref: '#/components/schemas/AutomateBuild'
"400":
$ref: '#/components/schemas/400.BadRequest'
"401":
$ref: '#/components/schemas/401.Unauthorized'
"404":
$ref: '#/components/schemas/404.NotFound'
"422":
$ref: '#/components/schemas/422.UnprocessableEntity'
"500":
$ref: '#/components/schemas/5xx.InternalServerError'
put:
tags: [Automate]
summary: Update the name of your project
description: Update the name of your project after the project is complete
operationId: updateAutomateProject
parameters:
- name: projectId
in: path
description: "ID of your project"
required: true
schema:
type: number
example: 966019
requestBody:
required: true
content:
application/json:
schema:
title: UpdateAutomateProjectRequest
type: object
required:
- name
properties:
name:
type: string
description: "Name of your project"
example: "pricing_project"
responses:
"200":
description: Successful operation
content:
application/json:
schema:
type: object
$ref: '#/components/schemas/AutomateProject'
"400":
$ref: '#/components/schemas/400.BadRequest'
"401":
$ref: '#/components/schemas/401.Unauthorized'
"404":
$ref: '#/components/schemas/404.NotFound'
"422":
$ref: '#/components/schemas/422.UnprocessableEntity'
"500":
$ref: '#/components/schemas/5xx.InternalServerError'
delete:
tags: [Automate]
summary: Delete your project
description: >-
Delete a project on the server using the DELETE method. Please note that to delete a project,
it needs to be empty of builds and sessions, and projects once deleted cannot be recovered
operationId: deleteAutomateProject
parameters:
- name: projectId
in: path
description: "ID of your project"
required: true
schema:
type: number
example: 966019
responses:
"200":
description: Successful operation
content:
application/json:
schema:
title: DeleteAutomateProjectResponse
type: object
properties:
status:
type: string
description: "Status of the operation"
example: "ok"
message:
type: string
description: "Message indicating the status of the operation"
example: "Project 966019 was deleted successfully."
"400":
$ref: '#/components/schemas/400.BadRequest'
"401":
$ref: '#/components/schemas/401.Unauthorized'
"404":
$ref: '#/components/schemas/404.NotFound'
"422":
$ref: '#/components/schemas/422.UnprocessableEntity'
"500":
$ref: '#/components/schemas/5xx.InternalServerError'
/automate/projects/{projectId}/badge_key:
get:
tags: [Automate]
summary: Fetches the badge key for the project
description: >-
Fetches the badge key for sharing a public link for the Automate dashboard to view
the latest build and sessions for that project
operationId: getAutomateProjectBadgeKey
parameters:
- name: projectId
in: path
description: "ID of your project"
required: true
schema:
type: number
example: 966019
responses:
"200":
description: Successful operation
content:
text/plain:
schema:
type: string
examples:
badge_key:
value: "VnZ6dGxkRGxGc1RIY01iZGZBVjJBNTA2R0s4ZUhiZkg2cnB..."
"400":
$ref: '#/components/schemas/400.BadRequest'
"401":
$ref: '#/components/schemas/401.Unauthorized'
"404":
$ref: '#/components/schemas/404.NotFound'
"422":
$ref: '#/components/schemas/422.UnprocessableEntity'
"500":
$ref: '#/components/schemas/5xx.InternalServerError'
/automate/builds.json:
get:
tags: [Automate]
summary: Fetches list of builds
description: >-
Fetch the 10 recent test builds that have run on BrowserStack. You can also limit the number
of builds and paginate through your data
operationId: getAutomateBuilds
parameters:
- name: projectId
in: query
description: "ID of your project"
required: false
schema:
type: number
example: 966019
- name: limit
in: query
description: "Specify the number of results to be displayed. The default value is 10, and the maximum value is 100"
required: false
schema:
type: number
example: 10
- name: offset
in: query
description: "Retrieve builds from a specific point using the offset parameter"
required: false
schema:
type: number
example: 0
- name: status
in: query
description: "Status of the build"
required: false
schema:
type: string
enum: ["running", "timeout", "failed", "done"]
responses:
"200":
description: Successful operation
content:
application/json:
schema:
type: array
items:
title: GetAutomateBuildsResponse
type: object
required: [automation_build]
properties:
automation_build:
$ref: '#/components/schemas/AutomateBuild'
"400":
$ref: '#/components/schemas/400.BadRequest'
"401":
$ref: '#/components/schemas/401.Unauthorized'
"404":
$ref: '#/components/schemas/404.NotFound'
"422":
$ref: '#/components/schemas/422.UnprocessableEntity'
"500":
$ref: '#/components/schemas/5xx.InternalServerError'
/automate/builds/{buildId}.json:
get:
tags: [Automate]
summary: Fetches a build
description: Fetches a build
operationId: getAutomateBuild
parameters:
- name: buildId
in: path
description: "ID of your build"
required: true
schema:
type: string
example: "a4fb480a55efd6b3c558afb1ee051a7c337b8ef0"
responses:
"200":
description: Successful operation
content:
application/json:
schema:
title: GetAutomateBuildResponse
type: object
required: [build]
properties:
build:
type: object
required: [automation_build, sessions]
properties:
automation_build:
$ref: '#/components/schemas/AutomateBuild'
sessions:
type: array
items:
type: object
required: [automation_session]
properties:
automation_session:
$ref: '#/components/schemas/AutomateSession'
"400":
$ref: '#/components/schemas/400.BadRequest'
"401":
$ref: '#/components/schemas/401.Unauthorized'
"403":
$ref: '#/components/schemas/403.Forbidden'
"404":
$ref: '#/components/schemas/404.NotFound'
"422":
$ref: '#/components/schemas/422.UnprocessableEntity'
"500":
$ref: '#/components/schemas/5xx.InternalServerError'
put:
tags: [Automate]
summary: Update the name or tag of your build
description: >-
Update the name or tag of your build after the build is complete. To delete a build tag,
simply pass an empty string as value for build_tag.
operationId: updateAutomateBuild
parameters:
- name: buildId
in: path
description: "ID of your build"
required: true
schema:
type: string
example: "a4fb480a55efd6b3c558afb1ee051a7c337b8ef0"
requestBody:
required: true
content:
application/json:
schema:
title: UpdateAutomateBuildRequest
type: object
anyOf:
- required: [name]
- required: [build_tag]
properties:
name:
type: string
description: "The new build name that you want to set. Accepted characters are A-Z, a-z, 0-9, ., :, -, [], /, @, &, ', _. Character limit is 255."
example: "Selenium test"
build_tag:
type: string
description: "The new build tag that you want to set"
example: "registration"
responses:
"200":
description: Successful operation
content:
application/json:
schema:
title: UpdateAutomateBuildResponse
oneOf:
- type: object
required: [automation_build]
properties:
automation_build:
$ref: '#/components/schemas/AutomateBuild'
- type: object
required: [error]
properties:
error:
type: string
description: "Error message"
example: "A build with this name already exists."
"400":
$ref: '#/components/schemas/400.BadRequest'
"401":
$ref: '#/components/schemas/401.Unauthorized'
"404":
$ref: '#/components/schemas/404.NotFound'
"422":
$ref: '#/components/schemas/422.UnprocessableEntity'
"500":
$ref: '#/components/schemas/5xx.InternalServerError'
delete:
tags: [Automate]
summary: Delete a build on the server
description: >-
Delete a build on the server. Please note that deleting a build will delete all the sessions
contained within it. Builds once deleted cannot be recovered
operationId: deleteAutomateBuild
parameters:
- name: buildId
in: path
description: "ID of your build"
required: true
schema:
type: string
example: "a4fb480a55efd6b3c558afb1ee051a7c337b8ef0"
responses:
"200":
description: Successful operation
content:
application/json:
schema:
title: DeleteAutomateBuildResponse
type: object
properties:
status:
type: string
description: "Status of deletion"
example: "ok"
message:
type: string
description: "Message indicating the deletion of the build"
example: "Build a4fb480a55efd6b3c558afb1ee051a7c337b8ef0 was deleted successfully."
"400":
$ref: '#/components/schemas/400.BadRequest'
"401":
$ref: '#/components/schemas/401.Unauthorized'
"404":
$ref: '#/components/schemas/404.NotFound'
"422":
$ref: '#/components/schemas/422.UnprocessableEntity'
"500":
$ref: '#/components/schemas/5xx.InternalServerError'
/automate/builds:
delete:
tags: [Automate]
summary: Delete multiple builds on the server
description: >-
Delete multiple builds on the server. You can delete a maximum of 5 builds at a time.
Builds once deleted cannot be recovered.
operationId: deleteAutomateBuilds
parameters:
- name: buildId[]
in: query
description: "IDs of your builds"
required: true
schema:
type: array
items:
type: string
example: "83078c39baf5c12cbbfcbd26a788d05ddfad626c"
maxItems: 5
responses:
"200":
description: Successful operation
content:
application/json:
schema:
title: DeleteAutomateBuildsResponse
type: object
properties:
message:
type: string
description: "Message indicating the deletion of the builds"
example: "The following build(s) were deleted successfully: 83078c39baf5c12cbbfcbd26a788d05ddfad626c,55e9782d749f601d09571023f56a8f0101929428."
"400":
$ref: '#/components/schemas/400.BadRequest'
"401":
$ref: '#/components/schemas/401.Unauthorized'
"404":
$ref: '#/components/schemas/404.NotFound'
"422":
$ref: '#/components/schemas/422.UnprocessableEntity'
"500":
$ref: '#/components/schemas/5xx.InternalServerError'
/automate/builds/{buildId}/terminallogs:
post:
tags: [Automate]
summary: Upload terminal logs for your build.
description: Upload terminal logs for your build.
operationId: uploadAutomateBuildTerminalLogs
parameters:
- name: buildId
in: path
description: "ID of your build"
required: true
schema:
type: string
example: "a4fb480a55efd6b3c558afb1ee051a7c337b8ef0"
requestBody:
required: true
content:
multipart/form-data:
schema:
title: UploadAutomateBuildTerminalLogsRequest
type: object
required: [file]
properties:
file:
type: string
format: binary
description: "Path to the terminal log file on your machine. The max allowed file size is 2MB"
responses:
"200":
description: Successful operation
content:
application/json:
schema:
title: UploadAutomateBuildTerminalLogsResponse
type: object
required: [message]
properties:
message:
type: string
description: "Message indicating upload result."
example: "File has been uploaded successfully!"
"400":
$ref: '#/components/schemas/400.BadRequest'
"401":
$ref: '#/components/schemas/401.Unauthorized'
"404":
$ref: '#/components/schemas/404.NotFound'
"422":
$ref: '#/components/schemas/422.UnprocessableEntity'
"500":
$ref: '#/components/schemas/5xx.InternalServerError'
/automate/builds/{buildId}/sessions.json:
get:
tags: [Automate]
summary: Fetches list of sessions
description: Fetches list of sessions for a particular build
operationId: getAutomateSessions
parameters:
- name: buildId
in: path
description: "ID of your build"
required: true
schema:
type: string
example: "a4fb480a55efd6b3c558afb1ee051a7c337b8ef0"
- name: limit
in: query
description: "Specify the number of results to be displayed. The default value is 10, and the maximum value is 100"
required: false
schema:
type: number
example: 10
- name: offset
in: query
description: "Retrieve sessions from a specific point using the offset parameter"
required: false
schema: