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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
|
openapi: 3.0.1
info:
title: GitLab API
version: v4
description: |
An OpenAPI definition for the GitLab REST API.
Few API resources or endpoints are currently included.
The intent is to expand this to match the entire Markdown documentation of the API:
<https://docs.gitlab.com/ee/api/>. Contributions are welcome.
When viewing this on gitlab.com, you can test API calls directly from the browser
against the `gitlab.com` instance, if you are logged in.
The feature uses the current [GitLab session cookie](https://docs.gitlab.com/ee/api/index.html#session-cookie),
so each request is made using your account.
Instructions for using this tool can be found in [Interactive API Documentation](https://docs.gitlab.com/ee/api/openapi/openapi_interactive.html)
termsOfService: 'https://about.gitlab.com/terms/'
license:
name: CC BY-SA 4.0
url: 'https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE'
servers:
- url: https://www.gitlab.com/api/
security:
- ApiKeyAuth: []
tags:
- name: badges
description: Operations about badges
- name: branches
description: Operations about branches
- name: alert_management
description: Operations about alert_managements
- name: batched_background_migrations
description: Operations about batched_background_migrations
- name: admin
description: Operations about admins
- name: migrations
description: Operations about migrations
- name: applications
description: Operations about applications
- name: avatar
description: Operations about avatars
- name: broadcast_messages
description: Operations about broadcast_messages
- name: bulk_imports
description: Operations about bulk_imports
- name: application
description: Operations about applications
- name: access_requests
description: Operations related to access requests
- name: ci_lint
description: Operations related to linting a CI config file
- name: ci_resource_groups
description: Operations to manage job concurrency with resource groups
- name: ci_variables
description: Operations related to CI/CD variables
- name: cluster_agents
description: Operations related to the GitLab agent for Kubernetes
- name: clusters
description: Operations related to clusters
- name: composer_packages
description: Operations related to Composer packages
- name: conan_packages
description: Operations related to Conan packages
- name: container_registry
description: Operations related to container registry
- name: container_registry_event
description: Operations related to container registry events
- name: dashboard_annotations
description: Operations related to dashboard annotations
- name: debian_distribution
description: Operations related to Debian Linux distributions
- name: debian_packages
description: Operations related to Debian Linux packages
- name: dependency_proxy
description: Operations to manage dependency proxy for a groups
- name: deploy_keys
description: Operations related to deploy keys
- name: deploy_tokens
description: Operations related to deploy tokens
- name: deployments
description: Operations related to deployments
- name: dora_metrics
description: Operations related to DevOps Research and Assessment (DORA) key metrics
- name: environments
description: Operations related to environments
- name: error_tracking_client_keys
description: Operations related to error tracking client keys
- name: error_tracking_project_settings
description: Operations related to error tracking project settings
- name: feature_flags_user_lists
description: Operations related to accessing GitLab feature flag user lists
- name: feature_flags
description: Operations related to feature flags
- name: features
description: Operations related to managing Flipper-based feature flags
- name: freeze_periods
description: Operations related to deploy freeze periods
- name: generic_packages
description: Operations related to Generic packages
- name: geo
description: Operations related to Geo
- name: geo_nodes
description: Operations related Geo Nodes
- name: go_proxy
description: Operations related to Go Proxy
- name: group_export
description: Operations related to exporting groups
- name: group_import
description: Operations related to importing groups
- name: group_packages
description: Operations related to group packages
- name: helm_packages
description: Operations related to Helm packages
- name: integrations
description: Operations related to integrations
- name: issue_links
description: Operations related to issue links
- name: jira_connect_subscriptions
description: Operations related to JiraConnect subscriptions
- name: maven_packages
description: Operations related to Maven packages
- name: merge_requests
description: Operations related to merge requests
- name: metadata
description: Operations related to metadata of the GitLab instance
- name: metrics_user_starred_dashboards
description: Operations related to User-starred metrics dashboards
- name: ml_model_registry
description: Operations related to Model registry
- name: npm_packages
description: Operations related to NPM packages
- name: nuget_packages
description: Operations related to Nuget packages
- name: package_files
description: Operations about package files
- name: plan_limits
description: Operations related to plan limits
- name: project_export
description: Operations related to exporting projects
- name: project_hooks
description: Operations related to project hooks
- name: project_import
description: Operations related to importing projects
- name: project_import_bitbucket
description: Operations related to importing BitBucket projects
- name: project_import_github
description: Operations related to importing GitHub projects
- name: project_packages
description: Operations related to project packages
- name: projects
description: Operations related to projects
- name: protected environments
description: Operations related to protected environments
- name: pypi_packages
description: Operations related to PyPI packages
- name: release_links
description: Operations related to release assets (links)
- name: releases
description: Operations related to releases
- name: resource_milestone_events
description: Operations about resource milestone events
- name: rpm_packages
description: Operations related to RPM packages
- name: rubygem_packages
description: Operations related to RubyGems
- name: suggestions
description: Operations related to suggestions
- name: system_hooks
description: Operations related to system hooks
- name: terraform_state
description: Operations related to Terraform state files
- name: terraform_registry
description: Operations related to the Terraform module registry
- name: unleash_api
description: Operations related to Unleash API
paths:
/api/v4/groups/{id}/badges/{badge_id}:
get:
tags:
- badges
summary: Gets a badge of a group.
description: This feature was introduced in GitLab 10.6.
operationId: getApiV4GroupsIdBadgesBadgeId
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the group owned by the authenticated
user.
required: true
schema:
type: string
- name: badge_id
in: path
description: The badge ID
required: true
schema:
type: integer
format: int32
responses:
200:
description: Gets a badge of a group.
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Badge'
put:
tags:
- badges
summary: Updates a badge of a group.
description: This feature was introduced in GitLab 10.6.
operationId: putApiV4GroupsIdBadgesBadgeId
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the group owned by the authenticated
user.
required: true
schema:
type: string
- name: badge_id
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
properties:
link_url:
type: string
description: URL of the badge link
image_url:
type: string
description: URL of the badge image
name:
type: string
description: Name for the badge
responses:
200:
description: Updates a badge of a group.
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Badge'
delete:
tags:
- badges
summary: Removes a badge from the group.
description: This feature was introduced in GitLab 10.6.
operationId: deleteApiV4GroupsIdBadgesBadgeId
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the group owned by the authenticated
user.
required: true
schema:
type: string
- name: badge_id
in: path
description: The badge ID
required: true
schema:
type: integer
format: int32
responses:
204:
description: Removes a badge from the group.
content: {}
/api/v4/groups/{id}/badges:
get:
tags:
- badges
summary: Gets a list of group badges viewable by the authenticated user.
description: This feature was introduced in GitLab 10.6.
operationId: getApiV4GroupsIdBadges
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the group owned by the authenticated
user.
required: true
schema:
type: string
- name: page
in: query
description: Current page number
schema:
type: integer
format: int32
default: 1
- name: per_page
in: query
description: Number of items per page
schema:
type: integer
format: int32
default: 20
- name: name
in: query
description: Name for the badge
schema:
type: string
responses:
200:
description: Gets a list of group badges viewable by the authenticated user.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/API_Entities_Badge'
post:
tags:
- badges
summary: Adds a badge to a group.
description: This feature was introduced in GitLab 10.6.
operationId: postApiV4GroupsIdBadges
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the group owned by the authenticated
user.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
required:
- image_url
- link_url
properties:
link_url:
type: string
description: URL of the badge link
image_url:
type: string
description: URL of the badge image
name:
type: string
description: Name for the badge
required: true
responses:
201:
description: Adds a badge to a group.
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Badge'
/api/v4/groups/{id}/badges/render:
get:
tags:
- badges
summary: Preview a badge from a group.
description: This feature was introduced in GitLab 10.6.
operationId: getApiV4GroupsIdBadgesRender
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the group owned by the authenticated
user.
required: true
schema:
type: string
- name: link_url
in: query
description: URL of the badge link
required: true
schema:
type: string
- name: image_url
in: query
description: URL of the badge image
required: true
schema:
type: string
responses:
200:
description: Preview a badge from a group.
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_BasicBadgeDetails'
/api/v4/groups/{id}/access_requests/{user_id}:
delete:
tags:
- access_requests
summary: Denies an access request for the given user.
description: This feature was introduced in GitLab 8.11.
operationId: deleteApiV4GroupsIdAccessRequestsUserId
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the group owned by the authenticated
user
required: true
schema:
type: string
- name: user_id
in: path
description: The user ID of the access requester
required: true
schema:
type: integer
format: int32
responses:
204:
description: Denies an access request for the given user.
content: {}
/api/v4/groups/{id}/access_requests/{user_id}/approve:
put:
tags:
- access_requests
summary: Approves an access request for the given user.
description: This feature was introduced in GitLab 8.11.
operationId: putApiV4GroupsIdAccessRequestsUserIdApprove
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the group owned by the authenticated
user
required: true
schema:
type: string
- name: user_id
in: path
description: The user ID of the access requester
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
properties:
access_level:
type: integer
description: 'A valid access level (defaults: `30`, the Developer
role)'
format: int32
default: 30
responses:
200:
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_AccessRequester'
successfull_response:
example:
id: 1
username: raymond_smith
name: Raymond Smith
state: active
created_at: 2012-10-22T14:13:35Z
access_level: 20
/api/v4/groups/{id}/access_requests:
get:
tags:
- access_requests
summary: Gets a list of access requests for a group.
description: This feature was introduced in GitLab 8.11.
operationId: getApiV4GroupsIdAccessRequests
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the group owned by the authenticated
user
required: true
schema:
type: string
- name: page
in: query
description: Current page number
schema:
type: integer
format: int32
default: 1
- name: per_page
in: query
description: Number of items per page
schema:
type: integer
format: int32
default: 20
responses:
200:
description: Gets a list of access requests for a group.
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_AccessRequester'
post:
tags:
- access_requests
summary: Requests access for the authenticated user to a group.
description: This feature was introduced in GitLab 8.11.
operationId: postApiV4GroupsIdAccessRequests
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the group owned by the authenticated
user
required: true
schema:
type: string
responses:
200:
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_AccessRequester'
successfull_response:
example:
id: 1
username: raymond_smith
name: Raymond Smith
state: active
created_at: 2012-10-22T14:13:35Z
access_level: 20
/api/v4/projects/{id}/repository/merged_branches:
delete:
tags:
- branches
description: Delete all merged branches
operationId: deleteApiV4ProjectsIdRepositoryMergedBranches
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the project
required: true
schema:
type: string
responses:
202:
description: 202 Accepted
content: {}
404:
description: 404 Project Not Found
content: {}
/api/v4/projects/{id}/repository/branches/{branch}:
get:
tags:
- branches
description: Get a single repository branch
operationId: getApiV4ProjectsIdRepositoryBranchesBranch
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the project
required: true
schema:
type: string
- name: branch
in: path
required: true
schema:
type: integer
format: int32
responses:
200:
description: Get a single repository branch
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Branch'
404:
description: Branch Not Found
content: {}
delete:
tags:
- branches
description: Delete a branch
operationId: deleteApiV4ProjectsIdRepositoryBranchesBranch
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the project
required: true
schema:
type: string
- name: branch
in: path
description: The name of the branch
required: true
schema:
type: string
responses:
204:
description: Delete a branch
content: {}
404:
description: Branch Not Found
content: {}
head:
tags:
- branches
description: Check if a branch exists
operationId: headApiV4ProjectsIdRepositoryBranchesBranch
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the project
required: true
schema:
type: string
- name: branch
in: path
description: The name of the branch
required: true
schema:
type: string
responses:
204:
description: No Content
content: {}
404:
description: Not Found
content: {}
/api/v4/projects/{id}/repository/branches:
get:
tags:
- branches
description: Get a project repository branches
operationId: getApiV4ProjectsIdRepositoryBranches
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the project
required: true
schema:
type: string
- name: page
in: query
description: Current page number
schema:
type: integer
format: int32
default: 1
- name: per_page
in: query
description: Number of items per page
schema:
type: integer
format: int32
default: 20
- name: search
in: query
description: Return list of branches matching the search criteria
schema:
type: string
- name: regex
in: query
description: Return list of branches matching the regex
schema:
type: string
- name: sort
in: query
description: Return list of branches sorted by the given field
schema:
type: string
enum:
- name_asc
- updated_asc
- updated_desc
- name: page_token
in: query
description: Name of branch to start the pagination from
schema:
type: string
responses:
200:
description: Get a project repository branches
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/API_Entities_Branch'
404:
description: 404 Project Not Found
content: {}
post:
tags:
- branches
description: Create branch
operationId: postApiV4ProjectsIdRepositoryBranches
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the project
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
required:
- branch
- ref
properties:
branch:
type: string
description: The name of the branch
ref:
type: string
description: Create branch from commit sha or existing branch
required: true
responses:
201:
description: Create branch
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Branch'
400:
description: Failed to create branch
content: {}
/api/v4/projects/{id}/repository/branches/{branch}/unprotect:
put:
tags:
- branches
description: Unprotect a single branch
operationId: putApiV4ProjectsIdRepositoryBranchesBranchUnprotect
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the project
required: true
schema:
type: string
- name: branch
in: path
description: The name of the branch
required: true
schema:
type: string
responses:
200:
description: Unprotect a single branch
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Branch'
404:
description: 404 Project Not Found
content: {}
/api/v4/projects/{id}/repository/branches/{branch}/protect:
put:
tags:
- branches
description: Protect a single branch
operationId: putApiV4ProjectsIdRepositoryBranchesBranchProtect
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the project
required: true
schema:
type: string
- name: branch
in: path
description: The name of the branch
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
properties:
developers_can_push:
type: boolean
description: Flag if developers can push to that branch
developers_can_merge:
type: boolean
description: Flag if developers can merge to that branch
responses:
200:
description: Protect a single branch
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Branch'
404:
description: 404 Branch Not Found
content: {}
/api/v4/projects/{id}/badges/{badge_id}:
get:
tags:
- badges
summary: Gets a badge of a project.
description: This feature was introduced in GitLab 10.6.
operationId: getApiV4ProjectsIdBadgesBadgeId
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the project owned by the authenticated
user.
required: true
schema:
type: string
- name: badge_id
in: path
description: The badge ID
required: true
schema:
type: integer
format: int32
responses:
200:
description: Gets a badge of a project.
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Badge'
put:
tags:
- badges
summary: Updates a badge of a project.
description: This feature was introduced in GitLab 10.6.
operationId: putApiV4ProjectsIdBadgesBadgeId
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the project owned by the authenticated
user.
required: true
schema:
type: string
- name: badge_id
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
properties:
link_url:
type: string
description: URL of the badge link
image_url:
type: string
description: URL of the badge image
name:
type: string
description: Name for the badge
responses:
200:
description: Updates a badge of a project.
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Badge'
delete:
tags:
- badges
summary: Removes a badge from the project.
description: This feature was introduced in GitLab 10.6.
operationId: deleteApiV4ProjectsIdBadgesBadgeId
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the project owned by the authenticated
user.
required: true
schema:
type: string
- name: badge_id
in: path
description: The badge ID
required: true
schema:
type: integer
format: int32
responses:
204:
description: Removes a badge from the project.
content: {}
/api/v4/projects/{id}/badges:
get:
tags:
- badges
summary: Gets a list of project badges viewable by the authenticated user.
description: This feature was introduced in GitLab 10.6.
operationId: getApiV4ProjectsIdBadges
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the project owned by the authenticated
user.
required: true
schema:
type: string
- name: page
in: query
description: Current page number
schema:
type: integer
format: int32
default: 1
- name: per_page
in: query
description: Number of items per page
schema:
type: integer
format: int32
default: 20
- name: name
in: query
description: Name for the badge
schema:
type: string
responses:
200:
description: Gets a list of project badges viewable by the authenticated
user.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/API_Entities_Badge'
post:
tags:
- badges
summary: Adds a badge to a project.
description: This feature was introduced in GitLab 10.6.
operationId: postApiV4ProjectsIdBadges
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the project owned by the authenticated
user.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
required:
- image_url
- link_url
properties:
link_url:
type: string
description: URL of the badge link
image_url:
type: string
description: URL of the badge image
name:
type: string
description: Name for the badge
required: true
responses:
201:
description: Adds a badge to a project.
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Badge'
/api/v4/projects/{id}/badges/render:
get:
tags:
- badges
summary: Preview a badge from a project.
description: This feature was introduced in GitLab 10.6.
operationId: getApiV4ProjectsIdBadgesRender
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the project owned by the authenticated
user.
required: true
schema:
type: string
- name: link_url
in: query
description: URL of the badge link
required: true
schema:
type: string
- name: image_url
in: query
description: URL of the badge image
required: true
schema:
type: string
responses:
200:
description: Preview a badge from a project.
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_BasicBadgeDetails'
/api/v4/projects/{id}/access_requests/{user_id}:
delete:
tags:
- access_requests
summary: Denies an access request for the given user.
description: This feature was introduced in GitLab 8.11.
operationId: deleteApiV4ProjectsIdAccessRequestsUserId
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the project owned by the authenticated
user
required: true
schema:
type: string
- name: user_id
in: path
description: The user ID of the access requester
required: true
schema:
type: integer
format: int32
responses:
204:
description: Denies an access request for the given user.
content: {}
/api/v4/projects/{id}/access_requests/{user_id}/approve:
put:
tags:
- access_requests
summary: Approves an access request for the given user.
description: This feature was introduced in GitLab 8.11.
operationId: putApiV4ProjectsIdAccessRequestsUserIdApprove
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the project owned by the authenticated
user
required: true
schema:
type: string
- name: user_id
in: path
description: The user ID of the access requester
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
properties:
access_level:
type: integer
description: 'A valid access level (defaults: `30`, the Developer
role)'
format: int32
default: 30
responses:
200:
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_AccessRequester'
successfull_response:
example:
id: 1
username: raymond_smith
name: Raymond Smith
state: active
created_at: 2012-10-22T14:13:35Z
access_level: 20
/api/v4/projects/{id}/access_requests:
get:
tags:
- access_requests
summary: Gets a list of access requests for a project.
description: This feature was introduced in GitLab 8.11.
operationId: getApiV4ProjectsIdAccessRequests
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the project owned by the authenticated
user
required: true
schema:
type: string
- name: page
in: query
description: Current page number
schema:
type: integer
format: int32
default: 1
- name: per_page
in: query
description: Number of items per page
schema:
type: integer
format: int32
default: 20
responses:
200:
description: Gets a list of access requests for a project.
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_AccessRequester'
post:
tags:
- access_requests
summary: Requests access for the authenticated user to a project.
description: This feature was introduced in GitLab 8.11.
operationId: postApiV4ProjectsIdAccessRequests
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the project owned by the authenticated
user
required: true
schema:
type: string
responses:
200:
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_AccessRequester'
successfull_response:
example:
id: 1
username: raymond_smith
name: Raymond Smith
state: active
created_at: 2012-10-22T14:13:35Z
access_level: 20
/api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id}:
put:
tags:
- alert_management
description: Update a metric image for an alert
operationId: putApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the project
required: true
schema:
type: string
- name: alert_iid
in: path
description: The IID of the Alert
required: true
schema:
type: integer
format: int32
- name: metric_image_id
in: path
description: The ID of metric image
required: true
schema:
type: integer
format: int32
requestBody:
content:
multipart/form-data:
schema:
properties:
url:
type: string
description: The url to view more metric info
url_text:
type: string
description: A description of the image or URL
responses:
200:
description: Update a metric image for an alert
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_MetricImage'
403:
description: Forbidden
content: {}
422:
description: Unprocessable entity
content: {}
delete:
tags:
- alert_management
description: Remove a metric image for an alert
operationId: deleteApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the project
required: true
schema:
type: string
- name: alert_iid
in: path
description: The IID of the Alert
required: true
schema:
type: integer
format: int32
- name: metric_image_id
in: path
description: The ID of metric image
required: true
schema:
type: integer
format: int32
responses:
204:
description: Remove a metric image for an alert
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_MetricImage'
403:
description: Forbidden
content: {}
422:
description: Unprocessable entity
content: {}
/api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images:
get:
tags:
- alert_management
description: Metric Images for alert
operationId: getApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the project
required: true
schema:
type: string
- name: alert_iid
in: path
description: The IID of the Alert
required: true
schema:
type: integer
format: int32
responses:
200:
description: Metric Images for alert
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/API_Entities_MetricImage'
404:
description: Not found
content: {}
post:
tags:
- alert_management
description: Upload a metric image for an alert
operationId: postApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the project
required: true
schema:
type: string
- name: alert_iid
in: path
description: The IID of the Alert
required: true
schema:
type: integer
format: int32
requestBody:
content:
multipart/form-data:
schema:
required:
- file
properties:
file:
type: string
description: The image file to be uploaded
format: binary
url:
type: string
description: The url to view more metric info
url_text:
type: string
description: A description of the image or URL
required: true
responses:
200:
description: Upload a metric image for an alert
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_MetricImage'
403:
description: Forbidden
content: {}
/api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/authorize:
post:
tags:
- alert_management
description: Workhorse authorize metric image file upload
operationId: postApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesAuthorize
parameters:
- name: id
in: path
description: The ID or URL-encoded path of the project
required: true
schema:
type: string
- name: alert_iid
in: path
description: The IID of the Alert
required: true
schema:
type: integer
format: int32
responses:
200:
description: Workhorse authorize metric image file upload
content: {}
403:
description: Forbidden
content: {}
/api/v4/admin/batched_background_migrations/{id}:
get:
tags:
- batched_background_migrations
description: Retrieve a batched background migration
operationId: getApiV4AdminBatchedBackgroundMigrationsId
parameters:
- name: database
in: query
description: The name of the database
schema:
type: string
default: main
enum:
- main
- ci
- embedding
- main_clusterwide
- geo
- name: id
in: path
description: The batched background migration id
required: true
schema:
type: integer
format: int32
responses:
200:
description: Retrieve a batched background migration
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_BatchedBackgroundMigration'
401:
description: 401 Unauthorized
content: {}
403:
description: 403 Forbidden
content: {}
404:
description: 404 Not found
content: {}
/api/v4/admin/batched_background_migrations:
get:
tags:
- batched_background_migrations
description: Get the list of batched background migrations
operationId: getApiV4AdminBatchedBackgroundMigrations
parameters:
- name: database
in: query
description: The name of the database, the default `main`
schema:
type: string
default: main
enum:
- main
- ci
- embedding
- main_clusterwide
- geo
responses:
200:
description: Get the list of batched background migrations
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/API_Entities_BatchedBackgroundMigration'
401:
description: 401 Unauthorized
content: {}
403:
description: 403 Forbidden
content: {}
/api/v4/admin/batched_background_migrations/{id}/resume:
put:
tags:
- batched_background_migrations
description: Resume a batched background migration
operationId: putApiV4AdminBatchedBackgroundMigrationsIdResume
parameters:
- name: id
in: path
description: The batched background migration id
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
properties:
database:
type: string
description: The name of the database
default: main
enum:
- main
- ci
- embedding
- main_clusterwide
- geo
responses:
200:
description: Resume a batched background migration
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_BatchedBackgroundMigration'
401:
description: 401 Unauthorized
content: {}
403:
description: 403 Forbidden
content: {}
404:
description: 404 Not found
content: {}
422:
description: You can resume only `paused` batched background migrations.
content: {}
/api/v4/admin/batched_background_migrations/{id}/pause:
put:
tags:
- batched_background_migrations
description: Pause a batched background migration
operationId: putApiV4AdminBatchedBackgroundMigrationsIdPause
parameters:
- name: id
in: path
description: The batched background migration id
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
properties:
database:
type: string
description: The name of the database
default: main
enum:
- main
- ci
- embedding
- main_clusterwide
- geo
responses:
200:
description: Pause a batched background migration
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_BatchedBackgroundMigration'
401:
description: 401 Unauthorized
content: {}
403:
description: 403 Forbidden
content: {}
404:
description: 404 Not found
content: {}
422:
description: You can pause only `active` batched background migrations.
content: {}
/api/v4/admin/ci/variables/{key}:
get:
tags:
- ci_variables
description: Get the details of a specific instance-level variable
operationId: getApiV4AdminCiVariablesKey
parameters:
- name: key
in: path
description: The key of a variable
required: true
schema:
type: string
responses:
200:
description: Get the details of a specific instance-level variable
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Ci_Variable'
404:
description: Instance Variable Not Found
content: {}
put:
tags:
- ci_variables
description: Update an instance-level variable
operationId: putApiV4AdminCiVariablesKey
parameters:
- name: key
in: path
description: The key of a variable
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
properties:
value:
type: string
description: The value of a variable
protected:
type: boolean
description: Whether the variable is protected
masked:
type: boolean
description: Whether the variable is masked
raw:
type: boolean
description: Whether the variable will be expanded
variable_type:
type: string
description: 'The type of a variable. Available types are: env_var
(default) and file'
enum:
- env_var
- file
responses:
200:
description: Update an instance-level variable
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Ci_Variable'
404:
description: Instance Variable Not Found
content: {}
delete:
tags:
- ci_variables
description: Delete an existing instance-level variable
operationId: deleteApiV4AdminCiVariablesKey
parameters:
- name: key
in: path
description: The key of a variable
required: true
schema:
type: string
responses:
204:
description: Delete an existing instance-level variable
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Ci_Variable'
404:
description: Instance Variable Not Found
content: {}
/api/v4/admin/ci/variables:
get:
tags:
- ci_variables
description: List all instance-level variables
operationId: getApiV4AdminCiVariables
parameters:
- name: page
in: query
description: Current page number
schema:
type: integer
format: int32
default: 1
- name: per_page
in: query
description: Number of items per page
schema:
type: integer
format: int32
default: 20
responses:
200:
description: List all instance-level variables
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Ci_Variable'
post:
tags:
- ci_variables
description: Create a new instance-level variable
operationId: postApiV4AdminCiVariables
requestBody:
content:
application/json:
schema:
required:
- key
- value
properties:
key:
type: string
description: The key of the variable. Max 255 characters
value:
type: string
description: The value of a variable
protected:
type: boolean
description: Whether the variable is protected
masked:
type: boolean
description: Whether the variable is masked
raw:
type: boolean
description: Whether the variable will be expanded
variable_type:
type: string
description: 'The type of a variable. Available types are: env_var
(default) and file'
enum:
- env_var
- file
required: true
responses:
201:
description: Create a new instance-level variable
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Ci_Variable'
400:
description: 400 Bad Request
content: {}
/api/v4/admin/databases/{database_name}/dictionary/tables/{table_name}:
get:
tags:
- admin
description: Retrieve dictionary details
operationId: getApiV4AdminDatabasesDatabaseNameDictionaryTablesTableName
parameters:
- name: database_name
in: path
description: The database name
required: true
schema:
type: string
enum:
- main
- ci
- name: table_name
in: path
description: The table name
required: true
schema:
type: string
responses:
200:
description: Retrieve dictionary details
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Dictionary_Table'
401:
description: 401 Unauthorized
content: {}
403:
description: 403 Forbidden
content: {}
404:
description: 404 Not found
content: {}
/api/v4/admin/clusters/{cluster_id}:
get:
tags:
- clusters
summary: Get a single instance cluster
description: This feature was introduced in GitLab 13.2. Returns a single instance
cluster.
operationId: getApiV4AdminClustersClusterId
parameters:
- name: cluster_id
in: path
description: The cluster ID
required: true
schema:
type: integer
format: int32
responses:
200:
description: Get a single instance cluster
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Cluster'
403:
description: Forbidden
content: {}
404:
description: Not found
content: {}
put:
tags:
- clusters
summary: Edit instance cluster
description: This feature was introduced in GitLab 13.2. Updates an existing
instance cluster.
operationId: putApiV4AdminClustersClusterId
parameters:
- name: cluster_id
in: path
description: The cluster ID
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
properties:
name:
type: string
description: Cluster name
enabled:
type: boolean
description: Enable or disable Gitlab's connection to your Kubernetes
cluster
environment_scope:
type: string
description: The associated environment to the cluster
namespace_per_environment:
type: boolean
description: Deploy each environment to a separate Kubernetes namespace
default: true
domain:
type: string
description: Cluster base domain
management_project_id:
type: integer
description: The ID of the management project
format: int32
managed:
type: boolean
description: Determines if GitLab will manage namespaces and service
accounts for this cluster
platform_kubernetes_attributes[api_url]:
type: string
description: URL to access the Kubernetes API
platform_kubernetes_attributes[token]:
type: string
description: Token to authenticate against Kubernetes
platform_kubernetes_attributes[ca_cert]:
type: string
description: TLS certificate (needed if API is using a self-signed
TLS certificate)
platform_kubernetes_attributes[namespace]:
type: string
description: Unique namespace related to Project
responses:
200:
description: Edit instance cluster
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Cluster'
400:
description: Validation error
content: {}
403:
description: Forbidden
content: {}
404:
description: Not found
content: {}
delete:
tags:
- clusters
summary: Delete instance cluster
description: This feature was introduced in GitLab 13.2. Deletes an existing
instance cluster. Does not remove existing resources within the connected
Kubernetes cluster.
operationId: deleteApiV4AdminClustersClusterId
parameters:
- name: cluster_id
in: path
description: The cluster ID
required: true
schema:
type: integer
format: int32
responses:
204:
description: Delete instance cluster
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Cluster'
403:
description: Forbidden
content: {}
404:
description: Not found
content: {}
/api/v4/admin/clusters/add:
post:
tags:
- clusters
summary: Add existing instance cluster
description: This feature was introduced in GitLab 13.2. Adds an existing Kubernetes
instance cluster.
operationId: postApiV4AdminClustersAdd
requestBody:
content:
application/json:
schema:
required:
- name
- platform_kubernetes_attributes[api_url]
- platform_kubernetes_attributes[token]
properties:
name:
type: string
description: Cluster name
enabled:
type: boolean
description: Determines if cluster is active or not, defaults to
true
default: true
environment_scope:
type: string
description: The associated environment to the cluster
default: '*'
namespace_per_environment:
type: boolean
description: Deploy each environment to a separate Kubernetes namespace
default: true
domain:
type: string
description: Cluster base domain
management_project_id:
type: integer
description: The ID of the management project
format: int32
managed:
type: boolean
description: Determines if GitLab will manage namespaces and service
accounts for this cluster, defaults to true
default: true
platform_kubernetes_attributes[api_url]:
type: string
description: URL to access the Kubernetes API
platform_kubernetes_attributes[token]:
type: string
description: Token to authenticate against Kubernetes
platform_kubernetes_attributes[ca_cert]:
type: string
description: TLS certificate (needed if API is using a self-signed
TLS certificate)
platform_kubernetes_attributes[namespace]:
type: string
description: Unique namespace related to Project
platform_kubernetes_attributes[authorization_type]:
type: string
description: Cluster authorization type, defaults to RBAC
default: rbac
enum:
- unknown_authorization
- rbac
- abac
required: true
responses:
201:
description: Add existing instance cluster
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Cluster'
400:
description: Validation error
content: {}
403:
description: Forbidden
content: {}
404:
description: Not found
content: {}
/api/v4/admin/clusters:
get:
tags:
- clusters
summary: List instance clusters
description: This feature was introduced in GitLab 13.2. Returns a list of instance
clusters.
operationId: getApiV4AdminClusters
responses:
200:
description: List instance clusters
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/API_Entities_Cluster'
403:
description: Forbidden
content: {}
/api/v4/admin/migrations/{timestamp}/mark:
post:
tags:
- migrations
description: Mark the migration as successfully executed
operationId: postApiV4AdminMigrationsTimestampMark
parameters:
- name: timestamp
in: path
description: The migration version timestamp
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
properties:
database:
type: string
description: The name of the database
default: main
enum:
- main
- ci
- embedding
- main_clusterwide
- geo
responses:
201:
description: 201 Created
content: {}
401:
description: 401 Unauthorized
content: {}
403:
description: 403 Forbidden
content: {}
404:
description: 404 Not found
content: {}
422:
description: You can mark only pending migrations
content: {}
/api/v4/applications/{id}:
delete:
tags:
- applications
summary: Delete an application
description: Delete a specific application
operationId: deleteApiV4ApplicationsId
parameters:
- name: id
in: path
description: The ID of the application (not the application_id)
required: true
schema:
type: integer
format: int32
responses:
204:
description: Delete an application
content: {}
/api/v4/applications:
get:
tags:
- applications
summary: Get applications
description: List all registered applications
operationId: getApiV4Applications
responses:
200:
description: Get applications
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/API_Entities_Application'
post:
tags:
- applications
summary: Create a new application
description: This feature was introduced in GitLab 10.5
operationId: postApiV4Applications
requestBody:
content:
application/json:
schema:
required:
- name
- redirect_uri
- scopes
properties:
name:
type: string
description: Name of the application.
redirect_uri:
type: string
description: Redirect URI of the application.
scopes:
type: string
description: |-
Scopes of the application. You can specify multiple scopes by separating\
each scope using a space
confidential:
type: boolean
description: |-
The application is used where the client secret can be kept confidential. Native mobile apps \
and Single Page Apps are considered non-confidential. Defaults to true if not supplied
default: true
required: true
responses:
200:
description: Create a new application
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_ApplicationWithSecret'
/api/v4/avatar:
get:
tags:
- avatar
description: Return avatar url for a user
operationId: getApiV4Avatar
parameters:
- name: email
in: query
description: Public email address of the user
required: true
schema:
type: string
- name: size
in: query
description: Single pixel dimension for Gravatar images
schema:
type: integer
format: int32
responses:
200:
description: Return avatar url for a user
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Avatar'
/api/v4/broadcast_messages/{id}:
get:
tags:
- broadcast_messages
summary: Get a specific broadcast message
description: This feature was introduced in GitLab 8.12.
operationId: getApiV4BroadcastMessagesId
parameters:
- name: id
in: path
description: Broadcast message ID
required: true
schema:
type: integer
format: int32
responses:
200:
description: Get a specific broadcast message
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_BroadcastMessage'
put:
tags:
- broadcast_messages
summary: Update a broadcast message
description: This feature was introduced in GitLab 8.12.
operationId: putApiV4BroadcastMessagesId
parameters:
- name: id
in: path
description: Broadcast message ID
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
properties:
message:
type: string
description: Message to display
starts_at:
type: string
description: Starting time
format: date-time
ends_at:
type: string
description: Ending time
format: date-time
color:
type: string
description: Background color
font:
type: string
description: Foreground color
target_access_levels:
type: array
description: Target user roles
items:
type: integer
format: int32
enum:
- 10
- 20
- 30
- 40
- 50
target_path:
type: string
description: Target path
broadcast_type:
type: string
description: Broadcast Type
enum:
- banner
- notification
dismissable:
type: boolean
description: Is dismissable
responses:
200:
description: Update a broadcast message
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_BroadcastMessage'
delete:
tags:
- broadcast_messages
summary: Delete a broadcast message
description: This feature was introduced in GitLab 8.12.
operationId: deleteApiV4BroadcastMessagesId
parameters:
- name: id
in: path
description: Broadcast message ID
required: true
schema:
type: integer
format: int32
responses:
200:
description: Delete a broadcast message
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_BroadcastMessage'
/api/v4/broadcast_messages:
get:
tags:
- broadcast_messages
summary: Get all broadcast messages
description: This feature was introduced in GitLab 8.12.
operationId: getApiV4BroadcastMessages
parameters:
- name: page
in: query
description: Current page number
schema:
type: integer
format: int32
default: 1
- name: per_page
in: query
description: Number of items per page
schema:
type: integer
format: int32
default: 20
responses:
200:
description: Get all broadcast messages
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_BroadcastMessage'
post:
tags:
- broadcast_messages
summary: Create a broadcast message
description: This feature was introduced in GitLab 8.12.
operationId: postApiV4BroadcastMessages
requestBody:
content:
application/json:
schema:
required:
- message
properties:
message:
type: string
description: Message to display
starts_at:
type: string
description: Starting time
format: date-time
ends_at:
type: string
description: Ending time
format: date-time
color:
type: string
description: Background color
font:
type: string
description: Foreground color
target_access_levels:
type: array
description: Target user roles
items:
type: integer
format: int32
enum:
- 10
- 20
- 30
- 40
- 50
target_path:
type: string
description: Target path
broadcast_type:
type: string
description: Broadcast type. Defaults to banner
enum:
- banner
- notification
dismissable:
type: boolean
description: Is dismissable
required: true
responses:
201:
description: Create a broadcast message
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_BroadcastMessage'
/api/v4/bulk_imports/{import_id}/entities/{entity_id}:
get:
tags:
- bulk_imports
summary: Get GitLab Migration entity details
description: This feature was introduced in GitLab 14.1.
operationId: getApiV4BulkImportsImportIdEntitiesEntityId
parameters:
- name: import_id
in: path
description: The ID of user's GitLab Migration
required: true
schema:
type: integer
format: int32
- name: entity_id
in: path
description: The ID of GitLab Migration entity
required: true
schema:
type: integer
format: int32
responses:
200:
description: Get GitLab Migration entity details
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_BulkImports'
401:
description: Unauthorized
content: {}
404:
description: Not found
content: {}
503:
description: Service unavailable
content: {}
/api/v4/bulk_imports/{import_id}/entities:
get:
tags:
- bulk_imports
summary: List GitLab Migration entities
description: This feature was introduced in GitLab 14.1.
operationId: getApiV4BulkImportsImportIdEntities
parameters:
- name: import_id
in: path
description: The ID of user's GitLab Migration
required: true
schema:
type: integer
format: int32
- name: status
in: query
description: Return import entities with specified status
schema:
type: string
enum:
- created
- started
- finished
- timeout
- failed
- name: page
in: query
description: Current page number
schema:
type: integer
format: int32
default: 1
- name: per_page
in: query
description: Number of items per page
schema:
type: integer
format: int32
default: 20
responses:
200:
description: List GitLab Migration entities
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/API_Entities_BulkImports'
401:
description: Unauthorized
content: {}
404:
description: Not found
content: {}
503:
description: Service unavailable
content: {}
/api/v4/bulk_imports/{import_id}:
get:
tags:
- bulk_imports
summary: Get GitLab Migration details
description: This feature was introduced in GitLab 14.1.
operationId: getApiV4BulkImportsImportId
parameters:
- name: import_id
in: path
description: The ID of user's GitLab Migration
required: true
schema:
type: integer
format: int32
responses:
200:
description: Get GitLab Migration details
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_BulkImport'
401:
description: Unauthorized
content: {}
404:
description: Not found
content: {}
503:
description: Service unavailable
content: {}
/api/v4/bulk_imports/entities:
get:
tags:
- bulk_imports
summary: List all GitLab Migrations' entities
description: This feature was introduced in GitLab 14.1.
operationId: getApiV4BulkImportsEntities
parameters:
- name: page
in: query
description: Current page number
schema:
type: integer
format: int32
default: 1
- name: per_page
in: query
description: Number of items per page
schema:
type: integer
format: int32
default: 20
- name: sort
in: query
description: Return GitLab Migrations sorted in created by `asc` or `desc`
order.
schema:
type: string
default: desc
enum:
- asc
- desc
- name: status
in: query
description: Return all GitLab Migrations' entities with specified status
schema:
type: string
enum:
- created
- started
- finished
- timeout
- failed
responses:
200:
description: List all GitLab Migrations' entities
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/API_Entities_BulkImports'
401:
description: Unauthorized
content: {}
404:
description: Not found
content: {}
503:
description: Service unavailable
content: {}
/api/v4/bulk_imports:
get:
tags:
- bulk_imports
summary: List all GitLab Migrations
description: This feature was introduced in GitLab 14.1.
operationId: getApiV4BulkImports
parameters:
- name: page
in: query
description: Current page number
schema:
type: integer
format: int32
default: 1
- name: per_page
in: query
description: Number of items per page
schema:
type: integer
format: int32
default: 20
- name: sort
in: query
description: Return GitLab Migrations sorted in created by `asc` or `desc`
order.
schema:
type: string
default: desc
enum:
- asc
- desc
- name: status
in: query
description: Return GitLab Migrations with specified status
schema:
type: string
enum:
- created
- started
- finished
- timeout
- failed
responses:
200:
description: List all GitLab Migrations
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/API_Entities_BulkImport'
401:
description: Unauthorized
content: {}
404:
description: Not found
content: {}
503:
description: Service unavailable
content: {}
post:
tags:
- bulk_imports
summary: Start a new GitLab Migration
description: This feature was introduced in GitLab 14.2.
operationId: postApiV4BulkImports
requestBody:
content:
application/x-www-form-urlencoded:
schema:
required:
- configuration[access_token]
- configuration[url]
- entities[destination_namespace]
- entities[source_full_path]
- entities[source_type]
properties:
configuration[url]:
type: string
description: Source GitLab instance URL
configuration[access_token]:
type: string
description: Access token to the source GitLab instance
entities[source_type]:
type: array
description: Source entity type
items:
type: string
enum:
- group_entity
- project_entity
entities[source_full_path]:
type: array
description: Relative path of the source entity to import
items:
type: string
entities[destination_namespace]:
type: array
description: Destination namespace for the entity
items:
type: string
entities[destination_slug]:
type: array
description: Destination slug for the entity
items:
type: string
entities[destination_name]:
type: array
description: 'Deprecated: Use :destination_slug instead. Destination
slug for the entity'
items:
type: string
entities[migrate_projects]:
type: array
description: Indicates group migration should include nested projects
items:
type: boolean
required: true
responses:
200:
description: Start a new GitLab Migration
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_BulkImport'
400:
description: Bad request
content: {}
401:
description: Unauthorized
content: {}
404:
description: Not found
content: {}
422:
description: Unprocessable entity
content: {}
503:
description: Service unavailable
content: {}
/api/v4/application/appearance:
get:
tags:
- application
description: Get the current appearance
operationId: getApiV4ApplicationAppearance
responses:
200:
description: Get the current appearance
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Appearance'
put:
tags:
- application
description: Modify appearance
operationId: putApiV4ApplicationAppearance
requestBody:
content:
multipart/form-data:
schema:
properties:
title:
type: string
description: Instance title on the sign in / sign up page
description:
type: string
description: Markdown text shown on the sign in / sign up page
pwa_name:
type: string
description: Name of the Progressive Web App
pwa_short_name:
type: string
description: Optional, short name for Progressive Web App
pwa_description:
type: string
description: An explanation of what the Progressive Web App does
logo:
type: string
description: Instance image used on the sign in / sign up page
format: binary
pwa_icon:
type: string
description: Icon used for Progressive Web App
format: binary
header_logo:
type: string
description: Instance image used for the main navigation bar
format: binary
favicon:
type: string
description: Instance favicon in .ico/.png format
format: binary
new_project_guidelines:
type: string
description: Markdown text shown on the new project page
profile_image_guidelines:
type: string
description: Markdown text shown on the profile page below Public
Avatar
header_message:
type: string
description: Message within the system header bar
footer_message:
type: string
description: Message within the system footer bar
message_background_color:
type: string
description: Background color for the system header / footer bar
message_font_color:
type: string
description: Font color for the system header / footer bar
email_header_and_footer_enabled:
type: boolean
description: Add header and footer to all outgoing emails if enabled
responses:
200:
description: Modify appearance
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Appearance'
/api/v4/application/plan_limits:
get:
tags:
- plan_limits
summary: Get current plan limits
description: List the current limits of a plan on the GitLab instance.
operationId: getApiV4ApplicationPlanLimits
parameters:
- name: plan_name
in: query
description: 'Name of the plan to get the limits from. Default: default.'
schema:
type: string
default: default
enum:
- default
- free
- bronze
- silver
- premium
- gold
- ultimate
- ultimate_trial
- premium_trial
- opensource
responses:
200:
description: Get current plan limits
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_PlanLimit'
401:
description: Unauthorized
content: {}
403:
description: Forbidden
content: {}
put:
tags:
- plan_limits
summary: Change plan limits
description: Modify the limits of a plan on the GitLab instance.
operationId: putApiV4ApplicationPlanLimits
requestBody:
content:
application/json:
schema:
required:
- plan_name
properties:
plan_name:
type: string
description: Name of the plan to update
enum:
- default
- free
- bronze
- silver
- premium
- gold
- ultimate
- ultimate_trial
- premium_trial
- opensource
ci_pipeline_size:
type: integer
description: Maximum number of jobs in a single pipeline
format: int32
ci_active_jobs:
type: integer
description: Total number of jobs in currently active pipelines
format: int32
ci_project_subscriptions:
type: integer
description: Maximum number of pipeline subscriptions to and from
a project
format: int32
ci_pipeline_schedules:
type: integer
description: Maximum number of pipeline schedules
format: int32
ci_needs_size_limit:
type: integer
description: Maximum number of DAG dependencies that a job can have
format: int32
ci_registered_group_runners:
type: integer
description: Maximum number of runners registered per group
format: int32
ci_registered_project_runners:
type: integer
description: Maximum number of runners registered per project
format: int32
conan_max_file_size:
type: integer
description: Maximum Conan package file size in bytes
format: int32
enforcement_limit:
type: integer
description: Maximum storage size for the root namespace enforcement
in MiB
format: int32
generic_packages_max_file_size:
type: integer
description: Maximum generic package file size in bytes
format: int32
helm_max_file_size:
type: integer
description: Maximum Helm chart file size in bytes
format: int32
maven_max_file_size:
type: integer
description: Maximum Maven package file size in bytes
format: int32
notification_limit:
type: integer
description: Maximum storage size for the root namespace notifications
in MiB
format: int32
npm_max_file_size:
type: integer
description: Maximum NPM package file size in bytes
format: int32
nuget_max_file_size:
type: integer
description: Maximum NuGet package file size in bytes
format: int32
pypi_max_file_size:
type: integer
description: Maximum PyPI package file size in bytes
format: int32
terraform_module_max_file_size:
type: integer
description: Maximum Terraform Module package file size in bytes
format: int32
storage_size_limit:
type: integer
description: Maximum storage size for the root namespace in MiB
format: int32
pipeline_hierarchy_size:
type: integer
description: Maximum number of downstream pipelines in a pipeline's
hierarchy tree
format: int32
required: true
responses:
200:
description: Change plan limits
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_PlanLimit'
400:
description: Bad request
content: {}
401:
description: Unauthorized
content: {}
403:
description: Forbidden
content: {}
/api/v4/metadata:
get:
tags:
- metadata
summary: Retrieve metadata information for this GitLab instance
description: This feature was introduced in GitLab 15.2.
operationId: getApiV4Metadata
responses:
200:
description: Retrieve metadata information for this GitLab instance
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Metadata'
401:
description: Unauthorized
content: {}
/api/v4/version:
get:
tags:
- metadata
summary: Retrieves version information for the GitLab instance
description: This feature was introduced in GitLab 8.13 and deprecated in 15.5.
We recommend you instead use the Metadata API.
operationId: getApiV4Version
responses:
200:
description: Retrieves version information for the GitLab instance
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_Metadata'
401:
description: Unauthorized
content: {}
components:
schemas:
API_Entities_Badge:
type: object
properties:
name:
type: string
link_url:
type: string
image_url:
type: string
rendered_link_url:
type: string
rendered_image_url:
type: string
id:
type: string
kind:
type: string
description: API_Entities_Badge model
API_Entities_BasicBadgeDetails:
type: object
properties:
name:
type: string
link_url:
type: string
image_url:
type: string
rendered_link_url:
type: string
rendered_image_url:
type: string
description: API_Entities_BasicBadgeDetails model
API_Entities_AccessRequester:
type: object
properties:
id:
type: integer
format: int32
example: 1
username:
type: string
example: admin
name:
type: string
example: Administrator
state:
type: string
example: active
avatar_url:
type: string
example: https://gravatar.com/avatar/1
avatar_path:
type: string
example: /user/avatar/28/The-Big-Lebowski-400-400.png
custom_attributes:
type: array
items:
$ref: '#/components/schemas/API_Entities_CustomAttribute'
web_url:
type: string
example: https://gitlab.example.com/root
email:
type: string
requested_at:
type: string
description: API_Entities_AccessRequester model
API_Entities_CustomAttribute:
type: object
properties:
key:
type: string
example: foo
value:
type: string
example: bar
API_Entities_Branch:
type: object
properties:
name:
type: string
example: master
commit:
$ref: '#/components/schemas/API_Entities_Commit'
merged:
type: boolean
example: true
protected:
type: boolean
example: true
developers_can_push:
type: boolean
example: true
developers_can_merge:
type: boolean
example: true
can_push:
type: boolean
example: true
default:
type: boolean
example: true
web_url:
type: string
example: https://gitlab.example.com/Commit921/the-dude/-/tree/master
description: API_Entities_Branch model
API_Entities_Commit:
type: object
properties:
id:
type: string
example: 2695effb5807a22ff3d138d593fd856244e155e7
short_id:
type: string
example: 2695effb
created_at:
type: string
format: date-time
example: 2017-07-26T11:08:53+02:00
parent_ids:
type: array
items:
type: string
example: 2a4b78934375d7f53875269ffd4f45fd83a84ebe
title:
type: string
example: Initial commit
message:
type: string
example: Initial commit
author_name:
type: string
example: John Smith
author_email:
type: string
example: john@example.com
authored_date:
type: string
format: date-time
example: 2012-05-28T04:42:42-07:00
committer_name:
type: string
example: Jack Smith
committer_email:
type: string
example: jack@example.com
committed_date:
type: string
format: date-time
example: 2012-05-28T04:42:42-07:00
trailers:
type: object
properties: {}
example: '{ "Merged-By": "Jane Doe janedoe@gitlab.com" }'
web_url:
type: string
example: https://gitlab.example.com/janedoe/gitlab-foss/-/commit/ed899a2f4b50b4370feeea94676502b42383c746
API_Entities_MetricImage:
type: object
properties:
id:
type: integer
format: int32
example: 23
created_at:
type: string
format: date-time
example: 2020-11-13T00:06:18.084Z
filename:
type: string
example: file.png
file_path:
type: string
example: /uploads/-/system/alert_metric_image/file/23/file.png
url:
type: string
example: https://example.com/metric
url_text:
type: string
example: An example metric
description: API_Entities_MetricImage model
API_Entities_BatchedBackgroundMigration:
type: object
properties:
id:
type: string
example: "1234"
job_class_name:
type: string
example: CopyColumnUsingBackgroundMigrationJob
table_name:
type: string
example: events
status:
type: string
example: active
progress:
type: number
format: float
example: 50.0
created_at:
type: string
format: date-time
example: 2022-11-28T16:26:39+02:00
description: API_Entities_BatchedBackgroundMigration model
API_Entities_Ci_Variable:
type: object
properties:
variable_type:
type: string
example: env_var
key:
type: string
example: TEST_VARIABLE_1
value:
type: string
example: TEST_1
protected:
type: boolean
masked:
type: boolean
raw:
type: boolean
environment_scope:
type: string
example: '*'
description: API_Entities_Ci_Variable model
API_Entities_Dictionary_Table:
type: object
properties:
table_name:
type: string
example: users
feature_categories:
type: array
items:
type: string
example: database
description: API_Entities_Dictionary_Table model
API_Entities_Cluster:
type: object
properties:
id:
type: string
name:
type: string
created_at:
type: string
domain:
type: string
enabled:
type: string
managed:
type: string
provider_type:
type: string
platform_type:
type: string
environment_scope:
type: string
cluster_type:
type: string
namespace_per_environment:
type: string
user:
$ref: '#/components/schemas/API_Entities_UserBasic'
platform_kubernetes:
$ref: '#/components/schemas/API_Entities_Platform_Kubernetes'
provider_gcp:
$ref: '#/components/schemas/API_Entities_Provider_Gcp'
management_project:
$ref: '#/components/schemas/API_Entities_ProjectIdentity'
description: API_Entities_Cluster model
API_Entities_UserBasic:
type: object
properties:
id:
type: integer
format: int32
example: 1
username:
type: string
example: admin
name:
type: string
example: Administrator
state:
type: string
example: active
avatar_url:
type: string
example: https://gravatar.com/avatar/1
avatar_path:
type: string
example: /user/avatar/28/The-Big-Lebowski-400-400.png
custom_attributes:
type: array
items:
$ref: '#/components/schemas/API_Entities_CustomAttribute'
web_url:
type: string
example: https://gitlab.example.com/root
email:
type: string
API_Entities_Platform_Kubernetes:
type: object
properties:
api_url:
type: string
namespace:
type: string
authorization_type:
type: string
ca_cert:
type: string
API_Entities_Provider_Gcp:
type: object
properties:
cluster_id:
type: string
status_name:
type: string
gcp_project_id:
type: string
zone:
type: string
machine_type:
type: string
num_nodes:
type: string
endpoint:
type: string
API_Entities_ProjectIdentity:
type: object
properties:
id:
type: integer
format: int32
example: 1
description:
type: string
example: desc
name:
type: string
example: project1
name_with_namespace:
type: string
example: John Doe / project1
path:
type: string
example: project1
path_with_namespace:
type: string
example: namespace1/project1
created_at:
type: string
format: date-time
example: 2020-05-07T04:27:17.016Z
API_Entities_Application:
type: object
properties:
id:
type: string
application_id:
type: string
example: 5832fc6e14300a0d962240a8144466eef4ee93ef0d218477e55f11cf12fc3737
application_name:
type: string
example: MyApplication
callback_url:
type: string
example: https://redirect.uri
confidential:
type: boolean
example: true
description: API_Entities_Application model
API_Entities_ApplicationWithSecret:
type: object
properties:
id:
type: string
application_id:
type: string
example: 5832fc6e14300a0d962240a8144466eef4ee93ef0d218477e55f11cf12fc3737
application_name:
type: string
example: MyApplication
callback_url:
type: string
example: https://redirect.uri
confidential:
type: boolean
example: true
secret:
type: string
example: ee1dd64b6adc89cf7e2c23099301ccc2c61b441064e9324d963c46902a85ec34
description: API_Entities_ApplicationWithSecret model
API_Entities_Avatar:
type: object
properties:
avatar_url:
type: string
description: API_Entities_Avatar model
API_Entities_BroadcastMessage:
type: object
properties:
id:
type: string
message:
type: string
starts_at:
type: string
ends_at:
type: string
color:
type: string
font:
type: string
target_access_levels:
type: string
target_path:
type: string
broadcast_type:
type: string
dismissable:
type: string
active:
type: string
description: API_Entities_BroadcastMessage model
API_Entities_BulkImports:
type: object
properties:
id:
type: integer
format: int32
example: 1
bulk_import_id:
type: integer
format: int32
example: 1
status:
type: string
example: created
enum:
- created
- started
- finished
- timeout
- failed
entity_type:
type: string
enum:
- group
- project
source_full_path:
type: string
example: source_group
destination_full_path:
type: string
example: some_group/source_project
destination_name:
type: string
example: destination_slug
destination_slug:
type: string
example: destination_slug
destination_namespace:
type: string
example: destination_path
parent_id:
type: integer
format: int32
example: 1
namespace_id:
type: integer
format: int32
example: 1
project_id:
type: integer
format: int32
example: 1
created_at:
type: string
format: date-time
example: 2012-05-28T04:42:42-07:00
updated_at:
type: string
format: date-time
example: 2012-05-28T04:42:42-07:00
failures:
type: array
items:
$ref: '#/components/schemas/API_Entities_BulkImports_EntityFailure'
migrate_projects:
type: boolean
example: true
description: API_Entities_BulkImports model
API_Entities_BulkImports_EntityFailure:
type: object
properties:
relation:
type: string
example: group
step:
type: string
example: extractor
exception_message:
type: string
example: error message
exception_class:
type: string
example: Exception
correlation_id_value:
type: string
example: dfcf583058ed4508e4c7c617bd7f0edd
created_at:
type: string
format: date-time
example: 2012-05-28T04:42:42-07:00
pipeline_class:
type: string
example: BulkImports::Groups::Pipelines::GroupPipeline
pipeline_step:
type: string
example: extractor
API_Entities_BulkImport:
type: object
properties:
id:
type: integer
format: int32
example: 1
status:
type: string
example: finished
enum:
- created
- started
- finished
- timeout
- failed
source_type:
type: string
example: gitlab
created_at:
type: string
format: date-time
example: 2012-05-28T04:42:42-07:00
updated_at:
type: string
format: date-time
example: 2012-05-28T04:42:42-07:00
description: API_Entities_BulkImport model
API_Entities_Appearance:
type: object
properties:
title:
type: string
description:
type: string
pwa_name:
type: string
pwa_short_name:
type: string
pwa_description:
type: string
logo:
type: string
pwa_icon:
type: string
header_logo:
type: string
favicon:
type: string
new_project_guidelines:
type: string
profile_image_guidelines:
type: string
header_message:
type: string
footer_message:
type: string
message_background_color:
type: string
message_font_color:
type: string
email_header_and_footer_enabled:
type: string
description: API_Entities_Appearance model
API_Entities_PlanLimit:
type: object
properties:
ci_pipeline_size:
type: integer
format: int32
example: 0
ci_active_jobs:
type: integer
format: int32
example: 0
ci_project_subscriptions:
type: integer
format: int32
example: 2
ci_pipeline_schedules:
type: integer
format: int32
example: 10
ci_needs_size_limit:
type: integer
format: int32
example: 50
ci_registered_group_runners:
type: integer
format: int32
example: 1000
ci_registered_project_runners:
type: integer
format: int32
example: 1000
conan_max_file_size:
type: integer
format: int32
example: 3221225472
enforcement_limit:
type: integer
format: int32
example: 15000
generic_packages_max_file_size:
type: integer
format: int32
example: 5368709120
helm_max_file_size:
type: integer
format: int32
example: 5242880
limits_history:
type: object
properties: {}
example: |-
{"enforcement_limit"=>[{"timestamp"=>1686909124, "user_id"=>1, "username"=>"x", "value"=>5}],
"notification_limit"=>[{"timestamp"=>1686909124, "user_id"=>2, "username"=>"y", "value"=>7}]}
maven_max_file_size:
type: integer
format: int32
example: 3221225472
notification_limit:
type: integer
format: int32
example: 15000
npm_max_file_size:
type: integer
format: int32
example: 524288000
nuget_max_file_size:
type: integer
format: int32
example: 524288000
pipeline_hierarchy_size:
type: integer
format: int32
example: 1000
pypi_max_file_size:
type: integer
format: int32
example: 3221225472
terraform_module_max_file_size:
type: integer
format: int32
example: 1073741824
storage_size_limit:
type: integer
format: int32
example: 15000
description: API_Entities_PlanLimit model
API_Entities_Metadata:
type: object
properties:
version:
type: string
example: 15.2-pre
revision:
type: string
example: c401a659d0c
kas:
type: object
properties:
enabled:
type: boolean
externalUrl:
type: string
example: grpc://gitlab.example.com:8150
version:
type: string
example: 15.0.0
enterprise:
type: boolean
description: API_Entities_Metadata model
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: Private-Token
|