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
|
consumes:
- application/json
produces:
- application/json
swagger: "2.0"
info:
description: |
This is the documentation for the Giant Swarm API starting at version `v4`.
For an introduction to Giant Swarm, refer to the [documentation site](https://docs.giantswarm.io/).
The Giant Swarm API attempts to behave in a __restful__ way. As a developer, you access resources using the `GET` method and, for example, delete them using the same path and the `DELETE` method.
Accessing resources via GET usually returns all information available about a resource, while collections, like for example the list of all clusters you have access to, only contain a selected few attributes of each member item.
Some requests, like for example the request to create a new cluster, don't return the resource itself. Instead, the response delivers a standard message body, showing a `code` and a `message` part. The `message` contains information for you or a client's end user. The `code` attribute contains some string (example: `RESOURCE_CREATED`) that is supposed to give you details on the state of the operation, in addition to standard HTTP status codes. This message format is also used in the case of errors. We provide a [list of all response codes](https://github.com/giantswarm/api-spec/blob/master/details/RESPONSE_CODES.md) outside this documentation.
Feedback on the API as well as this documentation is welcome via `support@giantswarm.io` or on IRC channel [#giantswarm](irc://irc.freenode.org:6667/#giantswarm) on freenode.
## Source
The source of this documentation is available on [GitHub](https://github.com/giantswarm/api-spec).
title: The Giant Swarm API v4
termsOfService: https://giantswarm.io/terms/
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
version: 4.0.0
paths:
/v4/auth-tokens/:
post:
description: |
Creates a Auth Token for a given user. Must authenticate with email and password.
tags:
- auth tokens
summary: Create Auth Token (Login)
operationId: createAuthToken
parameters:
- type: string
description: |
A randomly generated key that can be used to track a request throughout
services of Giant Swarm.
name: X-Request-ID
in: header
- type: string
description: |
Name of an activity to track, like "list-clusters". This allows to
analyze several API requests sent in context and gives an idea on
the purpose.
name: X-Giant-Swarm-Activity
in: header
- type: string
description: |
If activity has been issued by a CLI, this header can contain the
command line
name: X-Giant-Swarm-CmdLine
in: header
- x-examples:
application/json:
email: developer@example.com
password_base64: cGFzc3dvcmQ=
description: Create Auth Token Request
name: body
in: body
required: true
schema:
$ref: '#/definitions/v4CreateAuthTokenRequest'
responses:
"200":
description: Success
schema:
$ref: '#/definitions/v4CreateAuthTokenResponse'
examples:
application/json:
auth_token: e5239484-2299-41df-b901-d0568db7e3f9
"401":
description: Permission denied
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: PERMISSION_DENIED
message: The requested resource cannot be accessed using the provided
authentication details.
delete:
description: |
Deletes the authentication token provided in the Authorization header. This effectively logs you out.
tags:
- auth tokens
summary: Delete Auth Token (Logout)
operationId: deleteAuthToken
parameters:
- type: string
description: As described in the [authentication](#section/Authentication)
section
name: Authorization
in: header
required: true
- type: string
description: |
A randomly generated key that can be used to track a request throughout
services of Giant Swarm.
name: X-Request-ID
in: header
- type: string
description: |
Name of an activity to track, like "list-clusters". This allows to
analyze several API requests sent in context and gives an idea on
the purpose.
name: X-Giant-Swarm-Activity
in: header
- type: string
description: |
If activity has been issued by a CLI, this header can contain the
command line
name: X-Giant-Swarm-CmdLine
in: header
responses:
"200":
description: Success
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: RESOURCE_DELETED
message: The authentication token has been succesfully deleted.
"401":
description: Permission denied
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: PERMISSION_DENIED
message: The requested resource cannot be accessed using the provided
authentication details.
/v4/clusters/:
get:
description: |
This operation fetches a list of clusters.
The result depends on the permissions of the user.
A normal user will get all the clusters the user has access
to, via organization membership.
A user with admin permission will receive a list of all existing
clusters.
The result array items are sparse representations of the cluster objects.
To fetch more details on a cluster, use the [getCluster](#operation/getCluster)
operation.
tags:
- clusters
summary: Get clusters
operationId: getClusters
parameters:
- type: string
description: As described in the [authentication](#section/Authentication)
section
name: Authorization
in: header
required: true
- type: string
description: |
A randomly generated key that can be used to track a request throughout
services of Giant Swarm.
name: X-Request-ID
in: header
- type: string
description: |
Name of an activity to track, like "list-clusters". This allows to
analyze several API requests sent in context and gives an idea on
the purpose.
name: X-Giant-Swarm-Activity
in: header
- type: string
description: |
If activity has been issued by a CLI, this header can contain the
command line
name: X-Giant-Swarm-CmdLine
in: header
responses:
"200":
description: Success
schema:
type: array
items:
$ref: '#/definitions/v4ClusterListItem'
examples:
application/json:
- create_date: "2017-06-08T12:31:47.215Z"
id: g8s3o
name: Staging Cluster
owner: acme
- create_date: "2017-05-22T13:58:02.024Z"
id: 3dkr6
name: Test Cluster
owner: testorg
"401":
description: Permission denied
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: PERMISSION_DENIED
message: The requested resource cannot be accessed using the provided
authentication details.
default:
description: Error
schema:
$ref: '#/definitions/v4GenericResponse'
post:
description: |
This operation is used to create a new Kubernetes cluster for an
organization. The desired configuration can be specified using the
__cluster definition format__ (see
[external documentation](https://github.com/giantswarm/api-spec/blob/master/details/CLUSTER_DEFINITION.md)
for details).
The cluster definition format allows to set a number of optional
configuration details, like memory size and number of CPU cores.
However, one attribute is __mandatory__ upon creation: The `owner`
attribute must carry the name of the organization the cluster will
belong to. Note that the acting user must be a member of that
organization in order to create a cluster.
It is *recommended* to also specify the `name` attribute to give the
cluster a friendly name, like e. g. "Development Cluster".
Additional definition attributes can be used. Where attributes are
omitted, default configuration values will be applied. For example, if
no `release_version` is specified, the most recent version is used.
The `workers` attribute, if present, must contain an array of node
definition objects. The number of objects given determines the number
of workers created.
For example, requesting three worker nodes with default configuration
can be achieved by submitting an array of three empty objects:
```"workers": [{}, {}, {}]```
For clusters on AWS, note that all worker nodes must use the same instance type.
tags:
- clusters
summary: Create cluster
operationId: addCluster
parameters:
- type: string
description: As described in the [authentication](#section/Authentication)
section
name: Authorization
in: header
required: true
- type: string
description: |
A randomly generated key that can be used to track a request throughout
services of Giant Swarm.
name: X-Request-ID
in: header
- type: string
description: |
Name of an activity to track, like "list-clusters". This allows to
analyze several API requests sent in context and gives an idea on
the purpose.
name: X-Giant-Swarm-Activity
in: header
- type: string
description: |
If activity has been issued by a CLI, this header can contain the
command line
name: X-Giant-Swarm-CmdLine
in: header
- x-examples:
application/json:
name: Example cluster with 3 default worker nodes
owner: myteam
release_version: 1.4.2
workers:
- {}
- {}
- {}
description: New cluster definition
name: body
in: body
required: true
schema:
$ref: '#/definitions/v4AddClusterRequest'
responses:
"201":
description: Cluster created
schema:
$ref: '#/definitions/v4GenericResponse'
headers:
Location:
type: string
description: URI to obtain details on the new cluster using the [getCluster](#operation/getCluster)
operation
examples:
application/json:
code: RESOURCE_CREATED
message: A new cluster has been created with ID 'wqtlq'
"401":
description: Permission denied
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: PERMISSION_DENIED
message: The requested resource cannot be accessed using the provided
authentication details.
default:
description: error
schema:
$ref: '#/definitions/v4GenericResponse'
/v4/clusters/{cluster_id}/:
get:
description: |
This operation allows to obtain all available details on a particular cluster.
tags:
- clusters
summary: Get cluster details
operationId: getCluster
parameters:
- type: string
description: As described in the [authentication](#section/Authentication)
section
name: Authorization
in: header
required: true
- type: string
description: |
A randomly generated key that can be used to track a request throughout
services of Giant Swarm.
name: X-Request-ID
in: header
- type: string
description: |
Name of an activity to track, like "list-clusters". This allows to
analyze several API requests sent in context and gives an idea on
the purpose.
name: X-Giant-Swarm-Activity
in: header
- type: string
description: |
If activity has been issued by a CLI, this header can contain the
command line
name: X-Giant-Swarm-CmdLine
in: header
- type: string
description: Cluster ID
name: cluster_id
in: path
required: true
responses:
"200":
description: Cluster details
schema:
$ref: '#/definitions/v4ClusterDetailsResponse'
examples:
application/json:
api_endpoint: https://api.wqtlq.example.com
create_date: "2017-03-03T10:50:45.949270905Z"
id: wqtlq
kubernetes_version: ""
kvm:
port_mappings:
- port: 30020
protocol: http
- port: 30021
protocol: https
name: Just a Standard Cluster
owner: acme
release_version: 2.5.16
workers:
- cpu:
cores: 4
labels:
beta.kubernetes.io/arch: amd64
beta.kubernetes.io/os: linux
ip: 10.3.11.2
kubernetes.io/hostname: worker-1.x882ofna.k8s.gigantic.io
nodetype: hicpu
memory:
size_gb: 2
storage:
size_gb: 20
- cpu:
cores: 2
labels:
beta.kubernetes.io/arch: amd64
beta.kubernetes.io/os: linux
ip: 10.3.62.2
kubernetes.io/hostname: worker-2.x882ofna.k8s.gigantic.io
nodetype: hiram
memory:
size_gb: 8
storage:
size_gb: 20
"401":
description: Permission denied
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: PERMISSION_DENIED
message: The requested resource cannot be accessed using the provided
authentication details.
"404":
description: Cluster not found
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: RESOURCE_NOT_FOUND
message: The cluster with ID 'wqtlq' could not be found, or perhaps
you do not have access to it. Please make sure the cluster ID is correct,
and that you are a member of the organization that it belongs to.
default:
description: error
schema:
$ref: '#/definitions/v4GenericResponse'
delete:
description: |
This operation allows to delete a cluster.
__Caution:__ Deleting a cluster causes the termination of all workloads running on the cluster. Data stored on the worker nodes will be lost. There is no way to undo this operation.
The response is sent as soon as the request is validated.
At that point, workloads might still be running on the cluster and may be accessible for a little wile, until the cluster is actually deleted.
tags:
- clusters
summary: Delete cluster
operationId: deleteCluster
parameters:
- type: string
description: As described in the [authentication](#section/Authentication)
section
name: Authorization
in: header
required: true
- type: string
description: |
A randomly generated key that can be used to track a request throughout
services of Giant Swarm.
name: X-Request-ID
in: header
- type: string
description: |
Name of an activity to track, like "list-clusters". This allows to
analyze several API requests sent in context and gives an idea on
the purpose.
name: X-Giant-Swarm-Activity
in: header
- type: string
description: |
If activity has been issued by a CLI, this header can contain the
command line
name: X-Giant-Swarm-CmdLine
in: header
- type: string
description: Cluster ID
name: cluster_id
in: path
required: true
responses:
"202":
description: Deleting cluster
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: RESOURCE_DELETION_STARTED
message: The cluster with ID 'wqtlq' is being deleted.
"401":
description: Permission denied
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: PERMISSION_DENIED
message: The requested resource cannot be accessed using the provided
authentication details.
"404":
description: Cluster not found
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: RESOURCE_NOT_FOUND
message: The cluster with ID 'wqtlq' could not be found, or perhaps
you do not have access to it. Please make sure the cluster ID is correct,
and that you are a member of the organization that it belongs to.
default:
description: error
schema:
$ref: '#/definitions/v4GenericResponse'
patch:
description: |
This operation allows to modify an existing cluster.
A cluster modification is performed by submitting a `PATCH` request
to the cluster resource (as described in the
[addCluster](#operation/addCluster) and [getCluster](#operation/getCluster))
in form of a [JSON Patch Merge
(RFC 7386)](https://tools.ietf.org/html/rfc7386). This means, only the
attributes to be modified have to be contained in the request body.
The following attributes can be modified:
- `name`: Rename the cluster to something more fitting.
- `owner`: Changing the owner organization name means to change cluster
ownership from one organization to another. The user performing the
request has to be a member of both organizations.
- `release_version`: By changing this attribute you can upgrade a
cluster to a newer
[release](https://docs.giantswarm.io/api/#tag/releases).
- `workers`: By modifying the array of workers, nodes can be added to
increase the cluster's capacity. See details below.
### Adding and Removing Worker Nodes (Scaling)
Adding worker nodes to a cluster or removing worker nodes from a cluster
works by submitting the `workers` attribute, which contains a (sparse)
array of worker node defintions.
_Sparse_ here means that all configuration details are optional. In the
case that worker nodes are added to a cluster, wherever a configuration
detail is missing, defaults will be applied. See
[Creating a cluster](#operation/addCluster) for details.
When modifying the cluster resource, you describe the desired state.
For scaling, this means that the worker node array submitted must
contain as many elements as the cluster should have worker nodes.
If your cluster currently has five nodes and you submit a workers
array with four elements, this means that one worker node will be removed.
If your submitted workers array has six elements, this means one will
be added.
As an example, this request body could be used to scale a cluster to
three worker nodes:
```json
{
"workers": [{}, {}, {}]
}
```
If the scaled cluster had four worker nodes before, one would be removed.
If it had two worker nodes before, one with default settings would be
added.
### Limitations
- As of now, existing worker nodes cannot be modified.
- When removing nodes (scaling down), it is not possible to determine
which nodes will be removed.
- On AWS based clusters, all worker nodes must use the same EC2 instance
type (`instance_type` node attribute). By not setting an `instance_type`
when submitting a PATCH request, you ensure that the right instance type
is used automatically.
tags:
- clusters
summary: Modify cluster
operationId: modifyCluster
parameters:
- type: string
description: As described in the [authentication](#section/Authentication)
section
name: Authorization
in: header
required: true
- type: string
description: |
A randomly generated key that can be used to track a request throughout
services of Giant Swarm.
name: X-Request-ID
in: header
- type: string
description: |
Name of an activity to track, like "list-clusters". This allows to
analyze several API requests sent in context and gives an idea on
the purpose.
name: X-Giant-Swarm-Activity
in: header
- type: string
description: |
If activity has been issued by a CLI, this header can contain the
command line
name: X-Giant-Swarm-CmdLine
in: header
- x-examples:
application/merge-patch+json:
name: New cluster name
description: Merge-patch body
name: body
in: body
required: true
schema:
$ref: '#/definitions/v4ModifyClusterRequest'
- type: string
description: Cluster ID
name: cluster_id
in: path
required: true
responses:
"200":
description: Cluster modified
schema:
$ref: '#/definitions/v4ClusterDetailsResponse'
"401":
description: Permission denied
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: PERMISSION_DENIED
message: The requested resource cannot be accessed using the provided
authentication details.
"404":
description: Cluster not found
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: RESOURCE_NOT_FOUND
message: The cluster with ID 'wqtlq' could not be found, or perhaps
you do not have access to it. Please make sure the cluster ID is correct,
and that you are a member of the organization that it belongs to.
default:
description: error
schema:
$ref: '#/definitions/v4GenericResponse'
/v4/clusters/{cluster_id}/key-pairs/:
get:
description: |
Returns a list of information on all key pairs of a cluster as an array.
The individual array items contain metadata on the key pairs, but neither the key nor the certificate. These can only be obtained upon creation, using the [addKeypair](#operation/addKeyPair) operation.
tags:
- key pairs
summary: Get key pairs
operationId: getKeyPairs
parameters:
- type: string
description: As described in the [authentication](#section/Authentication)
section
name: Authorization
in: header
required: true
- type: string
description: |
A randomly generated key that can be used to track a request throughout
services of Giant Swarm.
name: X-Request-ID
in: header
- type: string
description: |
Name of an activity to track, like "list-clusters". This allows to
analyze several API requests sent in context and gives an idea on
the purpose.
name: X-Giant-Swarm-Activity
in: header
- type: string
description: |
If activity has been issued by a CLI, this header can contain the
command line
name: X-Giant-Swarm-CmdLine
in: header
- type: string
description: Cluster ID
name: cluster_id
in: path
required: true
responses:
"200":
description: Key pairs
schema:
$ref: '#/definitions/v4GetKeyPairsResponse'
"401":
description: Permission denied
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: PERMISSION_DENIED
message: The requested resource cannot be accessed using the provided
authentication details.
default:
description: error
schema:
$ref: '#/definitions/v4GenericResponse'
post:
description: |
This operation allows to create a new key pair for accessing a specific cluster.
A key pair consists of an unencrypted private RSA key and an X.509 certificate. In addition, when obtaining a key pair for a cluster, the cluster's certificate authority file (CA certificate) is delivered, which is required by TLS clients to establish trust to the cluster.
In addition to the credentials itself, a key pair has some metadata like a unique ID, a creation timestamp and a free text `description` that you can use at will, for example to note for whom a key pair has been issued.
### Customizing the certificate's subject for K8s RBAC
It is possible to set the Common Name and Organization fields of the generated certificate's subject.
- `cn_prefix`: The certificate's common name uses this format: `<cn_prefix>.user.<clusterdomain>`.
`clusterdomain` is specific to your cluster and is not editable.
The `cn_prefix` however is editable. When left blank it will default
to the email address of the Giant Swarm user that is performing the
create key pair request.
The common name is used as the username for requests to the Kubernetes API. This allows you
to set up role-based access controls.
- `certificate_organizations`: This will set the certificate's `organization` fields. Use a comma separated list of values.
The Kubernetes API will use these values as group memberships.
__Note:__ The actual credentials coming with the key pair (key, certificate) can only be accessed once, as the result of the `POST` request that triggers their creation. This restriction exists to minimize the risk of credentials being leaked. If you fail to capture the credentials upon creation, you'll have to repeat the creation request.
tags:
- key pairs
summary: Create key pair
operationId: addKeyPair
parameters:
- type: string
description: As described in the [authentication](#section/Authentication)
section
name: Authorization
in: header
required: true
- type: string
description: |
A randomly generated key that can be used to track a request throughout
services of Giant Swarm.
name: X-Request-ID
in: header
- type: string
description: |
Name of an activity to track, like "list-clusters". This allows to
analyze several API requests sent in context and gives an idea on
the purpose.
name: X-Giant-Swarm-Activity
in: header
- type: string
description: |
If activity has been issued by a CLI, this header can contain the
command line
name: X-Giant-Swarm-CmdLine
in: header
- type: string
description: Cluster ID
name: cluster_id
in: path
required: true
- x-examples:
application/json:
certificate_organizations: system:masters
description: Admin key pair lasting twelve hours
ttl_hours: 12
description: |
While the `ttl_hours` attribute is optional and will be set to a default value when omitted, the `description` is mandatory.
name: body
in: body
required: true
schema:
$ref: '#/definitions/v4AddKeyPairRequest'
responses:
"200":
description: Success
schema:
$ref: '#/definitions/v4AddKeyPairResponse'
examples:
application/json:
certificate_authority_data: '-----BEGIN CERTIFICATE-----...-----END
CERTIFICATE-----'
client_certificate_data: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----'
client_key_data: '-----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE
KEY-----'
create_date: "2016-06-01T12:00:00.000Z"
description: Key pair description
id: 02:cc:da:f9:fb:ce:c3:e5:e1:f6:27:d8:43:48:0d:37:4a:ee:b9:67
ttl_hours: 8640
"401":
description: Permission denied
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: PERMISSION_DENIED
message: The requested resource cannot be accessed using the provided
authentication details.
/v4/info/:
get:
description: |
Returns a set of details on the installation. The output varies based
on the provider used in the installation.
This information is useful for example when creating new cluster, to
prevent creating clusters with more worker nodes than possible.
### Example for an AWS-based installation
```json
{
"general": {
"installation_name": "shire",
"provider": "aws",
"datacenter": "eu-central-1"
},
"workers": {
"count_per_cluster": {
"max": 20,
"default": 3
},
"instance_type": {
"options": [
"m3.medium", "m3.large", "m3.xlarge"
],
"default": "m3.large"
}
}
}
```
### Example for a KVM-based installation
```json
{
"general": {
"installation_name": "isengard",
"provider": "kvm",
"datacenter": "string"
},
"workers": {
"count_per_cluster": {
"max": 8,
"default": 3
},
}
}
```
tags:
- info
summary: Get information on the installation
operationId: getInfo
parameters:
- type: string
description: As described in the [authentication](#section/Authentication)
section
name: Authorization
in: header
required: true
- type: string
description: |
A randomly generated key that can be used to track a request throughout
services of Giant Swarm.
name: X-Request-ID
in: header
- type: string
description: |
Name of an activity to track, like "list-clusters". This allows to
analyze several API requests sent in context and gives an idea on
the purpose.
name: X-Giant-Swarm-Activity
in: header
- type: string
description: |
If activity has been issued by a CLI, this header can contain the
command line
name: X-Giant-Swarm-CmdLine
in: header
responses:
"200":
description: Information
schema:
$ref: '#/definitions/v4InfoResponse'
examples:
application/json:
general:
datacenter: eu-central-1
installation_name: shire
provider: aws
workers:
count_per_cluster:
default: 3
max: 20
instance_type:
default: m3.large
options:
- m3.medium
- m3.large
- m3.xlarge
"401":
description: Permission denied
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: PERMISSION_DENIED
message: The requested resource cannot be accessed using the provided
authentication details.
default:
description: Error
schema:
$ref: '#/definitions/v4GenericResponse'
/v4/organizations/:
get:
description: |
This operation allows to fetch a list of organizations the user is a
member of. In the case of an admin user, the result includes all
existing organizations.
tags:
- organizations
summary: Get organizations
operationId: getOrganizations
parameters:
- type: string
description: As described in the [authentication](#section/Authentication)
section
name: Authorization
in: header
required: true
- type: string
description: |
A randomly generated key that can be used to track a request throughout
services of Giant Swarm.
name: X-Request-ID
in: header
- type: string
description: |
Name of an activity to track, like "list-clusters". This allows to
analyze several API requests sent in context and gives an idea on
the purpose.
name: X-Giant-Swarm-Activity
in: header
- type: string
description: |
If activity has been issued by a CLI, this header can contain the
command line
name: X-Giant-Swarm-CmdLine
in: header
responses:
"200":
description: Success
schema:
type: array
items:
$ref: '#/definitions/v4OrganizationListItem'
examples:
application/json:
- id: acme
- id: giantswarm
- id: testorg
"401":
description: Permission denied
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: PERMISSION_DENIED
message: The requested resource cannot be accessed using the provided
authentication details.
default:
description: Error
schema:
$ref: '#/definitions/v4GenericResponse'
/v4/organizations/{organization_id}/:
get:
description: |
This operation fetches organization details.
tags:
- organizations
summary: Get organization details
operationId: getOrganization
parameters:
- type: string
description: As described in the [authentication](#section/Authentication)
section
name: Authorization
in: header
required: true
- type: string
description: |
A randomly generated key that can be used to track a request throughout
services of Giant Swarm.
name: X-Request-ID
in: header
- type: string
description: |
Name of an activity to track, like "list-clusters". This allows to
analyze several API requests sent in context and gives an idea on
the purpose.
name: X-Giant-Swarm-Activity
in: header
- type: string
description: |
If activity has been issued by a CLI, this header can contain the
command line
name: X-Giant-Swarm-CmdLine
in: header
- type: string
description: |
An ID for the organization.
This ID must be unique and match this regular
expression: ^[a-z0-9_]{4,30}$
name: organization_id
in: path
required: true
responses:
"200":
description: Organization details
schema:
$ref: '#/definitions/v4Organization'
examples:
application/json:
id: acme
members:
- email: user1@example.com
- email: user2@example.com
"401":
description: Permission denied
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: PERMISSION_DENIED
message: The requested resource cannot be accessed using the provided
authentication details.
"404":
description: Organization not found
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: RESOURCE_NOT_FOUND
message: 'The organization could not be found. (not found: the organization
with id ''acme'' could not be found)'
default:
description: Error
schema:
$ref: '#/definitions/v4GenericResponse'
put:
description: |
This operation allows a user to create an organization.
tags:
- organizations
summary: Create an organization
operationId: addOrganization
parameters:
- type: string
description: As described in the [authentication](#section/Authentication)
section
name: Authorization
in: header
required: true
- type: string
description: |
A randomly generated key that can be used to track a request throughout
services of Giant Swarm.
name: X-Request-ID
in: header
- type: string
description: |
Name of an activity to track, like "list-clusters". This allows to
analyze several API requests sent in context and gives an idea on
the purpose.
name: X-Giant-Swarm-Activity
in: header
- type: string
description: |
If activity has been issued by a CLI, this header can contain the
command line
name: X-Giant-Swarm-CmdLine
in: header
- type: string
description: |
An ID for the organization.
This ID must be unique and match this regular
expression: ^[a-z0-9_]{4,30}$
name: organization_id
in: path
required: true
- x-examples:
application/json:
id: string
members:
- email: myself@example.com
- email: colleague@example.com
name: body
in: body
required: true
schema:
$ref: '#/definitions/v4Organization'
responses:
"201":
description: Organization created
schema:
$ref: '#/definitions/v4Organization'
examples:
application/json:
id: acme
members:
- email: user1@example.com
- email: user2@example.com
"401":
description: Permission denied
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: PERMISSION_DENIED
message: The requested resource cannot be accessed using the provided
authentication details.
"409":
description: Organization already exists
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: RESOURCE_ALREADY_EXISTS
message: The organization could not be created. (org already exists)
default:
description: Error
schema:
$ref: '#/definitions/v4GenericResponse'
delete:
description: |
This operation allows a user to delete an organization that they are a member of.
Admin users can delete any organization.
tags:
- organizations
summary: Delete an organization
operationId: deleteOrganization
parameters:
- type: string
description: As described in the [authentication](#section/Authentication)
section
name: Authorization
in: header
required: true
- type: string
description: |
A randomly generated key that can be used to track a request throughout
services of Giant Swarm.
name: X-Request-ID
in: header
- type: string
description: |
Name of an activity to track, like "list-clusters". This allows to
analyze several API requests sent in context and gives an idea on
the purpose.
name: X-Giant-Swarm-Activity
in: header
- type: string
description: |
If activity has been issued by a CLI, this header can contain the
command line
name: X-Giant-Swarm-CmdLine
in: header
- type: string
description: |
An ID for the organization.
This ID must be unique and match this regular
expression: ^[a-z0-9_]{4,30}$
name: organization_id
in: path
required: true
responses:
"200":
description: Organization deleted
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: RESOURCE_DELETED
message: The organization with ID 'acme' has been deleted.
"401":
description: Permission denied
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: PERMISSION_DENIED
message: The requested resource cannot be accessed using the provided
authentication details.
"404":
description: Organization not found
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: RESOURCE_NOT_FOUND
message: 'The organization could not be deleted. (not found: the organization
with id ''acme'' could not be found)'
default:
description: Error
schema:
$ref: '#/definitions/v4GenericResponse'
patch:
description: |
This operation allows you to modify an existing organization. You must be
a member of the organization or an admin in order to use this endpoint.
The following attributes can be modified:
- `members`: By modifying the array of members, members can be added to or removed from the organization
The request body must conform with the [JSON Patch Merge (RFC 7386)](https://tools.ietf.org/html/rfc7386) standard.
Requests have to be sent with the `Content-Type: application/merge-patch+json` header.
The full request must be valid before it will be executed, currently this
means every member you attempt to add to the organization must actually
exist in the system. If any member you attempt to add is invalid, the entire
patch operation will fail, no members will be added or removed, and an error message
will explain which members in your request are invalid.
tags:
- organizations
summary: Modify organization
operationId: modifyOrganization
parameters:
- type: string
description: As described in the [authentication](#section/Authentication)
section
name: Authorization
in: header
required: true
- type: string
description: |
A randomly generated key that can be used to track a request throughout
services of Giant Swarm.
name: X-Request-ID
in: header
- type: string
description: |
Name of an activity to track, like "list-clusters". This allows to
analyze several API requests sent in context and gives an idea on
the purpose.
name: X-Giant-Swarm-Activity
in: header
- type: string
description: |
If activity has been issued by a CLI, this header can contain the
command line
name: X-Giant-Swarm-CmdLine
in: header
- type: string
description: |
An ID for the organization.
This ID must be unique and match this regular
expression: ^[a-z0-9_]{4,30}$
name: organization_id
in: path
required: true
- x-examples:
application/merge-patch+json:
members:
- email: myself@example.com
name: body
in: body
required: true
schema:
$ref: '#/definitions/modifyOrganizationParamsBody'
responses:
"200":
description: Organization modified
schema:
$ref: '#/definitions/v4Organization'
"400":
description: Invalid input
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: INVALID_INPUT
message: 'The organization could not be modified. (invalid input: user
''invalid-email'' does not exist or is invalid)'
"401":
description: Permission denied
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: PERMISSION_DENIED
message: The requested resource cannot be accessed using the provided
authentication details.
"404":
description: Organization not found
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: RESOURCE_NOT_FOUND
message: 'The organization could not be modified. (not found: the organization
with id ''acme'' could not be found)'
default:
description: error
schema:
$ref: '#/definitions/v4GenericResponse'
/v4/organizations/{organization_id}/credentials/:
post:
description: |
Add a set of credentials to the organization allowing the creation and
operation of clusters within a cloud provider account/subscription.
The actual type of these credentials depends on the cloud provider the
installation is running on. Currently, only AWS is supported, with
support for Azure being planned for the near future.
Credentials in an organization are immutable. Each organization can only
have one set of credentials.
Once credentials have been set for an organization, they are used for
every new cluster that will be created for the organization.
### Example request body for AWS
```json
{
"provider": "aws",
"aws": {
"roles": {
"admin": "arn:aws:iam::123456789012:role/GiantSwarmAdmin",
"awsoperator": "arn:aws:iam::123456789012:role/GiantSwarmAWSOperator"
}
}
}
```
tags:
- organizations
summary: Set credentials
operationId: addCredentials
parameters:
- type: string
description: As described in the [authentication](#section/Authentication)
section
name: Authorization
in: header
required: true
- type: string
description: |
A randomly generated key that can be used to track a request throughout
services of Giant Swarm.
name: X-Request-ID
in: header
- type: string
description: |
Name of an activity to track, like "list-clusters". This allows to
analyze several API requests sent in context and gives an idea on
the purpose.
name: X-Giant-Swarm-Activity
in: header
- type: string
description: |
If activity has been issued by a CLI, this header can contain the
command line
name: X-Giant-Swarm-CmdLine
in: header
- type: string
description: |
An ID for the organization.
This ID must be unique and match this regular
expression: ^[a-z0-9_]{4,30}$
name: organization_id
in: path
required: true
- x-examples:
application/json:
aws:
roles:
admin: arn:aws:iam::123456789012:role/GiantSwarmAdmin
awsoperator: arn:aws:iam::123456789012:role/GiantSwarmAWSOperator
provider: aws
name: body
in: body
required: true
schema:
$ref: '#/definitions/v4AddCredentialsRequest'
responses:
"201":
description: Credentials created
schema:
$ref: '#/definitions/v4GenericResponse'
headers:
Location:
type: string
description: URI of the new credentials resource
examples:
application/json:
code: RESOURCE_CREATED
message: A new set of credentials has been created with ID '5d9h4'
"401":
description: Permission denied
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: PERMISSION_DENIED
message: The requested resource cannot be accessed using the provided
authentication details.
"409":
description: Conflict
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: RESOURCE_ALREADY_EXISTS
message: The organisation already has a set of credentials
default:
description: error
schema:
$ref: '#/definitions/v4GenericResponse'
/v4/releases/:
get:
description: |
Lists all releases available for new clusters or for upgrading existing
clusters. Might also serve as an archive to obtain details on older
releases.
tags:
- releases
summary: Get releases
operationId: getReleases
parameters:
- type: string
description: As described in the [authentication](#section/Authentication)
section
name: Authorization
in: header
required: true
- type: string
description: |
A randomly generated key that can be used to track a request throughout
services of Giant Swarm.
name: X-Request-ID
in: header
- type: string
description: |
Name of an activity to track, like "list-clusters". This allows to
analyze several API requests sent in context and gives an idea on
the purpose.
name: X-Giant-Swarm-Activity
in: header
- type: string
description: |
If activity has been issued by a CLI, this header can contain the
command line
name: X-Giant-Swarm-CmdLine
in: header
responses:
"200":
description: Releases list
schema:
type: array
items:
$ref: '#/definitions/v4ReleaseListItem'
examples:
application/json:
- active: false
changelog:
- component: kubernetes
description: Security fixes
- component: calico
description: Security fixes
components:
- name: kubernetes
version: 1.5.8
- name: calico
version: 0.9.1
timestamp: "2017-09-21T08:14:03.37759Z"
version: 1.14.9
- active: true
changelog:
- component: calico
description: Bugfix
components:
- name: kubernetes
version: 1.7.3
- name: calico
version: 1.1.1
timestamp: "2017-11-11T12:24:56.59969Z"
version: 2.8.4
"401":
description: Permission denied
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: PERMISSION_DENIED
message: The requested resource cannot be accessed using the provided
authentication details.
/v4/user/:
get:
description: |
Returns details about the currently authenticated user
tags:
- users
summary: Get current user
operationId: getCurrentUser
parameters:
- type: string
description: As described in the [authentication](#section/Authentication)
section
name: Authorization
in: header
required: true
- type: string
description: |
A randomly generated key that can be used to track a request throughout
services of Giant Swarm.
name: X-Request-ID
in: header
- type: string
description: |
Name of an activity to track, like "list-clusters". This allows to
analyze several API requests sent in context and gives an idea on
the purpose.
name: X-Giant-Swarm-Activity
in: header
- type: string
description: |
If activity has been issued by a CLI, this header can contain the
command line
name: X-Giant-Swarm-CmdLine
in: header
responses:
"200":
description: Success
schema:
$ref: '#/definitions/v4UserListItem'
examples:
application/json:
created: "2017-01-15T12:00:00Z"
email: andy@example.com
expiry: "2019-01-15T00:00:00Z"
"401":
description: Permission denied
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: PERMISSION_DENIED
message: The requested resource cannot be accessed using the provided
authentication details.
default:
description: Error
schema:
$ref: '#/definitions/v4GenericResponse'
/v4/users/:
get:
description: |
Returns a list of all users in the system. Currently this endpoint is only available to users with admin permissions.
tags:
- users
summary: Get users
operationId: getUsers
parameters:
- type: string
description: As described in the [authentication](#section/Authentication)
section
name: Authorization
in: header
required: true
- type: string
description: |
A randomly generated key that can be used to track a request throughout
services of Giant Swarm.
name: X-Request-ID
in: header
- type: string
description: |
Name of an activity to track, like "list-clusters". This allows to
analyze several API requests sent in context and gives an idea on
the purpose.
name: X-Giant-Swarm-Activity
in: header
- type: string
description: |
If activity has been issued by a CLI, this header can contain the
command line
name: X-Giant-Swarm-CmdLine
in: header
responses:
"200":
description: Success
schema:
type: array
items:
$ref: '#/definitions/v4UserListItem'
examples:
application/json:
- created: "2017-01-15T12:00:00Z"
email: andy@example.com
expiry: "2019-01-15T00:00:00Z"
- created: "2017-02-15T12:30:00Z"
email: bob@example.com
expiry: "2020-01-15T00:00:00Z"
- created: "2017-03-15T13:00:00Z"
email: charles@example.com
expiry: "2021-01-15T00:00:00Z"
"401":
description: Permission denied
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: PERMISSION_DENIED
message: The requested resource cannot be accessed using the provided
authentication details.
default:
description: Error
schema:
$ref: '#/definitions/v4GenericResponse'
/v4/users/{email}/:
get:
description: |
Returns details about a specific user
tags:
- users
summary: Get user
operationId: getUser
parameters:
- type: string
description: As described in the [authentication](#section/Authentication)
section
name: Authorization
in: header
required: true
- type: string
description: |
A randomly generated key that can be used to track a request throughout
services of Giant Swarm.
name: X-Request-ID
in: header
- type: string
description: |
Name of an activity to track, like "list-clusters". This allows to
analyze several API requests sent in context and gives an idea on
the purpose.
name: X-Giant-Swarm-Activity
in: header
- type: string
description: |
If activity has been issued by a CLI, this header can contain the
command line
name: X-Giant-Swarm-CmdLine
in: header
- type: string
description: The user's email address
name: email
in: path
required: true
responses:
"200":
description: Success
schema:
$ref: '#/definitions/v4UserListItem'
examples:
application/json:
created: "2017-01-15T12:00:00Z"
email: andy@example.com
expiry: "2019-01-15T00:00:00Z"
"401":
description: Permission denied
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: PERMISSION_DENIED
message: The requested resource cannot be accessed using the provided
authentication details.
"404":
description: User not found
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: RESOURCE_NOT_FOUND
message: 'The user could not be found. (not found: user with email ''bob@example.com''
could not be found)'
default:
description: Error
schema:
$ref: '#/definitions/v4GenericResponse'
put:
description: |
Creates a users in the system. Currently this endpoint is only available to users with admin permissions.
tags:
- users
summary: Create user
operationId: createUser
parameters:
- type: string
description: As described in the [authentication](#section/Authentication)
section
name: Authorization
in: header
required: true
- type: string
description: |
A randomly generated key that can be used to track a request throughout
services of Giant Swarm.
name: X-Request-ID
in: header
- type: string
description: |
Name of an activity to track, like "list-clusters". This allows to
analyze several API requests sent in context and gives an idea on
the purpose.
name: X-Giant-Swarm-Activity
in: header
- type: string
description: |
If activity has been issued by a CLI, this header can contain the
command line
name: X-Giant-Swarm-CmdLine
in: header
- type: string
description: The user's email address
name: email
in: path
required: true
- x-examples:
application/json:
expiry: "2020-01-01T12:00:00.000Z"
password: cGFzc3dvcmQ=
description: User account details
name: body
in: body
required: true
schema:
$ref: '#/definitions/v4CreateUserRequest'
responses:
"201":
description: User created
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: RESOURCE_CREATED
message: The user with email 'bob@example.com' has been created.
"400":
description: User already exists
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: RESOURCE_ALREADY_EXISTS
message: 'The user could not be created. (invalid input: email ''bob@example.com''
already exists)'
"401":
description: Permission denied
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: PERMISSION_DENIED
message: The requested resource cannot be accessed using the provided
authentication details.
default:
description: Error
schema:
$ref: '#/definitions/v4GenericResponse'
delete:
description: |
Deletes a users in the system. Currently this endpoint is only available
to users with admin permissions.
tags:
- users
summary: Delete user
operationId: deleteUser
parameters:
- type: string
description: As described in the [authentication](#section/Authentication)
section
name: Authorization
in: header
required: true
- type: string
description: |
A randomly generated key that can be used to track a request throughout
services of Giant Swarm.
name: X-Request-ID
in: header
- type: string
description: |
Name of an activity to track, like "list-clusters". This allows to
analyze several API requests sent in context and gives an idea on
the purpose.
name: X-Giant-Swarm-Activity
in: header
- type: string
description: |
If activity has been issued by a CLI, this header can contain the
command line
name: X-Giant-Swarm-CmdLine
in: header
- type: string
description: The user's email address
name: email
in: path
required: true
responses:
"200":
description: User deleted
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: RESOURCE_DELETED
message: The user with email 'bob@example.com' has been deleted.
"401":
description: Permission denied
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: PERMISSION_DENIED
message: The requested resource cannot be accessed using the provided
authentication details.
"404":
description: User not found
schema:
$ref: '#/definitions/v4GenericResponse'
examples:
application/json:
code: RESOURCE_NOT_FOUND
message: 'The user could not be deleted. (not found: user with email
''bob@example.com'' could not be found)'
default:
description: Error
schema:
$ref: '#/definitions/v4GenericResponse'
definitions:
modifyOrganizationParamsBody:
type: object
properties:
members:
description: List of members that belong to this organization
type: array
items:
$ref: '#/definitions/v4OrganizationMember'
x-go-gen-location: operations
v4AddClusterRequest:
description: Request model for creating a new cluster
type: object
required:
- owner
properties:
kubernetes_version:
description: |
Kubernetes version number (deprecated). Doesn't have any effect.
This attribute is going to be removed in future API versions.
type: string
name:
description: Cluster name
type: string
owner:
description: Name of the organization owning the cluster
type: string
release_version:
description: |
The [release](https://docs.giantswarm.io/api/#tag/releases) version
to use in the new cluster
type: string
workers:
type: array
items:
$ref: '#/definitions/v4AddClusterRequestWorkersItems'
v4AddClusterRequestWorkersItems:
type: object
properties:
aws:
$ref: '#/definitions/v4AddClusterRequestWorkersItemsAws'
azure:
$ref: '#/definitions/v4AddClusterRequestWorkersItemsAzure'
cpu:
$ref: '#/definitions/v4AddClusterRequestWorkersItemsCpu'
labels:
type: object
additionalProperties: true
memory:
$ref: '#/definitions/v4AddClusterRequestWorkersItemsMemory'
storage:
$ref: '#/definitions/v4AddClusterRequestWorkersItemsStorage'
x-go-gen-location: models
v4AddClusterRequestWorkersItemsAws:
description: |
Attributes specific to nodes running on Amazon Web Services (AWS)
type: object
properties:
instance_type:
description: |
EC2 instance type name. Must be the same for all worker nodes
of a cluster.
type: string
x-go-gen-location: models
v4AddClusterRequestWorkersItemsAzure:
description: |
Attributes specific to nodes running on Microsoft Azure
type: object
properties:
vm_size:
description: |
Azure Virtual Machine size. Must be the same for all worker nodes
of a cluster.
type: string
x-go-gen-location: models
v4AddClusterRequestWorkersItemsCpu:
type: object
properties:
cores:
description: Number of CPU cores
type: integer
x-go-gen-location: models
v4AddClusterRequestWorkersItemsMemory:
type: object
properties:
size_gb:
description: RAM size in GB. Can be an integer or float.
type: number
x-go-gen-location: models
v4AddClusterRequestWorkersItemsStorage:
type: object
properties:
size_gb:
description: Node storage size in GB. Can be an integer or float.
type: number
x-go-gen-location: models
v4AddCredentialsRequest:
description: Request model for adding a set of credentials
type: object
required:
- provider
properties:
aws:
$ref: '#/definitions/v4AddCredentialsRequestAws'
provider:
type: string
v4AddCredentialsRequestAws:
description: Credentials specific to an AWS account
type: object
required:
- roles
properties:
roles:
$ref: '#/definitions/v4AddCredentialsRequestAwsRoles'
x-go-gen-location: models
v4AddCredentialsRequestAwsRoles:
description: IAM roles to assume by certain entities
type: object
required:
- awsoperator
- admin
properties:
admin:
description: ARN of the IAM role to assume by Giant Swarm support staff
type: string
awsoperator:
description: ARN of the IAM role to assume by the software operating clusters
type: string
x-go-gen-location: models
v4AddKeyPairRequest:
type: object
required:
- description
properties:
certificate_organizations:
description: |
This will set the certificate subject's `organization` fields.
Use a comma seperated list of values.
type: string
cn_prefix:
description: The common name prefix of the certificate subject. This only
allows characters that are usable in domain names (`a-z`, `0-9`, and `.-`,
where `.-` must not occur at either the start or the end).
type: string
description:
description: Free text information about the key pair
type: string
ttl_hours:
description: Expiration time (from creation) in hours
type: integer
format: int32
v4AddKeyPairResponse:
type: object
properties:
certificate_authority_data:
description: PEM-encoded CA certificate of the cluster
type: string
client_certificate_data:
description: PEM-encoded certificate
type: string
client_key_data:
description: PEM-encoded RSA private key
type: string
create_date:
description: Date/time of creation
type: string
description:
description: Free text information about the key pair
type: string
id:
description: Unique identifier of the key pair
type: string
ttl_hours:
description: Expiration time (from creation) in hours
type: integer
v4ClusterDetailsResponse:
description: Response model showing details of a cluster
type: object
properties:
api_endpoint:
description: URI of the Kubernetes API endpoint
type: string
create_date:
description: Date/time of cluster creation
type: string
id:
description: Unique cluster identifier
type: string
kubernetes_version:
description: Deprecated. Will be removed in a future API version.
type: string
kvm:
$ref: '#/definitions/v4ClusterDetailsResponseKvm'
name:
description: Cluster name
type: string
owner:
description: Name of the organization owning the cluster
type: string
release_version:
description: |
The [release](https://docs.giantswarm.io/api/#tag/releases) version
currently running this cluster.
type: string
workers:
type: array
items:
$ref: '#/definitions/v4ClusterDetailsResponseWorkersItems'
v4ClusterDetailsResponseKvm:
description: Attributes specific to clusters running on KVM (on-prem) installations.
type: object
properties:
port_mappings:
description: |
Reveals the ports on the host cluster that are mapped to this guest cluster's ingress
and which protocol that port supports. Only shown and relevant on our on-prem KVM clusters.
type: array
items:
$ref: '#/definitions/v4ClusterDetailsResponseKvmPortMappingsItems'
x-go-gen-location: models
v4ClusterDetailsResponseKvmPortMappingsItems:
type: object
properties:
port:
description: |
The port on the host cluster that will forward traffic to the guest cluster
type: integer
protocol:
description: |
The protocol this port mapping is made for.
type: string
x-go-gen-location: models
v4ClusterDetailsResponseWorkersItems:
type: object
properties:
aws:
$ref: '#/definitions/v4ClusterDetailsResponseWorkersItemsAws'
azure:
$ref: '#/definitions/v4ClusterDetailsResponseWorkersItemsAzure'
cpu:
$ref: '#/definitions/v4ClusterDetailsResponseWorkersItemsCpu'
labels:
type: object
additionalProperties: true
memory:
$ref: '#/definitions/v4ClusterDetailsResponseWorkersItemsMemory'
storage:
$ref: '#/definitions/v4ClusterDetailsResponseWorkersItemsStorage'
x-go-gen-location: models
v4ClusterDetailsResponseWorkersItemsAws:
description: |
Attributes specific to nodes running on Amazon Web Services (AWS)
type: object
properties:
instance_type:
description: |
EC2 instance type name. Must be the same for all worker nodes
of a cluster.
type: string
x-go-gen-location: models
v4ClusterDetailsResponseWorkersItemsAzure:
description: |
Attributes specific to nodes running on Microsoft Azure
type: object
properties:
vm_size:
description: |
Azure Virtual Machine size. Must be the same for all worker nodes
of a cluster.
type: string
x-go-gen-location: models
v4ClusterDetailsResponseWorkersItemsCpu:
type: object
properties:
cores:
description: Number of CPU cores
type: integer
x-go-gen-location: models
v4ClusterDetailsResponseWorkersItemsMemory:
type: object
properties:
size_gb:
description: RAM size in GB. Can be an integer or float.
type: number
x-go-gen-location: models
v4ClusterDetailsResponseWorkersItemsStorage:
type: object
properties:
size_gb:
description: Node storage size in GB. Can be an integer or float.
type: number
x-go-gen-location: models
v4ClusterListItem:
type: object
properties:
create_date:
description: Date/time of cluster creation
type: string
id:
description: Unique cluster identifier
type: string
name:
description: Cluster name
type: string
owner:
description: Name of the organization owning the cluster
type: string
release_version:
description: The semantic version number of this cluster
type: string
v4CreateAuthTokenRequest:
type: object
properties:
email:
description: Your email address
type: string
password_base64:
description: Your password as a base64 encoded string
type: string
v4CreateAuthTokenResponse:
type: object
properties:
auth_token:
description: The newly created API token
type: string
v4CreateUserRequest:
description: Request model for creating a new user
type: object
required:
- password
properties:
expiry:
description: The date and time when this account will expire
type: string
password:
description: A Base64 encoded password
type: string
v4GenericResponse:
type: object
properties:
code:
description: |
A machine readable [response code](https://github.com/giantswarm/api-spec/blob/master/details/RESPONSE_CODES.md) like e. g. `INVALID_CREDENTIALS`
type: string
message:
description: A human readable message
type: string
v4GetKeyPairsResponse:
description: Array of sparse key pair objects
type: array
items:
$ref: '#/definitions/v4GetKeyPairsResponseItems'
v4GetKeyPairsResponseItems:
type: object
properties:
certificate_organizations:
description: The certificate subject's `organization` fields.
type: string
common_name:
description: The common name of the certificate subject.
type: string
create_date:
description: Date/time of creation
type: string
description:
description: Free text information about the key pair
type: string
id:
description: Unique identifier of the key pair
type: string
ttl_hours:
description: Expiration time (from creation) in hours
type: integer
x-go-gen-location: models
v4InfoResponse:
type: object
properties:
general:
$ref: '#/definitions/v4InfoResponseGeneral'
workers:
$ref: '#/definitions/v4InfoResponseWorkers'
v4InfoResponseGeneral:
description: General information
type: object
properties:
datacenter:
description: Identifier of the datacenter or cloud provider region, e. g.
"eu-west-1"
type: string
installation_name:
description: Unique name of the installation
type: string
provider:
description: The technical provider used in this installation. Either "kvm",
"aws", or "azure".
type: string
x-go-gen-location: models
v4InfoResponseWorkers:
description: Information related to worker nodes
type: object
properties:
count_per_cluster:
$ref: '#/definitions/v4InfoResponseWorkersCountPerCluster'
instance_type:
$ref: '#/definitions/v4InfoResponseWorkersInstanceType'
vm_size:
$ref: '#/definitions/v4InfoResponseWorkersVmSize'
x-go-gen-location: models
v4InfoResponseWorkersCountPerCluster:
description: Number of workers per cluster
type: object
properties:
default:
description: Default number of workers in a new cluster will have, if not
specifiec otherwise
type: number
max:
description: Maximum number of worker a cluster can have
type: number
x-go-gen-location: models
v4InfoResponseWorkersInstanceType:
description: Instance types to be used for worker nodes. Only available for AWS
clusters.
type: object
properties:
default:
description: The instance type used in new cluster, if not specified
type: string
options:
description: List of available instance types
type: array
items:
type: string
x-go-gen-location: models
v4InfoResponseWorkersVmSize:
description: Azure Virtual Machine size to be used for worker nodes. Only available
for Azure clusters.
type: object
properties:
default:
description: The instance type used in new cluster, if not specified
type: string
options:
description: List of available instance types
type: array
items:
type: string
x-go-gen-location: models
v4ModifyClusterRequest:
description: Request body for cluster modification
type: object
properties:
name:
description: Name for the cluster
type: string
owner:
description: Name of the organization owning the cluster
type: string
release_version:
description: Release version to use after an upgrade
type: string
workers:
description: Worker node array
type: array
items:
$ref: '#/definitions/v4ModifyClusterRequestWorkersItems'
v4ModifyClusterRequestWorkersItems:
type: object
properties:
aws:
$ref: '#/definitions/v4ModifyClusterRequestWorkersItemsAws'
azure:
$ref: '#/definitions/v4ModifyClusterRequestWorkersItemsAzure'
cpu:
$ref: '#/definitions/v4ModifyClusterRequestWorkersItemsCpu'
labels:
type: object
additionalProperties: true
memory:
$ref: '#/definitions/v4ModifyClusterRequestWorkersItemsMemory'
storage:
$ref: '#/definitions/v4ModifyClusterRequestWorkersItemsStorage'
x-go-gen-location: models
v4ModifyClusterRequestWorkersItemsAws:
description: |
Attributes specific to nodes running on Amazon Web Services (AWS)
type: object
properties:
instance_type:
description: |
EC2 instance type name. Must be the same for all worker nodes
of a cluster.
type: string
x-go-gen-location: models
v4ModifyClusterRequestWorkersItemsAzure:
description: |
Attributes specific to nodes running on Microsoft Azure
type: object
properties:
vm_size:
description: |
Azure Virtual Machine size. Must be the same for all worker nodes
of a cluster.
type: string
x-go-gen-location: models
v4ModifyClusterRequestWorkersItemsCpu:
type: object
properties:
cores:
description: Number of CPU cores
type: integer
x-go-gen-location: models
v4ModifyClusterRequestWorkersItemsMemory:
type: object
properties:
size_gb:
description: RAM size in GB. Can be an integer or float.
type: number
x-go-gen-location: models
v4ModifyClusterRequestWorkersItemsStorage:
type: object
properties:
size_gb:
description: Node storage size in GB. Can be an integer or float.
type: number
x-go-gen-location: models
v4Organization:
type: object
properties:
id:
description: Unique name/identifier of the organization
type: string
members:
description: List of members that belong to this organization
type: array
items:
$ref: '#/definitions/v4OrganizationMembersItems'
v4OrganizationListItem:
type: object
properties:
id:
description: Unique name/identifier of the organization
type: string
v4OrganizationMember:
type: object
properties:
email:
description: Email address of the user
type: string
v4OrganizationMembersItems:
type: object
properties:
email:
description: Email address of the user
type: string
x-go-gen-location: models
v4ReleaseListItem:
type: object
required:
- version
- timestamp
- changelog
- components
properties:
active:
description: |
If true, the version is available for new clusters and cluster
upgrades. Older versions become unavailable and thus have the
value `false` here.
type: boolean
changelog:
description: |
Structured list of changes in this release, in comparison to the
previous version, with respect to the contained components.
type: array
items:
$ref: '#/definitions/v4ReleaseListItemChangelogItems'
components:
description: |
List of components and their version contained in the release
type: array
items:
$ref: '#/definitions/v4ReleaseListItemComponentsItems'
timestamp:
description: Date and time of the release creation
type: string
version:
description: The semantic version number
type: string
v4ReleaseListItemChangelogItems:
type: object
properties:
component:
description: |
If the changed item was a component, this attribute is the
name of the component.
type: string
description:
description: Human-friendly description of the change
type: string
x-go-gen-location: models
v4ReleaseListItemComponentsItems:
type: object
required:
- name
- version
properties:
name:
description: Name of the component
type: string
version:
description: Version number of the component
type: string
x-go-gen-location: models
v4UserListItem:
type: object
properties:
created:
description: The date and time that this account was created
type: string
email:
description: Email address of the user
type: string
expiry:
description: The date and time when this account will expire
type: string
securityDefinitions:
AuthorizationHeaderToken:
description: |
Clients authenticate by passing an auth token via the `Authorization`
header with a value of the format `giantswarm <token>`. Auth tokens can be
obtained using the [createAuthToken](#operation/createAuthToken)
operation.
type: apiKey
name: Authorization
in: header
security:
- AuthorizationHeaderToken: []
tags:
- description: |
Auth Tokens are your way of authenticating against this API. You can create one by passing your email and base64 encoded password to the create auth token endpoint. The auth token never expires, in case you want to invalidate it you need to delete it (logout).
name: auth tokens
- description: |
Clusters are a central resource of the Giant Swarm API. As a user or team using Giant Swarm, you set up Kubernetes clusters to run your own workloads.
The API currently provides operations to create and delete clusters, as well as list all available clusters and get details on specific clusters.
name: clusters
- description: Information about the Giant Swarm installation
name: info
- description: A key pair is a unique combination of a X.509 certificate and a private
key. Key pairs are used to access the Kubernetes API of a cluster, both using
`kubectl` and any standard web browser.
name: key pairs
externalDocs:
description: 'User guide: Accessing Pods and Services from the Outside'
url: https://docs.giantswarm.io/guides/accessing-services-from-the-outside/
- description: Organizations are groups of users who own resources like clusters.
name: organizations
- description: A user represents a person that should have access to the Giant Swarm
API. Users can belong to many groups, and are identified by email address.
name: users
- description: |
A release is a software bundle that constitutes a cluster.
Releases are identified by their
[semantic version number](http://semver.org/) in the `MAJOR.MINOR.PATCH`
format.
A release provides _components_, like for example Kubernetes. For each
release the contained components are listed. Changes in components are
detailed in the _changelog_ of a release.
name: releases
|