@cycleplatform/api-client-typescript 0.3.15 → 0.3.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -247,7 +247,6 @@ export interface paths {
247
247
  * Get Billing Status
248
248
  * @description Retrieve meta details about the billing status of this Cycle core. It is unlikely that someone would need this endpoint outside
249
249
  * of Cycle's internal teams.
250
- *
251
250
  */
252
251
  get: operations["getBillingStatus"];
253
252
  put?: never;
@@ -270,7 +269,6 @@ export interface paths {
270
269
  * @description Lists the Billing Credits associated with the current Hub.
271
270
  *
272
271
  * Requires the `billing-credits-view` capability.
273
- *
274
272
  */
275
273
  get: operations["getCredits"];
276
274
  put?: never;
@@ -333,7 +331,6 @@ export interface paths {
333
331
  * @description List the Invoices assoicated with the Hub.
334
332
  *
335
333
  * Requires the `billing-invoices-view` capability.
336
- *
337
334
  */
338
335
  get: operations["getInvoices"];
339
336
  put?: never;
@@ -378,7 +375,6 @@ export interface paths {
378
375
  * @description Creates a new job for an Invoice. Generally used to make a payment on an invoice.
379
376
  *
380
377
  * Requires the `billing-invoices-pay` capability.
381
- *
382
378
  */
383
379
  post: operations["createInvoiceJob"];
384
380
  delete?: never;
@@ -399,7 +395,6 @@ export interface paths {
399
395
  * @description Lists the Billing Methods associated with the Hub defined in X-Hub-ID.
400
396
  *
401
397
  * Requires the `billing-methods-manage` capability.
402
- *
403
398
  */
404
399
  get: operations["getBillingMethods"];
405
400
  put?: never;
@@ -432,7 +427,6 @@ export interface paths {
432
427
  * Delete Biilling Method
433
428
  * @description Deletes the Billing Method. However, the primary payment method may not be deleted.
434
429
  * Requires the `billing-methods-manage` capability.
435
- *
436
430
  */
437
431
  delete: operations["deleteBillingMethod"];
438
432
  options?: never;
@@ -458,7 +452,6 @@ export interface paths {
458
452
  * @description Creates a new job for a billing method. Generally used to verify a payment method.
459
453
  *
460
454
  * Requires the `billing-methods-manage` capability.
461
- *
462
455
  */
463
456
  post: operations["createBillingMethodJob"];
464
457
  delete?: never;
@@ -529,7 +522,6 @@ export interface paths {
529
522
  * @description Used to confirm a Billing Order.
530
523
  *
531
524
  * Requires the `billing-services-manage` capability.
532
- *
533
525
  */
534
526
  post: operations["createOrderJob"];
535
527
  delete?: never;
@@ -671,7 +663,6 @@ export interface paths {
671
663
  * @description Gets a Container.
672
664
  *
673
665
  * Requires the `containers-view` capability.
674
- *
675
666
  */
676
667
  get: operations["getContainer"];
677
668
  put?: never;
@@ -688,7 +679,6 @@ export interface paths {
688
679
  * @description Updates the specified Container.
689
680
  *
690
681
  * Requires the `containers-manage` capability.
691
- *
692
682
  */
693
683
  patch: operations["updateContainer"];
694
684
  trace?: never;
@@ -734,7 +724,6 @@ export interface paths {
734
724
  * `volumes.reconfigure`: `containers-volumes-manage`
735
725
  * `reimage`: `containers-manage`
736
726
  * `scale`: `containers-manage`
737
- *
738
727
  */
739
728
  post: operations["createContainerJob"];
740
729
  delete?: never;
@@ -755,7 +744,6 @@ export interface paths {
755
744
  * @description Lists all Servers that currently have an Instance of this Container deployed to them.
756
745
  *
757
746
  * Requires the `containers-view` capability.
758
- *
759
747
  */
760
748
  get: operations["getContainerServers"];
761
749
  put?: never;
@@ -778,7 +766,6 @@ export interface paths {
778
766
  * @description Gets a list of servers that are compatible with the specified Container and its restrictions (tags, etc).
779
767
  *
780
768
  * Requires the `containers-view` capability.
781
- *
782
769
  */
783
770
  get: operations["getCompatibleServers"];
784
771
  put?: never;
@@ -802,7 +789,6 @@ export interface paths {
802
789
  * Used to quickly find Images that can be used for reimaging the Container.
803
790
  *
804
791
  * Requires the `containers-view` capability.
805
- *
806
792
  */
807
793
  get: operations["getCompatibleImages"];
808
794
  put?: never;
@@ -831,7 +817,6 @@ export interface paths {
831
817
  * @description Manually create Instances of a Container.
832
818
  *
833
819
  * Requires the `containers-update` capability.
834
- *
835
820
  */
836
821
  post: operations["createInstances"];
837
822
  /**
@@ -839,7 +824,6 @@ export interface paths {
839
824
  * @description Manually delete Instances of a Container.
840
825
  *
841
826
  * Requires the `containers-update` capability.
842
- *
843
827
  */
844
828
  delete: operations["deleteContainerInstances"];
845
829
  options?: never;
@@ -884,7 +868,6 @@ export interface paths {
884
868
  * into the Instance without exposing ports on the container or host.
885
869
  *
886
870
  * Requires the `containers-ssh` capability.
887
- *
888
871
  */
889
872
  get: operations["generateInstanceSSHCredentials"];
890
873
  put?: never;
@@ -894,7 +877,6 @@ export interface paths {
894
877
  * @description Instantly expires any SSH credentials generated for this Instance.
895
878
  *
896
879
  * Requires the `containers-ssh` capability.
897
- *
898
880
  */
899
881
  delete: operations["expireInstanceSSHCredentials"];
900
882
  options?: never;
@@ -916,7 +898,6 @@ export interface paths {
916
898
  * @description Used to perform different actions on a given Container Instance. Can be used to migrate or undo a migration of a Container Instance.
917
899
  *
918
900
  * Requires the `containers-instance-migrate` capability.
919
- *
920
901
  */
921
902
  post: operations["createInstanceJob"];
922
903
  delete?: never;
@@ -957,7 +938,6 @@ export interface paths {
957
938
  * @description Retrieves a point-in-time report of an Instance's resource usage (CPU, RAM, Network, Storage, etc).
958
939
  *
959
940
  * Requires the `containers-view` capability.
960
- *
961
941
  */
962
942
  get: operations["getInstanceTelemetryReport"];
963
943
  put?: never;
@@ -981,7 +961,6 @@ export interface paths {
981
961
  * This connects directly to the compute layer on the server the instance is hosted on, and streams telemetry in real time.
982
962
  *
983
963
  * Requires the `containers-view` capability.
984
- *
985
964
  */
986
965
  get: operations["getInstanceTelemetryStreamAuth"];
987
966
  put?: never;
@@ -1005,7 +984,6 @@ export interface paths {
1005
984
  * To connect via WebSocket, use the returned address, and append the returned token as a URL parameter: `<address>?token=<token>`.
1006
985
  *
1007
986
  * Requires the `containers-console` capability.
1008
- *
1009
987
  */
1010
988
  get: operations["getInstanceConsoleStreamAuth"];
1011
989
  put?: never;
@@ -1030,7 +1008,6 @@ export interface paths {
1030
1008
  * @description Used to perform different actions on a given Function Container.
1031
1009
  *
1032
1010
  * Requires the `containers-functions-trigger` capability.
1033
- *
1034
1011
  */
1035
1012
  post: operations["createFunctionJob"];
1036
1013
  delete?: never;
@@ -1071,7 +1048,6 @@ export interface paths {
1071
1048
  * @description Gets the specified Container Backup.
1072
1049
  *
1073
1050
  * Requires the `containers-backups-view` capability.
1074
- *
1075
1051
  */
1076
1052
  get: operations["getContainerBackup"];
1077
1053
  put?: never;
@@ -1101,7 +1077,6 @@ export interface paths {
1101
1077
  * Can be used to restore a Container Backup for a given Container Instance.
1102
1078
  *
1103
1079
  * Requires the `containers-backups-manage` capability.
1104
- *
1105
1080
  */
1106
1081
  post: operations["createContainerBackupJob"];
1107
1082
  delete?: never;
@@ -1216,7 +1191,6 @@ export interface paths {
1216
1191
  * @description Used to perform different actions on a given DNS zone.
1217
1192
  *
1218
1193
  * Requires the `dns-manage` capability.
1219
- *
1220
1194
  */
1221
1195
  post: operations["createDNSZoneJob"];
1222
1196
  delete?: never;
@@ -1287,7 +1261,6 @@ export interface paths {
1287
1261
  * @description Used to perform different actions on a given DNS Zone record.
1288
1262
  *
1289
1263
  * Requires the `dns-manage` capability.
1290
- *
1291
1264
  */
1292
1265
  post: operations["createDNSZoneRecordJob"];
1293
1266
  delete?: never;
@@ -1316,6 +1289,28 @@ export interface paths {
1316
1289
  patch?: never;
1317
1290
  trace?: never;
1318
1291
  };
1292
+ "/v1/dns/tls/certificates": {
1293
+ parameters: {
1294
+ query?: never;
1295
+ header?: never;
1296
+ path?: never;
1297
+ cookie?: never;
1298
+ };
1299
+ /**
1300
+ * List all TLS Certificates whether user generated or automatically generated by the platform.
1301
+ * @description Retrieve a list of TLS certificates.
1302
+ *
1303
+ * Requires the `dns-certs-view` capability.
1304
+ */
1305
+ get: operations["getAllTlsCertificates"];
1306
+ put?: never;
1307
+ post?: never;
1308
+ delete?: never;
1309
+ options?: never;
1310
+ head?: never;
1311
+ patch?: never;
1312
+ trace?: never;
1313
+ };
1319
1314
  "/v1/dns/tls/certificates/lookup": {
1320
1315
  parameters: {
1321
1316
  query?: never;
@@ -1328,7 +1323,6 @@ export interface paths {
1328
1323
  * @description Lookup and retrieve a TLS certificate bundle for a specified domain.
1329
1324
  *
1330
1325
  * If the `private` parameter is set to `true`, the private key, bundle, and/or CSR will be included. Including these private fields requires the `dns-certs-view` capability.
1331
- *
1332
1326
  */
1333
1327
  get: operations["lookupTLSCertificate"];
1334
1328
  put?: never;
@@ -1351,7 +1345,6 @@ export interface paths {
1351
1345
  * @description Retrieve a list of TLS certificates that were uploaded to Cycle.
1352
1346
  *
1353
1347
  * Requires the `dns-certs-view` capability.
1354
- *
1355
1348
  */
1356
1349
  get: operations["getUserSuppliedCertificates"];
1357
1350
  put?: never;
@@ -1360,7 +1353,6 @@ export interface paths {
1360
1353
  * @description Upload a user-supplied TLS certificate to the hub. This TLS certificate can be utilized by **LINKED** records matching the specified domains.
1361
1354
  *
1362
1355
  * Requires the `dns-manage` capability.
1363
- *
1364
1356
  */
1365
1357
  post: operations["uploadUserSuppliedCertificate"];
1366
1358
  delete?: never;
@@ -1381,7 +1373,6 @@ export interface paths {
1381
1373
  * @description Gets a list of custom TLS certificates uploaded to the hub.
1382
1374
  *
1383
1375
  * Requires the `dns-certs-view` capability.
1384
- *
1385
1376
  */
1386
1377
  get: operations["getUserSuppliedCertificate"];
1387
1378
  put?: never;
@@ -1406,7 +1397,6 @@ export interface paths {
1406
1397
  * @description Used to perform different actions on a given user supplied TLS certificate.
1407
1398
  *
1408
1399
  * Requires the `dns-manage` capability.
1409
- *
1410
1400
  */
1411
1401
  post: operations["createUserSuppliedCertificateJob"];
1412
1402
  delete?: never;
@@ -1465,7 +1455,6 @@ export interface paths {
1465
1455
  * @description Updates the specificed Environment.
1466
1456
  *
1467
1457
  * Requires the `environments-manage` capability.
1468
- *
1469
1458
  */
1470
1459
  patch: operations["updateEnvironment"];
1471
1460
  trace?: never;
@@ -1488,7 +1477,6 @@ export interface paths {
1488
1477
  * @description Updates the specificed Environment.
1489
1478
  *
1490
1479
  * Requires the `environments-manage` capability. If an ACL is present, requires the `manage` privilege.
1491
- *
1492
1480
  */
1493
1481
  patch: operations["updateEnvironmentAccess"];
1494
1482
  trace?: never;
@@ -1507,7 +1495,6 @@ export interface paths {
1507
1495
  * @description Create a job for an Environment, such as 'start' or 'stop'.
1508
1496
  *
1509
1497
  * Requires the `environments-manage` capability.
1510
- *
1511
1498
  */
1512
1499
  post: operations["createEnvironmentJob"];
1513
1500
  delete?: never;
@@ -1528,7 +1515,6 @@ export interface paths {
1528
1515
  * @description Gets the summary of an Environment. Contains useful and relevant data/statistics that would otherwise be several separate API calls.
1529
1516
  *
1530
1517
  * Requires the `environments-view` capability.
1531
- *
1532
1518
  */
1533
1519
  get: operations["getEnvironmentSummary"];
1534
1520
  put?: never;
@@ -1551,7 +1537,6 @@ export interface paths {
1551
1537
  * @description Gets a list of all deployments in the specified Environment.
1552
1538
  *
1553
1539
  * Requires the `environments-view` capability.
1554
- *
1555
1540
  */
1556
1541
  get: operations["getEnvironmentDeployments"];
1557
1542
  put?: never;
@@ -1576,7 +1561,6 @@ export interface paths {
1576
1561
  * @description Exports an environment as a stack file for reuse.
1577
1562
  *
1578
1563
  * Requires the `environments-manage` capability. You must also have management permissions on the target environment ACL.
1579
- *
1580
1564
  */
1581
1565
  post: operations["exportStack"];
1582
1566
  delete?: never;
@@ -1730,7 +1714,6 @@ export interface paths {
1730
1714
  *
1731
1715
  * ## Permissions
1732
1716
  * Requires the `environments-view` capability. Also requires the user to have access specifically to the requested Environment.
1733
- *
1734
1717
  */
1735
1718
  get: operations["getLoadBalancerTelemetryReport"];
1736
1719
  put?: never;
@@ -1754,7 +1737,6 @@ export interface paths {
1754
1737
  *
1755
1738
  * ## Permissions
1756
1739
  * Requires the `environments-view` capability. Also requires the user to have access specifically to the requested Environment.
1757
- *
1758
1740
  */
1759
1741
  get: operations["getLoadBalancerLatestTelemetryReport"];
1760
1742
  put?: never;
@@ -1778,7 +1760,6 @@ export interface paths {
1778
1760
  *
1779
1761
  * ## Permissions
1780
1762
  * Requires the `environments-view` capability. Also requires the user to have access specifically to the requested Environment.
1781
- *
1782
1763
  */
1783
1764
  get: operations["getLoadBalancerTelemetryLatestControllers"];
1784
1765
  put?: never;
@@ -2083,7 +2064,6 @@ export interface paths {
2083
2064
  * @description Retrieves details of a single integration associated with the current hub.
2084
2065
  *
2085
2066
  * Requires the `hubs-integrations-view` capability.
2086
- *
2087
2067
  */
2088
2068
  get: operations["getIntegration"];
2089
2069
  put?: never;
@@ -2114,7 +2094,6 @@ export interface paths {
2114
2094
  * @description Lists all integrations associated with the current Hub, with optional filtering.
2115
2095
  *
2116
2096
  * Requires the `hubs-integrations-view` capability.
2117
- *
2118
2097
  */
2119
2098
  get: operations["getIntegrations"];
2120
2099
  put?: never;
@@ -2165,7 +2144,6 @@ export interface paths {
2165
2144
  * ## Required Permissions
2166
2145
  * - Requires a valid hub membership to the target hub.
2167
2146
  * - Requires the `hubs-integrations-manage` capability.
2168
- *
2169
2147
  */
2170
2148
  post: operations["createIntegrationJob"];
2171
2149
  delete?: never;
@@ -2323,7 +2301,6 @@ export interface paths {
2323
2301
  * token can then be applied to the URL parameter to the same endpoint to upgrade the connection to a WebSocket.
2324
2302
  *
2325
2303
  * Requires the `apionly-notifications-listen` capability.
2326
- *
2327
2304
  */
2328
2305
  get: operations["getHubNotificationSocketAuth"];
2329
2306
  put?: never;
@@ -2346,7 +2323,6 @@ export interface paths {
2346
2323
  * @description Lists the Roles that have been created for this Hub.
2347
2324
  *
2348
2325
  * Requires the `hubs-roles-manage` capability.
2349
- *
2350
2326
  */
2351
2327
  get: operations["getRoles"];
2352
2328
  put?: never;
@@ -2355,7 +2331,6 @@ export interface paths {
2355
2331
  * @description Creates a custom Role for a Hub.
2356
2332
  *
2357
2333
  * Requires the `hubs-roles-manage` capability.
2358
- *
2359
2334
  */
2360
2335
  post: operations["createRole"];
2361
2336
  delete?: never;
@@ -2376,7 +2351,6 @@ export interface paths {
2376
2351
  * @description Retrieves the specified Role.
2377
2352
  *
2378
2353
  * Requries the `hubs-roles-manage` capability.
2379
- *
2380
2354
  */
2381
2355
  get: operations["getRole"];
2382
2356
  put?: never;
@@ -2386,7 +2360,6 @@ export interface paths {
2386
2360
  * @description Marks a Role as 'deleted'.
2387
2361
  *
2388
2362
  * Requires the 'hubs-roles-manage' capability.
2389
- *
2390
2363
  */
2391
2364
  delete: operations["deleteRole"];
2392
2365
  options?: never;
@@ -2396,7 +2369,6 @@ export interface paths {
2396
2369
  * @description Updates various properties of a specific Role.
2397
2370
  *
2398
2371
  * Requires the `hubs-roles-manage` capability.
2399
- *
2400
2372
  */
2401
2373
  patch: operations["updateRole"];
2402
2374
  trace?: never;
@@ -2504,7 +2476,6 @@ export interface paths {
2504
2476
  * @description Used to perform different actions on a given image.
2505
2477
  *
2506
2478
  * Requires the `images-manage` capability.
2507
- *
2508
2479
  */
2509
2480
  post: operations["createImagesJob"];
2510
2481
  delete?: never;
@@ -2527,7 +2498,6 @@ export interface paths {
2527
2498
  * @description Used to perform different actions on a given Image.
2528
2499
  *
2529
2500
  * Requires the `images-import` capability.
2530
- *
2531
2501
  */
2532
2502
  post: operations["createImageJob"];
2533
2503
  delete?: never;
@@ -2658,7 +2628,6 @@ export interface paths {
2658
2628
  /**
2659
2629
  * Get Cluster Monitoring Tiers
2660
2630
  * @description Gets all the available monitoring tiers that can be enabled for a cluster.
2661
- *
2662
2631
  */
2663
2632
  get: operations["getClusterMonitoringTiers"];
2664
2633
  put?: never;
@@ -2693,6 +2662,28 @@ export interface paths {
2693
2662
  patch?: never;
2694
2663
  trace?: never;
2695
2664
  };
2665
+ "/v1/infrastructure/external-volumes/tasks": {
2666
+ parameters: {
2667
+ query?: never;
2668
+ header?: never;
2669
+ path?: never;
2670
+ cookie?: never;
2671
+ };
2672
+ get?: never;
2673
+ put?: never;
2674
+ /**
2675
+ * Create External Volumes Job
2676
+ * @description Create a job for external volumes.
2677
+ *
2678
+ * Requires the `external-volumes-manage` capability.
2679
+ */
2680
+ post: operations["createExternalVolumesJob"];
2681
+ delete?: never;
2682
+ options?: never;
2683
+ head?: never;
2684
+ patch?: never;
2685
+ trace?: never;
2686
+ };
2696
2687
  "/v1/infrastructure/external-volumes/{externalVolumeId}": {
2697
2688
  parameters: {
2698
2689
  query?: never;
@@ -2705,7 +2696,6 @@ export interface paths {
2705
2696
  * @description Retrieves a single external volume by ID.
2706
2697
  *
2707
2698
  * Requires the `external-volumes-view` capability.
2708
- *
2709
2699
  */
2710
2700
  get: operations["getExternalVolume"];
2711
2701
  put?: never;
@@ -2722,7 +2712,6 @@ export interface paths {
2722
2712
  * @description Updates the specified external volume.
2723
2713
  *
2724
2714
  * Requires the `external-volumes-manage` capability.
2725
- *
2726
2715
  */
2727
2716
  patch: operations["updateExternalVolume"];
2728
2717
  trace?: never;
@@ -2765,7 +2754,6 @@ export interface paths {
2765
2754
  * @description Updates the ACL of the specified external volume.
2766
2755
  *
2767
2756
  * Requires the `external-volumes-manage` capability.
2768
- *
2769
2757
  */
2770
2758
  patch: operations["updateExternalVolumeAccess"];
2771
2759
  trace?: never;
@@ -2784,7 +2772,6 @@ export interface paths {
2784
2772
  * @description Create a job for an external volume.
2785
2773
  *
2786
2774
  * Requires the `external-volumes-manage` capability.
2787
- *
2788
2775
  */
2789
2776
  post: operations["createExternalVolumeJob"];
2790
2777
  delete?: never;
@@ -2865,15 +2852,15 @@ export interface paths {
2865
2852
  patch: operations["updateAutoScaleGroupAccess"];
2866
2853
  trace?: never;
2867
2854
  };
2868
- "/v1/infrastructure/providers/{providerVendor}/servers": {
2855
+ "/v1/infrastructure/providers/{integrationId}/servers": {
2869
2856
  parameters: {
2870
2857
  query?: never;
2871
2858
  header?: never;
2872
2859
  path?: never;
2873
2860
  cookie?: never;
2874
2861
  };
2875
- /** List Provider Servers */
2876
- get: operations["getProviderServers"];
2862
+ /** List Provider Server Models */
2863
+ get: operations["getProviderServerModels"];
2877
2864
  put?: never;
2878
2865
  post?: never;
2879
2866
  delete?: never;
@@ -2882,7 +2869,7 @@ export interface paths {
2882
2869
  patch?: never;
2883
2870
  trace?: never;
2884
2871
  };
2885
- "/v1/infrastructure/providers/{providerVendor}/locations": {
2872
+ "/v1/infrastructure/providers/{integrationId}/locations": {
2886
2873
  parameters: {
2887
2874
  query?: never;
2888
2875
  header?: never;
@@ -2911,7 +2898,6 @@ export interface paths {
2911
2898
  * @description Get ISOs for a virtual provider.
2912
2899
  *
2913
2900
  * Requires the `servers-manage` capability.
2914
- *
2915
2901
  */
2916
2902
  get: operations["getVirtualProviderIsos"];
2917
2903
  put?: never;
@@ -2920,7 +2906,6 @@ export interface paths {
2920
2906
  * @description Create an ISO for a virtual provider.
2921
2907
  *
2922
2908
  * Requires the `servers-manage` capability.
2923
- *
2924
2909
  */
2925
2910
  post: operations["createVirtualProviderIso"];
2926
2911
  delete?: never;
@@ -2971,7 +2956,6 @@ export interface paths {
2971
2956
  * @description Create a job for a virtual provider iso.
2972
2957
  *
2973
2958
  * Requires the `servers-manage` capability.
2974
- *
2975
2959
  */
2976
2960
  post: operations["createVirtualProviderIsoJob"];
2977
2961
  delete?: never;
@@ -3035,7 +3019,6 @@ export interface paths {
3035
3019
  * Get Cluster
3036
3020
  * @description Gets a Cluster.
3037
3021
  * Requires the `clusters-view` capability.
3038
- *
3039
3022
  */
3040
3023
  get: operations["getCluster"];
3041
3024
  put?: never;
@@ -3108,10 +3091,10 @@ export interface paths {
3108
3091
  get: operations["getServers"];
3109
3092
  put?: never;
3110
3093
  /**
3111
- * Create Server
3094
+ * Create Servers
3112
3095
  * @description Requires the `servers-provision` capability.
3113
3096
  */
3114
- post: operations["createServer"];
3097
+ post: operations["createServers"];
3115
3098
  delete?: never;
3116
3099
  options?: never;
3117
3100
  head?: never;
@@ -3158,7 +3141,6 @@ export interface paths {
3158
3141
  * @description This call requires the filter query parameter to be used.
3159
3142
  *
3160
3143
  * Requires the `servers-view` capability.
3161
- *
3162
3144
  */
3163
3145
  get: operations["getServerTelemetry"];
3164
3146
  put?: never;
@@ -3261,7 +3243,6 @@ export interface paths {
3261
3243
  * @description Gets the authorization information required to connect to a Server console websocket.
3262
3244
  *
3263
3245
  * Requires the `servers-console` capability.
3264
- *
3265
3246
  */
3266
3247
  get: operations["GetServerConsole"];
3267
3248
  put?: never;
@@ -3290,7 +3271,6 @@ export interface paths {
3290
3271
  * @description Create an infrastructure IP Pool
3291
3272
  *
3292
3273
  * Requires the 'ips-manage' capability.
3293
- *
3294
3274
  */
3295
3275
  post: operations["createIpPool"];
3296
3276
  delete?: never;
@@ -3435,7 +3415,6 @@ export interface paths {
3435
3415
  * @description A basic query for retrieving metrics. For a more complex and granular report, see the `/v1/monitoring/metrics/aggregate` endpoint.
3436
3416
  *
3437
3417
  * Requires the `monitor-view` capability.
3438
- *
3439
3418
  */
3440
3419
  get: operations["getMetrics"];
3441
3420
  put?: never;
@@ -3463,7 +3442,6 @@ export interface paths {
3463
3442
  * You should always provide a time range filter to this call, either through the filter parameter or in the critera body. The aggregate is limited to 25,000 input documents, so a time frame will give the best results.
3464
3443
  *
3465
3444
  * Requires the `monitor-view` capability.
3466
- *
3467
3445
  */
3468
3446
  post: operations["generateAggregatedMetrics"];
3469
3447
  delete?: never;
@@ -3484,7 +3462,6 @@ export interface paths {
3484
3462
  * @description A basic query for retrieving events. For a more complex and granular report, see the `/v1/monitoring/events/aggregate` endpoint.
3485
3463
  *
3486
3464
  * Requires the `monitor-view` capability.
3487
- *
3488
3465
  */
3489
3466
  get: operations["getEvents"];
3490
3467
  put?: never;
@@ -3512,7 +3489,6 @@ export interface paths {
3512
3489
  * You should always provide a time range filter to this call, either through the filter parameter or in the critera body. The aggregate is limited to 25,000 input documents, so a time frame will give the best results.
3513
3490
  *
3514
3491
  * Requires the `monitor-view` capability.
3515
- *
3516
3492
  */
3517
3493
  post: operations["generateAggregatedEvents"];
3518
3494
  delete?: never;
@@ -3537,7 +3513,6 @@ export interface paths {
3537
3513
  * If 'local' is set to true, only cached logs will be queried, and logs in object storage will be ignored. This leads to much faster performance.
3538
3514
  *
3539
3515
  * Requires the `monitor-view` capability.
3540
- *
3541
3516
  */
3542
3517
  post: operations["aggregateLogs"];
3543
3518
  delete?: never;
@@ -3558,7 +3533,6 @@ export interface paths {
3558
3533
  * @description Returns location information about the monitors used for Cycle's external monitoring service.
3559
3534
  * These monitors are used for determining the latency between the public internet and environment
3560
3535
  * load balancers.
3561
- *
3562
3536
  */
3563
3537
  get: operations["getMonitoringMonitors"];
3564
3538
  put?: never;
@@ -3641,6 +3615,28 @@ export interface paths {
3641
3615
  patch: operations["updatePipelineAccess"];
3642
3616
  trace?: never;
3643
3617
  };
3618
+ "/v1/pipelines/runs": {
3619
+ parameters: {
3620
+ query?: never;
3621
+ header?: never;
3622
+ path?: never;
3623
+ cookie?: never;
3624
+ };
3625
+ /**
3626
+ * List All Pipeline Runs
3627
+ * @description Lists all pipeline runs, regardless of the pipeline they are associated with.
3628
+ *
3629
+ * Requires the `pipelines-view` capability.
3630
+ */
3631
+ get: operations["getAllPipelineRuns"];
3632
+ put?: never;
3633
+ post?: never;
3634
+ delete?: never;
3635
+ options?: never;
3636
+ head?: never;
3637
+ patch?: never;
3638
+ trace?: never;
3639
+ };
3644
3640
  "/v1/pipelines/{pipelineId}/runs": {
3645
3641
  parameters: {
3646
3642
  query?: never;
@@ -3653,7 +3649,6 @@ export interface paths {
3653
3649
  * @description List information about times this Pipeline has run.
3654
3650
  *
3655
3651
  * Requires the `pipelines-view` capability.
3656
- *
3657
3652
  */
3658
3653
  get: operations["getPipelineRuns"];
3659
3654
  put?: never;
@@ -3898,7 +3893,6 @@ export interface paths {
3898
3893
  * Can be used to build a 'quick search' functionality for referencing the most frequently used resources.
3899
3894
  *
3900
3895
  * Requires the `view` capability for each returned segment, i.e. to retrieve Containers, you must have `containers-view`.
3901
- *
3902
3896
  */
3903
3897
  get: operations["getSearchIndex"];
3904
3898
  put?: never;
@@ -4001,6 +3995,28 @@ export interface paths {
4001
3995
  patch?: never;
4002
3996
  trace?: never;
4003
3997
  };
3998
+ "/v1/stacks/builds": {
3999
+ parameters: {
4000
+ query?: never;
4001
+ header?: never;
4002
+ path?: never;
4003
+ cookie?: never;
4004
+ };
4005
+ /**
4006
+ * List All Builds
4007
+ * @description Fetches all stack builds regardless of their association to a stack.
4008
+ *
4009
+ * Requires the `stacks-view` capability.
4010
+ */
4011
+ get: operations["getAllStackBuilds"];
4012
+ put?: never;
4013
+ post?: never;
4014
+ delete?: never;
4015
+ options?: never;
4016
+ head?: never;
4017
+ patch?: never;
4018
+ trace?: never;
4019
+ };
4004
4020
  "/v1/stacks/builds/{buildId}": {
4005
4021
  parameters: {
4006
4022
  query?: never;
@@ -4013,7 +4029,6 @@ export interface paths {
4013
4029
  * @description Look up a Stack Build using only the Build ID, instead of requiring a Stack ID as well.
4014
4030
  *
4015
4031
  * Requires the `stacks-view` capability.
4016
- *
4017
4032
  */
4018
4033
  get: operations["lookupStackBuild"];
4019
4034
  put?: never;
@@ -4089,7 +4104,6 @@ export interface paths {
4089
4104
  * will be included in the log.
4090
4105
  *
4091
4106
  * Requires the `stacks-view` capability.
4092
- *
4093
4107
  */
4094
4108
  get: operations["getStackBuildLog"];
4095
4109
  put?: never;
@@ -4156,7 +4170,6 @@ export interface paths {
4156
4170
  * @description Retrieves a single virtual machine by ID.
4157
4171
  *
4158
4172
  * Requires the `virtual-machines-view` capability.
4159
- *
4160
4173
  */
4161
4174
  get: operations["getVirtualMachine"];
4162
4175
  put?: never;
@@ -4173,7 +4186,6 @@ export interface paths {
4173
4186
  * @description Updates the specified virtual machine.
4174
4187
  *
4175
4188
  * Requires the `virtual-machines-manage` capability.
4176
- *
4177
4189
  */
4178
4190
  patch: operations["updateVirtualMachine"];
4179
4191
  trace?: never;
@@ -4198,7 +4210,6 @@ export interface paths {
4198
4210
  * `rootpw.change`: `virtual-machines-manage`
4199
4211
  * `ip.allocate`: `virtual-machines-manage`
4200
4212
  * `ip.unallocate`: `virtual-machines-manage`
4201
- *
4202
4213
  */
4203
4214
  post: operations["createVirtualMachineJob"];
4204
4215
  delete?: never;
@@ -4217,7 +4228,6 @@ export interface paths {
4217
4228
  /**
4218
4229
  * Get Virtual Machine Base Images
4219
4230
  * @description Retrieves the list of available base images for virtual machines provided by Cycle.
4220
- *
4221
4231
  */
4222
4232
  get: operations["getVirtualMachineBaseImages"];
4223
4233
  put?: never;
@@ -4240,7 +4250,6 @@ export interface paths {
4240
4250
  * @description Generates credentials for connecting to the serial console of a virtual machine via SSH.
4241
4251
  *
4242
4252
  * Requires the `virtual-machines-console` capability.
4243
- *
4244
4253
  */
4245
4254
  get: operations["generateVirtualMachineSosCredentials"];
4246
4255
  put?: never;
@@ -4250,7 +4259,6 @@ export interface paths {
4250
4259
  * @description Instantly expires any serial-over-SSH credentials generated for this virtual machine.
4251
4260
  *
4252
4261
  * Requires the `virtual-machines-console` capability.
4253
- *
4254
4262
  */
4255
4263
  delete: operations["expireVirtualMachineSosCredentials"];
4256
4264
  options?: never;
@@ -4294,7 +4302,6 @@ export interface paths {
4294
4302
  * @description Retrieves a single virtual machine SSH key by ID.
4295
4303
  *
4296
4304
  * Requires the `virtual-machines-ssh-keys-manage` capability.
4297
- *
4298
4305
  */
4299
4306
  get: operations["getVirtualMachineSshKey"];
4300
4307
  put?: never;
@@ -4311,7 +4318,6 @@ export interface paths {
4311
4318
  * @description Updates the specified virtual machine SSH key.
4312
4319
  *
4313
4320
  * Requires the `virtual-machines-ssh-keys-manage` capability.
4314
- *
4315
4321
  */
4316
4322
  patch: operations["updateVirtualMachineSshKey"];
4317
4323
  trace?: never;
@@ -4334,7 +4340,6 @@ export interface paths {
4334
4340
  * 3. The IP address must be in the `available` state.
4335
4341
  *
4336
4342
  * Requires the `virtual-machines-view` capability.
4337
- *
4338
4343
  */
4339
4344
  get: operations["getAvailableIps"];
4340
4345
  put?: never;
@@ -4357,7 +4362,6 @@ export interface paths {
4357
4362
  * @description Given a (base64'd) resource identifier string (i.e. `cluster:production/env:abc`), returns the ID of the matching resource.
4358
4363
  * If more than one resource matches the identifier, or no resource matches the identifier, this endpoint will return an error.
4359
4364
  * Given identifiers are NOT unique, you may need to be more specific to target the exact identifier.
4360
- *
4361
4365
  */
4362
4366
  get: operations["lookupIdentifier"];
4363
4367
  put?: never;
@@ -4377,9 +4381,10 @@ export interface paths {
4377
4381
  };
4378
4382
  get?: never;
4379
4383
  put?: never;
4380
- /** Look up Cycle components (resources such as containers, servers, etc) based on their ID.
4384
+ /**
4385
+ * Look up Cycle components (resources such as containers, servers, etc) based on their ID.
4381
4386
  * Useful when the IDs are known ahead of time - all relevant items can be fetched in a single request.
4382
- * */
4387
+ */
4383
4388
  post: operations["lookupComponents"];
4384
4389
  delete?: never;
4385
4390
  options?: never;
@@ -4388,7 +4393,48 @@ export interface paths {
4388
4393
  trace?: never;
4389
4394
  };
4390
4395
  }
4391
- export type webhooks = Record<string, never>;
4396
+ export interface webhooks {
4397
+ environmentMetricsPush: {
4398
+ parameters: {
4399
+ query?: never;
4400
+ header?: never;
4401
+ path?: never;
4402
+ cookie?: never;
4403
+ };
4404
+ get?: never;
4405
+ put?: never;
4406
+ /**
4407
+ * Environment Metrics Push
4408
+ * @description Regularly sends metrics from an environment to an endpoint.
4409
+ */
4410
+ post: operations["environmentMetricsPush"];
4411
+ delete?: never;
4412
+ options?: never;
4413
+ head?: never;
4414
+ patch?: never;
4415
+ trace?: never;
4416
+ };
4417
+ environmentEventsPush: {
4418
+ parameters: {
4419
+ query?: never;
4420
+ header?: never;
4421
+ path?: never;
4422
+ cookie?: never;
4423
+ };
4424
+ get?: never;
4425
+ put?: never;
4426
+ /**
4427
+ * Environment Events Push
4428
+ * @description Regularly sends events from an environment to an endpoint.
4429
+ */
4430
+ post: operations["environmentEventsPush"];
4431
+ delete?: never;
4432
+ options?: never;
4433
+ head?: never;
4434
+ patch?: never;
4435
+ trace?: never;
4436
+ };
4437
+ }
4392
4438
  export interface components {
4393
4439
  schemas: {
4394
4440
  /**
@@ -4436,11 +4482,13 @@ export interface components {
4436
4482
  * ID
4437
4483
  * Format: objectid
4438
4484
  * @description A 24 character hex string used to identify a unique resource.
4485
+ * @example 651586fca6078e98982dbd90
4439
4486
  */
4440
4487
  ID: string;
4441
4488
  /**
4442
4489
  * DateTime
4443
4490
  * Format: date-time
4491
+ * @example 2021-01-30T08:30:00Z
4444
4492
  */
4445
4493
  DateTime: string;
4446
4494
  /**
@@ -4608,6 +4656,7 @@ export interface components {
4608
4656
  /**
4609
4657
  * HubID
4610
4658
  * @description The unique ID of the Hub this resource was created in.
4659
+ * @example 651586fca6078e98982dbd90
4611
4660
  */
4612
4661
  HubID: string;
4613
4662
  /** MembershipState */
@@ -4753,7 +4802,6 @@ export interface components {
4753
4802
  * have the identifier of `my-container` and is automatically created by the platform.
4754
4803
  *
4755
4804
  * The identifier does not have to be unique.
4756
- *
4757
4805
  */
4758
4806
  Identifier: string;
4759
4807
  /**
@@ -5567,7 +5615,9 @@ export interface components {
5567
5615
  credit: {
5568
5616
  amount?: components["schemas"]["BillingAmount"];
5569
5617
  expires?: {
5618
+ /** @example months */
5570
5619
  interval: string;
5620
+ /** @example 2 */
5571
5621
  number: number;
5572
5622
  };
5573
5623
  } | null;
@@ -5858,9 +5908,15 @@ export interface components {
5858
5908
  };
5859
5909
  /** IPNet */
5860
5910
  IPNet: {
5861
- /** @description The IP address. */
5911
+ /**
5912
+ * @description The IP address.
5913
+ * @example fd00::21:0:0:0
5914
+ */
5862
5915
  ip: string;
5863
- /** @description The CIDR notation, describing the range of IP addresses. */
5916
+ /**
5917
+ * @description The CIDR notation, describing the range of IP addresses.
5918
+ * @example fd00::21:0:0:0/96
5919
+ */
5864
5920
  cidr: string;
5865
5921
  };
5866
5922
  /**
@@ -5926,7 +5982,6 @@ export interface components {
5926
5982
  * L2Domain
5927
5983
  * @description A standardized name for different layer-2 networks that can be configured on virtual provider hosts.
5928
5984
  * Containers will utilize this name to determine which network to attach to on the host, if set in the config.
5929
- *
5930
5985
  * @enum {string}
5931
5986
  */
5932
5987
  L2Domain: "public" | "shared" | "private";
@@ -5946,10 +6001,11 @@ export interface components {
5946
6001
  ports?: string[];
5947
6002
  /** @description Layer 2 network configuration options for containers running on virtual provider servers. */
5948
6003
  l2?: {
5949
- /** @description The layer 2 'domains' that this container's instances should bridge to on the host server.
6004
+ /**
6005
+ * @description The layer 2 'domains' that this container's instances should bridge to on the host server.
5950
6006
  * If the host has a matching layer 2 NIC configured via a virtual provider ISO, this container's instances
5951
6007
  * will be joined directly to the host's network.
5952
- * */
6008
+ */
5953
6009
  domains: components["schemas"]["L2Domain"][];
5954
6010
  };
5955
6011
  };
@@ -5961,6 +6017,7 @@ export interface components {
5961
6017
  /**
5962
6018
  * Duration
5963
6019
  * @description A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
6020
+ * @example 72h45m2s
5964
6021
  */
5965
6022
  Duration: string;
5966
6023
  /**
@@ -5977,7 +6034,7 @@ export interface components {
5977
6034
  /** @description The number of initial desired instances for a given container. */
5978
6035
  instances: number;
5979
6036
  /** @description The deployment strategy to use when scaling the given container. */
5980
- strategy?: components["schemas"]["DeploymentStrategyName"];
6037
+ strategy?: components["schemas"]["DeploymentStrategyName"] | null;
5981
6038
  /** @description Configuration options for containers using the 'function' deployment strategy. */
5982
6039
  function?: {
5983
6040
  /** @description The maximum number of instances that Cycle can pre-allocate (includes auto-scaled instances). */
@@ -5989,42 +6046,45 @@ export interface components {
5989
6046
  /** @description The maximum amount of time Cycle will wait for an instance to be available. */
5990
6047
  max_queue_time?: components["schemas"]["Duration"] | null;
5991
6048
  } | null;
6049
+ /** @description Configuration options for stateful deployments. */
5992
6050
  stateful?: {
6051
+ /** @description Options that modify behavior for stateful deployments. */
5993
6052
  options?: {
6053
+ /** @description When set, the base hostname will be used instead of a generated hostname. */
5994
6054
  use_base_hostname?: boolean | null;
5995
6055
  } | null;
5996
- };
6056
+ } | null;
5997
6057
  /** @description Settings that give more granular control over deployment targets and conditions. */
5998
6058
  constraints?: {
5999
- /** @description Constraint settings related to which nodes an instance can be deployed to. */
6000
6059
  node?: {
6001
6060
  /** @description Lists of server tags that formally declair servers that match the criteria for deployment. */
6002
6061
  tags: {
6003
6062
  /** @description A list of tags where a server matching any tags from the list is qualified as a deployment target. */
6004
- any?: string[];
6063
+ any?: string[] | null;
6005
6064
  /** @description A list of tags where a server matching all tags from the list is the only scenario where the server is qualified as a deployment target. */
6006
- all?: string[];
6065
+ all?: string[] | null;
6007
6066
  };
6008
- };
6009
- secrets?: string[];
6010
- };
6067
+ } | null;
6068
+ /** @description A list of secret identifiers that will be made available to the container. */
6069
+ secrets?: string[] | null;
6070
+ } | null;
6011
6071
  /** @description Configuration for what to do during container shutdown. */
6012
6072
  shutdown?: {
6013
6073
  /** @description How long the platform will wait for a container to stop gracefully. */
6014
6074
  graceful_timeout?: components["schemas"]["Duration"] | null;
6015
6075
  /** @description Process signal sent to the container process. */
6016
6076
  signals?: components["schemas"]["ShutdownSignal"][] | null;
6017
- };
6077
+ } | null;
6018
6078
  /** @description Configurations for container startup. */
6019
6079
  startup?: {
6020
6080
  /** @description How long the platform will wait before sending the start signal to the given container. */
6021
6081
  delay?: components["schemas"]["Duration"];
6022
- };
6082
+ } | null;
6023
6083
  /** @description Configurations for container updates. */
6024
6084
  update?: {
6025
6085
  /** @description When set, Cycle will pick a random time from `0 - this duration`, and stagger the instances so they all start at different times (up to the time specified here). */
6026
6086
  stagger?: components["schemas"]["Duration"];
6027
- };
6087
+ } | null;
6028
6088
  /** @description Configurations for container restart events. */
6029
6089
  restart?: {
6030
6090
  /**
@@ -6036,7 +6096,14 @@ export interface components {
6036
6096
  delay: components["schemas"]["Duration"];
6037
6097
  /** @description The amount of times the platform will attempt the restart policies. */
6038
6098
  max_attempts: number;
6039
- };
6099
+ } | null;
6100
+ /** @description Configuration for determining readiness of a container. */
6101
+ readiness_check?: {
6102
+ /** @description The command that will be run to verify readiness of the container. */
6103
+ command: string;
6104
+ interval: components["schemas"]["Duration"];
6105
+ timeout: components["schemas"]["Duration"];
6106
+ } | null;
6040
6107
  /** @description Configuration for determining the health of a container. */
6041
6108
  health_check?: {
6042
6109
  /** @description The command that will be run to verify the health of the container. */
@@ -6044,14 +6111,14 @@ export interface components {
6044
6111
  /** @description The number of times the platform will retry the command before marking the container unhealthy. */
6045
6112
  retries: number;
6046
6113
  /** @description How long to wait before performing an initial health check when the instance starts. The `state.health.healthy` field of the instance will be `null`` until the first check is performed. */
6047
- delay: components["schemas"]["Duration"] | null;
6114
+ delay: components["schemas"]["Duration"];
6048
6115
  /** @description How long to wait between restarts. */
6049
6116
  interval: components["schemas"]["Duration"];
6050
6117
  /** @description How long before a health check attempt times out. */
6051
6118
  timeout: components["schemas"]["Duration"];
6052
6119
  /** @description A boolean where `true` represents the desire for a container to restart if unhealthy. */
6053
6120
  restart: boolean;
6054
- };
6121
+ } | null;
6055
6122
  /** @description Configuration settings for container telemetery reporting. */
6056
6123
  telemetry?: {
6057
6124
  /** @description How long telemetry data should be retained. */
@@ -6060,7 +6127,7 @@ export interface components {
6060
6127
  interval: components["schemas"]["Duration"];
6061
6128
  /** @description A boolean where true disables all telemetry reporting for this container. */
6062
6129
  disable: boolean;
6063
- };
6130
+ } | null;
6064
6131
  };
6065
6132
  /**
6066
6133
  * ScaleThresholdMetricRam
@@ -6073,7 +6140,11 @@ export interface components {
6073
6140
  */
6074
6141
  type: "ram";
6075
6142
  details: {
6076
- /** @description The target average RAM usage of all instances of this container. Going above this threshold will trigger a scaling event. This threshold must be greater than 25MB. */
6143
+ /**
6144
+ * @description The target average RAM usage of all instances of this container. Going above this threshold will trigger a scaling event. This threshold must be greater than 25MB.
6145
+ * @example 2G
6146
+ * @example 25MB
6147
+ */
6077
6148
  usage: string;
6078
6149
  };
6079
6150
  };
@@ -6094,7 +6165,7 @@ export interface components {
6094
6165
  /**
6095
6166
  * WebhookURL
6096
6167
  * @description A URL describing the destination Cycle should send a POST webhook payload to.
6097
- *
6168
+ * @example https://example.com/cycle/autoscale
6098
6169
  */
6099
6170
  WebhookURL: string;
6100
6171
  /**
@@ -6151,7 +6222,11 @@ export interface components {
6151
6222
  type: "network-throughput";
6152
6223
  details: {
6153
6224
  private: boolean;
6154
- /** @description The limit (maximum) amount of throughput each instance of the given container can use before triggering a scaling event. */
6225
+ /**
6226
+ * @description The limit (maximum) amount of throughput each instance of the given container can use before triggering a scaling event.
6227
+ * @example 1gbps
6228
+ * @example 20mbps
6229
+ */
6155
6230
  bandwidth: string;
6156
6231
  };
6157
6232
  };
@@ -6208,42 +6283,48 @@ export interface components {
6208
6283
  * @description A host device exposed to the container during runtime.
6209
6284
  */
6210
6285
  RuntimeExposedDevice: {
6211
- /** @description The path to the device on the host. */
6286
+ /**
6287
+ * @description The path to the device on the host.
6288
+ * @example /dev/kvm
6289
+ * @example /dev/net/tun
6290
+ */
6212
6291
  source: string;
6213
- /** @description The path inside the container that the device is mapped to. */
6292
+ /**
6293
+ * @description The path inside the container that the device is mapped to.
6294
+ * @example /dev/kvm
6295
+ * @example /dev/net/tun
6296
+ */
6214
6297
  destination: string;
6215
6298
  options?: string[] | null;
6216
6299
  };
6217
6300
  /**
6218
6301
  * RuntimeDevicePermissionType
6219
6302
  * @description The class of device this rule applies to (for example, block devices or character devices).
6220
- *
6221
6303
  * @enum {string}
6222
6304
  */
6223
6305
  RuntimeDevicePermissionType: "b" | "c";
6224
6306
  /**
6225
6307
  * RuntimeDevicePermissionAccess
6226
6308
  * @description The access mode permitted by this rule. Common conventions use a combination of letters (e.g., r, w, m) to indicate read, write, and mknod capabilities.
6227
- *
6309
+ * @example r
6310
+ * @example rw
6311
+ * @example rwm
6228
6312
  */
6229
6313
  RuntimeDevicePermissionAccess: string;
6230
6314
  /**
6231
6315
  * RuntimeDevicePermission
6232
6316
  * @description A rule that grants or denies access to a device node (e.g., Linux cgroup device rule). Controls which device type and major/minor numbers are allowed, and with what access.
6233
- *
6234
6317
  */
6235
6318
  RuntimeDevicePermission: {
6236
6319
  type: components["schemas"]["RuntimeDevicePermissionType"];
6237
6320
  /**
6238
6321
  * Format: int64
6239
6322
  * @description Device major number.
6240
- *
6241
6323
  */
6242
6324
  major?: number | null;
6243
6325
  /**
6244
6326
  * Format: int64
6245
6327
  * @description Device minor number.
6246
- *
6247
6328
  */
6248
6329
  minor?: number | null;
6249
6330
  /** @description Whether this rule allows (true) or denies (false) access. */
@@ -6304,7 +6385,12 @@ export interface components {
6304
6385
  readonly?: boolean;
6305
6386
  };
6306
6387
  devices?: {
6307
- /** @description The size of the shared host memory device (/dev/shm). */
6388
+ /**
6389
+ * @description The size of the shared host memory device (/dev/shm).
6390
+ * @example 64M
6391
+ * @example 128M
6392
+ * @example 512M
6393
+ */
6308
6394
  shm_size?: string | null;
6309
6395
  expose?: components["schemas"]["RuntimeExposedDevice"][] | null;
6310
6396
  permissions?: components["schemas"]["RuntimeDevicePermission"][] | null;
@@ -6328,7 +6414,11 @@ export interface components {
6328
6414
  };
6329
6415
  /** @description Configuration settings for limits and reserves of RAM resources for the given container. */
6330
6416
  ram: {
6331
- /** @description The limit (maximum) amount of RAM each instance of the given container can use. */
6417
+ /**
6418
+ * @description The limit (maximum) amount of RAM each instance of the given container can use.
6419
+ * @example 1G
6420
+ * @example 1M
6421
+ */
6332
6422
  limit?: string;
6333
6423
  /** @description The reserve (allocation) of RAM given to each instance of the container. */
6334
6424
  reserve?: string;
@@ -6337,6 +6427,7 @@ export interface components {
6337
6427
  /**
6338
6428
  * HybridIdentifier
6339
6429
  * @description Either a resource ID (objectid - i.e. 651586fca6078e98982dbd90) or a resource Identifier (human-readable)
6430
+ * @example my-image-source
6340
6431
  */
6341
6432
  HybridIdentifier: string;
6342
6433
  /**
@@ -6425,7 +6516,7 @@ export interface components {
6425
6516
  /**
6426
6517
  * Version
6427
6518
  * @description Version can be any string, but if it begins with a "v", semantic version will be enforced. A [Semantic Version](https://semver.org/) string. Follows the format vMAJOR.MINOR.PATCH-build.
6428
- *
6519
+ * @example v1.2.3-dev
6429
6520
  */
6430
6521
  Version: string;
6431
6522
  /**
@@ -6433,11 +6524,9 @@ export interface components {
6433
6524
  * @description A logical grouping of containers inside of an Environment. Facilitates zero-downtime deployments by separating multiple versions of the same application within an environment.
6434
6525
  *
6435
6526
  * If a container is a member of a deployment, it can only resolve containers in that same deployment, or containers NOT in a deployment. If a container is NOT a member of a deployment, it can resolve all containers in the environment.
6436
- *
6437
6527
  */
6438
6528
  Deployment: {
6439
- /** @description A version string representing the deployment.
6440
- * */
6529
+ /** @description A version string representing the deployment. */
6441
6530
  version: components["schemas"]["Version"];
6442
6531
  };
6443
6532
  /**
@@ -6446,7 +6535,9 @@ export interface components {
6446
6535
  * - b, k, m, g, t, p (bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes)
6447
6536
  * - An optional "b" suffix may be added (e.g., "mb", "gb").
6448
6537
  * Units are case-insensitive. Example: "512M", "10GB", "1t".
6449
- *
6538
+ * @example 512M
6539
+ * @example 10GB
6540
+ * @example 1t
6450
6541
  */
6451
6542
  DataSize: string;
6452
6543
  /**
@@ -6457,8 +6548,7 @@ export interface components {
6457
6548
  identifier?: components["schemas"]["Identifier"] | null;
6458
6549
  /** @description A boolean where true marks the volume as read only. */
6459
6550
  read_only: boolean;
6460
- /** @description Indicates that the volume will be used as unformatted block storage.
6461
- * */
6551
+ /** @description Indicates that the volume will be used as unformatted block storage. */
6462
6552
  block_device: boolean;
6463
6553
  local?: {
6464
6554
  /** @description The maximum size this volume can grow to. Container volumes on Cycle are thinly provisioned, meaning this isn't an allocation - the volume will only use the space it needs up to this size. */
@@ -6608,6 +6698,16 @@ export interface components {
6608
6698
  };
6609
6699
  /** @description A LINKED record is a record special to Cycle. It represents a URL that points to a specific container or deployment of a container, however the IP address mapping in handled automatically by the platform. */
6610
6700
  linked?: {
6701
+ /** @description Rules for routing traffic at the load balancer for this linked record. */
6702
+ routing: {
6703
+ http?: {
6704
+ /**
6705
+ * @description If set, this record will configure the load balancer to only match for paths of this domain matching this string.
6706
+ * If the string starts with a /, it will be a literal prefix match (/test matches /test*). Otherwise, regex is used.
6707
+ */
6708
+ match_path?: string | null;
6709
+ } | null;
6710
+ };
6611
6711
  /** @description Features associated with this record. */
6612
6712
  features: {
6613
6713
  /** @description TLS properties of the record. */
@@ -6634,9 +6734,10 @@ export interface components {
6634
6734
  } | {
6635
6735
  virtual_machine: {
6636
6736
  id: components["schemas"]["ID"];
6637
- /** @description If true, traffic to this domain will skip the load balancer and go directly to the virtual machine
6737
+ /**
6738
+ * @description If true, traffic to this domain will skip the load balancer and go directly to the virtual machine
6638
6739
  * via the gateway service.
6639
- * */
6740
+ */
6640
6741
  dmz: boolean;
6641
6742
  };
6642
6743
  } | {
@@ -6702,7 +6803,7 @@ export interface components {
6702
6803
  * IpAddress
6703
6804
  * Format: ip-address
6704
6805
  * @description An IP address is a numerical label that uniquely identifies a device on a network and enables it to send and receive data.
6705
- *
6806
+ * @example 192.168.1.1
6706
6807
  */
6707
6808
  IpAddress: string;
6708
6809
  /**
@@ -6710,7 +6811,7 @@ export interface components {
6710
6811
  * Format: cidr
6711
6812
  * @description A CIDR (Classless Inter-Domain Routing) string is a notation used to represent an IP address and its associated network prefix.
6712
6813
  * It combines an IP address with a suffix that indicates how many bits are fixed for routing.
6713
- *
6814
+ * @example 192.168.1.0/24
6714
6815
  */
6715
6816
  Cidr: string;
6716
6817
  /**
@@ -6864,7 +6965,7 @@ export interface components {
6864
6965
  * @description The configuration for environment monitoring.
6865
6966
  */
6866
6967
  EnvironmentMonitoringConfig: {
6867
- /** @description An object describing the log configuration for the environment. */
6968
+ /** @description An object describing the log monitoring configuration for the environment. */
6868
6969
  logs?: {
6869
6970
  /** @description An object describing log drain configuration for the environment. */
6870
6971
  drain?: {
@@ -6876,7 +6977,29 @@ export interface components {
6876
6977
  exclude_services: boolean;
6877
6978
  } | null;
6878
6979
  } | null;
6879
- };
6980
+ /** @description An object describing the metrics monitoring configuration for the environment. */
6981
+ metrics?: {
6982
+ /**
6983
+ * @description Configuration options for pushing metrics externally.
6984
+ * For payload see webhook `environmentMetricsPush`
6985
+ */
6986
+ endpoint?: {
6987
+ /** @description The destination URL for the metrics. */
6988
+ url: string;
6989
+ } | null;
6990
+ } | null;
6991
+ /** @description An object describing the events monitoring configuration for the environment. */
6992
+ events?: {
6993
+ /**
6994
+ * @description Configuration options for pushing events externally.
6995
+ * For payload see webhook `environmentEventsPush`
6996
+ */
6997
+ endpoint?: {
6998
+ /** @description The destination URL for events. */
6999
+ url: string;
7000
+ } | null;
7001
+ } | null;
7002
+ };
6880
7003
  /**
6881
7004
  * EnvironmentFeatures
6882
7005
  * @description An object representing specialized features configured for this environment.
@@ -7001,7 +7124,10 @@ export interface components {
7001
7124
  * @enum {string}
7002
7125
  */
7003
7126
  operator: "==" | "!=" | ">" | "<" | ">=" | "<=";
7004
- /** @description The value corresponding to the condition type. */
7127
+ /**
7128
+ * @description The value corresponding to the condition type.
7129
+ * @example 0.0.0.0/0
7130
+ */
7005
7131
  value: string;
7006
7132
  }[];
7007
7133
  }[];
@@ -7134,10 +7260,12 @@ export interface components {
7134
7260
  value: string;
7135
7261
  }[] | null;
7136
7262
  } | null;
7137
- /** @description The URL to forward the request to.
7263
+ /**
7264
+ * @description The URL to forward the request to.
7138
7265
  *
7139
7266
  * Given a path match of `^/example/(.*)$`, a route such as `/example/wow.jpg` would be forwarded as /wow.jpg.
7140
- * */
7267
+ * @example /$$1
7268
+ */
7141
7269
  url?: string | null;
7142
7270
  } | null;
7143
7271
  proxy?: {
@@ -7158,7 +7286,10 @@ export interface components {
7158
7286
  } | null;
7159
7287
  caching?: {
7160
7288
  files?: {
7161
- /** @description Regex string that describes the files to cache. */
7289
+ /**
7290
+ * @description Regex string that describes the files to cache.
7291
+ * @example (.*)\.(js|jpg|css|png|svg)$
7292
+ */
7162
7293
  match: string;
7163
7294
  /** @description Time string that describes the time to live. */
7164
7295
  ttl: components["schemas"]["Duration"];
@@ -7191,7 +7322,6 @@ export interface components {
7191
7322
  * `random`: Pick a valid destination at random.
7192
7323
  * `round-robin`: Send each request to the 'next' destination on the list, restarting from the beginning when the last destination is used.
7193
7324
  * `source-ip`: Utilizes a hash function to ensure traffic from an IP will always hit the same destination instance.
7194
- *
7195
7325
  * @enum {string}
7196
7326
  */
7197
7327
  mode: "random" | "round-robin" | "source-ip";
@@ -7203,19 +7333,19 @@ export interface components {
7203
7333
  destination_prioritization?: ("latency" | "random" | "fixed") | null;
7204
7334
  /** @description TLS termination configuration. If null, the platform will use the default configuration. Port 443 by default has TLS termination enabled. */
7205
7335
  tls?: {
7206
- /** @description [Advanced] Change the domain the controller listens on.
7207
- * */
7336
+ /** @description [Advanced] Change the domain the controller listens on. */
7208
7337
  server_name?: string | null;
7209
7338
  /** @description If enabled, accept TLS traffic with an invalid certificate. This is usually done for development/testing, and is not recommended for production use. */
7210
7339
  allow_insecure?: boolean | null;
7211
7340
  /** @description A PEM encoded string of certificates. */
7212
7341
  client_cert_auth?: string | null;
7213
- /** @description Defines how to validate the connecting TLS certificate.
7342
+ /**
7343
+ * @description Defines how to validate the connecting TLS certificate.
7214
7344
  * `none`: Do not require a TLS certificate to be sent
7215
7345
  * `request`: Asks the client to send a TLS certificate, but does not require nor validate it.
7216
7346
  * `require`: Requires a certificate be sent for the request to be valid, but does not validate the certificate.
7217
7347
  * `require-verify`: Requires both that the client send a certificate, and that the certificate is valid. This is required when using https.
7218
- * */
7348
+ */
7219
7349
  client_auth?: ("none" | "request" | "require" | "require-verify") | null;
7220
7350
  } | null;
7221
7351
  /** @description Defines how the length of various sorts of timeouts when communicating with the destination. */
@@ -7247,9 +7377,10 @@ export interface components {
7247
7377
  mode: "tcp" | "udp" | "http";
7248
7378
  /** @description Defines how the transport for this controller operates. */
7249
7379
  config: {
7250
- /** @description Enable/disable performance mode. If enabled, some telemetry will be disabled to dedicate full processing to handling requests.
7380
+ /**
7381
+ * @description Enable/disable performance mode. If enabled, some telemetry will be disabled to dedicate full processing to handling requests.
7251
7382
  * You will not see per-request breakdowns or URL logging if performance mode is enabled.
7252
- * */
7383
+ */
7253
7384
  performance: boolean;
7254
7385
  /** @description Defines how traffic gets into the load balancer. */
7255
7386
  ingress: {
@@ -7334,8 +7465,6 @@ export interface components {
7334
7465
  */
7335
7466
  DiscoveryConfig: {
7336
7467
  empty_set_delay?: components["schemas"]["Duration"] | null;
7337
- /** @description When enabled, discovery will return both IPv6 and IPv4 when in legacy mode. Otherwise, only IPv4 will be returned. */
7338
- dual_stack_legacy?: boolean | null;
7339
7468
  /** @description A mapping of hostnames to IP addresses for custom internal resolutions. Acts as a custom /etc/resolv.conf file that works environment wide. */
7340
7469
  hosts?: {
7341
7470
  [key: string]: {
@@ -7347,6 +7476,12 @@ export interface components {
7347
7476
  } | null;
7348
7477
  /** @description A list of custom DNS resolver strings. Can specifify domains or ips. */
7349
7478
  custom_resolvers?: string[] | null;
7479
+ /** @description When enabled, discovery will return both IPv6 and IPv4 when in legacy mode. Otherwise, only IPv4 will be returned. */
7480
+ dual_stack_legacy?: boolean | null;
7481
+ external_resolution?: {
7482
+ /** @enum {string} */
7483
+ preference: "default" | "ipv4" | "ipv6";
7484
+ } | null;
7350
7485
  };
7351
7486
  /**
7352
7487
  * DiscoveryEnvironmentService
@@ -7379,8 +7514,15 @@ export interface components {
7379
7514
  config?: {
7380
7515
  /** @description If true, routes all traffic through the VPN, even non-Cycle traffic. */
7381
7516
  allow_internet: boolean;
7382
- /** @description Additional OpenVPN directives that will be appended to the server configuration on service start. Each line should follow standard OpenVPN syntax.
7383
- * */
7517
+ /**
7518
+ * @description Additional OpenVPN directives that will be appended to the server configuration on service start. Each line should follow standard OpenVPN syntax.
7519
+ * @example client-to-client
7520
+ * duplicate-cn
7521
+ * persist-key
7522
+ * persist-tun
7523
+ * @example verb 3
7524
+ * mute 10
7525
+ */
7384
7526
  custom_directives?: string | null;
7385
7527
  /** @description Auth configuration for the VPN. */
7386
7528
  auth: {
@@ -7410,8 +7552,7 @@ export interface components {
7410
7552
  * @description Configuration options for the scheduler Environment service.
7411
7553
  */
7412
7554
  SchedulerConfig: {
7413
- /** @description If true, this scheduler will be accessible over the public internet. It will enable a LINKED record to be pointed to the scheduler container, and inbound requests to trigger function containers.
7414
- * */
7555
+ /** @description If true, this scheduler will be accessible over the public internet. It will enable a LINKED record to be pointed to the scheduler container, and inbound requests to trigger function containers. */
7415
7556
  public: boolean;
7416
7557
  access_keys?: components["schemas"]["SchedulerAccessKey"][];
7417
7558
  };
@@ -7487,7 +7628,6 @@ export interface components {
7487
7628
  * `dev` version of your app within an environment, where you can continuously deploy and update it without needing to change the record. It is
7488
7629
  * even more useful when you have multiple LINKED records, and you update i.e. `prod`` tag to point to a new version, all records using the `prod` tag
7489
7630
  * are switched at once.
7490
- *
7491
7631
  */
7492
7632
  EnvironmentDeploymentTags: {
7493
7633
  [key: string]: components["schemas"]["Version"];
@@ -7515,6 +7655,18 @@ export interface components {
7515
7655
  image: components["schemas"]["ContainerImageSummary"];
7516
7656
  environment: components["schemas"]["ContainerEnvironmentSummary"];
7517
7657
  }[];
7658
+ /** @description A map where the key is the service and the value describes the version and date of last update. */
7659
+ service_versions?: {
7660
+ [key: string]: {
7661
+ /**
7662
+ * @description A string depicting the service version.
7663
+ * @example v2025.01.01.01
7664
+ */
7665
+ version: string;
7666
+ /** @description The time the version was last updated. */
7667
+ last_updated: components["schemas"]["DateTime"];
7668
+ };
7669
+ };
7518
7670
  };
7519
7671
  /**
7520
7672
  * Environment
@@ -7548,8 +7700,7 @@ export interface components {
7548
7700
  services: components["schemas"]["EnvironmentServices"];
7549
7701
  acl?: components["schemas"]["ACL"] | null;
7550
7702
  private_network?: components["schemas"]["PrivateNetwork"] | null;
7551
- /** @description A map of custom tags to deployment versions.
7552
- * */
7703
+ /** @description A map of custom tags to deployment versions. */
7553
7704
  deployments?: {
7554
7705
  tags: components["schemas"]["EnvironmentDeploymentTags"];
7555
7706
  } | null;
@@ -7842,7 +7993,6 @@ export interface components {
7842
7993
  *
7843
7994
  * In order to utilize this image origin type, a tar file of an OCI compliant image will need to be generated and pushed directly to the factory. The authentication token is generated when this image is created, and expires at the provided time.
7844
7995
  * Once you have a token, it can be uploaded as multipart form data under the key `file.tar`, directly to the factory at `https://factory.cycle.io:9414/v1/images/<IMAGE ID>/upload?hub-id=<HUB ID>&token=<TOKEN>`.
7845
- *
7846
7996
  */
7847
7997
  CycleUploadOrigin: {
7848
7998
  /**
@@ -7862,7 +8012,6 @@ export interface components {
7862
8012
  * @description An image origin that references an image source on Cycle.
7863
8013
  *
7864
8014
  * This origin will never be embedded in an image source. It is for use in stacks, describing an image which is already a part of an image source on Cycle.
7865
- *
7866
8015
  */
7867
8016
  CycleSourceOrigin: {
7868
8017
  /**
@@ -8074,6 +8223,7 @@ export interface components {
8074
8223
  /**
8075
8224
  * StackVariable
8076
8225
  * @description A variable specified in a stack spec.
8226
+ * @example {{$stack-variable}}
8077
8227
  */
8078
8228
  StackVariable: string;
8079
8229
  /**
@@ -8149,13 +8299,25 @@ export interface components {
8149
8299
  file?: ({
8150
8300
  /** @description When true, Cycle will interpret this variable as a base-64 encoded string, and decode it before writing it to the file inside the container. */
8151
8301
  decode: boolean | components["schemas"]["StackVariable"];
8152
- /** @description The absolute path to write the variable to (including file name). If `null`, it will be written to `/var/run/cycle/variables/{variable-identifier}`. */
8302
+ /**
8303
+ * @description The absolute path to write the variable to (including file name). If `null`, it will be written to `/var/run/cycle/variables/{variable-identifier}`.
8304
+ * @example /var/run/cycle/variables/<myVariable>
8305
+ */
8153
8306
  path: (string | null) | components["schemas"]["StackVariable"];
8154
- /** @description A linux file mode that will be set on the injected file. */
8307
+ /**
8308
+ * @description A linux file mode that will be set on the injected file.
8309
+ * @example 0644
8310
+ */
8155
8311
  permissions?: (string | null) | components["schemas"]["StackVariable"];
8156
- /** @description The linux UID to set on the file. */
8312
+ /**
8313
+ * @description The linux UID to set on the file.
8314
+ * @example 777
8315
+ */
8157
8316
  uid?: (number | null) | components["schemas"]["StackVariable"];
8158
- /** @description The linux GID to set on the file. */
8317
+ /**
8318
+ * @description The linux GID to set on the file.
8319
+ * @example 777
8320
+ */
8159
8321
  gid?: (number | null) | components["schemas"]["StackVariable"];
8160
8322
  } | null) | components["schemas"]["StackVariable"];
8161
8323
  } | components["schemas"]["StackVariable"];
@@ -8174,8 +8336,13 @@ export interface components {
8174
8336
  origin: components["schemas"]["StackSpecImageOrigin"] | components["schemas"]["StackVariable"];
8175
8337
  /** @description Additional details applied when building an image. */
8176
8338
  build?: ({
8339
+ /**
8340
+ * @description If true, will skip using /dev/shm when building an image on factory, which is limited to `6.5GB`. Allows for building much larger images, up to `20GB`.
8341
+ * @default false
8342
+ */
8343
+ use_disk: boolean;
8177
8344
  /** @description A map of build arguments applied to the image at build time. */
8178
- args: {
8345
+ args?: {
8179
8346
  [key: string]: string;
8180
8347
  } | components["schemas"]["StackVariable"];
8181
8348
  } | null) | components["schemas"]["StackVariable"];
@@ -8204,7 +8371,8 @@ export interface components {
8204
8371
  StackSpecContainerConfigDeploy: {
8205
8372
  /** @description The number of desired instances to deploy. */
8206
8373
  instances: number | components["schemas"]["StackVariable"];
8207
- /** @description The strategy Cycle will apply when deploying instances of this container.
8374
+ /**
8375
+ * @description The strategy Cycle will apply when deploying instances of this container.
8208
8376
  *
8209
8377
  * - ** resource-density **: Cycle will distribute instances across servers to maintain balanced resource usage.
8210
8378
  * - ** high-availability **: Cycle will deploy instances across servers with an emphasis on geographic and physical separation. Requires multiple locations.
@@ -8214,70 +8382,80 @@ export interface components {
8214
8382
  * - ** edge **: Cycle will prioritize geographic distribution of instances.
8215
8383
  * - ** function **: Every ingress request/connection receives its own instance.
8216
8384
  * - ** manual **: Cycle will not make any decisions on where instances are deployed. Instead, instances must be deployed manually using the portal or API.
8217
- * */
8218
- strategy?: ("resource-density" | "manual" | "high-availability" | "first-available" | "node" | "edge" | "function") | components["schemas"]["StackVariable"];
8385
+ */
8386
+ strategy?: ("resource-density" | "manual" | "high-availability" | "first-available" | "node" | "edge" | "function") | null | components["schemas"]["StackVariable"];
8219
8387
  /** @description Configuration options for containers using the 'function' deployment strategy. */
8220
- function?: ({
8388
+ function?: {
8221
8389
  /** @description The maximum number of instances that Cycle can pre-allocate (includes auto-scaled instances). */
8222
- max_pool_size?: (number | null) | components["schemas"]["StackVariable"];
8390
+ max_pool_size?: number | null | components["schemas"]["StackVariable"];
8223
8391
  /** @description For each shard (scheduler), the maximum number of tasks it can run in parallel. */
8224
- max_shard_concurrency?: (number | null) | components["schemas"]["StackVariable"];
8392
+ max_shard_concurrency?: number | null | components["schemas"]["StackVariable"];
8225
8393
  /** @description The maximum amount of time a function instance can run before timing out. */
8226
- max_runtime?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"] | null;
8394
+ max_runtime?: components["schemas"]["Duration"] | null | components["schemas"]["StackVariable"];
8227
8395
  /** @description The maximum amount of time Cycle will wait for an instance to be available. */
8228
- max_queue_time?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"] | null;
8229
- } | null) | components["schemas"]["StackVariable"];
8396
+ max_queue_time?: components["schemas"]["Duration"] | null | components["schemas"]["StackVariable"];
8397
+ } | null | components["schemas"]["StackVariable"];
8230
8398
  /** @description Configuration options for stateful containers. */
8231
- stateful?: ({
8399
+ stateful?: {
8232
8400
  /** @description Stateful container options. */
8233
8401
  options: {
8234
8402
  /** @description When enabled, instances will utilize stateless base hostnames instead of being prefixed with a unique ID. */
8235
8403
  use_base_hostname?: boolean | null;
8236
- } | null;
8237
- } | null) | components["schemas"]["StackVariable"];
8404
+ } | null | components["schemas"]["StackVariable"];
8405
+ } | null | components["schemas"]["StackVariable"];
8238
8406
  /** @description Configuration options that provide the ability to set restrictions on which nodes instances of this container are able to be deployed to. (i.e. if you have a GPU container, it should only go on nodes with a GPU). */
8239
- constraints?: ({
8407
+ constraints?: {
8408
+ /** @description Constraint settings related to which nodes an instance can be deployed to. */
8240
8409
  node?: {
8241
8410
  /** @description Tags applied to a node. Cycle generates some automatically, but additional, custom tags can be applied on a per-node basis. */
8242
8411
  tags: {
8243
8412
  /** @description If a node has at least one of these tags, it is considered a valid deployment target for this container. */
8244
- any?: string[] | components["schemas"]["StackVariable"];
8413
+ any?: string[] | null | components["schemas"]["StackVariable"];
8245
8414
  /** @description A node must have **ALL** of these tags to be considered a valid deployment target for this container. */
8246
- all?: string[] | components["schemas"]["StackVariable"];
8247
- } | components["schemas"]["StackVariable"];
8248
- } | null;
8249
- } | null) | components["schemas"]["StackVariable"];
8415
+ all?: string[] | null | components["schemas"]["StackVariable"];
8416
+ } | null | components["schemas"]["StackVariable"];
8417
+ } | null | components["schemas"]["StackVariable"];
8418
+ } | null | components["schemas"]["StackVariable"];
8250
8419
  /** @description Configuration options for how this container behaves during shutdown. */
8251
- shutdown?: ({
8420
+ shutdown?: {
8252
8421
  /** @description How long the platform will wait for a container to stop gracefully. */
8253
8422
  graceful_timeout?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"] | null;
8254
- signals?: components["schemas"]["ShutdownSignal"][] | components["schemas"]["StackVariable"];
8255
- } | null) | components["schemas"]["StackVariable"];
8423
+ /** @description Signals that should be sent to the container on shutdown. */
8424
+ signals?: components["schemas"]["ShutdownSignal"][] | null | components["schemas"]["StackVariable"];
8425
+ } | null | components["schemas"]["StackVariable"];
8256
8426
  /** @description Configuration options for how this container behaves during startup. */
8257
- startup?: ({
8427
+ startup?: {
8258
8428
  /** @description How long the platform will wait before sending the start signal to the given container. */
8259
8429
  delay?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"] | null;
8260
- } | null) | components["schemas"]["StackVariable"];
8430
+ } | null | components["schemas"]["StackVariable"];
8261
8431
  /** @description Configurations for how the container behaves during updates. */
8262
- update?: ({
8432
+ update?: {
8263
8433
  /** @description When set, Cycle will pick a random time from `0 - this duration`, and stagger the instances so they all start at different times (up to the time specified here). */
8264
8434
  stagger?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"] | null;
8265
- } | null) | components["schemas"]["StackVariable"];
8435
+ } | null | components["schemas"]["StackVariable"];
8266
8436
  /** @description Configuration options for how Cycle should handle restarting this container (i.e. in case the process inside the container dies). */
8267
- restart?: ({
8437
+ restart?: {
8268
8438
  /** @description Under what circumstances Cycle should try to restart this container. */
8269
8439
  condition: ("always" | "never" | "failure") | components["schemas"]["StackVariable"];
8270
8440
  /** @description How long the platform will wait between restart attempts. */
8271
8441
  delay: components["schemas"]["Duration"] | components["schemas"]["StackVariable"];
8272
8442
  /** @description The maximum number of restart attempts Cycle will make. */
8273
8443
  max_attempts: number | components["schemas"]["StackVariable"];
8274
- } | null) | components["schemas"]["StackVariable"];
8444
+ } | null | components["schemas"]["StackVariable"];
8445
+ /** @description Configuration for determining readiness of a container. */
8446
+ readiness_check?: {
8447
+ /** @description The command that will be run to verify readiness of the container. */
8448
+ command: string;
8449
+ interval: components["schemas"]["Duration"];
8450
+ timeout: components["schemas"]["Duration"];
8451
+ } | null | components["schemas"]["StackVariable"];
8275
8452
  /** @description Configuration options for automated container health checks. */
8276
- health_check?: ({
8277
- /** @description The command or script to run to verify the health of the container. This script is run inside the container by Cycle.
8453
+ health_check?: {
8454
+ /**
8455
+ * @description The command or script to run to verify the health of the container. This script is run inside the container by Cycle.
8278
8456
  * This command accepts two types of entries:
8279
8457
  * - The first is a reference to a script that already lives in the container filesystem. This can be defined by giving the full path to the script as the value. - The second format is an inline script. If you need the code to execute within a shell, wrap the commands in escaped quotes like this `"\"curl -s -o /dev/console -w \"%{http_code}\" http://localhost:3000/_health | grep '200' && exit 0 || exit 1\""`. Do not use the `/bin/sh -c <commands>` format, this will not be accepted.
8280
- * */
8458
+ */
8281
8459
  command: string | components["schemas"]["StackVariable"];
8282
8460
  /** @description The number of times to retry the command before marking an instance unhealthy. */
8283
8461
  retries: number | components["schemas"]["StackVariable"];
@@ -8289,18 +8467,18 @@ export interface components {
8289
8467
  restart: boolean | components["schemas"]["StackVariable"];
8290
8468
  /** @description How long to wait after a container start event before running health checks. */
8291
8469
  delay?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"] | null;
8292
- } | null) | components["schemas"]["StackVariable"];
8470
+ } | null | components["schemas"]["StackVariable"];
8293
8471
  /** @description Configuration options for how the instance telemetry (CPU usage, etc) is handled. */
8294
- telemetry?: ({
8472
+ telemetry?: {
8295
8473
  /** @description How long telemetry data should be retained. */
8296
- retention?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"] | null;
8474
+ retention?: components["schemas"]["Duration"] | null | components["schemas"]["StackVariable"];
8297
8475
  /** @description The duration between samples. */
8298
- interval?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"] | null;
8476
+ interval?: components["schemas"]["Duration"] | null | components["schemas"]["StackVariable"];
8299
8477
  /** @description A URL where Cycle will send telemetry data to. The payload will be an instance resource snapshot. */
8300
- webhook?: (string | null) | components["schemas"]["StackVariable"];
8478
+ webhook?: string | null | components["schemas"]["StackVariable"];
8301
8479
  /** @description If true, Cycle will not aggregate telemetry for this container's instances. */
8302
8480
  disable: boolean | components["schemas"]["StackVariable"];
8303
- } | null) | components["schemas"]["StackVariable"];
8481
+ } | null | components["schemas"]["StackVariable"];
8304
8482
  };
8305
8483
  /**
8306
8484
  * StackSpecContainerScaleThresholdRam
@@ -8313,7 +8491,11 @@ export interface components {
8313
8491
  */
8314
8492
  type: "ram";
8315
8493
  details: {
8316
- /** @description The target average RAM usage of all instances of this container. Going above this threshold will trigger a scaling event. This threshold must be greater than 25MB. */
8494
+ /**
8495
+ * @description The target average RAM usage of all instances of this container. Going above this threshold will trigger a scaling event. This threshold must be greater than 25MB.
8496
+ * @example 2G
8497
+ * @example 25MB
8498
+ */
8317
8499
  usage: string;
8318
8500
  };
8319
8501
  };
@@ -8385,7 +8567,11 @@ export interface components {
8385
8567
  type: "network-throughput";
8386
8568
  details: {
8387
8569
  private: boolean;
8388
- /** @description The limit (maximum) amount of throughput each instance of the given container can use before triggering a scaling event. */
8570
+ /**
8571
+ * @description The limit (maximum) amount of throughput each instance of the given container can use before triggering a scaling event.
8572
+ * @example 1gbps
8573
+ * @example 50mbps
8574
+ */
8389
8575
  bandwidth: string;
8390
8576
  };
8391
8577
  };
@@ -8428,28 +8614,26 @@ export interface components {
8428
8614
  /**
8429
8615
  * StackSpecRuntimeDevicePermissionType
8430
8616
  * @description The class of device this rule applies to (for example, block devices or character devices).
8431
- *
8432
8617
  * @enum {string}
8433
8618
  */
8434
8619
  StackSpecRuntimeDevicePermissionType: "b" | "c";
8435
8620
  /**
8436
8621
  * StackSpecRuntimeDevicePermissionAccess
8437
8622
  * @description The access mode permitted by this rule. Common conventions use a combination of letters (e.g., r, w, m) to indicate read, write, and mknod capabilities.
8438
- *
8623
+ * @example r
8624
+ * @example rw
8625
+ * @example rwm
8439
8626
  */
8440
8627
  StackSpecRuntimeDevicePermissionAccess: string;
8441
8628
  /**
8442
8629
  * StackSpecRuntimeDevicePermission
8443
8630
  * @description A rule that grants or denies access to a device node (e.g., Linux cgroup device rule). Controls which device type and major/minor numbers are allowed, and with what access.
8444
- *
8445
8631
  */
8446
8632
  StackSpecRuntimeDevicePermission: {
8447
8633
  type: components["schemas"]["StackSpecRuntimeDevicePermissionType"] | components["schemas"]["StackVariable"];
8448
- /** @description Device major number.
8449
- * */
8634
+ /** @description Device major number. */
8450
8635
  major?: (number | null) | components["schemas"]["StackVariable"];
8451
- /** @description Device minor number.
8452
- * */
8636
+ /** @description Device minor number. */
8453
8637
  minor?: (number | null) | components["schemas"]["StackVariable"];
8454
8638
  /** @description Whether this rule allows (true) or denies (false) access. */
8455
8639
  allow: boolean | components["schemas"]["StackVariable"];
@@ -8634,8 +8818,7 @@ export interface components {
8634
8818
  destination: string | components["schemas"]["StackVariable"];
8635
8819
  /** @description If true, the container will be unable to write data to the volume. */
8636
8820
  read_only?: boolean | components["schemas"]["StackVariable"];
8637
- /** @description Indicates that the volume will be used as unformatted block storage.
8638
- * */
8821
+ /** @description Indicates that the volume will be used as unformatted block storage. */
8639
8822
  block_device?: boolean | components["schemas"]["StackVariable"];
8640
8823
  /** @description Configuration options for setting up remote access to this volume via SFTP. */
8641
8824
  remote_access?: {
@@ -8728,8 +8911,6 @@ export interface components {
8728
8911
  /** StackSpecDiscoveryConfig */
8729
8912
  StackSpecDiscoveryConfig: {
8730
8913
  empty_set_delay?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"] | null;
8731
- /** @description When enabled, discovery will return both IPv6 and IPv4 when in legacy mode. Otherwise, only IPv4 will be returned. */
8732
- dual_stack_legacy?: boolean | components["schemas"]["StackVariable"] | null;
8733
8914
  /** @description A custom mapping of hosts - for forced resolution of specific IPs for a domain. */
8734
8915
  hosts?: ({
8735
8916
  [key: string]: {
@@ -8739,6 +8920,12 @@ export interface components {
8739
8920
  } | null) | components["schemas"]["StackVariable"];
8740
8921
  /** @description A list of custom DNS resolver strings. Can specifify domains or ips. */
8741
8922
  custom_resolvers?: string[] | components["schemas"]["StackVariable"] | null;
8923
+ /** @description When enabled, discovery will return both IPv6 and IPv4 when in legacy mode. Otherwise, only IPv4 will be returned. */
8924
+ dual_stack_legacy?: boolean | components["schemas"]["StackVariable"] | null;
8925
+ external_resolution?: {
8926
+ /** @enum {string} */
8927
+ preference: "default" | "ipv4" | "ipv6";
8928
+ } | components["schemas"]["StackVariable"] | null;
8742
8929
  };
8743
8930
  /**
8744
8931
  * StackSpecDiscoveryService
@@ -8751,9 +8938,11 @@ export interface components {
8751
8938
  /** StackSpecHAProxyConfigSet */
8752
8939
  StackSpecHaProxyConfigSet: {
8753
8940
  frontend: {
8754
- /** @description The type of traffic expected by the load balancer for this port. Can be either:
8941
+ /**
8942
+ * @description The type of traffic expected by the load balancer for this port. Can be either:
8755
8943
  * - tcp: Traffic is forwarded without any parsing or additional manipulation.
8756
- * - http: Traffic is treated as web traffic. If a LINKED record is configured for a container exposing this port, the domain will be parsed and it will be forwarded to the proper container. This allows multiple services to run on port 80 in the same environment. */
8944
+ * - http: Traffic is treated as web traffic. If a LINKED record is configured for a container exposing this port, the domain will be parsed and it will be forwarded to the proper container. This allows multiple services to run on port 80 in the same environment.
8945
+ */
8757
8946
  mode: ("tcp" | "http") | components["schemas"]["StackVariable"];
8758
8947
  /** @description The number of simultaneous connections that can be processed at a time. */
8759
8948
  max_connections: (number | null) | components["schemas"]["StackVariable"];
@@ -8770,12 +8959,14 @@ export interface components {
8770
8959
  } | null) | components["schemas"]["StackVariable"];
8771
8960
  } | components["schemas"]["StackVariable"];
8772
8961
  backend: {
8773
- /** @description How connections are balanced across your container instances. Can be one of the following:
8962
+ /**
8963
+ * @description How connections are balanced across your container instances. Can be one of the following:
8774
8964
  * - `roundrobin`: Each container instance is used in turns.
8775
8965
  * - `static-rr`: Each container instance is used in turns, but is faster than Round Robin at the expense of being less dynamic.
8776
8966
  * - `leastconn`: Routes traffic to the instance with the least number of active connections.
8777
8967
  * - `first`: Routes traffic to the first available instance.
8778
- * - `source`: The same client IP always reaches the same container instance as long as no instance goes down or up. */
8968
+ * - `source`: The same client IP always reaches the same container instance as long as no instance goes down or up.
8969
+ */
8779
8970
  balance: ("roundrobin" | "static-rr" | "leastconn" | "first" | "source") | components["schemas"]["StackVariable"];
8780
8971
  /** @description Various options for handling timeouts when communicating with a container instance behind the load balancer. */
8781
8972
  timeouts: ({
@@ -8839,7 +9030,10 @@ export interface components {
8839
9030
  type: ("ip-match" | "geo-match" | "url-match" | "method-match" | "header-match") | components["schemas"]["StackVariable"];
8840
9031
  /** @description A string that indicates the range of values relative to the value property. */
8841
9032
  operator: ("==" | "!=" | ">" | "<" | ">=" | "<=") | components["schemas"]["StackVariable"];
8842
- /** @description The value corresponding to the condition type. */
9033
+ /**
9034
+ * @description The value corresponding to the condition type.
9035
+ * @example 0.0.0.0/0
9036
+ */
8843
9037
  value: string | components["schemas"]["StackVariable"];
8844
9038
  } | components["schemas"]["StackVariable"])[] | components["schemas"]["StackVariable"];
8845
9039
  } | components["schemas"]["StackVariable"])[] | components["schemas"]["StackVariable"];
@@ -8969,10 +9163,12 @@ export interface components {
8969
9163
  value: string | components["schemas"]["StackVariable"];
8970
9164
  } | components["schemas"]["StackVariable"])[] | null) | components["schemas"]["StackVariable"];
8971
9165
  } | null) | components["schemas"]["StackVariable"];
8972
- /** @description The URL to forward the request to.
9166
+ /**
9167
+ * @description The URL to forward the request to.
8973
9168
  *
8974
9169
  * Given a path match of `^/example/(.*)$`, a route such as `/example/wow.jpg` would be forwarded as /wow.jpg.
8975
- * */
9170
+ * @example /$$1
9171
+ */
8976
9172
  url?: string | components["schemas"]["StackVariable"];
8977
9173
  } | null) | components["schemas"]["StackVariable"];
8978
9174
  proxy?: ({
@@ -8993,7 +9189,10 @@ export interface components {
8993
9189
  } | null) | components["schemas"]["StackVariable"];
8994
9190
  caching?: ({
8995
9191
  files?: (({
8996
- /** @description Regex string that describes the files to cache. */
9192
+ /**
9193
+ * @description Regex string that describes the files to cache.
9194
+ * @example (.*)\.(js|jpg|css|png|svg)$
9195
+ */
8997
9196
  match: string | components["schemas"]["StackVariable"];
8998
9197
  /** @description Time string that describes the time to live. */
8999
9198
  ttl: components["schemas"]["Duration"] | components["schemas"]["StackVariable"];
@@ -9020,11 +9219,12 @@ export interface components {
9020
9219
  exclude?: (components["schemas"]["HybridIdentifier"][] | null) | components["schemas"]["StackVariable"];
9021
9220
  } | null) | components["schemas"]["StackVariable"];
9022
9221
  } | components["schemas"]["StackVariable"];
9023
- /** @description How to route the traffic to the destination.
9222
+ /**
9223
+ * @description How to route the traffic to the destination.
9024
9224
  * `random`: Pick a valid destination at random.
9025
9225
  * `round-robin`: Send each request to the 'next' destination on the list, restarting from the beginning when the last destination is used.
9026
9226
  * `source-ip`: Utilizes a hash function to ensure traffic from an IP will always hit the same destination instance.
9027
- * */
9227
+ */
9028
9228
  mode: ("random" | "round-robin" | "source-ip") | components["schemas"]["StackVariable"];
9029
9229
  config: {
9030
9230
  /** @description If a request comes in from the same origin, ensure it hits the same destination. */
@@ -9034,19 +9234,19 @@ export interface components {
9034
9234
  destination_prioritization?: ("latency" | "random" | "fixed") | components["schemas"]["StackVariable"] | null;
9035
9235
  /** @description TLS termination configuration. If null, the platform will use the default configuration. Port 443 by default has TLS termination enabled. */
9036
9236
  tls?: ({
9037
- /** @description [Advanced] Change the domain the controller listens on.
9038
- * */
9237
+ /** @description [Advanced] Change the domain the controller listens on. */
9039
9238
  server_name?: (string | null) | components["schemas"]["StackVariable"];
9040
9239
  /** @description If enabled, accept TLS traffic with an invalid certificate. This is usually done for development/testing, and is not recommended for production use. */
9041
9240
  allow_insecure?: (boolean | null) | components["schemas"]["StackVariable"];
9042
9241
  /** @description A PEM encoded string of certificates. */
9043
9242
  client_cert_auth?: (string | null) | components["schemas"]["StackVariable"];
9044
- /** @description Defines how to validate the connecting TLS certificate.
9243
+ /**
9244
+ * @description Defines how to validate the connecting TLS certificate.
9045
9245
  * `none`: Do not require a TLS certificate to be sent
9046
9246
  * `request`: Asks the client to send a TLS certificate, but does not require nor validate it.
9047
9247
  * `require`: Requires a certificate be sent for the request to be valid, but does not validate the certificate.
9048
9248
  * `require-verify`: Requires both that the client send a certificate, and that the certificate is valid. This is required when using https.
9049
- * */
9249
+ */
9050
9250
  client_auth?: ("none" | "request" | "require" | "require-verify") | components["schemas"]["StackVariable"] | null;
9051
9251
  } | null) | components["schemas"]["StackVariable"];
9052
9252
  /** @description Defines how the length of various sorts of timeouts when communicating with the destination. */
@@ -9075,9 +9275,10 @@ export interface components {
9075
9275
  mode: ("tcp" | "udp" | "http") | components["schemas"]["StackVariable"];
9076
9276
  /** @description Defines how the transport for this controller operates. */
9077
9277
  config: {
9078
- /** @description Enable/disable performance mode. If enabled, some telemetry will be disabled to dedicate full processing to handling requests.
9278
+ /**
9279
+ * @description Enable/disable performance mode. If enabled, some telemetry will be disabled to dedicate full processing to handling requests.
9079
9280
  * You will not see per-request breakdowns or URL logging if performance mode is enabled.
9080
- * */
9281
+ */
9081
9282
  performance: boolean | components["schemas"]["StackVariable"];
9082
9283
  /** @description Defines how traffic gets into the load balancer. */
9083
9284
  ingress: {
@@ -9189,8 +9390,15 @@ export interface components {
9189
9390
  vpn_accounts: boolean | components["schemas"]["StackVariable"];
9190
9391
  } | components["schemas"]["StackVariable"];
9191
9392
  allow_internet: boolean | components["schemas"]["StackVariable"];
9192
- /** @description Additional OpenVPN directives that will be appended to the server configuration on service start. Each line should follow standard OpenVPN syntax.
9193
- * */
9393
+ /**
9394
+ * @description Additional OpenVPN directives that will be appended to the server configuration on service start. Each line should follow standard OpenVPN syntax.
9395
+ * @example client-to-client
9396
+ * duplicate-cn
9397
+ * persist-key
9398
+ * persist-tun
9399
+ * @example verb 3
9400
+ * mute 10
9401
+ */
9194
9402
  custom_directives?: string | null;
9195
9403
  };
9196
9404
  /**
@@ -9205,7 +9413,6 @@ export interface components {
9205
9413
  * StackSpec
9206
9414
  * @description A Cycle stack file is an "environment as code". This allows an environment to be generated consistently based on a fixed specification.
9207
9415
  * Stack files can describe multiple containers and their configurations, environment service settings, scoped variables, and important metadata.
9208
- *
9209
9416
  */
9210
9417
  StackSpec: {
9211
9418
  /**
@@ -9503,8 +9710,7 @@ export interface components {
9503
9710
  * @enum {string}
9504
9711
  */
9505
9712
  action: "volumes.reconfigure";
9506
- /** @description A map of volume objects where the key is the id and the value is the volume's config.
9507
- * */
9713
+ /** @description A map of volume objects where the key is the id and the value is the volume's config. */
9508
9714
  contents: {
9509
9715
  [key: string]: components["schemas"]["ContainerVolume"];
9510
9716
  };
@@ -9555,7 +9761,10 @@ export interface components {
9555
9761
  [key: string]: {
9556
9762
  /** @description String describing the server mount type. */
9557
9763
  type: string;
9558
- /** @description Comma separated string describing the server mount options. */
9764
+ /**
9765
+ * @description Comma separated string describing the server mount options.
9766
+ * @example key1=value1,key2=value2
9767
+ */
9559
9768
  options: string;
9560
9769
  /** @description String describing the server mount source. */
9561
9770
  source: string;
@@ -9644,9 +9853,9 @@ export interface components {
9644
9853
  * @description The current state of the node.
9645
9854
  * @enum {string}
9646
9855
  */
9647
- current: "new" | "offline" | "authorizing" | "online" | "decommissioned";
9856
+ current: "new" | "offline" | "authorizing" | "online" | "decommissioned" | "deleted";
9648
9857
  changed: components["schemas"]["DateTime"];
9649
- desired?: ("new" | "offline" | "authorizing" | "online" | "decommissioned") | null;
9858
+ desired?: ("new" | "offline" | "authorizing" | "online" | "decommissioned" | "deleted") | null;
9650
9859
  } & components["schemas"]["State"];
9651
9860
  /**
9652
9861
  * ServerStatsNetwork
@@ -9967,8 +10176,8 @@ export interface components {
9967
10176
  region: string;
9968
10177
  };
9969
10178
  /**
9970
- * LocationProvider
9971
- * @description Information about the locaiton of the provider.
10179
+ * ProviderLocationDetails
10180
+ * @description Information about the location of the provider.
9972
10181
  */
9973
10182
  ProviderLocationDetails: {
9974
10183
  /** @description An identifier for the given provider */
@@ -10034,6 +10243,8 @@ export interface components {
10034
10243
  creator: components["schemas"]["CreatorScope"];
10035
10244
  hub_id: components["schemas"]["HubID"];
10036
10245
  acl?: components["schemas"]["ACL"] | null;
10246
+ /** @description Marks a cluster as non-essential. Non-essential cluster resources are excluded by default from certain metrics and summaries unless opted in. */
10247
+ non_essential: boolean;
10037
10248
  state: components["schemas"]["ClusterState"];
10038
10249
  features: {
10039
10250
  /** @description The level of monitoring to enable for this cluster. There is a cost associated with higher levels of monitoring. */
@@ -10156,10 +10367,10 @@ export interface components {
10156
10367
  } | null;
10157
10368
  };
10158
10369
  /**
10159
- * ServerSpecs
10370
+ * ProviderServerModelSpec
10160
10371
  * @description Specs for a given server
10161
10372
  */
10162
- ServerSpecs: {
10373
+ ProviderServerModelSpec: {
10163
10374
  cpu: components["schemas"]["CPUSpec"];
10164
10375
  gpu: components["schemas"]["GPUSpec"];
10165
10376
  memory: components["schemas"]["MemorySpec"];
@@ -10168,11 +10379,13 @@ export interface components {
10168
10379
  features: components["schemas"]["FeaturesSpec"];
10169
10380
  };
10170
10381
  /**
10171
- * ProviderServerSpec
10382
+ * ProviderServerModelProviderSpec
10172
10383
  * @description Higher level information about a providers server.
10173
10384
  */
10174
- ProviderServerSpec: {
10175
- /** @description A provider identifier */
10385
+ ProviderServerModelProviderSpec: {
10386
+ /** @description The infrastructure vendor for the provider. */
10387
+ vendor?: string;
10388
+ /** @description A provider identifier. */
10176
10389
  identifier: string;
10177
10390
  integration_id?: components["schemas"]["ID"] | null;
10178
10391
  /** @description A category for the server. */
@@ -10197,8 +10410,8 @@ export interface components {
10197
10410
  name: string;
10198
10411
  /** @description A description of the server. */
10199
10412
  description: string;
10200
- specs: components["schemas"]["ServerSpecs"];
10201
- provider: components["schemas"]["ProviderServerSpec"];
10413
+ specs: components["schemas"]["ProviderServerModelSpec"];
10414
+ provider: components["schemas"]["ProviderServerModelProviderSpec"];
10202
10415
  price: components["schemas"]["BillingAmount"];
10203
10416
  /** @description A boolean where true signifies this server is compatible with the platform. */
10204
10417
  compatible: boolean;
@@ -10208,10 +10421,10 @@ export interface components {
10208
10421
  location_ids: string[];
10209
10422
  };
10210
10423
  /**
10211
- * ServerModelIncludes
10212
- * @description A resources that assocaited with a provider server.
10424
+ * ProviderServerModelsIncludes
10425
+ * @description A resource associated with a server models.
10213
10426
  */
10214
- ServerModelIncludes: {
10427
+ ProviderServerModelsIncludes: {
10215
10428
  [key: string]: components["schemas"]["ProviderServerModel"];
10216
10429
  };
10217
10430
  /** IntegrationAuth */
@@ -10372,7 +10585,7 @@ export interface components {
10372
10585
  clusters?: {
10373
10586
  [key: string]: components["schemas"]["Cluster"];
10374
10587
  };
10375
- models?: components["schemas"]["ServerModelIncludes"];
10588
+ models?: components["schemas"]["ProviderServerModelsIncludes"];
10376
10589
  integrations?: components["schemas"]["IntegrationsIncludes"];
10377
10590
  };
10378
10591
  /**
@@ -10413,15 +10626,28 @@ export interface components {
10413
10626
  current: "new" | "starting" | "migrating" | "running" | "stopping" | "stopped" | "failed" | "deleting" | "deleted";
10414
10627
  /** @description information about the health of the instance. */
10415
10628
  health?: {
10416
- /** @description Describes the healthiness of the instance. Health checks can be configured at the container level.
10629
+ /**
10630
+ * @description Describes the healthiness of the instance. Health checks can be configured at the container level.
10417
10631
  * - `true`: The instance is considered healthy.
10418
10632
  * - `false`: The instance is considered unhealthy.
10419
10633
  * - `null`: The instance has not yet reported its health, or a health check has not yet been performed.
10420
- * */
10634
+ */
10421
10635
  healthy: boolean | null;
10422
10636
  /** @description A timestamp of the last time the instance health was updated. */
10423
10637
  updated: components["schemas"]["DateTime"];
10424
10638
  } | null;
10639
+ /** @description information about the readiness of the instance. */
10640
+ readiness?: {
10641
+ /**
10642
+ * @description Describes the readiness of the instance.
10643
+ * - `true`: The instance is ready.
10644
+ * - `false`: The instance is not ready.
10645
+ * - `null`: The instance has not yet reported its readiness, or a readiness check has not yet been performed.
10646
+ */
10647
+ ready: boolean | null;
10648
+ /** @description A timestamp of the last time the instance readiness was updated. */
10649
+ updated: components["schemas"]["DateTime"];
10650
+ } | null;
10425
10651
  } & components["schemas"]["State"];
10426
10652
  /**
10427
10653
  * InstanceAutoScale
@@ -11009,7 +11235,6 @@ export interface components {
11009
11235
  /**
11010
11236
  * VirtualMachineNetworkConfig
11011
11237
  * @description Defines the network settings for a virtual machine, including public access mode, hostname, and ports.
11012
- *
11013
11238
  */
11014
11239
  VirtualMachineNetworkConfig: {
11015
11240
  /**
@@ -11027,7 +11252,6 @@ export interface components {
11027
11252
  /**
11028
11253
  * VirtualMachineDeployTags
11029
11254
  * @description Tags that define node requirements for the deployment. The `any` tag must match at least one condition, while `all` must match all conditions.
11030
- *
11031
11255
  */
11032
11256
  VirtualMachineDeployTags: {
11033
11257
  any?: string[] | null;
@@ -11036,7 +11260,6 @@ export interface components {
11036
11260
  /**
11037
11261
  * VirtualMachineNodeConstraints
11038
11262
  * @description Node-level constraints for the virtual machine deployment, specifying tags that must or must not be present.
11039
- *
11040
11263
  */
11041
11264
  VirtualMachineNodeConstraints: {
11042
11265
  tags: components["schemas"]["VirtualMachineDeployTags"];
@@ -11044,7 +11267,6 @@ export interface components {
11044
11267
  /**
11045
11268
  * VirtualMachineDeployConstraints
11046
11269
  * @description Constraints define node-level and resource restrictions for the virtual machine deployment.
11047
- *
11048
11270
  */
11049
11271
  VirtualMachineDeployConstraints: {
11050
11272
  node?: components["schemas"]["VirtualMachineNodeConstraints"] | null;
@@ -11054,7 +11276,6 @@ export interface components {
11054
11276
  /**
11055
11277
  * VirtualMachineShutdownPolicy
11056
11278
  * @description The shutdown policy defines how the virtual machine should handle shutdown, including a timeout and signals to be sent during shutdown.
11057
- *
11058
11279
  */
11059
11280
  VirtualMachineShutdownPolicy: {
11060
11281
  /** @description The timeout period for graceful shutdown. */
@@ -11063,7 +11284,6 @@ export interface components {
11063
11284
  /**
11064
11285
  * VirtualMachineStartupPolicy
11065
11286
  * @description The startup policy defines how the virtual machine should handle startup, including a possible delay before starting the machine.
11066
- *
11067
11287
  */
11068
11288
  VirtualMachineStartupPolicy: {
11069
11289
  /** @description Delay before startup. */
@@ -11072,7 +11292,6 @@ export interface components {
11072
11292
  /**
11073
11293
  * VirtualMachineTelemetryConfig
11074
11294
  * @description The telemetry configuration defines how telemetry data is handled, including retention, interval, and whether telemetry is disabled.
11075
- *
11076
11295
  */
11077
11296
  VirtualMachineTelemetryConfig: {
11078
11297
  /** @description Data retention duration for telemetry. */
@@ -11085,7 +11304,6 @@ export interface components {
11085
11304
  /**
11086
11305
  * VirtualMachineDeployConfig
11087
11306
  * @description Represents the deployment configuration for a virtual machine, including constraints, shutdown/startup policies, restart conditions, and telemetry settings.
11088
- *
11089
11307
  */
11090
11308
  VirtualMachineDeployConfig: {
11091
11309
  constraints?: components["schemas"]["VirtualMachineDeployConstraints"] | null;
@@ -11096,10 +11314,13 @@ export interface components {
11096
11314
  /**
11097
11315
  * VirtualMachineRamResources
11098
11316
  * @description Defines the RAM configuration of a virtual machine.
11099
- *
11100
11317
  */
11101
11318
  VirtualMachineRamResources: {
11102
- /** @description The limit (maximum) amount of RAM the virtual machine can consume. Must be at least 512M and less than 65GB. */
11319
+ /**
11320
+ * @description The limit (maximum) amount of RAM the virtual machine can consume. Must be at least 512M and less than 65GB.
11321
+ * @example 1G
11322
+ * @example 512M
11323
+ */
11103
11324
  limit: string;
11104
11325
  /** @description Whether or not the RAM set in limit should be preallocated. */
11105
11326
  allocate?: boolean | null;
@@ -11107,22 +11328,29 @@ export interface components {
11107
11328
  /**
11108
11329
  * VirtualMachineCpuResources
11109
11330
  * @description Defines the CPU configuration of a virtual machine. Set **either** `cores` or `cpus`.
11110
- *
11111
11331
  */
11112
11332
  VirtualMachineCpuResources: {
11113
11333
  cores?: {
11114
- /** @description The number of cores to assign to this virtual machine. Must be between 1 and 32. */
11334
+ /**
11335
+ * @description The number of cores to assign to this virtual machine. Must be between 1 and 32.
11336
+ * @example 1
11337
+ * @example 2
11338
+ */
11115
11339
  number: number;
11116
11340
  /** @description If true, reserves the cores so they cannot be used by any other virtual machine. */
11117
11341
  allocate?: boolean | null;
11118
11342
  } | null;
11119
- /** @description The specific cores/range of cores to allocate to the virtual machine. An 'x' indicates the maximum core for a given machine. */
11343
+ /**
11344
+ * @description The specific cores/range of cores to allocate to the virtual machine. An 'x' indicates the maximum core for a given machine.
11345
+ * @example 1
11346
+ * @example 1-3
11347
+ * @example 2-x
11348
+ */
11120
11349
  cpus?: string | null;
11121
11350
  };
11122
11351
  /**
11123
11352
  * VirtualMachineResourcesConfig
11124
11353
  * @description Defines the resource settings for a virtual machine, including CPU and RAM.
11125
- *
11126
11354
  */
11127
11355
  VirtualMachineResourcesConfig: {
11128
11356
  ram: components["schemas"]["VirtualMachineRamResources"];
@@ -11160,7 +11388,6 @@ export interface components {
11160
11388
  /**
11161
11389
  * VirtualMachineRuntimeConfigHardware
11162
11390
  * @description Hardware parameters applied for VM runtime.
11163
- *
11164
11391
  */
11165
11392
  VirtualMachineRuntimeConfigHardware: {
11166
11393
  /** @description QEMU machine type to emulate. */
@@ -11186,13 +11413,11 @@ export interface components {
11186
11413
  /**
11187
11414
  * VirtualMachineRuntimeConfigAttachment
11188
11415
  * @description Additional attachment (ISO, etc) added during runtime.
11189
- *
11190
11416
  */
11191
11417
  VirtualMachineRuntimeConfigAttachment: components["schemas"]["VirtualMachineAttachmentTypeIso"];
11192
11418
  /**
11193
11419
  * VirtualMachineRuntimeConfig
11194
11420
  * @description Defines the runtime settings for a virtual machine.
11195
- *
11196
11421
  */
11197
11422
  VirtualMachineRuntimeConfig: {
11198
11423
  /** @description Hardware parameters applied for VM runtime. */
@@ -11205,7 +11430,6 @@ export interface components {
11205
11430
  /**
11206
11431
  * VirtualMachineConfig
11207
11432
  * @description Defines the network and deployment configurations for a virtual machine.
11208
- *
11209
11433
  */
11210
11434
  VirtualMachineConfig: {
11211
11435
  network: components["schemas"]["VirtualMachineNetworkConfig"];
@@ -11280,18 +11504,19 @@ export interface components {
11280
11504
  /**
11281
11505
  * VirtualMachineImage
11282
11506
  * @description Represents the image used by a virtual machine. It can either reference a URL where the image is located or specify a base image provided by Cycle.
11283
- *
11284
11507
  */
11285
11508
  VirtualMachineImage: components["schemas"]["VirtualMachineImageSourceUrl"] | components["schemas"]["VirtualMachineImageSourceIpxe"] | components["schemas"]["VirtualMachineImageSourceBase"] | components["schemas"]["VirtualMachineImageSourceExternalVolume"];
11286
11509
  /**
11287
11510
  * VirtualMachineVolumeConfig
11288
11511
  * @description Represents the configuration for a volume attached to a virtual machine.
11289
- *
11290
11512
  */
11291
11513
  VirtualMachineVolumeConfig: {
11292
11514
  /** @description Configuration details for a local volume. */
11293
11515
  local?: {
11294
- /** @description The maximum size allowed for the local volume. */
11516
+ /**
11517
+ * @description The maximum size allowed for the local volume.
11518
+ * @example 100G
11519
+ */
11295
11520
  max_size: string;
11296
11521
  /** @description Indicates if the volume is part of a storage pool. */
11297
11522
  storage_pool?: boolean | null;
@@ -11308,7 +11533,6 @@ export interface components {
11308
11533
  /**
11309
11534
  * VirtualMachineVolume
11310
11535
  * @description Represents a storage volume attached to a virtual machine.
11311
- *
11312
11536
  */
11313
11537
  VirtualMachineVolume: {
11314
11538
  id: components["schemas"]["ID"];
@@ -11348,7 +11572,6 @@ export interface components {
11348
11572
  /**
11349
11573
  * VirtualMachine
11350
11574
  * @description Describes a virtual machine running on the Cycle Platform.
11351
- *
11352
11575
  */
11353
11576
  VirtualMachine: {
11354
11577
  id: components["schemas"]["ID"];
@@ -11356,8 +11579,7 @@ export interface components {
11356
11579
  name: string;
11357
11580
  identifier: components["schemas"]["Identifier"];
11358
11581
  creator: components["schemas"]["CreatorScope"];
11359
- /** @description Basic information about the environment this virtual machine is in.
11360
- * */
11582
+ /** @description Basic information about the environment this virtual machine is in. */
11361
11583
  environment: {
11362
11584
  id: components["schemas"]["ID"];
11363
11585
  /** @description The cluster this environment is associated with. */
@@ -11618,13 +11840,25 @@ export interface components {
11618
11840
  file?: {
11619
11841
  /** @description When true, Cycle will interpret this variable as a base-64 encoded string, and decode it before passing it into the container. */
11620
11842
  decode: boolean;
11621
- /** @description The path to mount the file to inside the container. */
11843
+ /**
11844
+ * @description The path to mount the file to inside the container.
11845
+ * @example /var/run/cycle/variables/<myVariable>
11846
+ */
11622
11847
  path: string | null;
11623
- /** @description A linux file mode that will be set on the injected file. */
11848
+ /**
11849
+ * @description A linux file mode that will be set on the injected file.
11850
+ * @example 0644
11851
+ */
11624
11852
  permissions?: string | null;
11625
- /** @description The linux UID to set on the file. */
11853
+ /**
11854
+ * @description The linux UID to set on the file.
11855
+ * @example 777
11856
+ */
11626
11857
  uid?: number | null;
11627
- /** @description The linux GID to set on the file. */
11858
+ /**
11859
+ * @description The linux GID to set on the file.
11860
+ * @example 777
11861
+ */
11628
11862
  gid?: number | null;
11629
11863
  } | null;
11630
11864
  };
@@ -11787,13 +12021,26 @@ export interface components {
11787
12021
  destinations: {
11788
12022
  [key: string]: {
11789
12023
  requests: {
11790
- /** @description The host name of the URL request. */
12024
+ /**
12025
+ * @description The host name of the URL request.
12026
+ * @example abc.cycle.io
12027
+ */
11791
12028
  host: string;
11792
- /** @description The HTTP method of the URL request. */
12029
+ /**
12030
+ * @description The HTTP method of the URL request.
12031
+ * @example GET
12032
+ */
11793
12033
  method: string;
11794
- /** @description The path portion of the inbound URL request. */
12034
+ /**
12035
+ * @description The path portion of the inbound URL request.
12036
+ * @example /pathname
12037
+ */
11795
12038
  path: string;
11796
- /** @description The number of requests to a this URL. */
12039
+ /**
12040
+ * @description The number of requests to a this URL.
12041
+ * @example 5
12042
+ * @example 10
12043
+ */
11797
12044
  total: number;
11798
12045
  /** @description The date of the most recent hit to the URL. */
11799
12046
  last_hit: components["schemas"]["DateTime"];
@@ -11808,11 +12055,21 @@ export interface components {
11808
12055
  /** @description Object containing hit count and timing data for redirect responses. */
11809
12056
  redirect: components["schemas"]["LoadBalancerTelemetryUrlRequestHandler"];
11810
12057
  };
11811
- /** @description An object where the key is the response type and the value is the number of hits with that response. */
12058
+ /**
12059
+ * @description An object where the key is the response type and the value is the number of hits with that response.
12060
+ * @example {
12061
+ * "http:404": 10
12062
+ * }
12063
+ */
11812
12064
  responses?: {
11813
12065
  [key: string]: number;
11814
12066
  };
11815
- /** @description An object where the key is the error type and the value is the number of hits with that error. */
12067
+ /**
12068
+ * @description An object where the key is the error type and the value is the number of hits with that error.
12069
+ * @example {
12070
+ * "i/o timeout": 1
12071
+ * }
12072
+ */
11816
12073
  errors?: {
11817
12074
  [key: string]: number;
11818
12075
  };
@@ -12060,8 +12317,15 @@ export interface components {
12060
12317
  config?: {
12061
12318
  /** @description If true, routes all traffic through the VPN, even non-Cycle traffic. */
12062
12319
  allow_internet?: boolean;
12063
- /** @description Additional OpenVPN directives that will be appended to the server configuration on service start. Each line should follow standard OpenVPN syntax.
12064
- * */
12320
+ /**
12321
+ * @description Additional OpenVPN directives that will be appended to the server configuration on service start. Each line should follow standard OpenVPN syntax.
12322
+ * @example client-to-client
12323
+ * duplicate-cn
12324
+ * persist-key
12325
+ * persist-tun
12326
+ * @example verb 3
12327
+ * mute 10
12328
+ */
12065
12329
  custom_directives?: string | null;
12066
12330
  /** @description Auth configuration for the VPN. */
12067
12331
  auth?: {
@@ -12155,7 +12419,6 @@ export interface components {
12155
12419
  ActivitySecurity: {
12156
12420
  /**
12157
12421
  * @description A risk level assessed by the platform. Depending on the nature of the incident, this may change even if the event type is the same.
12158
- *
12159
12422
  * @enum {string}
12160
12423
  */
12161
12424
  risk: "info" | "low" | "medium" | "high" | "critical";
@@ -12182,7 +12445,6 @@ export interface components {
12182
12445
  ActivityMonitor: {
12183
12446
  /**
12184
12447
  * @description The severity of the event.
12185
- *
12186
12448
  * @enum {string}
12187
12449
  */
12188
12450
  level: "info" | "low" | "medium" | "high" | "critical";
@@ -12214,13 +12476,14 @@ export interface components {
12214
12476
  /** @description The given user's ID. */
12215
12477
  id: string;
12216
12478
  };
12217
- /** @description A number representing the detail level (verbosity) of this activity.
12479
+ /**
12480
+ * @description A number representing the detail level (verbosity) of this activity.
12218
12481
  *
12219
12482
  * ## Levels
12220
12483
  * - 0: activity that other users would find useful
12221
12484
  * - 1: activity that can be useful in tracking down how a user did something
12222
12485
  * - 2: full activity, can be useful in debugging problems
12223
- * */
12486
+ */
12224
12487
  verbosity: number;
12225
12488
  context: components["schemas"]["Context"];
12226
12489
  session: components["schemas"]["Session"] | null;
@@ -12254,7 +12517,7 @@ export interface components {
12254
12517
  * @description The activity event.
12255
12518
  * @enum {string}
12256
12519
  */
12257
- event: "hub.images.prune" | "hub.update" | "hub.create" | "hub.task.delete" | "hub.task.images.prune" | "environment.services.discovery.reconfigure" | "environment.services.lb.reconfigure" | "environment.services.vpn.reconfigure" | "environment.services.scheduler.reconfigure" | "environment.delete" | "environment.initialize" | "environment.start" | "environment.stop" | "environment.create" | "environment.update" | "environment.task.delete" | "environment.services.discovery.task.reconfigure" | "environment.services.lb.task.reconfigure" | "environment.services.vpn.task.reconfigure" | "environment.services.scheduler.task.reconfigure" | "environment.services.vpn.user.create" | "environment.services.vpn.login" | "environment.services.vpn.reset" | "environment.services.vpn.task.reset" | "environment.task.initialize" | "environment.task.start" | "environment.task.stop" | "environment.task.deployments.reconfigure" | "environment.deployments.reconfigure" | "environment.task.monitoring.reconfigure" | "environment.monitoring.reconfigure" | "environment.deployments.prune" | "environment.deployment.start" | "environment.deployment.stop" | "environment.scoped-variable.delete" | "environment.scoped-variable.update" | "environment.scoped-variable.task.delete" | "environment.scoped-variable.create" | "image.delete" | "image.import" | "image.create" | "image.update" | "image.task.delete" | "image.task.import" | "image.source.delete" | "image.source.create" | "image.source.update" | "image.source.task.delete" | "billing.invoice.task.void" | "billing.invoice.task.credit" | "billing.invoice.task.refund" | "billing.invoice.pay" | "billing.invoice.task.pay" | "billing.order.confirm" | "billing.order.task.confirm" | "billing.method.update" | "billing.method.delete" | "billing.method.task.delete" | "billing.method.create" | "hub.apikey.update" | "hub.apikey.delete" | "hub.apikey.create" | "hub.role.update" | "hub.role.delete" | "hub.role.create" | "hub.role.task.delete" | "hub.membership.delete" | "hub.membership.create" | "hub.membership.update" | "hub.integration.create" | "hub.integration.update" | "hub.integration.delete" | "hub.integration.task.verify" | "hub.integration.task.delete" | "hub.inactive" | "container.initialize" | "container.task.start" | "container.start" | "container.task.stop" | "container.stop" | "container.task.restart" | "container.restart" | "container.task.reconfigure" | "container.reconfigure" | "container.task.volumes.reconfigure" | "container.function.trigger" | "container.function.task.trigger" | "container.volumes.reconfigure" | "container.create" | "container.restart" | "container.task.reimage" | "container.reimage" | "container.deprecate" | "container.update" | "container.task.delete" | "container.delete" | "container.task.scale" | "container.scale" | "container.instances.create" | "container.instances.delete" | "container.instances.autoscale.up" | "container.instances.autoscale.down" | "container.instance.healthcheck.restarted" | "container.instance.volume.extend" | "container.instance.task.volume.extend" | "container.instance.healthcheck.failed" | "container.instance.error" | "container.instance.ssh.login" | "container.instance.migration.start" | "container.instance.migration.revert" | "container.instance.delete" | "container.instance.task.migration.revert" | "container.instance.task.migration.start" | "container.instance.traffic-drain.reconfigure" | "container.backup.create" | "container.backup.restore" | "container.backup.delete" | "container.backup.task.delete" | "container.backup.task.restore" | "dns.zone.verify" | "dns.zone.delete" | "dns.zone.task.verify" | "dns.zone.update" | "dns.zone.task.delete" | "dns.zone.create" | "dns.zone.record.delete" | "dns.zone.record.cert.generate" | "dns.zone.record.cert.generate.auto" | "dns.zone.record.task.cert.generate" | "dns.zone.record.update" | "dns.zone.record.task.delete" | "dns.zone.record.create" | "dns.certificate.associate" | "dns.certificate.deprecate" | "dns.certificate.create" | "dns.certificate.task.deprecate" | "stack.update" | "stack.task.delete" | "stack.delete" | "stack.create" | "stack.task.prune" | "stack.prune" | "stack.build.create" | "stack.build.generate" | "stack.build.deploy" | "stack.build.delete" | "stack.build.task.delete" | "stack.build.task.generate" | "stack.build.task.deploy" | "infrastructure.provider.update" | "infrastructure.provider.task.delete" | "infrastructure.provider.create" | "infrastructure.provider.task.verify" | "infrastructure.virtual-providers.iso.create" | "infrastructure.virtual-providers.iso.generate" | "infrastructure.virtual-providers.iso.update" | "infrastructure.virtual-providers.iso.delete" | "infrastructure.virtual-providers.iso.task.delete" | "infrastructure.server.task.delete" | "infrastructure.server.task.restart" | "infrastructure.server.services.sftp.auth" | "infrastructure.server.live" | "infrastructure.server.delete" | "infrastructure.server.restart" | "infrastructure.server.unquarantine" | "infrastructure.server.compute.restart" | "infrastructure.server.compute.spawner.restart" | "infrastructure.server.features.reconfigure" | "infrastructure.server.sharedfs.reconfigure" | "infrastructure.server.provision" | "infrastructure.server.console" | "infrastructure.server.update" | "infrastructure.server.task.provision" | "infrastructure.server.ssh.token" | "infrastructure.server.task.features.reconfigure" | "infrastructure.server.task.sharedfs.reconfigure" | "infrastructure.server.services.sftp.lockdown" | "infrastructure.server.services.internal-api.throttle" | "infrastructure.server.evacuation.start" | "infrastructure.server.task.evacuation.start" | "infrastructure.server.evacuation.reset" | "infrastructure.server.task.evacuation.reset" | "infrastructure.server.power-off" | "infrastructure.server.auth.reset" | "infrastructure.autoscale.group.create" | "infrastructure.autoscale.group.update" | "infrastructure.autoscale.group.task.delete" | "infrastructure.autoscale.group.delete" | "infrastructure.external-volume.create" | "infrastructure.external-volume.update" | "infrastructure.external-volume.task.delete" | "infrastructure.external-volume.delete" | "infrastructure.external-volume.task.servers.reconfigure" | "infrastructure.external-volume.servers.reconfigure" | "infrastructure.cluster.create" | "infrastructure.cluster.update" | "infrastructure.cluster.task.delete" | "infrastructure.cluster.delete" | "infrastructure.cluster.features.monitoring.tier.reconfigure" | "infrastructure.ips.pool.task.delete" | "infrastructure.ips.pool.create" | "sdn.network.update" | "sdn.network.task.delete" | "sdn.network.create" | "sdn.network.task.reconfigure" | "pipeline.delete" | "pipeline.trigger" | "pipeline.update" | "pipeline.task.delete" | "pipeline.create" | "pipeline.task.trigger" | "pipeline.run.completed" | "pipeline.key.update" | "pipeline.key.delete" | "pipeline.key.create" | "virtual-machine.create" | "virtual-machine.initialize" | "virtual-machine.task.start" | "virtual-machine.start" | "virtual-machine.task.stop" | "virtual-machine.stop" | "virtual-machine.reconfigure" | "virtual-machine.task.reconfigure" | "virtual-machine.update" | "virtual-machine.task.delete" | "virtual-machine.delete" | "virtual-machine.sos.login" | "virtual-machine.rootpw.change" | "virtual-machine.task.volumes.reconfigure" | "virtual-machine.volumes.reconfigure" | "virtual-machine.ssh-key.create" | "virtual-machine.ssh-key.update" | "virtual-machine.ssh-key.task.delete" | "virtual-machine.ssh-key.delete" | "virtual-machine.ip.allocate" | "virtual-machine.task.ip.allocate" | "virtual-machine.ip.unallocate" | "virtual-machine.task.ip.unallocate";
12520
+ event: "hub.images.prune" | "hub.update" | "hub.create" | "hub.task.delete" | "hub.task.images.prune" | "environment.services.discovery.reconfigure" | "environment.services.lb.reconfigure" | "environment.services.vpn.reconfigure" | "environment.services.scheduler.reconfigure" | "environment.delete" | "environment.initialize" | "environment.start" | "environment.stop" | "environment.create" | "environment.update" | "environment.task.delete" | "environment.services.discovery.task.reconfigure" | "environment.services.lb.task.reconfigure" | "environment.services.vpn.task.reconfigure" | "environment.services.scheduler.task.reconfigure" | "environment.services.vpn.user.create" | "environment.services.vpn.login" | "environment.services.vpn.reset" | "environment.services.vpn.task.reset" | "environment.task.initialize" | "environment.task.start" | "environment.task.stop" | "environment.task.deployments.reconfigure" | "environment.deployments.reconfigure" | "environment.task.monitoring.reconfigure" | "environment.monitoring.reconfigure" | "environment.deployments.prune" | "environment.deployment.start" | "environment.deployment.stop" | "environment.scoped-variable.delete" | "environment.scoped-variable.update" | "environment.scoped-variable.task.delete" | "environment.scoped-variable.create" | "image.delete" | "image.import" | "image.create" | "image.update" | "image.task.delete" | "image.task.import" | "image.source.delete" | "image.source.create" | "image.source.update" | "image.source.task.delete" | "billing.invoice.task.void" | "billing.invoice.task.credit" | "billing.invoice.task.refund" | "billing.invoice.pay" | "billing.invoice.task.pay" | "billing.order.confirm" | "billing.order.task.confirm" | "billing.method.update" | "billing.method.delete" | "billing.method.task.delete" | "billing.method.create" | "hub.apikey.update" | "hub.apikey.delete" | "hub.apikey.create" | "hub.role.update" | "hub.role.delete" | "hub.role.create" | "hub.role.task.delete" | "hub.membership.delete" | "hub.membership.create" | "hub.membership.update" | "hub.integration.create" | "hub.integration.update" | "hub.integration.delete" | "hub.integration.task.verify" | "hub.integration.task.delete" | "hub.inactive" | "container.initialize" | "container.task.start" | "container.start" | "container.task.stop" | "container.stop" | "container.task.restart" | "container.restart" | "container.task.reconfigure" | "container.reconfigure" | "container.task.volumes.reconfigure" | "container.function.trigger" | "container.function.task.trigger" | "container.volumes.reconfigure" | "container.create" | "container.restart" | "container.task.reimage" | "container.reimage" | "container.deprecate" | "container.update" | "container.task.delete" | "container.delete" | "container.task.scale" | "container.scale" | "container.instances.create" | "container.instances.delete" | "container.instances.autoscale.up" | "container.instances.autoscale.down" | "container.instance.healthcheck.restarted" | "container.instance.volume.extend" | "container.instance.task.volume.extend" | "container.instance.healthcheck.failed" | "container.instance.error" | "container.instance.ssh.login" | "container.instance.migration.start" | "container.instance.migration.revert" | "container.instance.delete" | "container.instance.task.migration.revert" | "container.instance.task.migration.start" | "container.instance.traffic-drain.reconfigure" | "container.backup.create" | "container.backup.restore" | "container.backup.delete" | "container.backup.task.delete" | "container.backup.task.restore" | "dns.zone.verify" | "dns.zone.delete" | "dns.zone.task.verify" | "dns.zone.update" | "dns.zone.task.delete" | "dns.zone.create" | "dns.zone.record.delete" | "dns.zone.record.cert.generate" | "dns.zone.record.cert.generate.auto" | "dns.zone.record.task.cert.generate" | "dns.zone.record.update" | "dns.zone.record.task.delete" | "dns.zone.record.create" | "dns.certificate.associate" | "dns.certificate.deprecate" | "dns.certificate.create" | "dns.certificate.task.deprecate" | "stack.update" | "stack.task.delete" | "stack.delete" | "stack.create" | "stack.task.prune" | "stack.prune" | "stack.build.create" | "stack.build.generate" | "stack.build.deploy" | "stack.build.delete" | "stack.build.task.delete" | "stack.build.task.generate" | "stack.build.task.deploy" | "infrastructure.provider.update" | "infrastructure.provider.task.delete" | "infrastructure.provider.create" | "infrastructure.provider.task.verify" | "infrastructure.virtual-providers.iso.create" | "infrastructure.virtual-providers.iso.generate" | "infrastructure.virtual-providers.iso.update" | "infrastructure.virtual-providers.iso.delete" | "infrastructure.virtual-providers.iso.task.delete" | "infrastructure.server.task.delete" | "infrastructure.server.task.restart" | "infrastructure.server.services.sftp.auth" | "infrastructure.server.live" | "infrastructure.server.delete" | "infrastructure.server.restart" | "infrastructure.server.unquarantine" | "infrastructure.server.compute.restart" | "infrastructure.server.compute.spawner.restart" | "infrastructure.server.features.reconfigure" | "infrastructure.server.sharedfs.reconfigure" | "infrastructure.server.provision" | "infrastructure.server.console" | "infrastructure.server.update" | "infrastructure.server.task.provision" | "infrastructure.server.ssh.token" | "infrastructure.server.task.features.reconfigure" | "infrastructure.server.task.sharedfs.reconfigure" | "infrastructure.server.services.sftp.lockdown" | "infrastructure.server.services.internal-api.throttle" | "infrastructure.server.evacuation.start" | "infrastructure.server.task.evacuation.start" | "infrastructure.server.evacuation.reset" | "infrastructure.server.task.evacuation.reset" | "infrastructure.server.power-off" | "infrastructure.server.auth.reset" | "infrastructure.autoscale.group.create" | "infrastructure.autoscale.group.update" | "infrastructure.autoscale.group.task.delete" | "infrastructure.autoscale.group.delete" | "infrastructure.external-volume.create" | "infrastructure.external-volume.update" | "infrastructure.external-volume.task.delete" | "infrastructure.external-volume.delete" | "infrastructure.external-volume.task.servers.reconfigure" | "infrastructure.external-volume.task.attachment.reconfigure" | "infrastructure.external-volume.servers.reconfigure" | "infrastructure.external-volume.attachment.reconfigure" | "infrastructure.external-volumes.task.scan" | "infrastructure.cluster.create" | "infrastructure.cluster.update" | "infrastructure.cluster.task.delete" | "infrastructure.cluster.delete" | "infrastructure.cluster.features.monitoring.tier.reconfigure" | "infrastructure.ips.pool.task.delete" | "infrastructure.ips.pool.create" | "sdn.network.update" | "sdn.network.task.delete" | "sdn.network.create" | "sdn.network.task.reconfigure" | "pipeline.delete" | "pipeline.trigger" | "pipeline.update" | "pipeline.task.delete" | "pipeline.create" | "pipeline.task.trigger" | "pipeline.run.completed" | "pipeline.key.update" | "pipeline.key.delete" | "pipeline.key.create" | "virtual-machine.create" | "virtual-machine.initialize" | "virtual-machine.task.start" | "virtual-machine.start" | "virtual-machine.task.stop" | "virtual-machine.stop" | "virtual-machine.reconfigure" | "virtual-machine.task.reconfigure" | "virtual-machine.update" | "virtual-machine.task.delete" | "virtual-machine.delete" | "virtual-machine.sos.login" | "virtual-machine.rootpw.change" | "virtual-machine.task.volumes.reconfigure" | "virtual-machine.volumes.reconfigure" | "virtual-machine.ssh-key.create" | "virtual-machine.ssh-key.update" | "virtual-machine.ssh-key.task.delete" | "virtual-machine.ssh-key.delete" | "virtual-machine.ip.allocate" | "virtual-machine.task.ip.allocate" | "virtual-machine.ip.unallocate" | "virtual-machine.task.ip.unallocate";
12258
12521
  /** @description A timestamp for when the activity took place. */
12259
12522
  time: components["schemas"]["DateTime"];
12260
12523
  };
@@ -12318,7 +12581,6 @@ export interface components {
12318
12581
  * lacp - Standard link aggregations using LACP.
12319
12582
  * balance-tlb - Adaptive transmit-side balancing (no switch config needed)..
12320
12583
  * balance-alb - TLB + receive load balancing (no switch config needed)..
12321
- *
12322
12584
  * @enum {string}
12323
12585
  */
12324
12586
  mode: "balance-rr" | "active-backup" | "balance-xor" | "lacp" | "balance-tlb" | "balance-alb";
@@ -12620,7 +12882,9 @@ export interface components {
12620
12882
  * - `id:<mongo id>`: A raw resource ID
12621
12883
  * - `resource:<a resource identifier>`: A compound identifier pointing to a resource.
12622
12884
  * - `from:<stage/step>`: For referencing a previous pipeline step.
12623
- *
12885
+ * @example id:6515098637b66c233ed164e7
12886
+ * @example resource:cluster:dev,env:demo,container:api
12887
+ * @example from:/image-create
12624
12888
  */
12625
12889
  FluidIdentifier: string;
12626
12890
  /**
@@ -12884,7 +13148,6 @@ export interface components {
12884
13148
  /**
12885
13149
  * VariableString
12886
13150
  * @description A string value for a pipeline that supports a variable. To use as a variable, set this string to `{{variable}}` where `variable` is a custom name.
12887
- *
12888
13151
  */
12889
13152
  VariableString: string;
12890
13153
  /**
@@ -13083,7 +13346,6 @@ export interface components {
13083
13346
  * @description Waits for a deployment to be considered 'healthy' before allowing the pipeline to continue.
13084
13347
  * A deployement is considered 'healthy' when all instances of all containers that have had a state change in the last 15 minutes
13085
13348
  * that have health checks defined, become healthy.
13086
- *
13087
13349
  */
13088
13350
  EnvironmentDeploymentHealthyWatchStep: {
13089
13351
  /** @description An identifier for the step. */
@@ -13191,9 +13453,10 @@ export interface components {
13191
13453
  add_new: boolean;
13192
13454
  /** @description When deploying to the environment, any scoped variables defined in the build that match an existing scoped variable in the environment will cause the existing scoped variable to be updated to the new value. */
13193
13455
  replace_existing: boolean;
13194
- /** @description If set to true and `add_new` is enabled, any variables that dont exist FOR THAT DEPLOYMENT will be created.
13456
+ /**
13457
+ * @description If set to true and `add_new` is enabled, any variables that dont exist FOR THAT DEPLOYMENT will be created.
13195
13458
  * If set to true and `replace_existing` is enabled, any matching variables FOR THAT DEPLOYMENT will be replaced.
13196
- * */
13459
+ */
13197
13460
  associate_deployment: boolean;
13198
13461
  } | null;
13199
13462
  };
@@ -13290,7 +13553,6 @@ export interface components {
13290
13553
  * @description A pipeline step that will make a POST request to the specified endpoints. The webhook will post the full body of the resource referenced by the step.
13291
13554
  * For example if you were to reference a step creating a container, you would receive that container object in the post body.
13292
13555
  * You may also specify a custom body instead.
13293
- *
13294
13556
  */
13295
13557
  WebhookPostStep: {
13296
13558
  /** @description An identifier for the step. */
@@ -13313,14 +13575,16 @@ export interface components {
13313
13575
  options?: components["schemas"]["WebhookStepOptions"] | null;
13314
13576
  /** @description An optional POST body to send with the request. Cannot be used with `from``. */
13315
13577
  body?: string | null;
13316
- /** @description Takes the output from a previous step and uses it as the body for the POST request. Cannot be used with `body`. String format is <stageIdentifier/stepIdentifier> */
13578
+ /**
13579
+ * @description Takes the output from a previous step and uses it as the body for the POST request. Cannot be used with `body`. String format is <stageIdentifier/stepIdentifier>
13580
+ * @example init/image-create
13581
+ */
13317
13582
  from?: string | null;
13318
13583
  };
13319
13584
  };
13320
13585
  /**
13321
13586
  * WebhookGetStep
13322
13587
  * @description A pipeline step that will make a GET request to the specified endpoint.
13323
- *
13324
13588
  */
13325
13589
  WebhookGetStep: {
13326
13590
  /** @description An identifier for the step. */
@@ -13519,7 +13783,6 @@ export interface components {
13519
13783
  /**
13520
13784
  * SourceSanIscsi
13521
13785
  * @description A SAN iSCSI volume source. Defines one or more iSCSI targets and the LUN number to attach.
13522
- *
13523
13786
  */
13524
13787
  SourceSanIscsi: {
13525
13788
  /**
@@ -13528,13 +13791,11 @@ export interface components {
13528
13791
  */
13529
13792
  type: "san-iscsi";
13530
13793
  details: {
13531
- /** @description One or more iSCSI integration IDs to use for authentication.
13532
- * */
13794
+ /** @description One or more iSCSI integration IDs to use for authentication. */
13533
13795
  integration_ids: components["schemas"]["ID"][];
13534
13796
  /**
13535
13797
  * Format: int32
13536
13798
  * @description Logical Unit Number exposed by the target(s) to attach.
13537
- *
13538
13799
  */
13539
13800
  lun: number;
13540
13801
  };
@@ -13556,7 +13817,6 @@ export interface components {
13556
13817
  /**
13557
13818
  * SourceCephRbd
13558
13819
  * @description A Ceph RBD volume source. Defines monitor endpoints, optional cluster FSID, client identity (CephX), and the specific image to attach.
13559
- *
13560
13820
  */
13561
13821
  SourceCephRbd: {
13562
13822
  /**
@@ -13565,8 +13825,7 @@ export interface components {
13565
13825
  */
13566
13826
  type: "ceph-rbd";
13567
13827
  details: {
13568
- /** @description The ID of a Ceph cluster integration for authentication.
13569
- * */
13828
+ /** @description The ID of a Ceph cluster integration for authentication. */
13570
13829
  integration_id: components["schemas"]["ID"];
13571
13830
  image: components["schemas"]["SourceCephRbdImageRef"];
13572
13831
  };
@@ -13574,19 +13833,15 @@ export interface components {
13574
13833
  /**
13575
13834
  * SourceAwsEbsAuth
13576
13835
  * @description AWS credentials for accessing EBS. Either an instance role may be used or explicit Access Key credentials may be provided.
13577
- *
13578
13836
  */
13579
13837
  SourceAwsEbsAuth: {
13580
- /** @description When true, use the instance's IAM role for authentication.
13581
- * */
13838
+ /** @description When true, use the instance's IAM role for authentication. */
13582
13839
  use_instance_role?: boolean;
13583
- /** @description AWS Access Key ID to use for authentication (optional if using instance role).
13584
- * */
13840
+ /** @description AWS Access Key ID to use for authentication (optional if using instance role). */
13585
13841
  access_key_id?: string;
13586
13842
  /**
13587
13843
  * Format: password
13588
13844
  * @description AWS Secret Access Key to use for authentication (optional if using instance role).
13589
- *
13590
13845
  */
13591
13846
  secret_access_key?: string;
13592
13847
  };
@@ -13595,17 +13850,14 @@ export interface components {
13595
13850
  * @description Reference to the specific EBS volume to attach.
13596
13851
  */
13597
13852
  SourceAwsEbsRef: {
13598
- /** @description The EBS volume ID (for example, "vol-0abcd1234ef567890").
13599
- * */
13853
+ /** @description The EBS volume ID (for example, "vol-0abcd1234ef567890"). */
13600
13854
  volume_id: string;
13601
- /** @description Optional AWS Availability Zone where the volume resides (for example, "us-east-1a").
13602
- * */
13855
+ /** @description Optional AWS Availability Zone where the volume resides (for example, "us-east-1a"). */
13603
13856
  az?: string;
13604
13857
  };
13605
13858
  /**
13606
13859
  * SourceAwsEbs
13607
13860
  * @description An AWS EBS volume source. Defines how to authenticate to AWS and which EBS volume to attach.
13608
- *
13609
13861
  */
13610
13862
  SourceAwsEbs: {
13611
13863
  /**
@@ -13621,7 +13873,6 @@ export interface components {
13621
13873
  /**
13622
13874
  * ExternalVolumeSource
13623
13875
  * @description The source information for this volume.
13624
- *
13625
13876
  */
13626
13877
  ExternalVolumeSource: components["schemas"]["SourceSanIscsi"] | components["schemas"]["SourceCephRbd"] | components["schemas"]["SourceAwsEbs"];
13627
13878
  /**
@@ -13670,8 +13921,7 @@ export interface components {
13670
13921
  * @description Configuration options controlling the behavior of the volume.
13671
13922
  */
13672
13923
  ExternalVolumeOptions: {
13673
- /** @description If the volume doesn't exist, attempt to create it on container start if create struct defined.
13674
- * */
13924
+ /** @description If the volume doesn't exist, attempt to create it on container start if create struct defined. */
13675
13925
  create: {
13676
13926
  /** @description Indicates the size of volume to create. */
13677
13927
  size: components["schemas"]["DataSize"];
@@ -13683,7 +13933,7 @@ export interface components {
13683
13933
  * @description The current lifecycle state of the volume.
13684
13934
  * @enum {string}
13685
13935
  */
13686
- current: "new" | "configuring" | "live" | "deleting" | "deleted";
13936
+ current: "new" | "ready" | "configuring" | "live" | "deleting" | "deleted";
13687
13937
  } & components["schemas"]["State"];
13688
13938
  /**
13689
13939
  * ExternalVolumeEvents
@@ -13696,11 +13946,9 @@ export interface components {
13696
13946
  updated: components["schemas"]["DateTime"];
13697
13947
  /** @description The timestamp of when the attached volume was deleted. */
13698
13948
  deleted: components["schemas"]["DateTime"];
13699
- /** @description Timestamp of the last successful verification event for this volume.
13700
- * */
13949
+ /** @description Timestamp of the last successful verification event for this volume. */
13701
13950
  last_verified?: components["schemas"]["DateTime"];
13702
- /** @description Timestamp of the last successful synchronization event for this volume.
13703
- * */
13951
+ /** @description Timestamp of the last successful synchronization event for this volume. */
13704
13952
  last_sync?: components["schemas"]["DateTime"];
13705
13953
  };
13706
13954
  /**
@@ -13726,7 +13974,6 @@ export interface components {
13726
13974
  /**
13727
13975
  * ExternalVolume
13728
13976
  * @description A persistent storage volume within a cluster. Volumes may be attached to containers or VMs and can originate from different storage sources.
13729
- *
13730
13977
  */
13731
13978
  ExternalVolume: {
13732
13979
  id: components["schemas"]["ID"];
@@ -13740,9 +13987,8 @@ export interface components {
13740
13987
  server_ids: components["schemas"]["ID"][];
13741
13988
  source: components["schemas"]["ExternalVolumeSource"];
13742
13989
  /** @description Information about the resource the external volume is currently attached to. */
13743
- attachment?: components["schemas"]["ExternalVolumeAttachment"];
13744
- /** @description Size of the external volume; may be null or omitted if the size has not yet been determined.
13745
- * */
13990
+ attachment?: components["schemas"]["ExternalVolumeAttachment"] | null;
13991
+ /** @description Size of the external volume; may be null or omitted if the size has not yet been determined. */
13746
13992
  size?: components["schemas"]["DataSize"] | null;
13747
13993
  options: components["schemas"]["ExternalVolumeOptions"];
13748
13994
  state: components["schemas"]["ExternalVolumeState"];
@@ -13783,7 +14029,7 @@ export interface components {
13783
14029
  * @description The current state of the pipeline run.
13784
14030
  * @enum {string}
13785
14031
  */
13786
- current: "queued" | "acquiring" | "running" | "complete" | "deleting" | "deleted";
14032
+ current: "queued" | "acquiring" | "running" | "complete" | "cancelled" | "deleted";
13787
14033
  } & components["schemas"]["State"];
13788
14034
  /**
13789
14035
  * PipelineRunEvents
@@ -13834,7 +14080,6 @@ export interface components {
13834
14080
  /**
13835
14081
  * VirtualMachineSshKey
13836
14082
  * @description Describes an SSH key used to access a virtual machine.
13837
- *
13838
14083
  */
13839
14084
  VirtualMachineSshKey: {
13840
14085
  id: components["schemas"]["ID"];
@@ -13858,7 +14103,7 @@ export interface components {
13858
14103
  * @description A resource that is associated with activity.
13859
14104
  */
13860
14105
  ComponentsIncludes: {
13861
- [key: string]: components["schemas"]["Container"] | components["schemas"]["VirtualMachine"] | components["schemas"]["Instance"] | components["schemas"]["Environment"] | components["schemas"]["Image"] | components["schemas"]["ImageSource"] | components["schemas"]["Server"] | components["schemas"]["VirtualProviderIso"] | components["schemas"]["IpPool"] | components["schemas"]["Integration"] | components["schemas"]["Stack"] | components["schemas"]["StackBuild"] | components["schemas"]["DnsZone"] | components["schemas"]["DnsRecord"] | components["schemas"]["TlsCertificate"] | components["schemas"]["ApiKey"] | components["schemas"]["Network"] | components["schemas"]["HubMembership"] | components["schemas"]["Pipeline"] | components["schemas"]["TriggerKey"] | components["schemas"]["ScopedVariable"] | components["schemas"]["Hub"] | components["schemas"]["Invoice"] | components["schemas"]["Method"] | components["schemas"]["AutoScaleGroup"] | components["schemas"]["ExternalVolume"] | components["schemas"]["PipelineRun"] | components["schemas"]["Role"] | components["schemas"]["PublicAccount"] | components["schemas"]["VirtualMachineSshKey"];
14106
+ [key: string]: components["schemas"]["Container"] | components["schemas"]["VirtualMachine"] | components["schemas"]["Instance"] | components["schemas"]["Environment"] | components["schemas"]["Image"] | components["schemas"]["ImageSource"] | components["schemas"]["Server"] | components["schemas"]["VirtualProviderIso"] | components["schemas"]["IpPool"] | components["schemas"]["Integration"] | components["schemas"]["Stack"] | components["schemas"]["StackBuild"] | components["schemas"]["DnsZone"] | components["schemas"]["DnsRecord"] | components["schemas"]["TlsCertificate"] | components["schemas"]["ApiKey"] | components["schemas"]["Network"] | components["schemas"]["HubMembership"] | components["schemas"]["Pipeline"] | components["schemas"]["TriggerKey"] | components["schemas"]["ScopedVariable"] | components["schemas"]["Hub"] | components["schemas"]["Invoice"] | components["schemas"]["Method"] | components["schemas"]["AutoScaleGroup"] | components["schemas"]["ExternalVolume"] | components["schemas"]["PipelineRun"] | components["schemas"]["Role"] | components["schemas"]["PublicAccount"] | components["schemas"]["VirtualMachineSshKey"] | components["schemas"]["Cluster"];
13862
14107
  };
13863
14108
  /**
13864
14109
  * ActivityIncludes
@@ -14086,7 +14331,13 @@ export interface components {
14086
14331
  MonitoringUsage: {
14087
14332
  /** @description Number that, when used in conjunction with unit, describes the included usage. */
14088
14333
  included: number;
14089
- /** @description A string describing the metric unit. */
14334
+ /**
14335
+ * @description A string describing the metric unit.
14336
+ * @example Metrics
14337
+ * @example Events
14338
+ * @example Matches
14339
+ * @example GB
14340
+ */
14090
14341
  unit: string;
14091
14342
  /** @description A boolean indicating if there is hard usage limit on the tier. */
14092
14343
  hard_cap: boolean;
@@ -14158,44 +14409,83 @@ export interface components {
14158
14409
  price: components["schemas"]["BillingAmount"];
14159
14410
  };
14160
14411
  /**
14161
- * ExternalVolumeAttachAction
14162
- * @description A task to attach an external volume.
14412
+ * ExternalVolumeIncludes
14413
+ * @description All includable resources linked to the given external volume.
14414
+ */
14415
+ ExternalVolumeIncludes: {
14416
+ servers?: {
14417
+ [key: string]: components["schemas"]["Server"];
14418
+ };
14419
+ locations?: {
14420
+ [key: string]: components["schemas"]["ProviderLocation"];
14421
+ };
14422
+ };
14423
+ /**
14424
+ * ExternalVolumesScanAction
14425
+ * @description A task to scan for available external volumes on a given cluster.
14163
14426
  */
14164
- ExternalVolumeAttachAction: {
14427
+ ExternalVolumesScanAction: {
14165
14428
  /**
14166
- * @description The name of the action to perform (attach). (enum property replaced by openapi-typescript)
14429
+ * @description The action for the external volumes job. (enum property replaced by openapi-typescript)
14167
14430
  * @enum {string}
14168
14431
  */
14169
- action: "attach";
14170
- contents: components["schemas"]["ExternalVolumeAttachment"];
14432
+ action: "scan";
14433
+ /** @description Scan options used by the platform to create the job. */
14434
+ contents: {
14435
+ /** @description ID of the integration to scan for external volumes. */
14436
+ integration_id: components["schemas"]["ID"];
14437
+ /** @description ID of the location to scan for external volumes. */
14438
+ location_id?: components["schemas"]["ID"];
14439
+ /**
14440
+ * @description Type of external volume system to scan.
14441
+ * @enum {string}
14442
+ */
14443
+ source_type: "san-iscsi" | "ceph-rbd" | "aws-ebs";
14444
+ /** @description ID of the cluster to scan for external volumes. */
14445
+ cluster: components["schemas"]["Identifier"];
14446
+ /** @description Optional list of server IDs to limit the scan scope. */
14447
+ server_ids?: components["schemas"]["ID"][] | null;
14448
+ /** @description Optional namespace string to limit the scan scope. */
14449
+ namespace?: string | null;
14450
+ };
14171
14451
  };
14452
+ /** ExternalVolumesTask */
14453
+ ExternalVolumesTask: components["schemas"]["ExternalVolumesScanAction"];
14172
14454
  /**
14173
- * ExternalVolumeDetachAction
14174
- * @description A task to detach an external volume from an instance.
14455
+ * ExternalVolumeServersReconfigureAction
14456
+ * @description A task to reconfigure mountable destination servers for external volume.
14175
14457
  */
14176
- ExternalVolumeDetachAction: {
14458
+ ExternalVolumeServersReconfigureAction: {
14177
14459
  /**
14178
- * @description The name of the action to perform (detach). (enum property replaced by openapi-typescript)
14460
+ * @description The name of the action to perform (servers.reconfigure). (enum property replaced by openapi-typescript)
14179
14461
  * @enum {string}
14180
14462
  */
14181
- action: "detach";
14463
+ action: "servers.reconfigure";
14464
+ /** @description Contents contains an array of server ids to set as mountable destinations for the external volume. */
14465
+ contents?: components["schemas"]["ID"][];
14182
14466
  };
14183
- /** ExternalVolumeTask */
14184
- ExternalVolumeTasks: components["schemas"]["ExternalVolumeAttachAction"] | components["schemas"]["ExternalVolumeDetachAction"];
14185
14467
  /**
14186
- * ServerModelsIncludes
14187
- * @description A resource associated with a server models.
14468
+ * ExternalVolumeAttachmentReconfigureAction
14469
+ * @description A task to reconfigure the attachment for external volume.
14188
14470
  */
14189
- ServerModelsIncludes: {
14190
- [key: string]: components["schemas"]["ProviderServerModel"];
14471
+ ExternalVolumeAttachmentReconfigureAction: {
14472
+ /**
14473
+ * @description The name of the action to perform (attachment.reconfigure). (enum property replaced by openapi-typescript)
14474
+ * @enum {string}
14475
+ */
14476
+ action: "attachment.reconfigure";
14477
+ /** @description Attachment configuration details. */
14478
+ contents?: components["schemas"]["ExternalVolumeAttachment"];
14191
14479
  };
14480
+ /** ExternalVolumeTask */
14481
+ ExternalVolumeTask: components["schemas"]["ExternalVolumeServersReconfigureAction"] | components["schemas"]["ExternalVolumeAttachmentReconfigureAction"];
14192
14482
  /**
14193
14483
  * AutoScaleGroupIncludes
14194
14484
  * @description All includable resource linkable to the given auto-scale group.
14195
14485
  */
14196
14486
  AutoScaleGroupIncludes: {
14197
14487
  integrations?: components["schemas"]["IntegrationsIncludes"];
14198
- models?: components["schemas"]["ServerModelsIncludes"];
14488
+ models?: components["schemas"]["ProviderServerModelsIncludes"];
14199
14489
  locations?: components["schemas"]["LocationsIncludes"];
14200
14490
  };
14201
14491
  /**
@@ -14318,7 +14608,10 @@ export interface components {
14318
14608
  [key: string]: {
14319
14609
  /** @description String describing the server mount type. */
14320
14610
  type: string;
14321
- /** @description Comma separated string describing the server mount options. */
14611
+ /**
14612
+ * @description Comma separated string describing the server mount options.
14613
+ * @example key1=value1,key2=value2
14614
+ */
14322
14615
  options: string;
14323
14616
  /** @description String describing the server mount source. */
14324
14617
  source: string;
@@ -14368,7 +14661,6 @@ export interface components {
14368
14661
  * ServerPowerOffAction
14369
14662
  * @description A job that powers the server off.
14370
14663
  * Only for servers deployed from a virtual provider.
14371
- *
14372
14664
  */
14373
14665
  ServerPowerOffAction: {
14374
14666
  /**
@@ -14381,7 +14673,6 @@ export interface components {
14381
14673
  * ServerAuthResetAction
14382
14674
  * @description A job that resets authentication for the server.
14383
14675
  * Only for servers deployed from a virtual provider.
14384
- *
14385
14676
  */
14386
14677
  ServerAuthResetAction: {
14387
14678
  /**
@@ -14614,7 +14905,8 @@ export interface components {
14614
14905
  points: (components["schemas"]["DateTime"] | number)[][];
14615
14906
  /** @description Information about this metric, such as the type of metric, the data it represents, and critical common information such as hub ID and associated cluster. */
14616
14907
  metadata: {
14617
- /** @description The data this metric represents. Cycle provides several built-in metrics, and, tier allowing, hubs can submit custom metrics as well.
14908
+ /**
14909
+ * @description The data this metric represents. Cycle provides several built-in metrics, and, tier allowing, hubs can submit custom metrics as well.
14618
14910
  *
14619
14911
  * Here is a non-exhaustive list of some of the metrics provided by the platform automatically:
14620
14912
  * - container.instances.num
@@ -14663,7 +14955,7 @@ export interface components {
14663
14955
  * - memberships.num
14664
14956
  * - pipeline.runs.num
14665
14957
  * - stack.builds.num
14666
- * */
14958
+ */
14667
14959
  metric: string;
14668
14960
  /**
14669
14961
  * @description The type of data represented by the metric.
@@ -14674,7 +14966,6 @@ export interface components {
14674
14966
  * - **histogram**: tracks the statistical distribution of a set of values.
14675
14967
  * - **distribution**: aggregates data across multiple hosts and applications.
14676
14968
  * - **set**: tracks the number of unique elements in a group.
14677
- *
14678
14969
  * @enum {string}
14679
14970
  */
14680
14971
  type: "gauge" | "count" | "counter" | "rate" | "histogram" | "distribution" | "set";
@@ -14694,7 +14985,7 @@ export interface components {
14694
14985
  * EventType
14695
14986
  * @enum {string}
14696
14987
  */
14697
- EventType: "api.security_violation" | "console.ssh.login" | "console.ssh.login.failed" | "console.sos.login" | "console.sos.login.failed" | "container.instance.backup.completed" | "container.instance.backup.failed" | "container.instance.delete.failed" | "container.instance.error" | "container.instance.restart.max_restarts" | "container.instance.function.max_runtime" | "container.instance.healthcheck.failed" | "container.instance.healthcheck.recovered" | "container.instance.volume.extend.failed" | "container.instance.healthcheck.restarted" | "container.instance.migration.completed" | "container.instance.migration.failed" | "container.instance.network.interfaces.create.failed" | "container.instance.restart.failed" | "container.instance.start.failed" | "container.instance.start.privileged" | "container.instance.stop.failed" | "container.instances.autoscale.down" | "container.instances.autoscale.up" | "container.reconfigured.privileged" | "container.volumes.base.create.failed" | "container.volumes.create.failed" | "environment.service.auto_update" | "environment.service.lb.ips.sync.failed" | "environment.service.vpn.login.failed" | "environment.service.discovery.client.throttle.hit" | "environment.service.gateway.ips.sync.failed" | "infrastructure.cluster.resources.ram.full" | "infrastructure.server.compute.volumes.base.reconfigured" | "infrastructure.server.compute.full_restart" | "infrastructure.server.compute.sharedfs.mounts.mount" | "infrastructure.server.compute.sharedfs.mounts.mount.failed" | "infrastructure.server.compute.soft_restart" | "infrastructure.server.image.download.failed" | "infrastructure.server.monitoring.throttled" | "infrastructure.server.internal_api.throttled" | "infrastructure.server.manifest.sync.failed" | "infrastructure.server.mesh.connect.failed" | "infrastructure.server.neighbor.reachable" | "infrastructure.server.neighbor.rebuild" | "infrastructure.server.neighbors.rebuild" | "infrastructure.server.neighbor.unreachable" | "infrastructure.server.neighbor.upgraded" | "infrastructure.server.resources.load.high" | "infrastructure.server.resources.ram.full" | "infrastructure.server.resources.storage.volumes.base.full" | "infrastructure.server.resources.storage.cycle_pool.full" | "infrastructure.server.autoscale.up" | "infrastructure.server.sftp.lockdown" | "infrastructure.server.sftp.login" | "infrastructure.server.sftp.login.failed" | "infrastructure.server.evacuation.failed" | "infrastructure.server.evacuation.completed" | "infrastructure.server.checkin.missed" | "infrastructure.server.checkin.resumed" | "infrastructure.server.power.reboot" | "infrastructure.server.power.power-off" | "infrastructure.server.neighbor.incompatible";
14988
+ EventType: "api.security_violation" | "console.ssh.login" | "console.ssh.login.failed" | "console.sos.login" | "console.sos.login.failed" | "container.instance.backup.completed" | "container.instance.backup.failed" | "container.instance.delete.failed" | "container.instance.error" | "container.instance.restart.max_restarts" | "container.instance.function.max_runtime" | "container.instance.healthcheck.failed" | "container.instance.healthcheck.recovered" | "container.instance.volume.extend.failed" | "container.instance.healthcheck.restarted" | "container.instance.migration.completed" | "container.instance.migration.failed" | "container.instance.network.interfaces.create.failed" | "container.instance.restart.failed" | "container.instance.start.failed" | "container.instance.start.privileged" | "container.instance.stop.failed" | "container.instances.autoscale.down" | "container.instances.autoscale.up" | "container.reconfigured.privileged" | "container.volumes.base.create.failed" | "container.volumes.create.failed" | "environment.service.auto_update" | "environment.service.lb.ips.sync.failed" | "environment.service.vpn.login.failed" | "environment.service.discovery.client.throttle.hit" | "environment.service.gateway.ips.sync.failed" | "infrastructure.cluster.resources.ram.full" | "infrastructure.server.compute.volumes.base.reconfigured" | "infrastructure.server.compute.full_restart" | "infrastructure.server.compute.sharedfs.mounts.mount" | "infrastructure.server.compute.sharedfs.mounts.mount.failed" | "infrastructure.server.compute.soft_restart" | "infrastructure.server.compute.start.failure" | "infrastructure.server.compute.died" | "infrastructure.server.compute-spawner.full_restart" | "infrastructure.server.image.download.failed" | "infrastructure.server.monitoring.throttled" | "infrastructure.server.internal_api.throttled" | "infrastructure.server.manifest.sync.failed" | "infrastructure.server.mesh.connect.failed" | "infrastructure.server.neighbor.reachable" | "infrastructure.server.neighbor.rebuild" | "infrastructure.server.neighbors.rebuild" | "infrastructure.server.neighbor.unreachable" | "infrastructure.server.neighbor.upgraded" | "infrastructure.server.power.power_off" | "infrastructure.server.resources.load.high" | "infrastructure.server.resources.ram.full" | "infrastructure.server.resources.storage.volumes.base.full" | "infrastructure.server.resources.storage.cycle_pool.full" | "infrastructure.server.autoscale.up" | "infrastructure.server.sftp.lockdown" | "infrastructure.server.sftp.login" | "infrastructure.server.sftp.login.failed" | "infrastructure.server.evacuation.failed" | "infrastructure.server.evacuation.completed" | "infrastructure.server.checkin.missed" | "infrastructure.server.checkin.resumed" | "infrastructure.server.power.reboot" | "infrastructure.server.neighbor.incompatible";
14698
14989
  /**
14699
14990
  * Event
14700
14991
  * @description A platform-generated event. Describes something happening on the platform at a specific time. Can be informational, security related, or a notice of something important.
@@ -14712,8 +15003,7 @@ export interface components {
14712
15003
  text?: string;
14713
15004
  /** @description Information about this event, such as the type of event, the data it represents, and critical common information such as hub ID and associated cluster. */
14714
15005
  metadata: {
14715
- /** @description Describes what this event is.
14716
- * */
15006
+ /** @description Describes what this event is. */
14717
15007
  event: components["schemas"]["EventType"];
14718
15008
  /**
14719
15009
  * @description The type of event.
@@ -14724,7 +15014,6 @@ export interface components {
14724
15014
  * - **alert**: represents a critical message indicating a severe issue.
14725
15015
  * - **notice**: represents a notice message indicating a noteworthy event.
14726
15016
  * - **audit**: represents a notice message indicating a message that would be needed for audits
14727
- *
14728
15017
  * @enum {string}
14729
15018
  */
14730
15019
  type: "info" | "warning" | "error" | "success" | "alert" | "notice" | "audit";
@@ -14752,22 +15041,25 @@ export interface components {
14752
15041
  LogLine: {
14753
15042
  /** @description The time the log line occurred. */
14754
15043
  time: components["schemas"]["DateTime"];
14755
- /** @description The source that generated the log line. */
15044
+ /**
15045
+ * @description The source that generated the log line.
15046
+ * @example stdout
15047
+ */
14756
15048
  source: string;
14757
15049
  /** @description The message associated with the log line. */
14758
15050
  message: string;
14759
15051
  /** @description The container instance that the log line originated from. */
14760
15052
  instance_id?: string | null;
14761
- /** @description A randomly generated ID that is assigned to all lines in the same context window.
15053
+ /**
15054
+ * @description A randomly generated ID that is assigned to all lines in the same context window.
14762
15055
  * The first line with a specific ID is the log line that matches the query, and the following
14763
15056
  * log lines are included due to the the set context window in the aggregate.
14764
- * */
15057
+ */
14765
15058
  context_window?: string;
14766
15059
  };
14767
15060
  /**
14768
15061
  * Monitor
14769
15062
  * @description A monitor used to determine latency between the public internet and a load balancer on Cycle. These monitors are automatically created and managed by the platform. Information about specific monitors is provided for determining the regional latencies for an environment.
14770
- *
14771
15063
  */
14772
15064
  Monitor: {
14773
15065
  /** @description The ID of the node this monitor is running on. */
@@ -14805,6 +15097,29 @@ export interface components {
14805
15097
  };
14806
15098
  "components:identifiers"?: components["schemas"]["IdentifierIncludes"];
14807
15099
  };
15100
+ /**
15101
+ * IncludedPipelines
15102
+ * @description A map of pipelines, keyed by ID, included on endpoints that support it when passing the matching includes query parameter.
15103
+ */
15104
+ IncludedPipelines: {
15105
+ [key: string]: components["schemas"]["Pipeline"];
15106
+ };
15107
+ /**
15108
+ * IncludedTriggerKeys
15109
+ * @description A map of trigger keys, keyed by ID, included on endpoints that support it when passing the matching includes query parameter.
15110
+ */
15111
+ IncludedTriggerKeys: {
15112
+ [key: string]: components["schemas"]["TriggerKey"];
15113
+ };
15114
+ /**
15115
+ * PipelineRunIncludes
15116
+ * @description Resources related to a pipeline run, that can be included on supported endpoints when the matching includes query parameter is passed.
15117
+ */
15118
+ PipelineRunIncludes: {
15119
+ creators?: components["schemas"]["CreatorInclude"];
15120
+ pipelines?: components["schemas"]["IncludedPipelines"];
15121
+ keys?: components["schemas"]["IncludedTriggerKeys"];
15122
+ };
14808
15123
  /** TriggerPipelineAction */
14809
15124
  PipelineTriggerAction: {
14810
15125
  /**
@@ -14820,9 +15135,10 @@ export interface components {
14820
15135
  advanced?: {
14821
15136
  /** @description Sub queue allows multiple concurrent pipeline runs. */
14822
15137
  sub_queue?: string | null;
14823
- /** @description To enable skip locks, pass the current UNIX timestamp. Must be accurate within 10 minutes of the current UTC time.
15138
+ /**
15139
+ * @description To enable skip locks, pass the current UNIX timestamp. Must be accurate within 10 minutes of the current UTC time.
14824
15140
  * This will skip lock checks when running a pipeline - the user takes all risk of ensuring two pipeline runs won't make conflicting changes.
14825
- * */
15141
+ */
14826
15142
  skip_locks?: number | null;
14827
15143
  };
14828
15144
  };
@@ -15115,8 +15431,7 @@ export interface components {
15115
15431
  * @enum {string}
15116
15432
  */
15117
15433
  action: "volumes.reconfigure";
15118
- /** @description A map of volume objects where the key is the id and the value is the volume's config.
15119
- * */
15434
+ /** @description A map of volume objects where the key is the id and the value is the volume's config. */
15120
15435
  contents: {
15121
15436
  [key: string]: components["schemas"]["VirtualMachineVolumeConfig"];
15122
15437
  };
@@ -15126,7 +15441,6 @@ export interface components {
15126
15441
  /**
15127
15442
  * VirtualMachineBaseImage
15128
15443
  * @description Represents a virtual machine base OS image provided by Cycle.
15129
- *
15130
15444
  */
15131
15445
  VirtualMachineBaseImage: {
15132
15446
  /** @description The name of the base image (e.g., "Alpine Linux"). */
@@ -15140,9 +15454,15 @@ export interface components {
15140
15454
  homepage: string;
15141
15455
  /** @description A list of available versions for the base image, including details like version number and disk image URL. */
15142
15456
  versions: {
15143
- /** @description A unique identifier for the version. */
15457
+ /**
15458
+ * @description A unique identifier for the version.
15459
+ * @example alpine-3-19
15460
+ */
15144
15461
  identifier: string;
15145
- /** @description The version number of the base image. */
15462
+ /**
15463
+ * @description The version number of the base image.
15464
+ * @example 3.19
15465
+ */
15146
15466
  version: string;
15147
15467
  /**
15148
15468
  * Format: uri
@@ -15641,9 +15961,10 @@ export interface operations {
15641
15961
  sort?: components["parameters"]["SortParam"];
15642
15962
  /** @description In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2` */
15643
15963
  page?: components["parameters"]["PageParam"];
15644
- /** @description ## Filter Field
15964
+ /**
15965
+ * @description ## Filter Field
15645
15966
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
15646
- * */
15967
+ */
15647
15968
  filter?: {
15648
15969
  /**
15649
15970
  * @description Get only Announcements that have been resolved, or only those that have not.
@@ -15708,12 +16029,12 @@ export interface operations {
15708
16029
  query?: {
15709
16030
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
15710
16031
  sort?: components["parameters"]["SortParam"];
15711
- /** @description ## Filter Field
16032
+ /**
16033
+ * @description ## Filter Field
15712
16034
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
15713
- * */
16035
+ */
15714
16036
  filter?: {
15715
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the credit's current state.
15716
- * */
16037
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the credit's current state. */
15717
16038
  state?: string;
15718
16039
  /** @description Use a text-based search to filter the credits. */
15719
16040
  search?: string;
@@ -15805,15 +16126,14 @@ export interface operations {
15805
16126
  page?: components["parameters"]["PageParam"];
15806
16127
  /** @description A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled. */
15807
16128
  meta?: "due"[];
15808
- /** @description ## Filter Field
16129
+ /**
16130
+ * @description ## Filter Field
15809
16131
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
15810
- * */
16132
+ */
15811
16133
  filter?: {
15812
- /** @description `filter[search]=value` search for the specified text on supported fields.
15813
- * */
16134
+ /** @description `filter[search]=value` search for the specified text on supported fields. */
15814
16135
  search?: string;
15815
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the invoice's current state.
15816
- * */
16136
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the invoice's current state. */
15817
16137
  state?: string;
15818
16138
  /** @description The start date from when to pull the invoices */
15819
16139
  "range-start"?: components["schemas"]["DateTime"];
@@ -16459,52 +16779,40 @@ export interface operations {
16459
16779
  meta?: ("instances_count" | "domains" | "ips")[];
16460
16780
  /** @description A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return. */
16461
16781
  include?: ("creators" | "images" | "stack_builds" | "stacks" | "environments")[];
16462
- /** @description ## Filter Field
16782
+ /**
16783
+ * @description ## Filter Field
16463
16784
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
16464
- * */
16785
+ */
16465
16786
  filter?: {
16466
- /** @description `filter[creator]=account-ID` filter for containers matching a particular creator, such as `account-ID` or `environment-ID`
16467
- * */
16787
+ /** @description `filter[creator]=account-ID` filter for containers matching a particular creator, such as `account-ID` or `environment-ID` */
16468
16788
  creator?: string;
16469
- /** @description `filter[identifier]=value` List only those containers matching this identifier. May return multiple results.
16470
- * */
16789
+ /** @description `filter[identifier]=value` List only those containers matching this identifier. May return multiple results. */
16471
16790
  identifier?: string;
16472
- /** @description `filter[search]=value` search containers for a value associated with a field on the given container(s).
16473
- * */
16791
+ /** @description `filter[search]=value` search containers for a value associated with a field on the given container(s). */
16474
16792
  search?: string;
16475
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the container's current state.
16476
- * */
16793
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the container's current state. */
16477
16794
  state?: string;
16478
- /** @description `filter[deprecated]=true` filter for containers that are deprecated.
16479
- * */
16795
+ /** @description `filter[deprecated]=true` filter for containers that are deprecated. */
16480
16796
  deprecated?: string;
16481
- /** @description `filter[service]=value` service filtering will allow you to filter by service type: `loadbalancer`, `discovery`, `vpn`.
16482
- * */
16797
+ /** @description `filter[service]=value` service filtering will allow you to filter by service type: `loadbalancer`, `discovery`, `vpn`. */
16483
16798
  service?: string;
16484
- /** @description `filter[public_network]=value` public network filtering will allow you to filter by the containers network settings: `enabled`, `disabled`, `egress-only`.
16485
- * */
16799
+ /** @description `filter[public_network]=value` public network filtering will allow you to filter by the containers network settings: `enabled`, `disabled`, `egress-only`. */
16486
16800
  public_network?: string;
16487
- /** @description `filter[image]=ID` image filtering by ID. Submit the ID of the image you wish to filter for and the return will be any containers currently using the image.
16488
- * */
16801
+ /** @description `filter[image]=ID` image filtering by ID. Submit the ID of the image you wish to filter for and the return will be any containers currently using the image. */
16489
16802
  image?: string;
16490
- /** @description `filter[environment]=ID` environment filtering by ID. Submit the ID of the environment you wish to filter for and the return will be any containers in that environment.
16491
- * */
16803
+ /** @description `filter[environment]=ID` environment filtering by ID. Submit the ID of the environment you wish to filter for and the return will be any containers in that environment. */
16492
16804
  environment?: string;
16493
- /** @description `filter[tags]=tagone,tagtwo,tagthree` container filtering using server tags. If the container has the tags you submit it will be part of the return.
16494
- * */
16805
+ /** @description `filter[tags]=tagone,tagtwo,tagthree` container filtering using server tags. If the container has the tags you submit it will be part of the return. */
16495
16806
  tags?: string;
16496
- /** @description `filter[stack]=ID` stack filtering by ID. Submit the ID of the stack you wish to filter for and the return will be any containers deployed associated with 'containers' from the stack.
16497
- * */
16807
+ /** @description `filter[stack]=ID` stack filtering by ID. Submit the ID of the stack you wish to filter for and the return will be any containers deployed associated with 'containers' from the stack. */
16498
16808
  stack?: string;
16499
- /** @description `filter[deployment]=v1,v2` filter containers by deployment(s).
16500
- * */
16809
+ /** @description `filter[deployment]=v1,v2` filter containers by deployment(s). */
16501
16810
  deployment?: string;
16502
16811
  /** @description The start date from when to pull the containers */
16503
16812
  "range-start"?: components["schemas"]["DateTime"];
16504
16813
  /** @description The end date from when to pull the containers */
16505
16814
  "range-end"?: components["schemas"]["DateTime"];
16506
- /** @description `filter[deployment_strategy]=strategy` deployment strategy filtering by strategy string. Submit the deployment strategy (example: "function") of the strategy you wish to filter for and the return will be any containers matching that description.
16507
- * */
16815
+ /** @description `filter[deployment_strategy]=strategy` deployment strategy filtering by strategy string. Submit the deployment strategy (example: "function") of the strategy you wish to filter for and the return will be any containers matching that description. */
16508
16816
  deployment_strategy?: string;
16509
16817
  };
16510
16818
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -16851,18 +17159,16 @@ export interface operations {
16851
17159
  include?: ("creators" | "servers" | "locations" | "integrations" | "containers" | "environments")[];
16852
17160
  /** @description A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled. */
16853
17161
  meta?: ("node" | "sdn_pool_ips")[];
16854
- /** @description ## Filter Field
17162
+ /**
17163
+ * @description ## Filter Field
16855
17164
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
16856
- * */
17165
+ */
16857
17166
  filter?: {
16858
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the instance's current state.
16859
- * */
17167
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the instance's current state. */
16860
17168
  state?: string;
16861
- /** @description `filter[search]=value` search instances for a value associated with a field on the given instance(s).
16862
- * */
17169
+ /** @description `filter[search]=value` search instances for a value associated with a field on the given instance(s). */
16863
17170
  search?: string;
16864
- /** @description `filter[server]=ID` server filtering by ID. Submit the ID of the server you wish to filter for and the return will be any instances of the container currently deployed to the given server.
16865
- * */
17171
+ /** @description `filter[server]=ID` server filtering by ID. Submit the ID of the server you wish to filter for and the return will be any instances of the container currently deployed to the given server. */
16866
17172
  server?: string;
16867
17173
  /** @description The start date from when to pull the instances */
16868
17174
  "range-start"?: components["schemas"]["DateTime"];
@@ -17150,9 +17456,10 @@ export interface operations {
17150
17456
  getInstanceTelemetryReport: {
17151
17457
  parameters: {
17152
17458
  query?: {
17153
- /** @description ## Filter Field
17459
+ /**
17460
+ * @description ## Filter Field
17154
17461
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
17155
- * */
17462
+ */
17156
17463
  filter?: {
17157
17464
  /** @description The start date from when to pull instance telemetry data */
17158
17465
  "range-start"?: components["schemas"]["DateTime"];
@@ -17454,12 +17761,12 @@ export interface operations {
17454
17761
  query?: {
17455
17762
  /** @description A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return. */
17456
17763
  include?: "creators"[];
17457
- /** @description ## Filter Field
17764
+ /**
17765
+ * @description ## Filter Field
17458
17766
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
17459
- * */
17767
+ */
17460
17768
  filter?: {
17461
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the DNS Zone's current state.
17462
- * */
17769
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the DNS Zone's current state. */
17463
17770
  state?: string;
17464
17771
  };
17465
17772
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -17691,12 +17998,12 @@ export interface operations {
17691
17998
  query?: {
17692
17999
  /** @description A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return. */
17693
18000
  include?: components["parameters"]["RecordIncludeParam"];
17694
- /** @description ## Filter Field
18001
+ /**
18002
+ * @description ## Filter Field
17695
18003
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
17696
- * */
18004
+ */
17697
18005
  filter?: {
17698
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the DNS record's current state.
17699
- * */
18006
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the DNS record's current state. */
17700
18007
  state?: string;
17701
18008
  };
17702
18009
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -17854,7 +18161,7 @@ export interface operations {
17854
18161
  * @description The action that the job will take.
17855
18162
  * @enum {string}
17856
18163
  */
17857
- action: "generateCert";
18164
+ action: "cert.generate";
17858
18165
  };
17859
18166
  };
17860
18167
  };
@@ -17876,12 +18183,12 @@ export interface operations {
17876
18183
  getTLSGenerationAttempts: {
17877
18184
  parameters: {
17878
18185
  query?: {
17879
- /** @description ## Filter Field
18186
+ /**
18187
+ * @description ## Filter Field
17880
18188
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
17881
- * */
18189
+ */
17882
18190
  filter?: {
17883
- /** @description `filter[domain]=value` filter the return for TLS attempts by domain.
17884
- * */
18191
+ /** @description `filter[domain]=value` filter the return for TLS attempts by domain. */
17885
18192
  domain?: string;
17886
18193
  };
17887
18194
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -17909,6 +18216,49 @@ export interface operations {
17909
18216
  default: components["responses"]["DefaultError"];
17910
18217
  };
17911
18218
  };
18219
+ getAllTlsCertificates: {
18220
+ parameters: {
18221
+ query?: {
18222
+ /**
18223
+ * @description ## Filter Field
18224
+ * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
18225
+ */
18226
+ filter?: {
18227
+ /** @description `filter[domain]=value1` filter user certificates by associated domain. */
18228
+ domain?: string;
18229
+ /** @description `filter[state]=value1,value2` state filtering will allow filtering by the current state. */
18230
+ state?: string;
18231
+ /**
18232
+ * @description `filter[user-supplied]=true` List only those certificates that are user supplied.
18233
+ * `filter[user-supplied]=false` List only those certificates that are auto generated.
18234
+ */
18235
+ "user-supplied"?: string;
18236
+ };
18237
+ /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
18238
+ sort?: components["parameters"]["SortParam"];
18239
+ /** @description In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2` */
18240
+ page?: components["parameters"]["PageParam"];
18241
+ };
18242
+ header?: never;
18243
+ path?: never;
18244
+ cookie?: never;
18245
+ };
18246
+ requestBody?: never;
18247
+ responses: {
18248
+ /** @description Returns a TLS certificate. */
18249
+ 200: {
18250
+ headers: {
18251
+ [name: string]: unknown;
18252
+ };
18253
+ content: {
18254
+ "application/json": {
18255
+ data: components["schemas"]["TlsCertificate"][];
18256
+ };
18257
+ };
18258
+ };
18259
+ default: components["responses"]["DefaultError"];
18260
+ };
18261
+ };
17912
18262
  lookupTLSCertificate: {
17913
18263
  parameters: {
17914
18264
  query: {
@@ -17944,15 +18294,14 @@ export interface operations {
17944
18294
  getUserSuppliedCertificates: {
17945
18295
  parameters: {
17946
18296
  query?: {
17947
- /** @description ## Filter Field
18297
+ /**
18298
+ * @description ## Filter Field
17948
18299
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
17949
- * */
18300
+ */
17950
18301
  filter?: {
17951
- /** @description `filter[domain]=value1` filter user certificates by associated domain.
17952
- * */
18302
+ /** @description `filter[domain]=value1` filter user certificates by associated domain. */
17953
18303
  domain?: string;
17954
- /** @description `filter[state]=value1,value2` state filtering will allow filtering by the current state.
17955
- * */
18304
+ /** @description `filter[state]=value1,value2` state filtering will allow filtering by the current state. */
17956
18305
  state?: string;
17957
18306
  };
17958
18307
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -18058,7 +18407,6 @@ export interface operations {
18058
18407
  *
18059
18408
  * **deprecate**: Cycle will deprecate this certificate, and try to find another usable certificate. If none exists, it will generate a new one
18060
18409
  * for the applicable domains.
18061
- *
18062
18410
  * @enum {string}
18063
18411
  */
18064
18412
  action: "deprecate";
@@ -18084,27 +18432,23 @@ export interface operations {
18084
18432
  parameters: {
18085
18433
  query?: {
18086
18434
  /** @description A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled. */
18087
- meta?: ("containers" | "containers_count" | "instances_count")[];
18435
+ meta?: ("containers" | "containers_count" | "instances_count" | "service_versions")[];
18088
18436
  /** @description A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return. */
18089
18437
  include?: ("creators" | "stacks")[];
18090
- /** @description ## Filter Field
18438
+ /**
18439
+ * @description ## Filter Field
18091
18440
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
18092
- * */
18441
+ */
18093
18442
  filter?: {
18094
- /** @description `filter[creator]=account-ID` filter for environments matching a particular creator, such as `account-ID`.
18095
- * */
18443
+ /** @description `filter[creator]=account-ID` filter for environments matching a particular creator, such as `account-ID`. */
18096
18444
  creator?: string;
18097
- /** @description `filter[identifier]=value` List only those environments matching this identifier. May return multiple results.
18098
- * */
18445
+ /** @description `filter[identifier]=value` List only those environments matching this identifier. May return multiple results. */
18099
18446
  identifier?: string;
18100
- /** @description `filter[search]=value` search for a value associated with a field on the given environment(s).
18101
- * */
18447
+ /** @description `filter[search]=value` search for a value associated with a field on the given environment(s). */
18102
18448
  search?: string;
18103
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the environment's current state.
18104
- * */
18449
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the environment's current state. */
18105
18450
  state?: string;
18106
- /** @description `filter[stack_build]=ID` stack build filtering by ID. Submit the ID of the stack build you wish to filter for and the return sill be any environments that have the stack build deployed to them.
18107
- * */
18451
+ /** @description `filter[stack_build]=ID` stack build filtering by ID. Submit the ID of the stack build you wish to filter for and the return sill be any environments that have the stack build deployed to them. */
18108
18452
  stack_build?: string;
18109
18453
  };
18110
18454
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -18179,7 +18523,7 @@ export interface operations {
18179
18523
  parameters: {
18180
18524
  query?: {
18181
18525
  /** @description A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled. */
18182
- meta?: ("containers" | "containers_count" | "instances_count")[];
18526
+ meta?: ("containers" | "containers_count" | "instances_count" | "service_versions")[];
18183
18527
  /** @description A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return. */
18184
18528
  include?: ("creators" | "stacks" | "clusters")[];
18185
18529
  };
@@ -18411,15 +18755,15 @@ export interface operations {
18411
18755
  requestBody?: {
18412
18756
  content: {
18413
18757
  "application/json": {
18414
- /** @description Defines which deployment containers to include in the stack export. By default, no containers tagged in a deployment are exported.
18758
+ /**
18759
+ * @description Defines which deployment containers to include in the stack export. By default, no containers tagged in a deployment are exported.
18415
18760
  * This option includes all containers with the specific, comma separated deployment tags in the final output in addition to the
18416
18761
  * containers that are not part of any deployment.
18417
- * */
18762
+ */
18418
18763
  deployment_tags?: string[];
18419
18764
  /**
18420
18765
  * @description When set to true, Cycle will resolve image origins and inline them into the stack, essentially making this stack portable outside the hub it's currently used in.
18421
18766
  * By default, this is set to false, and the export will just reference existing image sources used by this stack in your hub by ID.
18422
- *
18423
18767
  * @default false
18424
18768
  */
18425
18769
  resolve_origins?: boolean;
@@ -18444,21 +18788,18 @@ export interface operations {
18444
18788
  getScopedVariables: {
18445
18789
  parameters: {
18446
18790
  query?: {
18447
- /** @description ## Filter Field
18791
+ /**
18792
+ * @description ## Filter Field
18448
18793
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
18449
- * */
18794
+ */
18450
18795
  filter?: {
18451
- /** @description `filter[identifier]=value` List only those scoped variables matching this identifier. May return multiple results.
18452
- * */
18796
+ /** @description `filter[identifier]=value` List only those scoped variables matching this identifier. May return multiple results. */
18453
18797
  identifier?: string;
18454
- /** @description `filter[container]=value` List only those scoped variables assigned to the specified container ID.
18455
- * */
18798
+ /** @description `filter[container]=value` List only those scoped variables assigned to the specified container ID. */
18456
18799
  container?: string;
18457
- /** @description `filter[search]=value` search for a value associated with a field on the given scoped variable(s).
18458
- * */
18800
+ /** @description `filter[search]=value` search for a value associated with a field on the given scoped variable(s). */
18459
18801
  search?: string;
18460
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the scoped variable's current state.
18461
- * */
18802
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the scoped variable's current state. */
18462
18803
  state?: string;
18463
18804
  };
18464
18805
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -18794,9 +19135,10 @@ export interface operations {
18794
19135
  getLoadBalancerTelemetryReport: {
18795
19136
  parameters: {
18796
19137
  query: {
18797
- /** @description ## Filter Field
19138
+ /**
19139
+ * @description ## Filter Field
18798
19140
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
18799
- * */
19141
+ */
18800
19142
  filter: {
18801
19143
  /** @description The start date from when to pull load balancer telemetry data */
18802
19144
  "range-start"?: components["schemas"]["DateTime"];
@@ -18832,14 +19174,14 @@ export interface operations {
18832
19174
  getLoadBalancerLatestTelemetryReport: {
18833
19175
  parameters: {
18834
19176
  query: {
18835
- /** @description ## Filter Field
19177
+ /**
19178
+ * @description ## Filter Field
18836
19179
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
18837
19180
  * ### Required Filter
18838
19181
  * On this endpoint, you MUST pass filter[controller].
18839
- * */
19182
+ */
18840
19183
  filter: {
18841
- /** @description `filter[controller]=port-123` filter for a specific controller to load telemetry for. THIS FILTER IS REQUIRED.
18842
- * */
19184
+ /** @description `filter[controller]=port-123` filter for a specific controller to load telemetry for. THIS FILTER IS REQUIRED. */
18843
19185
  controller?: string;
18844
19186
  };
18845
19187
  };
@@ -19119,18 +19461,16 @@ export interface operations {
19119
19461
  query?: {
19120
19462
  /** @description In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2` */
19121
19463
  page?: components["parameters"]["PageParam"];
19122
- /** @description ## Filter Field
19464
+ /**
19465
+ * @description ## Filter Field
19123
19466
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
19124
- * */
19467
+ */
19125
19468
  filter?: {
19126
- /** @description `filter[identifier]=value` List only those environments matching this identifier. May return multiple results.
19127
- * */
19469
+ /** @description `filter[identifier]=value` List only those environments matching this identifier. May return multiple results. */
19128
19470
  identifier?: string;
19129
- /** @description `filter[search]=value` search hubs for a value associated with a field on the given Hub(s).
19130
- * */
19471
+ /** @description `filter[search]=value` search hubs for a value associated with a field on the given Hub(s). */
19131
19472
  search?: string;
19132
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Hub's current state.
19133
- * */
19473
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Hub's current state. */
19134
19474
  state?: string;
19135
19475
  };
19136
19476
  };
@@ -19346,42 +19686,38 @@ export interface operations {
19346
19686
  query?: {
19347
19687
  /** @description A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return. */
19348
19688
  include?: ("users" | "components" | "creators" | "images" | "stack_builds" | "stacks" | "environments")[];
19349
- /** @description ## Filter Field
19689
+ /**
19690
+ * @description ## Filter Field
19350
19691
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
19351
- * */
19692
+ */
19352
19693
  filter?: {
19353
- /** @description `filter[search]=value` search activities for a value associated with a field on the given activity(s).
19354
- * */
19694
+ /** @description `filter[search]=value` search activities for a value associated with a field on the given activity(s). */
19355
19695
  search?: string;
19356
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the activity's current state.
19357
- * */
19696
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the activity's current state. */
19358
19697
  state?: string;
19359
- /** @description `filter[user]=ID` user filtering by ID. Submit the ID of the user you wish to filter for and the return will be any activity from that user.
19360
- * */
19698
+ /** @description `filter[user]=ID` user filtering by ID. Submit the ID of the user you wish to filter for and the return will be any activity from that user. */
19361
19699
  user?: string;
19362
- /** @description `filter[environment]=ID` environment filtering by ID. Submit the ID of the environment you wish to filter for and the return will be any activity from that environment.
19363
- * */
19700
+ /** @description `filter[environment]=ID` environment filtering by ID. Submit the ID of the environment you wish to filter for and the return will be any activity from that environment. */
19364
19701
  environment?: string;
19365
- /** @description `filter[container]=ID` container filtering by ID. Submit the ID of the container you wish to filter for and the return will be any activity from that container.
19366
- * */
19702
+ /** @description `filter[container]=ID` container filtering by ID. Submit the ID of the container you wish to filter for and the return will be any activity from that container. */
19367
19703
  container?: string;
19368
- /** @description `filter[virtual-machine]=ID` virtual machine filtering by ID. Submit the ID of the virtual machine you wish to filter for and the return will be any activity from that virtual machine.
19369
- * */
19704
+ /** @description `filter[virtual-machine]=ID` virtual machine filtering by ID. Submit the ID of the virtual machine you wish to filter for and the return will be any activity from that virtual machine. */
19370
19705
  "virtual-machine"?: string;
19371
- /** @description `filter[instance]=ID` instance filtering by ID. Submit the ID of the instance you wish to filter for and the return will be any activity from that instance.
19372
- * */
19706
+ /** @description `filter[instance]=ID` instance filtering by ID. Submit the ID of the instance you wish to filter for and the return will be any activity from that instance. */
19373
19707
  instance?: string;
19374
- /** @description `filter[server]=ID` server filtering by ID. Submit the ID of the server you wish to filter for and the return will be any activity from that server.
19375
- * */
19708
+ /** @description `filter[server]=ID` server filtering by ID. Submit the ID of the server you wish to filter for and the return will be any activity from that server. */
19376
19709
  server?: string;
19377
- /** @description `filter[events]=value` filter by event names.
19378
- * */
19710
+ /**
19711
+ * @description `filter[events]=value` filter by event names.
19712
+ * @example filter[events]=environment.services.vpn.login
19713
+ */
19379
19714
  events?: string;
19380
- /** @description `filter[verbosity]=integer` filter the activity return by verbosity. The verbosity can be:
19715
+ /**
19716
+ * @description `filter[verbosity]=integer` filter the activity return by verbosity. The verbosity can be:
19381
19717
  * `0` - Activity that users would find useful.
19382
19718
  * `1` - Activity that can be useful when tracking down how something happened.
19383
19719
  * `2` - Full activity, can be useful in debugging problems.
19384
- * */
19720
+ */
19385
19721
  verbosity?: number;
19386
19722
  };
19387
19723
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -19675,18 +20011,16 @@ export interface operations {
19675
20011
  sort?: components["parameters"]["SortParam"];
19676
20012
  /** @description A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled. */
19677
20013
  meta?: "definition"[];
19678
- /** @description ## Filter Field
20014
+ /**
20015
+ * @description ## Filter Field
19679
20016
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for. Supports filtering by state and a text search.
19680
- * */
20017
+ */
19681
20018
  filter?: {
19682
- /** @description `filter[state]=value` Filters integrations by their current state. For example, `filter[state]=active` would return only integrations in an active state.
19683
- * */
20019
+ /** @description `filter[state]=value` Filters integrations by their current state. For example, `filter[state]=active` would return only integrations in an active state. */
19684
20020
  state?: string;
19685
- /** @description `filter[search]=value` Performs a text search across relevant fields of the integrations. For example, `filter[search]=example` would return integrations that have "example" in any of the searchable fields
19686
- * */
20021
+ /** @description `filter[search]=value` Performs a text search across relevant fields of the integrations. For example, `filter[search]=example` would return integrations that have "example" in any of the searchable fields */
19687
20022
  search?: string;
19688
- /** @description `filter[category]=value` Filters integrations by their category. For example, `filter[category]=infrastructure-provider` would return only integrations that are capable of provisioning infrastructure.
19689
- * */
20023
+ /** @description `filter[category]=value` Filters integrations by their category. For example, `filter[category]=infrastructure-provider` would return only integrations that are capable of provisioning infrastructure. */
19690
20024
  category?: string;
19691
20025
  };
19692
20026
  };
@@ -20383,24 +20717,20 @@ export interface operations {
20383
20717
  meta?: "containers_count"[];
20384
20718
  /** @description A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return. */
20385
20719
  include?: ("creators" | "stack_builds" | "stacks" | "sources" | "integrations")[];
20386
- /** @description ## Filter Field
20720
+ /**
20721
+ * @description ## Filter Field
20387
20722
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
20388
- * */
20723
+ */
20389
20724
  filter?: {
20390
- /** @description `filter[identifier]=value` List only those images matching this identifier. May return multiple results.
20391
- * */
20725
+ /** @description `filter[identifier]=value` List only those images matching this identifier. May return multiple results. */
20392
20726
  identifier?: string;
20393
- /** @description `filter[search]=value` search for a value associated with a field on the given Image(s).
20394
- * */
20727
+ /** @description `filter[search]=value` search for a value associated with a field on the given Image(s). */
20395
20728
  search?: string;
20396
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Image's current state.
20397
- * */
20729
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Image's current state. */
20398
20730
  state?: string;
20399
- /** @description `filter[source_type]=value` filter images by the Image source's type. Can be: `direct`, `stack-build`, or `bucket`
20400
- * */
20731
+ /** @description `filter[source_type]=value` filter images by the Image source's type. Can be: `direct`, `stack-build`, or `bucket` */
20401
20732
  source_type?: string;
20402
- /** @description `filter[source_id]=ID` Image filtering by source ID. Submit the ID of the Image source you wish to filter for and the return will be any Images created from that source.
20403
- * */
20733
+ /** @description `filter[source_id]=ID` Image filtering by source ID. Submit the ID of the Image source you wish to filter for and the return will be any Images created from that source. */
20404
20734
  source_id?: string;
20405
20735
  };
20406
20736
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -20616,7 +20946,7 @@ export interface operations {
20616
20946
  * @enum {string}
20617
20947
  */
20618
20948
  action: "prune";
20619
- /** @description Additional contents needed by the platform to create the Job. */
20949
+ /** @description Additional contents needed by the platform to create the job. */
20620
20950
  contents: {
20621
20951
  /** @description A list of IDs to be pruned. */
20622
20952
  source_ids: string[];
@@ -20680,18 +21010,16 @@ export interface operations {
20680
21010
  meta?: "images_count"[];
20681
21011
  /** @description A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return. */
20682
21012
  include?: ("creators" | "integrations")[];
20683
- /** @description ## Filter Field
21013
+ /**
21014
+ * @description ## Filter Field
20684
21015
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
20685
- * */
21016
+ */
20686
21017
  filter?: {
20687
- /** @description `filter[identifier]=value` List only those image sources matching this identifier. May return multiple results.
20688
- * */
21018
+ /** @description `filter[identifier]=value` List only those image sources matching this identifier. May return multiple results. */
20689
21019
  identifier?: string;
20690
- /** @description `filter[search]=value` search for a value associated with a field on the given Image Source(s).
20691
- * */
21020
+ /** @description `filter[search]=value` search for a value associated with a field on the given Image Source(s). */
20692
21021
  search?: string;
20693
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Image Source's current state.
20694
- * */
21022
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Image Source's current state. */
20695
21023
  state?: string;
20696
21024
  };
20697
21025
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -20901,12 +21229,12 @@ export interface operations {
20901
21229
  getInfrastructureSummary: {
20902
21230
  parameters: {
20903
21231
  query?: {
20904
- /** @description ## Filter Field
21232
+ /**
21233
+ * @description ## Filter Field
20905
21234
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
20906
- * */
21235
+ */
20907
21236
  filter?: {
20908
- /** @description `filter[cluster]=value` return an infrastructure summary only for the specified cluster.
20909
- * */
21237
+ /** @description `filter[cluster]=value` return an infrastructure summary only for the specified cluster. */
20910
21238
  cluster?: string;
20911
21239
  };
20912
21240
  };
@@ -20992,22 +21320,26 @@ export interface operations {
20992
21320
  query?: {
20993
21321
  /** @description A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled. */
20994
21322
  meta?: "containers"[];
20995
- /** @description ## Filter Field
21323
+ /**
21324
+ * @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
21325
+ * In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.
21326
+ */
21327
+ include?: ("servers" | "locations")[];
21328
+ /**
21329
+ * @description ## Filter Field
20996
21330
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
20997
- * */
21331
+ */
20998
21332
  filter?: {
20999
- /** @description `filter[location]=value` List only those attached volumes available at the specified location.
21000
- * */
21333
+ /** @description `filter[location]=value` List only those attached volumes available at the specified location. */
21001
21334
  location?: string;
21002
- /** @description `filter[server-id]=value` List only those attached volumes attached to the specified server.
21003
- * */
21335
+ /** @description `filter[server-id]=value` List only those attached volumes attached to the specified server. */
21004
21336
  server?: string;
21005
- /** @description `filter[search]=value` List only those attached volumes within the specified cluster.
21006
- * */
21337
+ /** @description `filter[search]=value` List only those attached volumes within the specified cluster. */
21007
21338
  cluster?: string;
21008
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the attached volume's current state.
21009
- * */
21339
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the attached volume's current state. */
21010
21340
  state?: string;
21341
+ /** @description `filter[unused]=true` List only those external volumes that are unused (not attached). */
21342
+ unused?: string;
21011
21343
  };
21012
21344
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
21013
21345
  sort?: components["parameters"]["SortParam"];
@@ -21028,9 +21360,7 @@ export interface operations {
21028
21360
  content: {
21029
21361
  "application/json": {
21030
21362
  data: components["schemas"]["ExternalVolume"][];
21031
- includes?: {
21032
- creators?: components["schemas"]["CreatorInclude"];
21033
- };
21363
+ includes?: components["schemas"]["ExternalVolumeIncludes"];
21034
21364
  };
21035
21365
  };
21036
21366
  };
@@ -21039,7 +21369,15 @@ export interface operations {
21039
21369
  };
21040
21370
  createExternalVolume: {
21041
21371
  parameters: {
21042
- query?: never;
21372
+ query?: {
21373
+ /** @description A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled. */
21374
+ meta?: "containers"[];
21375
+ /**
21376
+ * @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
21377
+ * In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.
21378
+ */
21379
+ include?: ("servers" | "locations")[];
21380
+ };
21043
21381
  header?: never;
21044
21382
  path?: never;
21045
21383
  cookie?: never;
@@ -21075,6 +21413,35 @@ export interface operations {
21075
21413
  content: {
21076
21414
  "application/json": {
21077
21415
  data: components["schemas"]["ExternalVolume"];
21416
+ includes?: components["schemas"]["ExternalVolumeIncludes"];
21417
+ };
21418
+ };
21419
+ };
21420
+ default: components["responses"]["DefaultError"];
21421
+ };
21422
+ };
21423
+ createExternalVolumesJob: {
21424
+ parameters: {
21425
+ query?: never;
21426
+ header?: never;
21427
+ path?: never;
21428
+ cookie?: never;
21429
+ };
21430
+ /** @description Parameters for creating a new external volumes job. */
21431
+ requestBody?: {
21432
+ content: {
21433
+ "application/json": components["schemas"]["ExternalVolumesTask"];
21434
+ };
21435
+ };
21436
+ responses: {
21437
+ /** @description Returns a job descriptor. */
21438
+ 202: {
21439
+ headers: {
21440
+ [name: string]: unknown;
21441
+ };
21442
+ content: {
21443
+ "application/json": {
21444
+ data: components["schemas"]["JobDescriptor"];
21078
21445
  };
21079
21446
  };
21080
21447
  };
@@ -21084,11 +21451,17 @@ export interface operations {
21084
21451
  getExternalVolume: {
21085
21452
  parameters: {
21086
21453
  query?: {
21087
- /** @description A comma-separated list of meta values. Meta values will show up under a resource's `meta` field.
21454
+ /**
21455
+ * @description A comma-separated list of meta values. Meta values will show up under a resource's `meta` field.
21088
21456
  * In the case of applying a meta to a collection of resources, each resource will have its own relevant meta data.
21089
21457
  * In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
21090
- * */
21458
+ */
21091
21459
  meta?: "containers"[];
21460
+ /**
21461
+ * @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
21462
+ * In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.
21463
+ */
21464
+ include?: ("servers" | "locations")[];
21092
21465
  };
21093
21466
  header?: never;
21094
21467
  path: {
@@ -21107,6 +21480,7 @@ export interface operations {
21107
21480
  content: {
21108
21481
  "application/json": {
21109
21482
  data: components["schemas"]["ExternalVolume"];
21483
+ includes?: components["schemas"]["ExternalVolumeIncludes"];
21110
21484
  };
21111
21485
  };
21112
21486
  };
@@ -21123,7 +21497,17 @@ export interface operations {
21123
21497
  };
21124
21498
  cookie?: never;
21125
21499
  };
21126
- requestBody?: never;
21500
+ /** @description Parameters for deleting a external volume. */
21501
+ requestBody?: {
21502
+ content: {
21503
+ "application/json": {
21504
+ options?: {
21505
+ /** @description If source device is set to true, this will delete the underlying source device. */
21506
+ source_device?: boolean;
21507
+ };
21508
+ };
21509
+ };
21510
+ };
21127
21511
  responses: {
21128
21512
  /** @description Returns a job descriptor. */
21129
21513
  202: {
@@ -21141,7 +21525,15 @@ export interface operations {
21141
21525
  };
21142
21526
  updateExternalVolume: {
21143
21527
  parameters: {
21144
- query?: never;
21528
+ query?: {
21529
+ /** @description A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled. */
21530
+ meta?: "containers"[];
21531
+ /**
21532
+ * @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
21533
+ * In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.
21534
+ */
21535
+ include?: ("servers" | "locations")[];
21536
+ };
21145
21537
  header?: never;
21146
21538
  path: {
21147
21539
  /** @description The ID of the external volume. */
@@ -21174,6 +21566,7 @@ export interface operations {
21174
21566
  content: {
21175
21567
  "application/json": {
21176
21568
  data: components["schemas"]["ExternalVolume"];
21569
+ includes?: components["schemas"]["ExternalVolumeIncludes"];
21177
21570
  };
21178
21571
  };
21179
21572
  };
@@ -21258,7 +21651,7 @@ export interface operations {
21258
21651
  /** @description Parameters for creating a new attached volume job. */
21259
21652
  requestBody?: {
21260
21653
  content: {
21261
- "application/json": components["schemas"]["ExternalVolumeTasks"];
21654
+ "application/json": components["schemas"]["ExternalVolumeTask"];
21262
21655
  };
21263
21656
  };
21264
21657
  responses: {
@@ -21283,21 +21676,18 @@ export interface operations {
21283
21676
  page?: components["parameters"]["PageParam"];
21284
21677
  /** @description A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return. */
21285
21678
  include?: ("integrations" | "models" | "locations")[];
21286
- /** @description ## Filter Field
21679
+ /**
21680
+ * @description ## Filter Field
21287
21681
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
21288
- * */
21682
+ */
21289
21683
  filter?: {
21290
- /** @description `filter[search]=value` search for a value associated with a field on the given auto-scale group(s).
21291
- * */
21684
+ /** @description `filter[search]=value` search for a value associated with a field on the given auto-scale group(s). */
21292
21685
  search?: string;
21293
- /** @description `filter[cluster]=value` return a list of auto-scale groups that are associated with the specified cluster.
21294
- * */
21686
+ /** @description `filter[cluster]=value` return a list of auto-scale groups that are associated with the specified cluster. */
21295
21687
  cluster?: string;
21296
- /** @description `filter[identifier]=value` list only those auto-scale groups matching this identifier. May return multiple results.
21297
- * */
21688
+ /** @description `filter[identifier]=value` list only those auto-scale groups matching this identifier. May return multiple results. */
21298
21689
  identifier?: string;
21299
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the provider's current state.
21300
- * */
21690
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the provider's current state. */
21301
21691
  state?: string;
21302
21692
  };
21303
21693
  };
@@ -21482,26 +21872,29 @@ export interface operations {
21482
21872
  default: components["responses"]["DefaultError"];
21483
21873
  };
21484
21874
  };
21485
- getProviderServers: {
21875
+ getProviderServerModels: {
21486
21876
  parameters: {
21487
21877
  query?: {
21488
21878
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
21489
21879
  sort?: components["parameters"]["SortParam"];
21490
21880
  /** @description In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2` */
21491
21881
  page?: components["parameters"]["PageParam"];
21492
- /** @description ## Filter Field
21882
+ /**
21883
+ * @description ## Filter Field
21493
21884
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
21494
- * */
21885
+ */
21495
21886
  filter?: {
21496
- /** @description `filter[location_ids]=value` List only those provider servers matching this location. May return multiple results.
21497
- * */
21887
+ /** @description `filter[location_ids]=value` List only those provider servers matching this location. May return multiple results. */
21498
21888
  location_ids?: string;
21499
21889
  };
21500
21890
  };
21501
21891
  header?: never;
21502
21892
  path: {
21503
- /** @description The vendor for the given provider. Example `gcp`, `equinix-metal`, `abstraction`, etc. Can also use a Provider Integration ID. */
21504
- providerVendor: string;
21893
+ /**
21894
+ * @description The infrastructure provider integration ID to query for server models.
21895
+ * Can also use a vendor string. Example `gcp`, `equinix-metal`, `abstraction`, etc.
21896
+ */
21897
+ integrationId: string;
21505
21898
  };
21506
21899
  cookie?: never;
21507
21900
  };
@@ -21531,8 +21924,11 @@ export interface operations {
21531
21924
  };
21532
21925
  header?: never;
21533
21926
  path: {
21534
- /** @description The vendor for the given Provider Integration. Example `gcp`, `equinix-metal`, `abstraction`, etc. Can also use the Integration ID. */
21535
- providerVendor: string;
21927
+ /**
21928
+ * @description The infrastructure provider integration ID to query for server models.
21929
+ * Can also use a vendor string. Example `gcp`, `equinix-metal`, `abstraction`, etc.
21930
+ */
21931
+ integrationId: string;
21536
21932
  };
21537
21933
  cookie?: never;
21538
21934
  };
@@ -21844,6 +22240,19 @@ export interface operations {
21844
22240
  query?: {
21845
22241
  /** @description In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2` */
21846
22242
  page?: components["parameters"]["PageParam"];
22243
+ /**
22244
+ * @description ## Filter Field
22245
+ * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
22246
+ */
22247
+ filter?: {
22248
+ /** @description `filter[essential]=true` filter for essential/non-essential clusters. */
22249
+ essential?: string;
22250
+ /**
22251
+ * @description `filter[state]=value1,value2` state filtering will allow you to filter by the cluster's current state.
22252
+ * `filter[stack_build]=ID` stack build filtering by ID. Submit the ID of the stack build you wish to filter for and the return sill be any environments that have the stack build deployed to them.
22253
+ */
22254
+ state?: string;
22255
+ };
21847
22256
  };
21848
22257
  header?: never;
21849
22258
  path?: never;
@@ -21961,7 +22370,10 @@ export interface operations {
21961
22370
  /** @description Parameters for updating a cluster. */
21962
22371
  requestBody?: {
21963
22372
  content: {
21964
- "application/json": Record<string, never>;
22373
+ "application/json": {
22374
+ /** @description Set to true to mark the cluster as 'non-essential'. Non-essential cluster resources are excluded by default from certain metrics and summaries unless opted in. */
22375
+ non_essential?: boolean;
22376
+ };
21965
22377
  };
21966
22378
  };
21967
22379
  responses: {
@@ -22050,24 +22462,20 @@ export interface operations {
22050
22462
  meta?: ("node" | "instances_count")[];
22051
22463
  /** @description A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return. */
22052
22464
  include?: ("locations" | "models" | "integrations" | "clusters")[];
22053
- /** @description ## Filter Field
22465
+ /**
22466
+ * @description ## Filter Field
22054
22467
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
22055
- * */
22468
+ */
22056
22469
  filter?: {
22057
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the provider's current state.
22058
- * */
22470
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the provider's current state. */
22059
22471
  state?: string;
22060
- /** @description `filter[tags]=tagone,tagtwo,tagthree` filtering by Server tag. Enter one or more tags (comma separated) and the return will include servers that match any tags in the list.
22061
- * */
22472
+ /** @description `filter[tags]=tagone,tagtwo,tagthree` filtering by Server tag. Enter one or more tags (comma separated) and the return will include servers that match any tags in the list. */
22062
22473
  tags?: string;
22063
- /** @description `filter[cluster]=clusterIdentifier` filtering by cluster. Enter the cluster identifier and the return will include servers belonging to the specified cluster.
22064
- * */
22474
+ /** @description `filter[cluster]=clusterIdentifier` filtering by cluster. Enter the cluster identifier and the return will include servers belonging to the specified cluster. */
22065
22475
  cluster?: string;
22066
- /** @description `filter[location]=location` filtering by location. Enter the location id and the return will include servers belonging to the specified location.
22067
- * */
22476
+ /** @description `filter[location]=location` filtering by location. Enter the location id and the return will include servers belonging to the specified location. */
22068
22477
  location?: string;
22069
- /** @description `filter[providers]=providerone,providertwo` filtering by provider. Enter one or more providers (commas separated) and the return will include servers that match any providers in the list.
22070
- * */
22478
+ /** @description `filter[providers]=providerone,providertwo` filtering by provider. Enter one or more providers (commas separated) and the return will include servers that match any providers in the list. */
22071
22479
  providers?: string;
22072
22480
  };
22073
22481
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -22096,7 +22504,7 @@ export interface operations {
22096
22504
  default: components["responses"]["DefaultError"];
22097
22505
  };
22098
22506
  };
22099
- createServer: {
22507
+ createServers: {
22100
22508
  parameters: {
22101
22509
  query?: never;
22102
22510
  header?: never;
@@ -22117,14 +22525,12 @@ export interface operations {
22117
22525
  model_id: string;
22118
22526
  /** @description The location ID of the Server. */
22119
22527
  location_id: string;
22120
- /** @description The number of this Server at this location to deploy. */
22121
- quantity: number;
22122
- /** @description An array of hostnames for the given servers. */
22123
- hostnames?: string[];
22124
22528
  advanced?: {
22125
- /** @description Advanced options to apply to the provisioning of a server. */
22126
22529
  provision_options?: {
22127
- /** @description For providers that support setting this value dynamically; A number representing the GB size of the volume to be attached to the server. */
22530
+ /**
22531
+ * @description For providers that support setting this value dynamically;
22532
+ * A number representing the GB size of the volume to be attached to the server.
22533
+ */
22128
22534
  attached_storage_size?: number | null;
22129
22535
  /** @description A reservation ID to be used to provision a server that has been reserved at the provider. */
22130
22536
  reservation_id?: string | null;
@@ -22132,7 +22538,7 @@ export interface operations {
22132
22538
  encrypt_storage?: boolean | null;
22133
22539
  } | null;
22134
22540
  zone?: string | null;
22135
- }[];
22541
+ } | null;
22136
22542
  }[];
22137
22543
  };
22138
22544
  };
@@ -22199,7 +22605,7 @@ export interface operations {
22199
22605
  content: {
22200
22606
  "application/json": {
22201
22607
  options?: {
22202
- /** @description If force is set to true, this will force delete the hub, even if there are servers running on it. */
22608
+ /** @description If force is set to true, this will force delete the server, even if there are instances running on it. */
22203
22609
  force?: boolean;
22204
22610
  };
22205
22611
  };
@@ -22273,9 +22679,10 @@ export interface operations {
22273
22679
  getServerTelemetry: {
22274
22680
  parameters: {
22275
22681
  query?: {
22276
- /** @description ## Filter Field
22682
+ /**
22683
+ * @description ## Filter Field
22277
22684
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
22278
- * */
22685
+ */
22279
22686
  filter?: {
22280
22687
  /** @description The start date from when to pull Server telemetry data */
22281
22688
  "range-start"?: components["schemas"]["DateTime"];
@@ -22376,12 +22783,12 @@ export interface operations {
22376
22783
  getServerTags: {
22377
22784
  parameters: {
22378
22785
  query?: {
22379
- /** @description ## Filter Field
22786
+ /**
22787
+ * @description ## Filter Field
22380
22788
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
22381
- * */
22789
+ */
22382
22790
  filter?: {
22383
- /** @description `filter[cluster]=clusterone,clustertwo` filtering by cluster. Enter one or more clusters (commas separated) and the return will include tags from servers that match any cluster(s) in the list.
22384
- * */
22791
+ /** @description `filter[cluster]=clusterone,clustertwo` filtering by cluster. Enter one or more clusters (commas separated) and the return will include tags from servers that match any cluster(s) in the list. */
22385
22792
  cluster?: string;
22386
22793
  };
22387
22794
  };
@@ -22465,21 +22872,18 @@ export interface operations {
22465
22872
  query?: {
22466
22873
  /** @description A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return. */
22467
22874
  include?: ("servers" | "integrations" | "locations")[];
22468
- /** @description ## Filter Field
22875
+ /**
22876
+ * @description ## Filter Field
22469
22877
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
22470
- * */
22878
+ */
22471
22879
  filter?: {
22472
- /** @description `filter[available]=true` filter for IPs that are available for use.
22473
- * */
22880
+ /** @description `filter[available]=true` filter for IPs that are available for use. */
22474
22881
  available?: string;
22475
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the IP's current state.
22476
- * */
22882
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the IP's current state. */
22477
22883
  state?: string;
22478
- /** @description `filter[server]=ID` server filtering by ID. Submit the ID of the server you wish to filter for and the return will be any IP pool associated with that server.
22479
- * */
22884
+ /** @description `filter[server]=ID` server filtering by ID. Submit the ID of the server you wish to filter for and the return will be any IP pool associated with that server. */
22480
22885
  server?: string;
22481
- /** @description `filter[location]=ID` location filtering by ID. Submit the ID of the location you wish to filter by.
22482
- * */
22886
+ /** @description `filter[location]=ID` location filtering by ID. Submit the ID of the location you wish to filter by. */
22483
22887
  location?: string;
22484
22888
  };
22485
22889
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -22662,19 +23066,18 @@ export interface operations {
22662
23066
  query?: {
22663
23067
  /** @description A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return. */
22664
23068
  include?: "creators"[];
22665
- /** @description ## Filter Field
23069
+ /**
23070
+ * @description ## Filter Field
22666
23071
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
22667
- * */
23072
+ */
22668
23073
  filter?: {
22669
23074
  /** @description The start date from when to fetch Jobs */
22670
23075
  "range-start"?: components["schemas"]["DateTime"];
22671
23076
  /** @description The end date from when to fetch Jobs */
22672
23077
  "range-end"?: components["schemas"]["DateTime"];
22673
- /** @description `filter[search]=value` search jobs for a value associated with a field on the given job(s).
22674
- * */
23078
+ /** @description `filter[search]=value` search jobs for a value associated with a field on the given job(s). */
22675
23079
  search?: string;
22676
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the job's current state.
22677
- * */
23080
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the job's current state. */
22678
23081
  state?: string;
22679
23082
  };
22680
23083
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -22755,11 +23158,12 @@ export interface operations {
22755
23158
  getMetrics: {
22756
23159
  parameters: {
22757
23160
  query?: {
22758
- /** @description ## Filter Field
23161
+ /**
23162
+ * @description ## Filter Field
22759
23163
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
22760
23164
  *
22761
23165
  * To search via labels, use `label:<label key>` as the filter. For example in URL parameters, `filter[label:test]=abc`.
22762
- * */
23166
+ */
22763
23167
  filter?: {
22764
23168
  /** @description Specify the environment associated with the metrics. */
22765
23169
  environment?: components["schemas"]["ID"];
@@ -22811,9 +23215,10 @@ export interface operations {
22811
23215
  generateAggregatedMetrics: {
22812
23216
  parameters: {
22813
23217
  query?: {
22814
- /** @description ## Filter Field
23218
+ /**
23219
+ * @description ## Filter Field
22815
23220
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
22816
- * */
23221
+ */
22817
23222
  filter?: {
22818
23223
  /** @description The start date from when to pull metrics. Providing 'time' in the post-body criteria field will override this filter. */
22819
23224
  "range-start"?: components["schemas"]["DateTime"];
@@ -22860,11 +23265,12 @@ export interface operations {
22860
23265
  getEvents: {
22861
23266
  parameters: {
22862
23267
  query?: {
22863
- /** @description ## Filter Field
23268
+ /**
23269
+ * @description ## Filter Field
22864
23270
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
22865
23271
  *
22866
23272
  * To search via labels, use `label:<label key>` as the filter. For example in URL parameters, `filter[label:test]=abc`.
22867
- * */
23273
+ */
22868
23274
  filter?: {
22869
23275
  /** @description Specify the environment associated with the events. */
22870
23276
  environment?: components["schemas"]["ID"];
@@ -22916,9 +23322,10 @@ export interface operations {
22916
23322
  generateAggregatedEvents: {
22917
23323
  parameters: {
22918
23324
  query?: {
22919
- /** @description ## Filter Field
23325
+ /**
23326
+ * @description ## Filter Field
22920
23327
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
22921
- * */
23328
+ */
22922
23329
  filter?: {
22923
23330
  /** @description The start date from when to pull events. Providing 'time' in the post-body criteria field will override this filter. */
22924
23331
  "range-start"?: components["schemas"]["DateTime"];
@@ -23000,15 +23407,17 @@ export interface operations {
23000
23407
  }[];
23001
23408
  /** @description Indicates that only locally cached log lines should be queried. If true, logs in object storage will not be returned. */
23002
23409
  local?: boolean | null;
23003
- /** @description Describes the maximum number of log lines the query will return. */
23410
+ /**
23411
+ * @description Describes the maximum number of log lines the query will return.
23412
+ * @example 1000
23413
+ */
23004
23414
  limit?: number | null;
23005
23415
  /**
23006
23416
  * @description Context window size indicates how many log lines after a match to return in the response.
23007
23417
  * This allows greater context around the matched lines.
23008
- *
23009
23418
  * @default 5
23010
23419
  */
23011
- context_window_size?: number;
23420
+ context_window_size?: number | null;
23012
23421
  };
23013
23422
  };
23014
23423
  };
@@ -23055,18 +23464,16 @@ export interface operations {
23055
23464
  query?: {
23056
23465
  /** @description A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return. */
23057
23466
  include?: ("creators" | "name" | "components")[];
23058
- /** @description ## Filter Field
23467
+ /**
23468
+ * @description ## Filter Field
23059
23469
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
23060
- * */
23470
+ */
23061
23471
  filter?: {
23062
- /** @description `filter[identifier]=value` List only those pipelines matching this identifier. May return multiple results.
23063
- * */
23472
+ /** @description `filter[identifier]=value` List only those pipelines matching this identifier. May return multiple results. */
23064
23473
  identifier?: string;
23065
- /** @description `filter[search]=value` search for a value associated with a field on the given pipelines(s).
23066
- * */
23474
+ /** @description `filter[search]=value` search for a value associated with a field on the given pipelines(s). */
23067
23475
  search?: string;
23068
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Pipeline's current state.
23069
- * */
23476
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Pipeline's current state. */
23070
23477
  state?: string;
23071
23478
  };
23072
23479
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -23265,6 +23672,37 @@ export interface operations {
23265
23672
  default: components["responses"]["DefaultError"];
23266
23673
  };
23267
23674
  };
23675
+ getAllPipelineRuns: {
23676
+ parameters: {
23677
+ query?: {
23678
+ /** @description In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2` */
23679
+ page?: components["parameters"]["PageParam"];
23680
+ /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
23681
+ sort?: components["parameters"]["SortParam"];
23682
+ /** @description A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return. */
23683
+ include?: ("creators" | "keys" | "pipelines")[];
23684
+ };
23685
+ header?: never;
23686
+ path?: never;
23687
+ cookie?: never;
23688
+ };
23689
+ requestBody?: never;
23690
+ responses: {
23691
+ /** @description Returns a list of pipeline runs. */
23692
+ 200: {
23693
+ headers: {
23694
+ [name: string]: unknown;
23695
+ };
23696
+ content: {
23697
+ "application/json": {
23698
+ data: components["schemas"]["PipelineRun"][];
23699
+ includes?: components["schemas"]["PipelineRunIncludes"];
23700
+ };
23701
+ };
23702
+ };
23703
+ default: components["responses"]["DefaultError"];
23704
+ };
23705
+ };
23268
23706
  getPipelineRuns: {
23269
23707
  parameters: {
23270
23708
  query?: {
@@ -23282,7 +23720,7 @@ export interface operations {
23282
23720
  };
23283
23721
  requestBody?: never;
23284
23722
  responses: {
23285
- /** @description Returns a list of Pipeline runs. */
23723
+ /** @description Returns a list of pipeline runs. */
23286
23724
  200: {
23287
23725
  headers: {
23288
23726
  [name: string]: unknown;
@@ -23420,9 +23858,10 @@ export interface operations {
23420
23858
  advanced?: {
23421
23859
  /** @description Sub queue allows multiple concurrent pipeline runs. */
23422
23860
  sub_queue?: string | null;
23423
- /** @description To enable skip locks, pass the current UNIX timestamp. Must be accurate within 10 minutes of the current UTC time.
23861
+ /**
23862
+ * @description To enable skip locks, pass the current UNIX timestamp. Must be accurate within 10 minutes of the current UTC time.
23424
23863
  * This will skip lock checks when running a pipeline - the user takes all risk of ensuring two pipeline runs won't make conflicting changes.
23425
- * */
23864
+ */
23426
23865
  skip_locks?: number | null;
23427
23866
  };
23428
23867
  };
@@ -23446,15 +23885,14 @@ export interface operations {
23446
23885
  getPipelineTriggerKeys: {
23447
23886
  parameters: {
23448
23887
  query?: {
23449
- /** @description ## Filter Field
23888
+ /**
23889
+ * @description ## Filter Field
23450
23890
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
23451
- * */
23891
+ */
23452
23892
  filter?: {
23453
- /** @description `filter[search]=value` search for a value associated with a field on the given Trigger Key(s).
23454
- * */
23893
+ /** @description `filter[search]=value` search for a value associated with a field on the given Trigger Key(s). */
23455
23894
  search?: string;
23456
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Trigger Key's current state.
23457
- * */
23895
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Trigger Key's current state. */
23458
23896
  state?: string;
23459
23897
  };
23460
23898
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -23619,18 +24057,16 @@ export interface operations {
23619
24057
  query?: {
23620
24058
  /** @description A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return. */
23621
24059
  include?: ("creators" | "environments")[];
23622
- /** @description ## Filter Field
24060
+ /**
24061
+ * @description ## Filter Field
23623
24062
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
23624
- * */
24063
+ */
23625
24064
  filter?: {
23626
- /** @description `filter[environment]=ID` Filter networks based on linked environment. Submit the ID of the environment you wish to filter for.
23627
- * */
24065
+ /** @description `filter[environment]=ID` Filter networks based on linked environment. Submit the ID of the environment you wish to filter for. */
23628
24066
  environment?: string;
23629
- /** @description `filter[search]=value` search for a value associated with a field on the given Network(s).
23630
- * */
24067
+ /** @description `filter[search]=value` search for a value associated with a field on the given Network(s). */
23631
24068
  search?: string;
23632
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the network's current state.
23633
- * */
24069
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the network's current state. */
23634
24070
  state?: string;
23635
24071
  };
23636
24072
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -23894,18 +24330,16 @@ export interface operations {
23894
24330
  meta?: ("containers_count" | "builds_count")[];
23895
24331
  /** @description A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return. */
23896
24332
  include?: "creators"[];
23897
- /** @description ## Filter Field
24333
+ /**
24334
+ * @description ## Filter Field
23898
24335
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
23899
- * */
24336
+ */
23900
24337
  filter?: {
23901
- /** @description `filter[identifier]=value` List only those stacks matching this identifier. May return multiple results.
23902
- * */
24338
+ /** @description `filter[identifier]=value` List only those stacks matching this identifier. May return multiple results. */
23903
24339
  identifier?: string;
23904
- /** @description `filter[search]=value` search for a value associated with a field on the given Stack(s).
23905
- * */
24340
+ /** @description `filter[search]=value` search for a value associated with a field on the given Stack(s). */
23906
24341
  search?: string;
23907
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Stack's current state.
23908
- * */
24342
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Stack's current state. */
23909
24343
  state?: string;
23910
24344
  };
23911
24345
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -24133,6 +24567,46 @@ export interface operations {
24133
24567
  default: components["responses"]["DefaultError"];
24134
24568
  };
24135
24569
  };
24570
+ getAllStackBuilds: {
24571
+ parameters: {
24572
+ query?: {
24573
+ /** @description A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled. */
24574
+ meta?: "containers_count"[];
24575
+ /**
24576
+ * @description ## Filter Field
24577
+ * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
24578
+ */
24579
+ filter?: {
24580
+ /** @description `filter[search]=value` search for a value associated with a field on the given Stack Build(s). */
24581
+ search?: string;
24582
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Stack Build's current state. */
24583
+ state?: string;
24584
+ };
24585
+ /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
24586
+ sort?: components["parameters"]["SortParam"];
24587
+ /** @description In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2` */
24588
+ page?: components["parameters"]["PageParam"];
24589
+ };
24590
+ header?: never;
24591
+ path?: never;
24592
+ cookie?: never;
24593
+ };
24594
+ requestBody?: never;
24595
+ responses: {
24596
+ /** @description Returns a list of stack builds. */
24597
+ 200: {
24598
+ headers: {
24599
+ [name: string]: unknown;
24600
+ };
24601
+ content: {
24602
+ "application/json": {
24603
+ data: components["schemas"]["StackBuild"][];
24604
+ };
24605
+ };
24606
+ };
24607
+ default: components["responses"]["DefaultError"];
24608
+ };
24609
+ };
24136
24610
  lookupStackBuild: {
24137
24611
  parameters: {
24138
24612
  query?: never;
@@ -24164,15 +24638,14 @@ export interface operations {
24164
24638
  query?: {
24165
24639
  /** @description A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled. */
24166
24640
  meta?: "containers_count"[];
24167
- /** @description ## Filter Field
24641
+ /**
24642
+ * @description ## Filter Field
24168
24643
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
24169
- * */
24644
+ */
24170
24645
  filter?: {
24171
- /** @description `filter[search]=value` search for a value associated with a field on the given Stack Build(s).
24172
- * */
24646
+ /** @description `filter[search]=value` search for a value associated with a field on the given Stack Build(s). */
24173
24647
  search?: string;
24174
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Stack Build's current state.
24175
- * */
24648
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Stack Build's current state. */
24176
24649
  state?: string;
24177
24650
  };
24178
24651
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -24357,34 +24830,32 @@ export interface operations {
24357
24830
  getVirtualMachines: {
24358
24831
  parameters: {
24359
24832
  query?: {
24360
- /** @description A comma-separated list of meta values. Meta values will show up under a resource's `meta` field.
24833
+ /**
24834
+ * @description A comma-separated list of meta values. Meta values will show up under a resource's `meta` field.
24361
24835
  * In the case of applying a meta to a collection of resources, each resource will have its own relevant meta data.
24362
24836
  * In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
24363
- * */
24837
+ */
24364
24838
  meta?: ("domains" | "ips" | "hypervisor_ips" | "server")[];
24365
- /** @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
24839
+ /**
24840
+ * @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
24366
24841
  * In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.
24367
- * */
24842
+ */
24368
24843
  include?: ("creators" | "environments" | "clusters" | "containers")[];
24369
- /** @description ## Filter Field
24844
+ /**
24845
+ * @description ## Filter Field
24370
24846
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
24371
- * */
24847
+ */
24372
24848
  filter?: {
24373
- /** @description `filter[identifier]=value` List only those virtual machines matching this identifier. May return multiple results.
24374
- * */
24849
+ /** @description `filter[identifier]=value` List only those virtual machines matching this identifier. May return multiple results. */
24375
24850
  identifier?: string;
24376
- /** @description `filter[search]=value` Search virtual machines for a value associated with a field.
24377
- * */
24851
+ /** @description `filter[search]=value` Search virtual machines for a value associated with a field. */
24378
24852
  search?: string;
24379
- /** @description `filter[creator]=account-ID` Filter for virtual machines matching a particular creator, such as `account-<ID>` or `environment-<ID>`.
24380
- * */
24853
+ /** @description `filter[creator]=account-ID` Filter for virtual machines matching a particular creator, such as `account-<ID>` or `environment-<ID>`. */
24381
24854
  creator?: string;
24382
- /** @description `filter[environment]=ID` Filter virtual machines by environment ID. Submit the ID of the environment you wish to filter for.
24383
- * */
24855
+ /** @description `filter[environment]=ID` Filter virtual machines by environment ID. Submit the ID of the environment you wish to filter for. */
24384
24856
  environment?: string;
24385
24857
  /**
24386
24858
  * @description `filter[state]=value` Filter virtual machines by their current state.
24387
- *
24388
24859
  * @enum {string}
24389
24860
  */
24390
24861
  state?: "new" | "starting" | "running" | "stopping" | "stopped" | "deleting" | "deleted";
@@ -24392,12 +24863,10 @@ export interface operations {
24392
24863
  "range-start"?: components["schemas"]["DateTime"];
24393
24864
  /** @description The end date from when to pull the virtual machines. */
24394
24865
  "range-end"?: components["schemas"]["DateTime"];
24395
- /** @description `filter[tags]=value` Filter virtual machines by their tags.
24396
- * */
24866
+ /** @description `filter[tags]=value` Filter virtual machines by their tags. */
24397
24867
  tags?: string;
24398
24868
  /**
24399
24869
  * @description `filter[public_network]=value` Filter virtual machines by their public network status.
24400
- *
24401
24870
  * @enum {string}
24402
24871
  */
24403
24872
  public_network?: "enabled" | "disabled";
@@ -24431,14 +24900,16 @@ export interface operations {
24431
24900
  createVirtualMachine: {
24432
24901
  parameters: {
24433
24902
  query?: {
24434
- /** @description A comma-separated list of meta values. Meta values will show up under a resource's `meta` field.
24903
+ /**
24904
+ * @description A comma-separated list of meta values. Meta values will show up under a resource's `meta` field.
24435
24905
  * In the case of applying a meta to a collection of resources, each resource will have its own relevant meta data.
24436
24906
  * In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
24437
- * */
24907
+ */
24438
24908
  meta?: ("domains" | "ips" | "server")[];
24439
- /** @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
24909
+ /**
24910
+ * @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
24440
24911
  * In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.
24441
- * */
24912
+ */
24442
24913
  include?: ("creators" | "environments" | "clusters")[];
24443
24914
  };
24444
24915
  header?: never;
@@ -24487,14 +24958,16 @@ export interface operations {
24487
24958
  getVirtualMachine: {
24488
24959
  parameters: {
24489
24960
  query?: {
24490
- /** @description A comma-separated list of meta values. Meta values will show up under a resource's `meta` field.
24961
+ /**
24962
+ * @description A comma-separated list of meta values. Meta values will show up under a resource's `meta` field.
24491
24963
  * In the case of applying a meta to a collection of resources, each resource will have its own relevant meta data.
24492
24964
  * In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
24493
- * */
24965
+ */
24494
24966
  meta?: ("domains" | "ips" | "server" | "hypervisor_ips")[];
24495
- /** @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
24967
+ /**
24968
+ * @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
24496
24969
  * In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.
24497
- * */
24970
+ */
24498
24971
  include?: ("creators" | "environments" | "clusters" | "containers")[];
24499
24972
  };
24500
24973
  header?: never;
@@ -24708,25 +25181,21 @@ export interface operations {
24708
25181
  getVirtualMachineSshKeys: {
24709
25182
  parameters: {
24710
25183
  query?: {
24711
- /** @description ## Filter Field
25184
+ /**
25185
+ * @description ## Filter Field
24712
25186
  * The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
24713
- * */
25187
+ */
24714
25188
  filter?: {
24715
- /** @description `filter[identifier]=value` List only those SSH keys matching this identifier. May return multiple results.
24716
- * */
25189
+ /** @description `filter[identifier]=value` List only those SSH keys matching this identifier. May return multiple results. */
24717
25190
  identifier?: string;
24718
- /** @description `filter[search]=value` Search SSH keys for a value associated with a field.
24719
- * */
25191
+ /** @description `filter[search]=value` Search SSH keys for a value associated with a field. */
24720
25192
  search?: string;
24721
- /** @description `filter[creator]=account-ID` Filter for SSH keys matching a particular creator, such as `account-<ID>` or `environment-<ID>`.
24722
- * */
25193
+ /** @description `filter[creator]=account-ID` Filter for SSH keys matching a particular creator, such as `account-<ID>` or `environment-<ID>`. */
24723
25194
  creator?: string;
24724
- /** @description `filter[environment]=ID` Filter SSH keys by environment ID. Submit the ID of the environment you wish to filter for.
24725
- * */
25195
+ /** @description `filter[environment]=ID` Filter SSH keys by environment ID. Submit the ID of the environment you wish to filter for. */
24726
25196
  environment?: string;
24727
25197
  /**
24728
25198
  * @description `filter[state]=value` Filter virtual machines by their current state.
24729
- *
24730
25199
  * @enum {string}
24731
25200
  */
24732
25201
  state?: "live" | "deleting" | "deleted";
@@ -24735,9 +25204,10 @@ export interface operations {
24735
25204
  /** @description The end date from when to pull the virtual machines. */
24736
25205
  "range-end"?: components["schemas"]["DateTime"];
24737
25206
  };
24738
- /** @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
25207
+ /**
25208
+ * @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
24739
25209
  * In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.
24740
- * */
25210
+ */
24741
25211
  include?: ("creators" | "environments")[];
24742
25212
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
24743
25213
  sort?: components["parameters"]["SortParam"];
@@ -24768,9 +25238,10 @@ export interface operations {
24768
25238
  createVirtualMachineSshKey: {
24769
25239
  parameters: {
24770
25240
  query?: {
24771
- /** @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
25241
+ /**
25242
+ * @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
24772
25243
  * In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.
24773
- * */
25244
+ */
24774
25245
  include?: ("creators" | "environments")[];
24775
25246
  };
24776
25247
  header?: never;
@@ -24808,9 +25279,10 @@ export interface operations {
24808
25279
  getVirtualMachineSshKey: {
24809
25280
  parameters: {
24810
25281
  query?: {
24811
- /** @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
25282
+ /**
25283
+ * @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
24812
25284
  * In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.
24813
- * */
25285
+ */
24814
25286
  include?: ("creators" | "environments")[];
24815
25287
  };
24816
25288
  header?: never;
@@ -24866,9 +25338,10 @@ export interface operations {
24866
25338
  updateVirtualMachineSshKey: {
24867
25339
  parameters: {
24868
25340
  query?: {
24869
- /** @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
25341
+ /**
25342
+ * @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
24870
25343
  * In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.
24871
- * */
25344
+ */
24872
25345
  include?: ("creators" | "environments")[];
24873
25346
  };
24874
25347
  header?: never;
@@ -24969,9 +25442,10 @@ export interface operations {
24969
25442
  path?: never;
24970
25443
  cookie?: never;
24971
25444
  };
24972
- /** @description Accepts an array of component lookup objects. Consists of the type of resource to look up,
25445
+ /**
25446
+ * @description Accepts an array of component lookup objects. Consists of the type of resource to look up,
24973
25447
  * and the ID.
24974
- * */
25448
+ */
24975
25449
  requestBody?: {
24976
25450
  content: {
24977
25451
  "application/json": {
@@ -24997,4 +25471,32 @@ export interface operations {
24997
25471
  default: components["responses"]["DefaultError"];
24998
25472
  };
24999
25473
  };
25474
+ environmentMetricsPush: {
25475
+ parameters: {
25476
+ query?: never;
25477
+ header?: never;
25478
+ path?: never;
25479
+ cookie?: never;
25480
+ };
25481
+ requestBody?: {
25482
+ content: {
25483
+ "application/json": components["schemas"]["Metric"][];
25484
+ };
25485
+ };
25486
+ responses: never;
25487
+ };
25488
+ environmentEventsPush: {
25489
+ parameters: {
25490
+ query?: never;
25491
+ header?: never;
25492
+ path?: never;
25493
+ cookie?: never;
25494
+ };
25495
+ requestBody?: {
25496
+ content: {
25497
+ "application/json": components["schemas"]["Event"][];
25498
+ };
25499
+ };
25500
+ responses: never;
25501
+ };
25000
25502
  }