-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathgithub-repo-actions-api-openapi.yml
More file actions
8716 lines (8540 loc) · 296 KB
/
github-repo-actions-api-openapi.yml
File metadata and controls
8716 lines (8540 loc) · 296 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.1.0
info:
version: 1.1.4
title: github-repo-actions-api
description: |-
Use the REST API to create, manage and control the workflow of public and
private GitHub repositories.
license:
name: MIT
url: https://spdx.org/licenses/MIT
termsOfService: https://docs.github.com/articles/github-terms-of-service
contact:
name: Support
url: https://support.github.com/contact
servers:
- url: '{protocol}://{hostname}'
variables:
hostname:
description: Self-hosted Enterprise Server hostname
default: api.github.com
protocol:
description: Self-hosted Enterprise Server protocol
default: https
externalDocs:
description: GitHub Enterprise Developer Docs
url: https://docs.github.com/enterprise-server@3.9/rest/
tags:
- name: Access
- name: Actions
- name: Add
- name: All
- name: Allowed
- name: Applications
- name: Artifacts
- name: Attempts
- name: Cache
- name: Caches
- name: Cancel
- name: Claims
- name: Create
- name: Custom
- name: Customizations
- name: Delete
- name: Deployments
- name: Disables
- name: Dispatch
- name: Download
- name: Enables
- name: Event
- name: Failed
- name: Get
- name: History
- name: Identifiers
- name: Jobs
- name: Keys
- name: Label
- name: Labels
- name: Levels
- name: Lists
- name: Logs
- name: Openid Connect
- name: Organizations
- name: Outside
- name: Pending
- name: Permissions
- name: Policies
- name: Public
- name: Re-Run
- name: Registration
- name: Remove
- name: Repositories
description: Source control repositories.
- name: Reviews
- name: Runners
- name: Runs
- name: Secrets
- name: Self-Hosted
- name: Sets
- name: Subject
- name: Templates
- name: Tokens
- name: Update
- name: Usage
- name: Variables
- name: Workflows
paths:
/repos/{owner}/{repo}/actions/artifacts:
get:
summary: GitHub List Artifacts for Repository
description: |-
Lists all artifacts for a repository.
Anyone with read access to the repository can use this endpoint.
OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
tags:
- Artifacts
- Lists
- Repositories
operationId: listArtifactsForRepository
externalDocs:
description: API method documentation
url: |-
https://docs.github.com/enterprise-server@3.9/rest/actions/artifacts#list-artifacts-for-a-repository
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/per-page'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/artifact-name'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
responses:
'200':
description: Response
content:
application/json:
schema:
type: object
required:
- total_count
- artifacts
properties:
total_count:
type: integer
artifacts:
type: array
items:
$ref: '#/components/schemas/artifact'
examples:
default:
$ref: '#/components/examples/artifact-paginated'
headers:
Link:
$ref: '#/components/headers/link'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: actions
subcategory: artifacts
x-api-evangelist-certified: '2025-07-18'
x-api-naftiko-published: '2025-07-25'
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/actions/artifacts/{artifact_id}:
get:
summary: GitHub Get an Artifact
description: |-
Gets a specific artifact for a workflow run.
Anyone with read access to the repository can use this endpoint.
If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
tags:
- Artifacts
- Get
operationId: getAnArtifact
externalDocs:
description: API method documentation
url: |-
https://docs.github.com/enterprise-server@3.9/rest/actions/artifacts#get-an-artifact
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/artifact-id'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/artifact'
examples:
default:
$ref: '#/components/examples/artifact'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: actions
subcategory: artifacts
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
summary: GitHub Delete an Artifact
description: |-
Deletes an artifact for a workflow run.
OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
tags:
- Artifacts
- Delete
operationId: deleteAnArtifact
externalDocs:
description: API method documentation
url: |-
https://docs.github.com/enterprise-server@3.9/rest/actions/artifacts#delete-an-artifact
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/artifact-id'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
responses:
'204':
description: Response
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: actions
subcategory: artifacts
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}:
get:
summary: GitHub Download an Artifact
description: |-
Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in
the response header to find the URL for the download. The `:archive_format` must be `zip`.
OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
tags:
- Artifacts
- Download
operationId: downloadAnArtifact
externalDocs:
description: API method documentation
url: |-
https://docs.github.com/enterprise-server@3.9/rest/actions/artifacts#download-an-artifact
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/artifact-id'
- name: archive_format
in: path
required: true
schema:
type: string
example: example_value
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
responses:
'302':
description: Response
headers:
Location:
$ref: '#/components/headers/location'
'410':
$ref: '#/components/responses/gone'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: actions
subcategory: artifacts
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/actions/cache/usage:
get:
summary: GitHub Get Github Actions Cache Usage for Repository
description: |-
Gets GitHub Actions cache usage for a repository.
The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
Anyone with read access to the repository can use this endpoint.
If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
tags:
- Actions
- Cache
- Get
- Repositories
- Usage
operationId: getGithubActionsCacheUsageForRepository
externalDocs:
description: API method documentation
url: |-
https://docs.github.com/enterprise-server@3.9/rest/actions/cache#get-github-actions-cache-usage-for-a-repository
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/actions-cache-usage-by-repository'
examples:
default:
$ref: '#/components/examples/actions-cache-usage'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: actions
subcategory: cache
x-api-evangelist-certified: '2025-07-16'
x-api-naftiko-published: '2025-07-25'
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/actions/cache/usage-policy:
get:
summary: GitHub Get Github Actions Cache Usage Policy for Repository
description: |-
Gets GitHub Actions cache usage policy for a repository.
OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
tags:
- Actions
- Cache
- Get
- Policies
- Repositories
- Usage
operationId: getGithubActionsCacheUsagePolicyForRepository
externalDocs:
description: API method documentation
url: |-
https://docs.github.com/enterprise-server@3.9/rest/actions/cache#get-github-actions-cache-usage-policy-for-a-repository
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/actions-cache-usage-policy-for-repository'
examples:
default:
$ref: '#/components/examples/actions-cache-usage-policy'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: actions
subcategory: cache
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
patch:
summary: GitHub Set Github Actions Cache Usage Policy for Repository
description: |-
Sets GitHub Actions cache usage policy for a repository.
OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
tags:
- Actions
- Cache
- Policies
- Repositories
- Sets
- Usage
operationId: setGithubActionsCacheUsagePolicyForRepository
externalDocs:
description: API method documentation
url: |-
https://docs.github.com/enterprise-server@3.9/rest/actions/cache#set-github-actions-cache-usage-policy-for-a-repository
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
responses:
'204':
description: Response
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/actions-cache-usage-policy-for-repository'
examples:
selected_actions:
$ref: '#/components/examples/actions-cache-usage-policy'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: actions
subcategory: cache
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/actions/caches:
get:
summary: GitHub List Github Actions Caches for Repository
description: |-
Lists the GitHub Actions caches for a repository.
OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
tags:
- Actions
- Caches
- Lists
- Repositories
operationId: listGithubActionsCachesForRepository
externalDocs:
description: API method documentation
url: |-
https://docs.github.com/enterprise-server@3.9/rest/actions/cache#list-github-actions-caches-for-a-repository
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/per-page'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/actions-cache-git-ref-full'
- $ref: '#/components/parameters/actions-cache-key'
- $ref: '#/components/parameters/actions-cache-list-sort'
- $ref: '#/components/parameters/direction'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/actions-cache-list'
examples:
default:
$ref: '#/components/examples/actions-cache-list'
headers:
Link:
$ref: '#/components/headers/link'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
previews: []
category: actions
subcategory: cache
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
summary: GitHub Delete Github Actions Caches for Repository (using Cache Key)
description: |-
Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.
OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
tags:
- Actions
- Cache
- Caches
- Delete
- Keys
- Repositories
operationId: deleteGithubActionsCachesForRepositoryUsingCacheKey
externalDocs:
description: API method documentation
url: |-
https://docs.github.com/enterprise-server@3.9/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/actions-cache-key-required'
- $ref: '#/components/parameters/actions-cache-git-ref-full'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/actions-cache-list'
examples:
default:
$ref: '#/components/examples/actions-cache-list'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: actions
subcategory: cache
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/actions/caches/{cache_id}:
delete:
summary: GitHub Delete Github Actions Cache for Repository (using Cache Id)
description: |-
Deletes a GitHub Actions cache for a repository, using a cache ID.
OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
tags:
- Actions
- Cache
- Delete
- Identifiers
- Repositories
operationId: deleteGithubActionsCacheForRepositoryUsingCacheId
externalDocs:
description: API method documentation
url: |-
https://docs.github.com/enterprise-server@3.9/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/cache-id'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
responses:
'204':
description: Response
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: actions
subcategory: cache
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/actions/jobs/{job_id}:
get:
summary: GitHub Get Job for Workflow Run
description: |-
Gets a specific job in a workflow run.
Anyone with read access to the repository can use this endpoint.
If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
tags:
- Get
- Jobs
- Runs
operationId: getJobForWorkflowRun
externalDocs:
description: API method documentation
url: |-
https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/job-id'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/job'
examples:
default:
$ref: '#/components/examples/job'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: actions
subcategory: workflow-jobs
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/actions/jobs/{job_id}/logs:
get:
summary: GitHub Download Job Logs for Workflow Run
description: |-
Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look
for `Location:` in the response header to find the URL for the download.
Anyone with read access to the repository can use this endpoint.
If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
tags:
- Download
- Jobs
- Logs
- Runs
- Workflows
operationId: downloadJobLogsForWorkflowRun
externalDocs:
description: API method documentation
url: |-
https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/job-id'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
responses:
'302':
description: Response
headers:
Location:
example: |-
https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D
schema:
type: string
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: actions
subcategory: workflow-jobs
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun:
post:
summary: GitHub Re-run Job from Workflow Run
description: |-
Re-run a job and its dependent jobs in a workflow run.
OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
tags:
- Jobs
- Re-Run
- Runs
- Workflows
operationId: rerunJobFromWorkflowRun
externalDocs:
description: API method documentation
url: |-
https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/job-id'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
enable_debug_logging:
type: boolean
default: false
description: Whether to enable debug logging for the re-run.
examples:
default:
value: {}
responses:
'201':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/empty-object'
examples:
default:
value: {}
'403':
$ref: '#/components/responses/forbidden'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: actions
subcategory: workflow-runs
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/actions/oidc/customization/sub:
get:
summary: GitHub Get the Customization Template for an Oidc Subject Claim for Repository
description: |-
Gets the customization template for an OpenID Connect (OIDC) subject claim.
OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
tags:
- Claims
- Customizations
- Get
- Openid Connect
- Repositories
- Subject
- Templates
operationId: getTheCustomizationTemplateForAnOidcSubjectClaimForRepository
externalDocs:
description: API method documentation
url: |-
https://docs.github.com/enterprise-server@3.9/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
responses:
'200':
description: Status response
content:
application/json:
schema:
$ref: '#/components/schemas/oidc-custom-sub-repo'
examples:
default:
$ref: '#/components/examples/oidc-custom-sub-repo'
'400':
$ref: '#/components/responses/bad_request'
'404':
$ref: '#/components/responses/not_found'
x-github:
enabledForGitHubApps: true
previews: []
category: actions
subcategory: oidc
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
put:
summary: GitHub Set the Customization Template for an Oidc Subject Claim for Repository
description: |-
Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository.
OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
tags:
- Claims
- Customizations
- Openid Connect
- Repositories
- Sets
- Subject
- Templates
operationId: setTheCustomizationTemplateForAnOidcSubjectClaimForRepository
externalDocs:
description: API method documentation
url: |-
https://docs.github.com/enterprise-server@3.9/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: true
content:
application/json:
schema:
title: Actions OIDC subject customization for a repository
description: Actions OIDC subject customization for a repository
type: object
required:
- use_default
properties:
use_default:
description: |-
Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored.