@cycleplatform/api-client-typescript 0.3.15 → 0.3.19

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;
@@ -1328,7 +1301,6 @@ export interface paths {
1328
1301
  * @description Lookup and retrieve a TLS certificate bundle for a specified domain.
1329
1302
  *
1330
1303
  * 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
1304
  */
1333
1305
  get: operations["lookupTLSCertificate"];
1334
1306
  put?: never;
@@ -1351,7 +1323,6 @@ export interface paths {
1351
1323
  * @description Retrieve a list of TLS certificates that were uploaded to Cycle.
1352
1324
  *
1353
1325
  * Requires the `dns-certs-view` capability.
1354
- *
1355
1326
  */
1356
1327
  get: operations["getUserSuppliedCertificates"];
1357
1328
  put?: never;
@@ -1360,7 +1331,6 @@ export interface paths {
1360
1331
  * @description Upload a user-supplied TLS certificate to the hub. This TLS certificate can be utilized by **LINKED** records matching the specified domains.
1361
1332
  *
1362
1333
  * Requires the `dns-manage` capability.
1363
- *
1364
1334
  */
1365
1335
  post: operations["uploadUserSuppliedCertificate"];
1366
1336
  delete?: never;
@@ -1381,7 +1351,6 @@ export interface paths {
1381
1351
  * @description Gets a list of custom TLS certificates uploaded to the hub.
1382
1352
  *
1383
1353
  * Requires the `dns-certs-view` capability.
1384
- *
1385
1354
  */
1386
1355
  get: operations["getUserSuppliedCertificate"];
1387
1356
  put?: never;
@@ -1406,7 +1375,6 @@ export interface paths {
1406
1375
  * @description Used to perform different actions on a given user supplied TLS certificate.
1407
1376
  *
1408
1377
  * Requires the `dns-manage` capability.
1409
- *
1410
1378
  */
1411
1379
  post: operations["createUserSuppliedCertificateJob"];
1412
1380
  delete?: never;
@@ -1465,7 +1433,6 @@ export interface paths {
1465
1433
  * @description Updates the specificed Environment.
1466
1434
  *
1467
1435
  * Requires the `environments-manage` capability.
1468
- *
1469
1436
  */
1470
1437
  patch: operations["updateEnvironment"];
1471
1438
  trace?: never;
@@ -1488,7 +1455,6 @@ export interface paths {
1488
1455
  * @description Updates the specificed Environment.
1489
1456
  *
1490
1457
  * Requires the `environments-manage` capability. If an ACL is present, requires the `manage` privilege.
1491
- *
1492
1458
  */
1493
1459
  patch: operations["updateEnvironmentAccess"];
1494
1460
  trace?: never;
@@ -1507,7 +1473,6 @@ export interface paths {
1507
1473
  * @description Create a job for an Environment, such as 'start' or 'stop'.
1508
1474
  *
1509
1475
  * Requires the `environments-manage` capability.
1510
- *
1511
1476
  */
1512
1477
  post: operations["createEnvironmentJob"];
1513
1478
  delete?: never;
@@ -1528,7 +1493,6 @@ export interface paths {
1528
1493
  * @description Gets the summary of an Environment. Contains useful and relevant data/statistics that would otherwise be several separate API calls.
1529
1494
  *
1530
1495
  * Requires the `environments-view` capability.
1531
- *
1532
1496
  */
1533
1497
  get: operations["getEnvironmentSummary"];
1534
1498
  put?: never;
@@ -1551,7 +1515,6 @@ export interface paths {
1551
1515
  * @description Gets a list of all deployments in the specified Environment.
1552
1516
  *
1553
1517
  * Requires the `environments-view` capability.
1554
- *
1555
1518
  */
1556
1519
  get: operations["getEnvironmentDeployments"];
1557
1520
  put?: never;
@@ -1576,7 +1539,6 @@ export interface paths {
1576
1539
  * @description Exports an environment as a stack file for reuse.
1577
1540
  *
1578
1541
  * Requires the `environments-manage` capability. You must also have management permissions on the target environment ACL.
1579
- *
1580
1542
  */
1581
1543
  post: operations["exportStack"];
1582
1544
  delete?: never;
@@ -1730,7 +1692,6 @@ export interface paths {
1730
1692
  *
1731
1693
  * ## Permissions
1732
1694
  * Requires the `environments-view` capability. Also requires the user to have access specifically to the requested Environment.
1733
- *
1734
1695
  */
1735
1696
  get: operations["getLoadBalancerTelemetryReport"];
1736
1697
  put?: never;
@@ -1754,7 +1715,6 @@ export interface paths {
1754
1715
  *
1755
1716
  * ## Permissions
1756
1717
  * Requires the `environments-view` capability. Also requires the user to have access specifically to the requested Environment.
1757
- *
1758
1718
  */
1759
1719
  get: operations["getLoadBalancerLatestTelemetryReport"];
1760
1720
  put?: never;
@@ -1778,7 +1738,6 @@ export interface paths {
1778
1738
  *
1779
1739
  * ## Permissions
1780
1740
  * Requires the `environments-view` capability. Also requires the user to have access specifically to the requested Environment.
1781
- *
1782
1741
  */
1783
1742
  get: operations["getLoadBalancerTelemetryLatestControllers"];
1784
1743
  put?: never;
@@ -2083,7 +2042,6 @@ export interface paths {
2083
2042
  * @description Retrieves details of a single integration associated with the current hub.
2084
2043
  *
2085
2044
  * Requires the `hubs-integrations-view` capability.
2086
- *
2087
2045
  */
2088
2046
  get: operations["getIntegration"];
2089
2047
  put?: never;
@@ -2114,7 +2072,6 @@ export interface paths {
2114
2072
  * @description Lists all integrations associated with the current Hub, with optional filtering.
2115
2073
  *
2116
2074
  * Requires the `hubs-integrations-view` capability.
2117
- *
2118
2075
  */
2119
2076
  get: operations["getIntegrations"];
2120
2077
  put?: never;
@@ -2165,7 +2122,6 @@ export interface paths {
2165
2122
  * ## Required Permissions
2166
2123
  * - Requires a valid hub membership to the target hub.
2167
2124
  * - Requires the `hubs-integrations-manage` capability.
2168
- *
2169
2125
  */
2170
2126
  post: operations["createIntegrationJob"];
2171
2127
  delete?: never;
@@ -2323,7 +2279,6 @@ export interface paths {
2323
2279
  * token can then be applied to the URL parameter to the same endpoint to upgrade the connection to a WebSocket.
2324
2280
  *
2325
2281
  * Requires the `apionly-notifications-listen` capability.
2326
- *
2327
2282
  */
2328
2283
  get: operations["getHubNotificationSocketAuth"];
2329
2284
  put?: never;
@@ -2346,7 +2301,6 @@ export interface paths {
2346
2301
  * @description Lists the Roles that have been created for this Hub.
2347
2302
  *
2348
2303
  * Requires the `hubs-roles-manage` capability.
2349
- *
2350
2304
  */
2351
2305
  get: operations["getRoles"];
2352
2306
  put?: never;
@@ -2355,7 +2309,6 @@ export interface paths {
2355
2309
  * @description Creates a custom Role for a Hub.
2356
2310
  *
2357
2311
  * Requires the `hubs-roles-manage` capability.
2358
- *
2359
2312
  */
2360
2313
  post: operations["createRole"];
2361
2314
  delete?: never;
@@ -2376,7 +2329,6 @@ export interface paths {
2376
2329
  * @description Retrieves the specified Role.
2377
2330
  *
2378
2331
  * Requries the `hubs-roles-manage` capability.
2379
- *
2380
2332
  */
2381
2333
  get: operations["getRole"];
2382
2334
  put?: never;
@@ -2386,7 +2338,6 @@ export interface paths {
2386
2338
  * @description Marks a Role as 'deleted'.
2387
2339
  *
2388
2340
  * Requires the 'hubs-roles-manage' capability.
2389
- *
2390
2341
  */
2391
2342
  delete: operations["deleteRole"];
2392
2343
  options?: never;
@@ -2396,7 +2347,6 @@ export interface paths {
2396
2347
  * @description Updates various properties of a specific Role.
2397
2348
  *
2398
2349
  * Requires the `hubs-roles-manage` capability.
2399
- *
2400
2350
  */
2401
2351
  patch: operations["updateRole"];
2402
2352
  trace?: never;
@@ -2504,7 +2454,6 @@ export interface paths {
2504
2454
  * @description Used to perform different actions on a given image.
2505
2455
  *
2506
2456
  * Requires the `images-manage` capability.
2507
- *
2508
2457
  */
2509
2458
  post: operations["createImagesJob"];
2510
2459
  delete?: never;
@@ -2527,7 +2476,6 @@ export interface paths {
2527
2476
  * @description Used to perform different actions on a given Image.
2528
2477
  *
2529
2478
  * Requires the `images-import` capability.
2530
- *
2531
2479
  */
2532
2480
  post: operations["createImageJob"];
2533
2481
  delete?: never;
@@ -2658,7 +2606,6 @@ export interface paths {
2658
2606
  /**
2659
2607
  * Get Cluster Monitoring Tiers
2660
2608
  * @description Gets all the available monitoring tiers that can be enabled for a cluster.
2661
- *
2662
2609
  */
2663
2610
  get: operations["getClusterMonitoringTiers"];
2664
2611
  put?: never;
@@ -2693,6 +2640,28 @@ export interface paths {
2693
2640
  patch?: never;
2694
2641
  trace?: never;
2695
2642
  };
2643
+ "/v1/infrastructure/external-volumes/tasks": {
2644
+ parameters: {
2645
+ query?: never;
2646
+ header?: never;
2647
+ path?: never;
2648
+ cookie?: never;
2649
+ };
2650
+ get?: never;
2651
+ put?: never;
2652
+ /**
2653
+ * Create External Volumes Job
2654
+ * @description Create a job for external volumes.
2655
+ *
2656
+ * Requires the `external-volumes-manage` capability.
2657
+ */
2658
+ post: operations["createExternalVolumesJob"];
2659
+ delete?: never;
2660
+ options?: never;
2661
+ head?: never;
2662
+ patch?: never;
2663
+ trace?: never;
2664
+ };
2696
2665
  "/v1/infrastructure/external-volumes/{externalVolumeId}": {
2697
2666
  parameters: {
2698
2667
  query?: never;
@@ -2705,7 +2674,6 @@ export interface paths {
2705
2674
  * @description Retrieves a single external volume by ID.
2706
2675
  *
2707
2676
  * Requires the `external-volumes-view` capability.
2708
- *
2709
2677
  */
2710
2678
  get: operations["getExternalVolume"];
2711
2679
  put?: never;
@@ -2722,7 +2690,6 @@ export interface paths {
2722
2690
  * @description Updates the specified external volume.
2723
2691
  *
2724
2692
  * Requires the `external-volumes-manage` capability.
2725
- *
2726
2693
  */
2727
2694
  patch: operations["updateExternalVolume"];
2728
2695
  trace?: never;
@@ -2765,7 +2732,6 @@ export interface paths {
2765
2732
  * @description Updates the ACL of the specified external volume.
2766
2733
  *
2767
2734
  * Requires the `external-volumes-manage` capability.
2768
- *
2769
2735
  */
2770
2736
  patch: operations["updateExternalVolumeAccess"];
2771
2737
  trace?: never;
@@ -2784,7 +2750,6 @@ export interface paths {
2784
2750
  * @description Create a job for an external volume.
2785
2751
  *
2786
2752
  * Requires the `external-volumes-manage` capability.
2787
- *
2788
2753
  */
2789
2754
  post: operations["createExternalVolumeJob"];
2790
2755
  delete?: never;
@@ -2911,7 +2876,6 @@ export interface paths {
2911
2876
  * @description Get ISOs for a virtual provider.
2912
2877
  *
2913
2878
  * Requires the `servers-manage` capability.
2914
- *
2915
2879
  */
2916
2880
  get: operations["getVirtualProviderIsos"];
2917
2881
  put?: never;
@@ -2920,7 +2884,6 @@ export interface paths {
2920
2884
  * @description Create an ISO for a virtual provider.
2921
2885
  *
2922
2886
  * Requires the `servers-manage` capability.
2923
- *
2924
2887
  */
2925
2888
  post: operations["createVirtualProviderIso"];
2926
2889
  delete?: never;
@@ -2971,7 +2934,6 @@ export interface paths {
2971
2934
  * @description Create a job for a virtual provider iso.
2972
2935
  *
2973
2936
  * Requires the `servers-manage` capability.
2974
- *
2975
2937
  */
2976
2938
  post: operations["createVirtualProviderIsoJob"];
2977
2939
  delete?: never;
@@ -3035,7 +2997,6 @@ export interface paths {
3035
2997
  * Get Cluster
3036
2998
  * @description Gets a Cluster.
3037
2999
  * Requires the `clusters-view` capability.
3038
- *
3039
3000
  */
3040
3001
  get: operations["getCluster"];
3041
3002
  put?: never;
@@ -3158,7 +3119,6 @@ export interface paths {
3158
3119
  * @description This call requires the filter query parameter to be used.
3159
3120
  *
3160
3121
  * Requires the `servers-view` capability.
3161
- *
3162
3122
  */
3163
3123
  get: operations["getServerTelemetry"];
3164
3124
  put?: never;
@@ -3261,7 +3221,6 @@ export interface paths {
3261
3221
  * @description Gets the authorization information required to connect to a Server console websocket.
3262
3222
  *
3263
3223
  * Requires the `servers-console` capability.
3264
- *
3265
3224
  */
3266
3225
  get: operations["GetServerConsole"];
3267
3226
  put?: never;
@@ -3290,7 +3249,6 @@ export interface paths {
3290
3249
  * @description Create an infrastructure IP Pool
3291
3250
  *
3292
3251
  * Requires the 'ips-manage' capability.
3293
- *
3294
3252
  */
3295
3253
  post: operations["createIpPool"];
3296
3254
  delete?: never;
@@ -3435,7 +3393,6 @@ export interface paths {
3435
3393
  * @description A basic query for retrieving metrics. For a more complex and granular report, see the `/v1/monitoring/metrics/aggregate` endpoint.
3436
3394
  *
3437
3395
  * Requires the `monitor-view` capability.
3438
- *
3439
3396
  */
3440
3397
  get: operations["getMetrics"];
3441
3398
  put?: never;
@@ -3463,7 +3420,6 @@ export interface paths {
3463
3420
  * 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
3421
  *
3465
3422
  * Requires the `monitor-view` capability.
3466
- *
3467
3423
  */
3468
3424
  post: operations["generateAggregatedMetrics"];
3469
3425
  delete?: never;
@@ -3484,7 +3440,6 @@ export interface paths {
3484
3440
  * @description A basic query for retrieving events. For a more complex and granular report, see the `/v1/monitoring/events/aggregate` endpoint.
3485
3441
  *
3486
3442
  * Requires the `monitor-view` capability.
3487
- *
3488
3443
  */
3489
3444
  get: operations["getEvents"];
3490
3445
  put?: never;
@@ -3512,7 +3467,6 @@ export interface paths {
3512
3467
  * 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
3468
  *
3514
3469
  * Requires the `monitor-view` capability.
3515
- *
3516
3470
  */
3517
3471
  post: operations["generateAggregatedEvents"];
3518
3472
  delete?: never;
@@ -3537,7 +3491,6 @@ export interface paths {
3537
3491
  * 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
3492
  *
3539
3493
  * Requires the `monitor-view` capability.
3540
- *
3541
3494
  */
3542
3495
  post: operations["aggregateLogs"];
3543
3496
  delete?: never;
@@ -3558,7 +3511,6 @@ export interface paths {
3558
3511
  * @description Returns location information about the monitors used for Cycle's external monitoring service.
3559
3512
  * These monitors are used for determining the latency between the public internet and environment
3560
3513
  * load balancers.
3561
- *
3562
3514
  */
3563
3515
  get: operations["getMonitoringMonitors"];
3564
3516
  put?: never;
@@ -3653,7 +3605,6 @@ export interface paths {
3653
3605
  * @description List information about times this Pipeline has run.
3654
3606
  *
3655
3607
  * Requires the `pipelines-view` capability.
3656
- *
3657
3608
  */
3658
3609
  get: operations["getPipelineRuns"];
3659
3610
  put?: never;
@@ -3898,7 +3849,6 @@ export interface paths {
3898
3849
  * Can be used to build a 'quick search' functionality for referencing the most frequently used resources.
3899
3850
  *
3900
3851
  * Requires the `view` capability for each returned segment, i.e. to retrieve Containers, you must have `containers-view`.
3901
- *
3902
3852
  */
3903
3853
  get: operations["getSearchIndex"];
3904
3854
  put?: never;
@@ -4013,7 +3963,6 @@ export interface paths {
4013
3963
  * @description Look up a Stack Build using only the Build ID, instead of requiring a Stack ID as well.
4014
3964
  *
4015
3965
  * Requires the `stacks-view` capability.
4016
- *
4017
3966
  */
4018
3967
  get: operations["lookupStackBuild"];
4019
3968
  put?: never;
@@ -4089,7 +4038,6 @@ export interface paths {
4089
4038
  * will be included in the log.
4090
4039
  *
4091
4040
  * Requires the `stacks-view` capability.
4092
- *
4093
4041
  */
4094
4042
  get: operations["getStackBuildLog"];
4095
4043
  put?: never;
@@ -4156,7 +4104,6 @@ export interface paths {
4156
4104
  * @description Retrieves a single virtual machine by ID.
4157
4105
  *
4158
4106
  * Requires the `virtual-machines-view` capability.
4159
- *
4160
4107
  */
4161
4108
  get: operations["getVirtualMachine"];
4162
4109
  put?: never;
@@ -4173,7 +4120,6 @@ export interface paths {
4173
4120
  * @description Updates the specified virtual machine.
4174
4121
  *
4175
4122
  * Requires the `virtual-machines-manage` capability.
4176
- *
4177
4123
  */
4178
4124
  patch: operations["updateVirtualMachine"];
4179
4125
  trace?: never;
@@ -4198,7 +4144,6 @@ export interface paths {
4198
4144
  * `rootpw.change`: `virtual-machines-manage`
4199
4145
  * `ip.allocate`: `virtual-machines-manage`
4200
4146
  * `ip.unallocate`: `virtual-machines-manage`
4201
- *
4202
4147
  */
4203
4148
  post: operations["createVirtualMachineJob"];
4204
4149
  delete?: never;
@@ -4217,7 +4162,6 @@ export interface paths {
4217
4162
  /**
4218
4163
  * Get Virtual Machine Base Images
4219
4164
  * @description Retrieves the list of available base images for virtual machines provided by Cycle.
4220
- *
4221
4165
  */
4222
4166
  get: operations["getVirtualMachineBaseImages"];
4223
4167
  put?: never;
@@ -4240,7 +4184,6 @@ export interface paths {
4240
4184
  * @description Generates credentials for connecting to the serial console of a virtual machine via SSH.
4241
4185
  *
4242
4186
  * Requires the `virtual-machines-console` capability.
4243
- *
4244
4187
  */
4245
4188
  get: operations["generateVirtualMachineSosCredentials"];
4246
4189
  put?: never;
@@ -4250,7 +4193,6 @@ export interface paths {
4250
4193
  * @description Instantly expires any serial-over-SSH credentials generated for this virtual machine.
4251
4194
  *
4252
4195
  * Requires the `virtual-machines-console` capability.
4253
- *
4254
4196
  */
4255
4197
  delete: operations["expireVirtualMachineSosCredentials"];
4256
4198
  options?: never;
@@ -4294,7 +4236,6 @@ export interface paths {
4294
4236
  * @description Retrieves a single virtual machine SSH key by ID.
4295
4237
  *
4296
4238
  * Requires the `virtual-machines-ssh-keys-manage` capability.
4297
- *
4298
4239
  */
4299
4240
  get: operations["getVirtualMachineSshKey"];
4300
4241
  put?: never;
@@ -4311,7 +4252,6 @@ export interface paths {
4311
4252
  * @description Updates the specified virtual machine SSH key.
4312
4253
  *
4313
4254
  * Requires the `virtual-machines-ssh-keys-manage` capability.
4314
- *
4315
4255
  */
4316
4256
  patch: operations["updateVirtualMachineSshKey"];
4317
4257
  trace?: never;
@@ -4334,7 +4274,6 @@ export interface paths {
4334
4274
  * 3. The IP address must be in the `available` state.
4335
4275
  *
4336
4276
  * Requires the `virtual-machines-view` capability.
4337
- *
4338
4277
  */
4339
4278
  get: operations["getAvailableIps"];
4340
4279
  put?: never;
@@ -4357,7 +4296,6 @@ export interface paths {
4357
4296
  * @description Given a (base64'd) resource identifier string (i.e. `cluster:production/env:abc`), returns the ID of the matching resource.
4358
4297
  * If more than one resource matches the identifier, or no resource matches the identifier, this endpoint will return an error.
4359
4298
  * Given identifiers are NOT unique, you may need to be more specific to target the exact identifier.
4360
- *
4361
4299
  */
4362
4300
  get: operations["lookupIdentifier"];
4363
4301
  put?: never;
@@ -4377,9 +4315,10 @@ export interface paths {
4377
4315
  };
4378
4316
  get?: never;
4379
4317
  put?: never;
4380
- /** Look up Cycle components (resources such as containers, servers, etc) based on their ID.
4318
+ /**
4319
+ * Look up Cycle components (resources such as containers, servers, etc) based on their ID.
4381
4320
  * Useful when the IDs are known ahead of time - all relevant items can be fetched in a single request.
4382
- * */
4321
+ */
4383
4322
  post: operations["lookupComponents"];
4384
4323
  delete?: never;
4385
4324
  options?: never;
@@ -4436,11 +4375,13 @@ export interface components {
4436
4375
  * ID
4437
4376
  * Format: objectid
4438
4377
  * @description A 24 character hex string used to identify a unique resource.
4378
+ * @example 651586fca6078e98982dbd90
4439
4379
  */
4440
4380
  ID: string;
4441
4381
  /**
4442
4382
  * DateTime
4443
4383
  * Format: date-time
4384
+ * @example 2021-01-30T08:30:00Z
4444
4385
  */
4445
4386
  DateTime: string;
4446
4387
  /**
@@ -4608,6 +4549,7 @@ export interface components {
4608
4549
  /**
4609
4550
  * HubID
4610
4551
  * @description The unique ID of the Hub this resource was created in.
4552
+ * @example 651586fca6078e98982dbd90
4611
4553
  */
4612
4554
  HubID: string;
4613
4555
  /** MembershipState */
@@ -4753,7 +4695,6 @@ export interface components {
4753
4695
  * have the identifier of `my-container` and is automatically created by the platform.
4754
4696
  *
4755
4697
  * The identifier does not have to be unique.
4756
- *
4757
4698
  */
4758
4699
  Identifier: string;
4759
4700
  /**
@@ -5567,7 +5508,9 @@ export interface components {
5567
5508
  credit: {
5568
5509
  amount?: components["schemas"]["BillingAmount"];
5569
5510
  expires?: {
5511
+ /** @example months */
5570
5512
  interval: string;
5513
+ /** @example 2 */
5571
5514
  number: number;
5572
5515
  };
5573
5516
  } | null;
@@ -5858,9 +5801,15 @@ export interface components {
5858
5801
  };
5859
5802
  /** IPNet */
5860
5803
  IPNet: {
5861
- /** @description The IP address. */
5804
+ /**
5805
+ * @description The IP address.
5806
+ * @example fd00::21:0:0:0
5807
+ */
5862
5808
  ip: string;
5863
- /** @description The CIDR notation, describing the range of IP addresses. */
5809
+ /**
5810
+ * @description The CIDR notation, describing the range of IP addresses.
5811
+ * @example fd00::21:0:0:0/96
5812
+ */
5864
5813
  cidr: string;
5865
5814
  };
5866
5815
  /**
@@ -5926,7 +5875,6 @@ export interface components {
5926
5875
  * L2Domain
5927
5876
  * @description A standardized name for different layer-2 networks that can be configured on virtual provider hosts.
5928
5877
  * Containers will utilize this name to determine which network to attach to on the host, if set in the config.
5929
- *
5930
5878
  * @enum {string}
5931
5879
  */
5932
5880
  L2Domain: "public" | "shared" | "private";
@@ -5946,10 +5894,11 @@ export interface components {
5946
5894
  ports?: string[];
5947
5895
  /** @description Layer 2 network configuration options for containers running on virtual provider servers. */
5948
5896
  l2?: {
5949
- /** @description The layer 2 'domains' that this container's instances should bridge to on the host server.
5897
+ /**
5898
+ * @description The layer 2 'domains' that this container's instances should bridge to on the host server.
5950
5899
  * If the host has a matching layer 2 NIC configured via a virtual provider ISO, this container's instances
5951
5900
  * will be joined directly to the host's network.
5952
- * */
5901
+ */
5953
5902
  domains: components["schemas"]["L2Domain"][];
5954
5903
  };
5955
5904
  };
@@ -5961,6 +5910,7 @@ export interface components {
5961
5910
  /**
5962
5911
  * Duration
5963
5912
  * @description A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
5913
+ * @example 72h45m2s
5964
5914
  */
5965
5915
  Duration: string;
5966
5916
  /**
@@ -6073,7 +6023,11 @@ export interface components {
6073
6023
  */
6074
6024
  type: "ram";
6075
6025
  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. */
6026
+ /**
6027
+ * @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.
6028
+ * @example 2G
6029
+ * @example 25MB
6030
+ */
6077
6031
  usage: string;
6078
6032
  };
6079
6033
  };
@@ -6094,7 +6048,7 @@ export interface components {
6094
6048
  /**
6095
6049
  * WebhookURL
6096
6050
  * @description A URL describing the destination Cycle should send a POST webhook payload to.
6097
- *
6051
+ * @example https://example.com/cycle/autoscale
6098
6052
  */
6099
6053
  WebhookURL: string;
6100
6054
  /**
@@ -6151,7 +6105,11 @@ export interface components {
6151
6105
  type: "network-throughput";
6152
6106
  details: {
6153
6107
  private: boolean;
6154
- /** @description The limit (maximum) amount of throughput each instance of the given container can use before triggering a scaling event. */
6108
+ /**
6109
+ * @description The limit (maximum) amount of throughput each instance of the given container can use before triggering a scaling event.
6110
+ * @example 1gbps
6111
+ * @example 20mbps
6112
+ */
6155
6113
  bandwidth: string;
6156
6114
  };
6157
6115
  };
@@ -6208,42 +6166,48 @@ export interface components {
6208
6166
  * @description A host device exposed to the container during runtime.
6209
6167
  */
6210
6168
  RuntimeExposedDevice: {
6211
- /** @description The path to the device on the host. */
6169
+ /**
6170
+ * @description The path to the device on the host.
6171
+ * @example /dev/kvm
6172
+ * @example /dev/net/tun
6173
+ */
6212
6174
  source: string;
6213
- /** @description The path inside the container that the device is mapped to. */
6175
+ /**
6176
+ * @description The path inside the container that the device is mapped to.
6177
+ * @example /dev/kvm
6178
+ * @example /dev/net/tun
6179
+ */
6214
6180
  destination: string;
6215
6181
  options?: string[] | null;
6216
6182
  };
6217
6183
  /**
6218
6184
  * RuntimeDevicePermissionType
6219
6185
  * @description The class of device this rule applies to (for example, block devices or character devices).
6220
- *
6221
6186
  * @enum {string}
6222
6187
  */
6223
6188
  RuntimeDevicePermissionType: "b" | "c";
6224
6189
  /**
6225
6190
  * RuntimeDevicePermissionAccess
6226
6191
  * @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
- *
6192
+ * @example r
6193
+ * @example rw
6194
+ * @example rwm
6228
6195
  */
6229
6196
  RuntimeDevicePermissionAccess: string;
6230
6197
  /**
6231
6198
  * RuntimeDevicePermission
6232
6199
  * @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
6200
  */
6235
6201
  RuntimeDevicePermission: {
6236
6202
  type: components["schemas"]["RuntimeDevicePermissionType"];
6237
6203
  /**
6238
6204
  * Format: int64
6239
6205
  * @description Device major number.
6240
- *
6241
6206
  */
6242
6207
  major?: number | null;
6243
6208
  /**
6244
6209
  * Format: int64
6245
6210
  * @description Device minor number.
6246
- *
6247
6211
  */
6248
6212
  minor?: number | null;
6249
6213
  /** @description Whether this rule allows (true) or denies (false) access. */
@@ -6304,7 +6268,12 @@ export interface components {
6304
6268
  readonly?: boolean;
6305
6269
  };
6306
6270
  devices?: {
6307
- /** @description The size of the shared host memory device (/dev/shm). */
6271
+ /**
6272
+ * @description The size of the shared host memory device (/dev/shm).
6273
+ * @example 64M
6274
+ * @example 128M
6275
+ * @example 512M
6276
+ */
6308
6277
  shm_size?: string | null;
6309
6278
  expose?: components["schemas"]["RuntimeExposedDevice"][] | null;
6310
6279
  permissions?: components["schemas"]["RuntimeDevicePermission"][] | null;
@@ -6328,7 +6297,11 @@ export interface components {
6328
6297
  };
6329
6298
  /** @description Configuration settings for limits and reserves of RAM resources for the given container. */
6330
6299
  ram: {
6331
- /** @description The limit (maximum) amount of RAM each instance of the given container can use. */
6300
+ /**
6301
+ * @description The limit (maximum) amount of RAM each instance of the given container can use.
6302
+ * @example 1G
6303
+ * @example 1M
6304
+ */
6332
6305
  limit?: string;
6333
6306
  /** @description The reserve (allocation) of RAM given to each instance of the container. */
6334
6307
  reserve?: string;
@@ -6337,6 +6310,7 @@ export interface components {
6337
6310
  /**
6338
6311
  * HybridIdentifier
6339
6312
  * @description Either a resource ID (objectid - i.e. 651586fca6078e98982dbd90) or a resource Identifier (human-readable)
6313
+ * @example my-image-source
6340
6314
  */
6341
6315
  HybridIdentifier: string;
6342
6316
  /**
@@ -6425,7 +6399,7 @@ export interface components {
6425
6399
  /**
6426
6400
  * Version
6427
6401
  * @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
- *
6402
+ * @example v1.2.3-dev
6429
6403
  */
6430
6404
  Version: string;
6431
6405
  /**
@@ -6433,11 +6407,9 @@ export interface components {
6433
6407
  * @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
6408
  *
6435
6409
  * 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
6410
  */
6438
6411
  Deployment: {
6439
- /** @description A version string representing the deployment.
6440
- * */
6412
+ /** @description A version string representing the deployment. */
6441
6413
  version: components["schemas"]["Version"];
6442
6414
  };
6443
6415
  /**
@@ -6446,7 +6418,9 @@ export interface components {
6446
6418
  * - b, k, m, g, t, p (bytes, kilobytes, megabytes, gigabytes, terabytes, petabytes)
6447
6419
  * - An optional "b" suffix may be added (e.g., "mb", "gb").
6448
6420
  * Units are case-insensitive. Example: "512M", "10GB", "1t".
6449
- *
6421
+ * @example 512M
6422
+ * @example 10GB
6423
+ * @example 1t
6450
6424
  */
6451
6425
  DataSize: string;
6452
6426
  /**
@@ -6457,8 +6431,7 @@ export interface components {
6457
6431
  identifier?: components["schemas"]["Identifier"] | null;
6458
6432
  /** @description A boolean where true marks the volume as read only. */
6459
6433
  read_only: boolean;
6460
- /** @description Indicates that the volume will be used as unformatted block storage.
6461
- * */
6434
+ /** @description Indicates that the volume will be used as unformatted block storage. */
6462
6435
  block_device: boolean;
6463
6436
  local?: {
6464
6437
  /** @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. */
@@ -6634,9 +6607,10 @@ export interface components {
6634
6607
  } | {
6635
6608
  virtual_machine: {
6636
6609
  id: components["schemas"]["ID"];
6637
- /** @description If true, traffic to this domain will skip the load balancer and go directly to the virtual machine
6610
+ /**
6611
+ * @description If true, traffic to this domain will skip the load balancer and go directly to the virtual machine
6638
6612
  * via the gateway service.
6639
- * */
6613
+ */
6640
6614
  dmz: boolean;
6641
6615
  };
6642
6616
  } | {
@@ -6702,7 +6676,7 @@ export interface components {
6702
6676
  * IpAddress
6703
6677
  * Format: ip-address
6704
6678
  * @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
- *
6679
+ * @example 192.168.1.1
6706
6680
  */
6707
6681
  IpAddress: string;
6708
6682
  /**
@@ -6710,7 +6684,7 @@ export interface components {
6710
6684
  * Format: cidr
6711
6685
  * @description A CIDR (Classless Inter-Domain Routing) string is a notation used to represent an IP address and its associated network prefix.
6712
6686
  * It combines an IP address with a suffix that indicates how many bits are fixed for routing.
6713
- *
6687
+ * @example 192.168.1.0/24
6714
6688
  */
6715
6689
  Cidr: string;
6716
6690
  /**
@@ -7001,7 +6975,10 @@ export interface components {
7001
6975
  * @enum {string}
7002
6976
  */
7003
6977
  operator: "==" | "!=" | ">" | "<" | ">=" | "<=";
7004
- /** @description The value corresponding to the condition type. */
6978
+ /**
6979
+ * @description The value corresponding to the condition type.
6980
+ * @example 0.0.0.0/0
6981
+ */
7005
6982
  value: string;
7006
6983
  }[];
7007
6984
  }[];
@@ -7134,10 +7111,12 @@ export interface components {
7134
7111
  value: string;
7135
7112
  }[] | null;
7136
7113
  } | null;
7137
- /** @description The URL to forward the request to.
7114
+ /**
7115
+ * @description The URL to forward the request to.
7138
7116
  *
7139
7117
  * Given a path match of `^/example/(.*)$`, a route such as `/example/wow.jpg` would be forwarded as /wow.jpg.
7140
- * */
7118
+ * @example /$$1
7119
+ */
7141
7120
  url?: string | null;
7142
7121
  } | null;
7143
7122
  proxy?: {
@@ -7158,7 +7137,10 @@ export interface components {
7158
7137
  } | null;
7159
7138
  caching?: {
7160
7139
  files?: {
7161
- /** @description Regex string that describes the files to cache. */
7140
+ /**
7141
+ * @description Regex string that describes the files to cache.
7142
+ * @example (.*)\.(js|jpg|css|png|svg)$
7143
+ */
7162
7144
  match: string;
7163
7145
  /** @description Time string that describes the time to live. */
7164
7146
  ttl: components["schemas"]["Duration"];
@@ -7191,7 +7173,6 @@ export interface components {
7191
7173
  * `random`: Pick a valid destination at random.
7192
7174
  * `round-robin`: Send each request to the 'next' destination on the list, restarting from the beginning when the last destination is used.
7193
7175
  * `source-ip`: Utilizes a hash function to ensure traffic from an IP will always hit the same destination instance.
7194
- *
7195
7176
  * @enum {string}
7196
7177
  */
7197
7178
  mode: "random" | "round-robin" | "source-ip";
@@ -7203,19 +7184,19 @@ export interface components {
7203
7184
  destination_prioritization?: ("latency" | "random" | "fixed") | null;
7204
7185
  /** @description TLS termination configuration. If null, the platform will use the default configuration. Port 443 by default has TLS termination enabled. */
7205
7186
  tls?: {
7206
- /** @description [Advanced] Change the domain the controller listens on.
7207
- * */
7187
+ /** @description [Advanced] Change the domain the controller listens on. */
7208
7188
  server_name?: string | null;
7209
7189
  /** @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
7190
  allow_insecure?: boolean | null;
7211
7191
  /** @description A PEM encoded string of certificates. */
7212
7192
  client_cert_auth?: string | null;
7213
- /** @description Defines how to validate the connecting TLS certificate.
7193
+ /**
7194
+ * @description Defines how to validate the connecting TLS certificate.
7214
7195
  * `none`: Do not require a TLS certificate to be sent
7215
7196
  * `request`: Asks the client to send a TLS certificate, but does not require nor validate it.
7216
7197
  * `require`: Requires a certificate be sent for the request to be valid, but does not validate the certificate.
7217
7198
  * `require-verify`: Requires both that the client send a certificate, and that the certificate is valid. This is required when using https.
7218
- * */
7199
+ */
7219
7200
  client_auth?: ("none" | "request" | "require" | "require-verify") | null;
7220
7201
  } | null;
7221
7202
  /** @description Defines how the length of various sorts of timeouts when communicating with the destination. */
@@ -7247,9 +7228,10 @@ export interface components {
7247
7228
  mode: "tcp" | "udp" | "http";
7248
7229
  /** @description Defines how the transport for this controller operates. */
7249
7230
  config: {
7250
- /** @description Enable/disable performance mode. If enabled, some telemetry will be disabled to dedicate full processing to handling requests.
7231
+ /**
7232
+ * @description Enable/disable performance mode. If enabled, some telemetry will be disabled to dedicate full processing to handling requests.
7251
7233
  * You will not see per-request breakdowns or URL logging if performance mode is enabled.
7252
- * */
7234
+ */
7253
7235
  performance: boolean;
7254
7236
  /** @description Defines how traffic gets into the load balancer. */
7255
7237
  ingress: {
@@ -7379,8 +7361,15 @@ export interface components {
7379
7361
  config?: {
7380
7362
  /** @description If true, routes all traffic through the VPN, even non-Cycle traffic. */
7381
7363
  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
- * */
7364
+ /**
7365
+ * @description Additional OpenVPN directives that will be appended to the server configuration on service start. Each line should follow standard OpenVPN syntax.
7366
+ * @example client-to-client
7367
+ * duplicate-cn
7368
+ * persist-key
7369
+ * persist-tun
7370
+ * @example verb 3
7371
+ * mute 10
7372
+ */
7384
7373
  custom_directives?: string | null;
7385
7374
  /** @description Auth configuration for the VPN. */
7386
7375
  auth: {
@@ -7410,8 +7399,7 @@ export interface components {
7410
7399
  * @description Configuration options for the scheduler Environment service.
7411
7400
  */
7412
7401
  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
- * */
7402
+ /** @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
7403
  public: boolean;
7416
7404
  access_keys?: components["schemas"]["SchedulerAccessKey"][];
7417
7405
  };
@@ -7487,7 +7475,6 @@ export interface components {
7487
7475
  * `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
7476
  * 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
7477
  * are switched at once.
7490
- *
7491
7478
  */
7492
7479
  EnvironmentDeploymentTags: {
7493
7480
  [key: string]: components["schemas"]["Version"];
@@ -7548,8 +7535,7 @@ export interface components {
7548
7535
  services: components["schemas"]["EnvironmentServices"];
7549
7536
  acl?: components["schemas"]["ACL"] | null;
7550
7537
  private_network?: components["schemas"]["PrivateNetwork"] | null;
7551
- /** @description A map of custom tags to deployment versions.
7552
- * */
7538
+ /** @description A map of custom tags to deployment versions. */
7553
7539
  deployments?: {
7554
7540
  tags: components["schemas"]["EnvironmentDeploymentTags"];
7555
7541
  } | null;
@@ -7842,7 +7828,6 @@ export interface components {
7842
7828
  *
7843
7829
  * 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
7830
  * 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
7831
  */
7847
7832
  CycleUploadOrigin: {
7848
7833
  /**
@@ -7862,7 +7847,6 @@ export interface components {
7862
7847
  * @description An image origin that references an image source on Cycle.
7863
7848
  *
7864
7849
  * 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
7850
  */
7867
7851
  CycleSourceOrigin: {
7868
7852
  /**
@@ -8074,6 +8058,7 @@ export interface components {
8074
8058
  /**
8075
8059
  * StackVariable
8076
8060
  * @description A variable specified in a stack spec.
8061
+ * @example {{$stack-variable}}
8077
8062
  */
8078
8063
  StackVariable: string;
8079
8064
  /**
@@ -8149,13 +8134,25 @@ export interface components {
8149
8134
  file?: ({
8150
8135
  /** @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
8136
  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}`. */
8137
+ /**
8138
+ * @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}`.
8139
+ * @example /var/run/cycle/variables/<myVariable>
8140
+ */
8153
8141
  path: (string | null) | components["schemas"]["StackVariable"];
8154
- /** @description A linux file mode that will be set on the injected file. */
8142
+ /**
8143
+ * @description A linux file mode that will be set on the injected file.
8144
+ * @example 0644
8145
+ */
8155
8146
  permissions?: (string | null) | components["schemas"]["StackVariable"];
8156
- /** @description The linux UID to set on the file. */
8147
+ /**
8148
+ * @description The linux UID to set on the file.
8149
+ * @example 777
8150
+ */
8157
8151
  uid?: (number | null) | components["schemas"]["StackVariable"];
8158
- /** @description The linux GID to set on the file. */
8152
+ /**
8153
+ * @description The linux GID to set on the file.
8154
+ * @example 777
8155
+ */
8159
8156
  gid?: (number | null) | components["schemas"]["StackVariable"];
8160
8157
  } | null) | components["schemas"]["StackVariable"];
8161
8158
  } | components["schemas"]["StackVariable"];
@@ -8174,8 +8171,13 @@ export interface components {
8174
8171
  origin: components["schemas"]["StackSpecImageOrigin"] | components["schemas"]["StackVariable"];
8175
8172
  /** @description Additional details applied when building an image. */
8176
8173
  build?: ({
8174
+ /**
8175
+ * @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`.
8176
+ * @default false
8177
+ */
8178
+ use_disk: boolean;
8177
8179
  /** @description A map of build arguments applied to the image at build time. */
8178
- args: {
8180
+ args?: {
8179
8181
  [key: string]: string;
8180
8182
  } | components["schemas"]["StackVariable"];
8181
8183
  } | null) | components["schemas"]["StackVariable"];
@@ -8204,7 +8206,8 @@ export interface components {
8204
8206
  StackSpecContainerConfigDeploy: {
8205
8207
  /** @description The number of desired instances to deploy. */
8206
8208
  instances: number | components["schemas"]["StackVariable"];
8207
- /** @description The strategy Cycle will apply when deploying instances of this container.
8209
+ /**
8210
+ * @description The strategy Cycle will apply when deploying instances of this container.
8208
8211
  *
8209
8212
  * - ** resource-density **: Cycle will distribute instances across servers to maintain balanced resource usage.
8210
8213
  * - ** high-availability **: Cycle will deploy instances across servers with an emphasis on geographic and physical separation. Requires multiple locations.
@@ -8214,8 +8217,8 @@ export interface components {
8214
8217
  * - ** edge **: Cycle will prioritize geographic distribution of instances.
8215
8218
  * - ** function **: Every ingress request/connection receives its own instance.
8216
8219
  * - ** 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"];
8220
+ */
8221
+ strategy?: ("resource-density" | "manual" | "high-availability" | "first-available" | "node" | "edge" | "function" | null) | components["schemas"]["StackVariable"];
8219
8222
  /** @description Configuration options for containers using the 'function' deployment strategy. */
8220
8223
  function?: ({
8221
8224
  /** @description The maximum number of instances that Cycle can pre-allocate (includes auto-scaled instances). */
@@ -8274,10 +8277,11 @@ export interface components {
8274
8277
  } | null) | components["schemas"]["StackVariable"];
8275
8278
  /** @description Configuration options for automated container health checks. */
8276
8279
  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.
8280
+ /**
8281
+ * @description The command or script to run to verify the health of the container. This script is run inside the container by Cycle.
8278
8282
  * This command accepts two types of entries:
8279
8283
  * - 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
- * */
8284
+ */
8281
8285
  command: string | components["schemas"]["StackVariable"];
8282
8286
  /** @description The number of times to retry the command before marking an instance unhealthy. */
8283
8287
  retries: number | components["schemas"]["StackVariable"];
@@ -8313,7 +8317,11 @@ export interface components {
8313
8317
  */
8314
8318
  type: "ram";
8315
8319
  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. */
8320
+ /**
8321
+ * @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.
8322
+ * @example 2G
8323
+ * @example 25MB
8324
+ */
8317
8325
  usage: string;
8318
8326
  };
8319
8327
  };
@@ -8385,7 +8393,11 @@ export interface components {
8385
8393
  type: "network-throughput";
8386
8394
  details: {
8387
8395
  private: boolean;
8388
- /** @description The limit (maximum) amount of throughput each instance of the given container can use before triggering a scaling event. */
8396
+ /**
8397
+ * @description The limit (maximum) amount of throughput each instance of the given container can use before triggering a scaling event.
8398
+ * @example 1gbps
8399
+ * @example 50mbps
8400
+ */
8389
8401
  bandwidth: string;
8390
8402
  };
8391
8403
  };
@@ -8428,28 +8440,26 @@ export interface components {
8428
8440
  /**
8429
8441
  * StackSpecRuntimeDevicePermissionType
8430
8442
  * @description The class of device this rule applies to (for example, block devices or character devices).
8431
- *
8432
8443
  * @enum {string}
8433
8444
  */
8434
8445
  StackSpecRuntimeDevicePermissionType: "b" | "c";
8435
8446
  /**
8436
8447
  * StackSpecRuntimeDevicePermissionAccess
8437
8448
  * @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
- *
8449
+ * @example r
8450
+ * @example rw
8451
+ * @example rwm
8439
8452
  */
8440
8453
  StackSpecRuntimeDevicePermissionAccess: string;
8441
8454
  /**
8442
8455
  * StackSpecRuntimeDevicePermission
8443
8456
  * @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
8457
  */
8446
8458
  StackSpecRuntimeDevicePermission: {
8447
8459
  type: components["schemas"]["StackSpecRuntimeDevicePermissionType"] | components["schemas"]["StackVariable"];
8448
- /** @description Device major number.
8449
- * */
8460
+ /** @description Device major number. */
8450
8461
  major?: (number | null) | components["schemas"]["StackVariable"];
8451
- /** @description Device minor number.
8452
- * */
8462
+ /** @description Device minor number. */
8453
8463
  minor?: (number | null) | components["schemas"]["StackVariable"];
8454
8464
  /** @description Whether this rule allows (true) or denies (false) access. */
8455
8465
  allow: boolean | components["schemas"]["StackVariable"];
@@ -8634,8 +8644,7 @@ export interface components {
8634
8644
  destination: string | components["schemas"]["StackVariable"];
8635
8645
  /** @description If true, the container will be unable to write data to the volume. */
8636
8646
  read_only?: boolean | components["schemas"]["StackVariable"];
8637
- /** @description Indicates that the volume will be used as unformatted block storage.
8638
- * */
8647
+ /** @description Indicates that the volume will be used as unformatted block storage. */
8639
8648
  block_device?: boolean | components["schemas"]["StackVariable"];
8640
8649
  /** @description Configuration options for setting up remote access to this volume via SFTP. */
8641
8650
  remote_access?: {
@@ -8751,9 +8760,11 @@ export interface components {
8751
8760
  /** StackSpecHAProxyConfigSet */
8752
8761
  StackSpecHaProxyConfigSet: {
8753
8762
  frontend: {
8754
- /** @description The type of traffic expected by the load balancer for this port. Can be either:
8763
+ /**
8764
+ * @description The type of traffic expected by the load balancer for this port. Can be either:
8755
8765
  * - 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. */
8766
+ * - 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.
8767
+ */
8757
8768
  mode: ("tcp" | "http") | components["schemas"]["StackVariable"];
8758
8769
  /** @description The number of simultaneous connections that can be processed at a time. */
8759
8770
  max_connections: (number | null) | components["schemas"]["StackVariable"];
@@ -8770,12 +8781,14 @@ export interface components {
8770
8781
  } | null) | components["schemas"]["StackVariable"];
8771
8782
  } | components["schemas"]["StackVariable"];
8772
8783
  backend: {
8773
- /** @description How connections are balanced across your container instances. Can be one of the following:
8784
+ /**
8785
+ * @description How connections are balanced across your container instances. Can be one of the following:
8774
8786
  * - `roundrobin`: Each container instance is used in turns.
8775
8787
  * - `static-rr`: Each container instance is used in turns, but is faster than Round Robin at the expense of being less dynamic.
8776
8788
  * - `leastconn`: Routes traffic to the instance with the least number of active connections.
8777
8789
  * - `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. */
8790
+ * - `source`: The same client IP always reaches the same container instance as long as no instance goes down or up.
8791
+ */
8779
8792
  balance: ("roundrobin" | "static-rr" | "leastconn" | "first" | "source") | components["schemas"]["StackVariable"];
8780
8793
  /** @description Various options for handling timeouts when communicating with a container instance behind the load balancer. */
8781
8794
  timeouts: ({
@@ -8839,7 +8852,10 @@ export interface components {
8839
8852
  type: ("ip-match" | "geo-match" | "url-match" | "method-match" | "header-match") | components["schemas"]["StackVariable"];
8840
8853
  /** @description A string that indicates the range of values relative to the value property. */
8841
8854
  operator: ("==" | "!=" | ">" | "<" | ">=" | "<=") | components["schemas"]["StackVariable"];
8842
- /** @description The value corresponding to the condition type. */
8855
+ /**
8856
+ * @description The value corresponding to the condition type.
8857
+ * @example 0.0.0.0/0
8858
+ */
8843
8859
  value: string | components["schemas"]["StackVariable"];
8844
8860
  } | components["schemas"]["StackVariable"])[] | components["schemas"]["StackVariable"];
8845
8861
  } | components["schemas"]["StackVariable"])[] | components["schemas"]["StackVariable"];
@@ -8969,10 +8985,12 @@ export interface components {
8969
8985
  value: string | components["schemas"]["StackVariable"];
8970
8986
  } | components["schemas"]["StackVariable"])[] | null) | components["schemas"]["StackVariable"];
8971
8987
  } | null) | components["schemas"]["StackVariable"];
8972
- /** @description The URL to forward the request to.
8988
+ /**
8989
+ * @description The URL to forward the request to.
8973
8990
  *
8974
8991
  * Given a path match of `^/example/(.*)$`, a route such as `/example/wow.jpg` would be forwarded as /wow.jpg.
8975
- * */
8992
+ * @example /$$1
8993
+ */
8976
8994
  url?: string | components["schemas"]["StackVariable"];
8977
8995
  } | null) | components["schemas"]["StackVariable"];
8978
8996
  proxy?: ({
@@ -8993,7 +9011,10 @@ export interface components {
8993
9011
  } | null) | components["schemas"]["StackVariable"];
8994
9012
  caching?: ({
8995
9013
  files?: (({
8996
- /** @description Regex string that describes the files to cache. */
9014
+ /**
9015
+ * @description Regex string that describes the files to cache.
9016
+ * @example (.*)\.(js|jpg|css|png|svg)$
9017
+ */
8997
9018
  match: string | components["schemas"]["StackVariable"];
8998
9019
  /** @description Time string that describes the time to live. */
8999
9020
  ttl: components["schemas"]["Duration"] | components["schemas"]["StackVariable"];
@@ -9020,11 +9041,12 @@ export interface components {
9020
9041
  exclude?: (components["schemas"]["HybridIdentifier"][] | null) | components["schemas"]["StackVariable"];
9021
9042
  } | null) | components["schemas"]["StackVariable"];
9022
9043
  } | components["schemas"]["StackVariable"];
9023
- /** @description How to route the traffic to the destination.
9044
+ /**
9045
+ * @description How to route the traffic to the destination.
9024
9046
  * `random`: Pick a valid destination at random.
9025
9047
  * `round-robin`: Send each request to the 'next' destination on the list, restarting from the beginning when the last destination is used.
9026
9048
  * `source-ip`: Utilizes a hash function to ensure traffic from an IP will always hit the same destination instance.
9027
- * */
9049
+ */
9028
9050
  mode: ("random" | "round-robin" | "source-ip") | components["schemas"]["StackVariable"];
9029
9051
  config: {
9030
9052
  /** @description If a request comes in from the same origin, ensure it hits the same destination. */
@@ -9034,19 +9056,19 @@ export interface components {
9034
9056
  destination_prioritization?: ("latency" | "random" | "fixed") | components["schemas"]["StackVariable"] | null;
9035
9057
  /** @description TLS termination configuration. If null, the platform will use the default configuration. Port 443 by default has TLS termination enabled. */
9036
9058
  tls?: ({
9037
- /** @description [Advanced] Change the domain the controller listens on.
9038
- * */
9059
+ /** @description [Advanced] Change the domain the controller listens on. */
9039
9060
  server_name?: (string | null) | components["schemas"]["StackVariable"];
9040
9061
  /** @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
9062
  allow_insecure?: (boolean | null) | components["schemas"]["StackVariable"];
9042
9063
  /** @description A PEM encoded string of certificates. */
9043
9064
  client_cert_auth?: (string | null) | components["schemas"]["StackVariable"];
9044
- /** @description Defines how to validate the connecting TLS certificate.
9065
+ /**
9066
+ * @description Defines how to validate the connecting TLS certificate.
9045
9067
  * `none`: Do not require a TLS certificate to be sent
9046
9068
  * `request`: Asks the client to send a TLS certificate, but does not require nor validate it.
9047
9069
  * `require`: Requires a certificate be sent for the request to be valid, but does not validate the certificate.
9048
9070
  * `require-verify`: Requires both that the client send a certificate, and that the certificate is valid. This is required when using https.
9049
- * */
9071
+ */
9050
9072
  client_auth?: ("none" | "request" | "require" | "require-verify") | components["schemas"]["StackVariable"] | null;
9051
9073
  } | null) | components["schemas"]["StackVariable"];
9052
9074
  /** @description Defines how the length of various sorts of timeouts when communicating with the destination. */
@@ -9075,9 +9097,10 @@ export interface components {
9075
9097
  mode: ("tcp" | "udp" | "http") | components["schemas"]["StackVariable"];
9076
9098
  /** @description Defines how the transport for this controller operates. */
9077
9099
  config: {
9078
- /** @description Enable/disable performance mode. If enabled, some telemetry will be disabled to dedicate full processing to handling requests.
9100
+ /**
9101
+ * @description Enable/disable performance mode. If enabled, some telemetry will be disabled to dedicate full processing to handling requests.
9079
9102
  * You will not see per-request breakdowns or URL logging if performance mode is enabled.
9080
- * */
9103
+ */
9081
9104
  performance: boolean | components["schemas"]["StackVariable"];
9082
9105
  /** @description Defines how traffic gets into the load balancer. */
9083
9106
  ingress: {
@@ -9189,8 +9212,15 @@ export interface components {
9189
9212
  vpn_accounts: boolean | components["schemas"]["StackVariable"];
9190
9213
  } | components["schemas"]["StackVariable"];
9191
9214
  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
- * */
9215
+ /**
9216
+ * @description Additional OpenVPN directives that will be appended to the server configuration on service start. Each line should follow standard OpenVPN syntax.
9217
+ * @example client-to-client
9218
+ * duplicate-cn
9219
+ * persist-key
9220
+ * persist-tun
9221
+ * @example verb 3
9222
+ * mute 10
9223
+ */
9194
9224
  custom_directives?: string | null;
9195
9225
  };
9196
9226
  /**
@@ -9205,7 +9235,6 @@ export interface components {
9205
9235
  * StackSpec
9206
9236
  * @description A Cycle stack file is an "environment as code". This allows an environment to be generated consistently based on a fixed specification.
9207
9237
  * Stack files can describe multiple containers and their configurations, environment service settings, scoped variables, and important metadata.
9208
- *
9209
9238
  */
9210
9239
  StackSpec: {
9211
9240
  /**
@@ -9503,8 +9532,7 @@ export interface components {
9503
9532
  * @enum {string}
9504
9533
  */
9505
9534
  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
- * */
9535
+ /** @description A map of volume objects where the key is the id and the value is the volume's config. */
9508
9536
  contents: {
9509
9537
  [key: string]: components["schemas"]["ContainerVolume"];
9510
9538
  };
@@ -9555,7 +9583,10 @@ export interface components {
9555
9583
  [key: string]: {
9556
9584
  /** @description String describing the server mount type. */
9557
9585
  type: string;
9558
- /** @description Comma separated string describing the server mount options. */
9586
+ /**
9587
+ * @description Comma separated string describing the server mount options.
9588
+ * @example key1=value1,key2=value2
9589
+ */
9559
9590
  options: string;
9560
9591
  /** @description String describing the server mount source. */
9561
9592
  source: string;
@@ -9644,9 +9675,9 @@ export interface components {
9644
9675
  * @description The current state of the node.
9645
9676
  * @enum {string}
9646
9677
  */
9647
- current: "new" | "offline" | "authorizing" | "online" | "decommissioned";
9678
+ current: "new" | "offline" | "authorizing" | "online" | "decommissioned" | "deleted";
9648
9679
  changed: components["schemas"]["DateTime"];
9649
- desired?: ("new" | "offline" | "authorizing" | "online" | "decommissioned") | null;
9680
+ desired?: ("new" | "offline" | "authorizing" | "online" | "decommissioned" | "deleted") | null;
9650
9681
  } & components["schemas"]["State"];
9651
9682
  /**
9652
9683
  * ServerStatsNetwork
@@ -10413,11 +10444,12 @@ export interface components {
10413
10444
  current: "new" | "starting" | "migrating" | "running" | "stopping" | "stopped" | "failed" | "deleting" | "deleted";
10414
10445
  /** @description information about the health of the instance. */
10415
10446
  health?: {
10416
- /** @description Describes the healthiness of the instance. Health checks can be configured at the container level.
10447
+ /**
10448
+ * @description Describes the healthiness of the instance. Health checks can be configured at the container level.
10417
10449
  * - `true`: The instance is considered healthy.
10418
10450
  * - `false`: The instance is considered unhealthy.
10419
10451
  * - `null`: The instance has not yet reported its health, or a health check has not yet been performed.
10420
- * */
10452
+ */
10421
10453
  healthy: boolean | null;
10422
10454
  /** @description A timestamp of the last time the instance health was updated. */
10423
10455
  updated: components["schemas"]["DateTime"];
@@ -11009,7 +11041,6 @@ export interface components {
11009
11041
  /**
11010
11042
  * VirtualMachineNetworkConfig
11011
11043
  * @description Defines the network settings for a virtual machine, including public access mode, hostname, and ports.
11012
- *
11013
11044
  */
11014
11045
  VirtualMachineNetworkConfig: {
11015
11046
  /**
@@ -11027,7 +11058,6 @@ export interface components {
11027
11058
  /**
11028
11059
  * VirtualMachineDeployTags
11029
11060
  * @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
11061
  */
11032
11062
  VirtualMachineDeployTags: {
11033
11063
  any?: string[] | null;
@@ -11036,7 +11066,6 @@ export interface components {
11036
11066
  /**
11037
11067
  * VirtualMachineNodeConstraints
11038
11068
  * @description Node-level constraints for the virtual machine deployment, specifying tags that must or must not be present.
11039
- *
11040
11069
  */
11041
11070
  VirtualMachineNodeConstraints: {
11042
11071
  tags: components["schemas"]["VirtualMachineDeployTags"];
@@ -11044,7 +11073,6 @@ export interface components {
11044
11073
  /**
11045
11074
  * VirtualMachineDeployConstraints
11046
11075
  * @description Constraints define node-level and resource restrictions for the virtual machine deployment.
11047
- *
11048
11076
  */
11049
11077
  VirtualMachineDeployConstraints: {
11050
11078
  node?: components["schemas"]["VirtualMachineNodeConstraints"] | null;
@@ -11054,7 +11082,6 @@ export interface components {
11054
11082
  /**
11055
11083
  * VirtualMachineShutdownPolicy
11056
11084
  * @description The shutdown policy defines how the virtual machine should handle shutdown, including a timeout and signals to be sent during shutdown.
11057
- *
11058
11085
  */
11059
11086
  VirtualMachineShutdownPolicy: {
11060
11087
  /** @description The timeout period for graceful shutdown. */
@@ -11063,7 +11090,6 @@ export interface components {
11063
11090
  /**
11064
11091
  * VirtualMachineStartupPolicy
11065
11092
  * @description The startup policy defines how the virtual machine should handle startup, including a possible delay before starting the machine.
11066
- *
11067
11093
  */
11068
11094
  VirtualMachineStartupPolicy: {
11069
11095
  /** @description Delay before startup. */
@@ -11072,7 +11098,6 @@ export interface components {
11072
11098
  /**
11073
11099
  * VirtualMachineTelemetryConfig
11074
11100
  * @description The telemetry configuration defines how telemetry data is handled, including retention, interval, and whether telemetry is disabled.
11075
- *
11076
11101
  */
11077
11102
  VirtualMachineTelemetryConfig: {
11078
11103
  /** @description Data retention duration for telemetry. */
@@ -11085,7 +11110,6 @@ export interface components {
11085
11110
  /**
11086
11111
  * VirtualMachineDeployConfig
11087
11112
  * @description Represents the deployment configuration for a virtual machine, including constraints, shutdown/startup policies, restart conditions, and telemetry settings.
11088
- *
11089
11113
  */
11090
11114
  VirtualMachineDeployConfig: {
11091
11115
  constraints?: components["schemas"]["VirtualMachineDeployConstraints"] | null;
@@ -11096,10 +11120,13 @@ export interface components {
11096
11120
  /**
11097
11121
  * VirtualMachineRamResources
11098
11122
  * @description Defines the RAM configuration of a virtual machine.
11099
- *
11100
11123
  */
11101
11124
  VirtualMachineRamResources: {
11102
- /** @description The limit (maximum) amount of RAM the virtual machine can consume. Must be at least 512M and less than 65GB. */
11125
+ /**
11126
+ * @description The limit (maximum) amount of RAM the virtual machine can consume. Must be at least 512M and less than 65GB.
11127
+ * @example 1G
11128
+ * @example 512M
11129
+ */
11103
11130
  limit: string;
11104
11131
  /** @description Whether or not the RAM set in limit should be preallocated. */
11105
11132
  allocate?: boolean | null;
@@ -11107,22 +11134,29 @@ export interface components {
11107
11134
  /**
11108
11135
  * VirtualMachineCpuResources
11109
11136
  * @description Defines the CPU configuration of a virtual machine. Set **either** `cores` or `cpus`.
11110
- *
11111
11137
  */
11112
11138
  VirtualMachineCpuResources: {
11113
11139
  cores?: {
11114
- /** @description The number of cores to assign to this virtual machine. Must be between 1 and 32. */
11140
+ /**
11141
+ * @description The number of cores to assign to this virtual machine. Must be between 1 and 32.
11142
+ * @example 1
11143
+ * @example 2
11144
+ */
11115
11145
  number: number;
11116
11146
  /** @description If true, reserves the cores so they cannot be used by any other virtual machine. */
11117
11147
  allocate?: boolean | null;
11118
11148
  } | 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. */
11149
+ /**
11150
+ * @description The specific cores/range of cores to allocate to the virtual machine. An 'x' indicates the maximum core for a given machine.
11151
+ * @example 1
11152
+ * @example 1-3
11153
+ * @example 2-x
11154
+ */
11120
11155
  cpus?: string | null;
11121
11156
  };
11122
11157
  /**
11123
11158
  * VirtualMachineResourcesConfig
11124
11159
  * @description Defines the resource settings for a virtual machine, including CPU and RAM.
11125
- *
11126
11160
  */
11127
11161
  VirtualMachineResourcesConfig: {
11128
11162
  ram: components["schemas"]["VirtualMachineRamResources"];
@@ -11160,7 +11194,6 @@ export interface components {
11160
11194
  /**
11161
11195
  * VirtualMachineRuntimeConfigHardware
11162
11196
  * @description Hardware parameters applied for VM runtime.
11163
- *
11164
11197
  */
11165
11198
  VirtualMachineRuntimeConfigHardware: {
11166
11199
  /** @description QEMU machine type to emulate. */
@@ -11186,13 +11219,11 @@ export interface components {
11186
11219
  /**
11187
11220
  * VirtualMachineRuntimeConfigAttachment
11188
11221
  * @description Additional attachment (ISO, etc) added during runtime.
11189
- *
11190
11222
  */
11191
11223
  VirtualMachineRuntimeConfigAttachment: components["schemas"]["VirtualMachineAttachmentTypeIso"];
11192
11224
  /**
11193
11225
  * VirtualMachineRuntimeConfig
11194
11226
  * @description Defines the runtime settings for a virtual machine.
11195
- *
11196
11227
  */
11197
11228
  VirtualMachineRuntimeConfig: {
11198
11229
  /** @description Hardware parameters applied for VM runtime. */
@@ -11205,7 +11236,6 @@ export interface components {
11205
11236
  /**
11206
11237
  * VirtualMachineConfig
11207
11238
  * @description Defines the network and deployment configurations for a virtual machine.
11208
- *
11209
11239
  */
11210
11240
  VirtualMachineConfig: {
11211
11241
  network: components["schemas"]["VirtualMachineNetworkConfig"];
@@ -11280,18 +11310,19 @@ export interface components {
11280
11310
  /**
11281
11311
  * VirtualMachineImage
11282
11312
  * @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
11313
  */
11285
11314
  VirtualMachineImage: components["schemas"]["VirtualMachineImageSourceUrl"] | components["schemas"]["VirtualMachineImageSourceIpxe"] | components["schemas"]["VirtualMachineImageSourceBase"] | components["schemas"]["VirtualMachineImageSourceExternalVolume"];
11286
11315
  /**
11287
11316
  * VirtualMachineVolumeConfig
11288
11317
  * @description Represents the configuration for a volume attached to a virtual machine.
11289
- *
11290
11318
  */
11291
11319
  VirtualMachineVolumeConfig: {
11292
11320
  /** @description Configuration details for a local volume. */
11293
11321
  local?: {
11294
- /** @description The maximum size allowed for the local volume. */
11322
+ /**
11323
+ * @description The maximum size allowed for the local volume.
11324
+ * @example 100G
11325
+ */
11295
11326
  max_size: string;
11296
11327
  /** @description Indicates if the volume is part of a storage pool. */
11297
11328
  storage_pool?: boolean | null;
@@ -11308,7 +11339,6 @@ export interface components {
11308
11339
  /**
11309
11340
  * VirtualMachineVolume
11310
11341
  * @description Represents a storage volume attached to a virtual machine.
11311
- *
11312
11342
  */
11313
11343
  VirtualMachineVolume: {
11314
11344
  id: components["schemas"]["ID"];
@@ -11348,7 +11378,6 @@ export interface components {
11348
11378
  /**
11349
11379
  * VirtualMachine
11350
11380
  * @description Describes a virtual machine running on the Cycle Platform.
11351
- *
11352
11381
  */
11353
11382
  VirtualMachine: {
11354
11383
  id: components["schemas"]["ID"];
@@ -11356,8 +11385,7 @@ export interface components {
11356
11385
  name: string;
11357
11386
  identifier: components["schemas"]["Identifier"];
11358
11387
  creator: components["schemas"]["CreatorScope"];
11359
- /** @description Basic information about the environment this virtual machine is in.
11360
- * */
11388
+ /** @description Basic information about the environment this virtual machine is in. */
11361
11389
  environment: {
11362
11390
  id: components["schemas"]["ID"];
11363
11391
  /** @description The cluster this environment is associated with. */
@@ -11618,13 +11646,25 @@ export interface components {
11618
11646
  file?: {
11619
11647
  /** @description When true, Cycle will interpret this variable as a base-64 encoded string, and decode it before passing it into the container. */
11620
11648
  decode: boolean;
11621
- /** @description The path to mount the file to inside the container. */
11649
+ /**
11650
+ * @description The path to mount the file to inside the container.
11651
+ * @example /var/run/cycle/variables/<myVariable>
11652
+ */
11622
11653
  path: string | null;
11623
- /** @description A linux file mode that will be set on the injected file. */
11654
+ /**
11655
+ * @description A linux file mode that will be set on the injected file.
11656
+ * @example 0644
11657
+ */
11624
11658
  permissions?: string | null;
11625
- /** @description The linux UID to set on the file. */
11659
+ /**
11660
+ * @description The linux UID to set on the file.
11661
+ * @example 777
11662
+ */
11626
11663
  uid?: number | null;
11627
- /** @description The linux GID to set on the file. */
11664
+ /**
11665
+ * @description The linux GID to set on the file.
11666
+ * @example 777
11667
+ */
11628
11668
  gid?: number | null;
11629
11669
  } | null;
11630
11670
  };
@@ -11787,13 +11827,26 @@ export interface components {
11787
11827
  destinations: {
11788
11828
  [key: string]: {
11789
11829
  requests: {
11790
- /** @description The host name of the URL request. */
11830
+ /**
11831
+ * @description The host name of the URL request.
11832
+ * @example abc.cycle.io
11833
+ */
11791
11834
  host: string;
11792
- /** @description The HTTP method of the URL request. */
11835
+ /**
11836
+ * @description The HTTP method of the URL request.
11837
+ * @example GET
11838
+ */
11793
11839
  method: string;
11794
- /** @description The path portion of the inbound URL request. */
11840
+ /**
11841
+ * @description The path portion of the inbound URL request.
11842
+ * @example /pathname
11843
+ */
11795
11844
  path: string;
11796
- /** @description The number of requests to a this URL. */
11845
+ /**
11846
+ * @description The number of requests to a this URL.
11847
+ * @example 5
11848
+ * @example 10
11849
+ */
11797
11850
  total: number;
11798
11851
  /** @description The date of the most recent hit to the URL. */
11799
11852
  last_hit: components["schemas"]["DateTime"];
@@ -11808,11 +11861,21 @@ export interface components {
11808
11861
  /** @description Object containing hit count and timing data for redirect responses. */
11809
11862
  redirect: components["schemas"]["LoadBalancerTelemetryUrlRequestHandler"];
11810
11863
  };
11811
- /** @description An object where the key is the response type and the value is the number of hits with that response. */
11864
+ /**
11865
+ * @description An object where the key is the response type and the value is the number of hits with that response.
11866
+ * @example {
11867
+ * "http:404": 10
11868
+ * }
11869
+ */
11812
11870
  responses?: {
11813
11871
  [key: string]: number;
11814
11872
  };
11815
- /** @description An object where the key is the error type and the value is the number of hits with that error. */
11873
+ /**
11874
+ * @description An object where the key is the error type and the value is the number of hits with that error.
11875
+ * @example {
11876
+ * "i/o timeout": 1
11877
+ * }
11878
+ */
11816
11879
  errors?: {
11817
11880
  [key: string]: number;
11818
11881
  };
@@ -12060,8 +12123,15 @@ export interface components {
12060
12123
  config?: {
12061
12124
  /** @description If true, routes all traffic through the VPN, even non-Cycle traffic. */
12062
12125
  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
- * */
12126
+ /**
12127
+ * @description Additional OpenVPN directives that will be appended to the server configuration on service start. Each line should follow standard OpenVPN syntax.
12128
+ * @example client-to-client
12129
+ * duplicate-cn
12130
+ * persist-key
12131
+ * persist-tun
12132
+ * @example verb 3
12133
+ * mute 10
12134
+ */
12065
12135
  custom_directives?: string | null;
12066
12136
  /** @description Auth configuration for the VPN. */
12067
12137
  auth?: {
@@ -12155,7 +12225,6 @@ export interface components {
12155
12225
  ActivitySecurity: {
12156
12226
  /**
12157
12227
  * @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
12228
  * @enum {string}
12160
12229
  */
12161
12230
  risk: "info" | "low" | "medium" | "high" | "critical";
@@ -12182,7 +12251,6 @@ export interface components {
12182
12251
  ActivityMonitor: {
12183
12252
  /**
12184
12253
  * @description The severity of the event.
12185
- *
12186
12254
  * @enum {string}
12187
12255
  */
12188
12256
  level: "info" | "low" | "medium" | "high" | "critical";
@@ -12214,13 +12282,14 @@ export interface components {
12214
12282
  /** @description The given user's ID. */
12215
12283
  id: string;
12216
12284
  };
12217
- /** @description A number representing the detail level (verbosity) of this activity.
12285
+ /**
12286
+ * @description A number representing the detail level (verbosity) of this activity.
12218
12287
  *
12219
12288
  * ## Levels
12220
12289
  * - 0: activity that other users would find useful
12221
12290
  * - 1: activity that can be useful in tracking down how a user did something
12222
12291
  * - 2: full activity, can be useful in debugging problems
12223
- * */
12292
+ */
12224
12293
  verbosity: number;
12225
12294
  context: components["schemas"]["Context"];
12226
12295
  session: components["schemas"]["Session"] | null;
@@ -12254,7 +12323,7 @@ export interface components {
12254
12323
  * @description The activity event.
12255
12324
  * @enum {string}
12256
12325
  */
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";
12326
+ 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
12327
  /** @description A timestamp for when the activity took place. */
12259
12328
  time: components["schemas"]["DateTime"];
12260
12329
  };
@@ -12318,7 +12387,6 @@ export interface components {
12318
12387
  * lacp - Standard link aggregations using LACP.
12319
12388
  * balance-tlb - Adaptive transmit-side balancing (no switch config needed)..
12320
12389
  * balance-alb - TLB + receive load balancing (no switch config needed)..
12321
- *
12322
12390
  * @enum {string}
12323
12391
  */
12324
12392
  mode: "balance-rr" | "active-backup" | "balance-xor" | "lacp" | "balance-tlb" | "balance-alb";
@@ -12620,7 +12688,9 @@ export interface components {
12620
12688
  * - `id:<mongo id>`: A raw resource ID
12621
12689
  * - `resource:<a resource identifier>`: A compound identifier pointing to a resource.
12622
12690
  * - `from:<stage/step>`: For referencing a previous pipeline step.
12623
- *
12691
+ * @example id:6515098637b66c233ed164e7
12692
+ * @example resource:cluster:dev,env:demo,container:api
12693
+ * @example from:/image-create
12624
12694
  */
12625
12695
  FluidIdentifier: string;
12626
12696
  /**
@@ -12884,7 +12954,6 @@ export interface components {
12884
12954
  /**
12885
12955
  * VariableString
12886
12956
  * @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
12957
  */
12889
12958
  VariableString: string;
12890
12959
  /**
@@ -13083,7 +13152,6 @@ export interface components {
13083
13152
  * @description Waits for a deployment to be considered 'healthy' before allowing the pipeline to continue.
13084
13153
  * A deployement is considered 'healthy' when all instances of all containers that have had a state change in the last 15 minutes
13085
13154
  * that have health checks defined, become healthy.
13086
- *
13087
13155
  */
13088
13156
  EnvironmentDeploymentHealthyWatchStep: {
13089
13157
  /** @description An identifier for the step. */
@@ -13191,9 +13259,10 @@ export interface components {
13191
13259
  add_new: boolean;
13192
13260
  /** @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
13261
  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.
13262
+ /**
13263
+ * @description If set to true and `add_new` is enabled, any variables that dont exist FOR THAT DEPLOYMENT will be created.
13195
13264
  * If set to true and `replace_existing` is enabled, any matching variables FOR THAT DEPLOYMENT will be replaced.
13196
- * */
13265
+ */
13197
13266
  associate_deployment: boolean;
13198
13267
  } | null;
13199
13268
  };
@@ -13290,7 +13359,6 @@ export interface components {
13290
13359
  * @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
13360
  * For example if you were to reference a step creating a container, you would receive that container object in the post body.
13292
13361
  * You may also specify a custom body instead.
13293
- *
13294
13362
  */
13295
13363
  WebhookPostStep: {
13296
13364
  /** @description An identifier for the step. */
@@ -13313,14 +13381,16 @@ export interface components {
13313
13381
  options?: components["schemas"]["WebhookStepOptions"] | null;
13314
13382
  /** @description An optional POST body to send with the request. Cannot be used with `from``. */
13315
13383
  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> */
13384
+ /**
13385
+ * @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>
13386
+ * @example init/image-create
13387
+ */
13317
13388
  from?: string | null;
13318
13389
  };
13319
13390
  };
13320
13391
  /**
13321
13392
  * WebhookGetStep
13322
13393
  * @description A pipeline step that will make a GET request to the specified endpoint.
13323
- *
13324
13394
  */
13325
13395
  WebhookGetStep: {
13326
13396
  /** @description An identifier for the step. */
@@ -13519,7 +13589,6 @@ export interface components {
13519
13589
  /**
13520
13590
  * SourceSanIscsi
13521
13591
  * @description A SAN iSCSI volume source. Defines one or more iSCSI targets and the LUN number to attach.
13522
- *
13523
13592
  */
13524
13593
  SourceSanIscsi: {
13525
13594
  /**
@@ -13528,13 +13597,11 @@ export interface components {
13528
13597
  */
13529
13598
  type: "san-iscsi";
13530
13599
  details: {
13531
- /** @description One or more iSCSI integration IDs to use for authentication.
13532
- * */
13600
+ /** @description One or more iSCSI integration IDs to use for authentication. */
13533
13601
  integration_ids: components["schemas"]["ID"][];
13534
13602
  /**
13535
13603
  * Format: int32
13536
13604
  * @description Logical Unit Number exposed by the target(s) to attach.
13537
- *
13538
13605
  */
13539
13606
  lun: number;
13540
13607
  };
@@ -13556,7 +13623,6 @@ export interface components {
13556
13623
  /**
13557
13624
  * SourceCephRbd
13558
13625
  * @description A Ceph RBD volume source. Defines monitor endpoints, optional cluster FSID, client identity (CephX), and the specific image to attach.
13559
- *
13560
13626
  */
13561
13627
  SourceCephRbd: {
13562
13628
  /**
@@ -13565,8 +13631,7 @@ export interface components {
13565
13631
  */
13566
13632
  type: "ceph-rbd";
13567
13633
  details: {
13568
- /** @description The ID of a Ceph cluster integration for authentication.
13569
- * */
13634
+ /** @description The ID of a Ceph cluster integration for authentication. */
13570
13635
  integration_id: components["schemas"]["ID"];
13571
13636
  image: components["schemas"]["SourceCephRbdImageRef"];
13572
13637
  };
@@ -13574,19 +13639,15 @@ export interface components {
13574
13639
  /**
13575
13640
  * SourceAwsEbsAuth
13576
13641
  * @description AWS credentials for accessing EBS. Either an instance role may be used or explicit Access Key credentials may be provided.
13577
- *
13578
13642
  */
13579
13643
  SourceAwsEbsAuth: {
13580
- /** @description When true, use the instance's IAM role for authentication.
13581
- * */
13644
+ /** @description When true, use the instance's IAM role for authentication. */
13582
13645
  use_instance_role?: boolean;
13583
- /** @description AWS Access Key ID to use for authentication (optional if using instance role).
13584
- * */
13646
+ /** @description AWS Access Key ID to use for authentication (optional if using instance role). */
13585
13647
  access_key_id?: string;
13586
13648
  /**
13587
13649
  * Format: password
13588
13650
  * @description AWS Secret Access Key to use for authentication (optional if using instance role).
13589
- *
13590
13651
  */
13591
13652
  secret_access_key?: string;
13592
13653
  };
@@ -13595,17 +13656,14 @@ export interface components {
13595
13656
  * @description Reference to the specific EBS volume to attach.
13596
13657
  */
13597
13658
  SourceAwsEbsRef: {
13598
- /** @description The EBS volume ID (for example, "vol-0abcd1234ef567890").
13599
- * */
13659
+ /** @description The EBS volume ID (for example, "vol-0abcd1234ef567890"). */
13600
13660
  volume_id: string;
13601
- /** @description Optional AWS Availability Zone where the volume resides (for example, "us-east-1a").
13602
- * */
13661
+ /** @description Optional AWS Availability Zone where the volume resides (for example, "us-east-1a"). */
13603
13662
  az?: string;
13604
13663
  };
13605
13664
  /**
13606
13665
  * SourceAwsEbs
13607
13666
  * @description An AWS EBS volume source. Defines how to authenticate to AWS and which EBS volume to attach.
13608
- *
13609
13667
  */
13610
13668
  SourceAwsEbs: {
13611
13669
  /**
@@ -13621,7 +13679,6 @@ export interface components {
13621
13679
  /**
13622
13680
  * ExternalVolumeSource
13623
13681
  * @description The source information for this volume.
13624
- *
13625
13682
  */
13626
13683
  ExternalVolumeSource: components["schemas"]["SourceSanIscsi"] | components["schemas"]["SourceCephRbd"] | components["schemas"]["SourceAwsEbs"];
13627
13684
  /**
@@ -13670,8 +13727,7 @@ export interface components {
13670
13727
  * @description Configuration options controlling the behavior of the volume.
13671
13728
  */
13672
13729
  ExternalVolumeOptions: {
13673
- /** @description If the volume doesn't exist, attempt to create it on container start if create struct defined.
13674
- * */
13730
+ /** @description If the volume doesn't exist, attempt to create it on container start if create struct defined. */
13675
13731
  create: {
13676
13732
  /** @description Indicates the size of volume to create. */
13677
13733
  size: components["schemas"]["DataSize"];
@@ -13696,11 +13752,9 @@ export interface components {
13696
13752
  updated: components["schemas"]["DateTime"];
13697
13753
  /** @description The timestamp of when the attached volume was deleted. */
13698
13754
  deleted: components["schemas"]["DateTime"];
13699
- /** @description Timestamp of the last successful verification event for this volume.
13700
- * */
13755
+ /** @description Timestamp of the last successful verification event for this volume. */
13701
13756
  last_verified?: components["schemas"]["DateTime"];
13702
- /** @description Timestamp of the last successful synchronization event for this volume.
13703
- * */
13757
+ /** @description Timestamp of the last successful synchronization event for this volume. */
13704
13758
  last_sync?: components["schemas"]["DateTime"];
13705
13759
  };
13706
13760
  /**
@@ -13726,7 +13780,6 @@ export interface components {
13726
13780
  /**
13727
13781
  * ExternalVolume
13728
13782
  * @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
13783
  */
13731
13784
  ExternalVolume: {
13732
13785
  id: components["schemas"]["ID"];
@@ -13740,9 +13793,8 @@ export interface components {
13740
13793
  server_ids: components["schemas"]["ID"][];
13741
13794
  source: components["schemas"]["ExternalVolumeSource"];
13742
13795
  /** @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
- * */
13796
+ attachment?: components["schemas"]["ExternalVolumeAttachment"] | null;
13797
+ /** @description Size of the external volume; may be null or omitted if the size has not yet been determined. */
13746
13798
  size?: components["schemas"]["DataSize"] | null;
13747
13799
  options: components["schemas"]["ExternalVolumeOptions"];
13748
13800
  state: components["schemas"]["ExternalVolumeState"];
@@ -13783,7 +13835,7 @@ export interface components {
13783
13835
  * @description The current state of the pipeline run.
13784
13836
  * @enum {string}
13785
13837
  */
13786
- current: "queued" | "acquiring" | "running" | "complete" | "deleting" | "deleted";
13838
+ current: "queued" | "acquiring" | "running" | "complete" | "cancelled" | "deleted";
13787
13839
  } & components["schemas"]["State"];
13788
13840
  /**
13789
13841
  * PipelineRunEvents
@@ -13834,7 +13886,6 @@ export interface components {
13834
13886
  /**
13835
13887
  * VirtualMachineSshKey
13836
13888
  * @description Describes an SSH key used to access a virtual machine.
13837
- *
13838
13889
  */
13839
13890
  VirtualMachineSshKey: {
13840
13891
  id: components["schemas"]["ID"];
@@ -14086,7 +14137,13 @@ export interface components {
14086
14137
  MonitoringUsage: {
14087
14138
  /** @description Number that, when used in conjunction with unit, describes the included usage. */
14088
14139
  included: number;
14089
- /** @description A string describing the metric unit. */
14140
+ /**
14141
+ * @description A string describing the metric unit.
14142
+ * @example Metrics
14143
+ * @example Events
14144
+ * @example Matches
14145
+ * @example GB
14146
+ */
14090
14147
  unit: string;
14091
14148
  /** @description A boolean indicating if there is hard usage limit on the tier. */
14092
14149
  hard_cap: boolean;
@@ -14158,30 +14215,76 @@ export interface components {
14158
14215
  price: components["schemas"]["BillingAmount"];
14159
14216
  };
14160
14217
  /**
14161
- * ExternalVolumeAttachAction
14162
- * @description A task to attach an external volume.
14218
+ * ExternalVolumeIncludes
14219
+ * @description All includable resources linked to the given external volume.
14163
14220
  */
14164
- ExternalVolumeAttachAction: {
14221
+ ExternalVolumeIncludes: {
14222
+ servers?: {
14223
+ [key: string]: components["schemas"]["Server"];
14224
+ };
14225
+ locations?: {
14226
+ [key: string]: components["schemas"]["ProviderLocation"];
14227
+ };
14228
+ };
14229
+ /**
14230
+ * ExternalVolumesScanAction
14231
+ * @description A task to scan for available external volumes on a given cluster.
14232
+ */
14233
+ ExternalVolumesScanAction: {
14165
14234
  /**
14166
- * @description The name of the action to perform (attach). (enum property replaced by openapi-typescript)
14235
+ * @description The action for the external volumes job. (enum property replaced by openapi-typescript)
14167
14236
  * @enum {string}
14168
14237
  */
14169
- action: "attach";
14170
- contents: components["schemas"]["ExternalVolumeAttachment"];
14238
+ action: "scan";
14239
+ /** @description Scan options used by the platform to create the job. */
14240
+ contents: {
14241
+ /** @description ID of the integration to scan for external volumes. */
14242
+ integration_id: components["schemas"]["ID"];
14243
+ /** @description ID of the location to scan for external volumes. */
14244
+ location_id?: components["schemas"]["ID"];
14245
+ /**
14246
+ * @description Type of external volume system to scan.
14247
+ * @enum {string}
14248
+ */
14249
+ source_type: "san-iscsi" | "ceph-rbd" | "aws-ebs";
14250
+ /** @description ID of the cluster to scan for external volumes. */
14251
+ cluster: components["schemas"]["Identifier"];
14252
+ /** @description Optional list of server IDs to limit the scan scope. */
14253
+ server_ids?: components["schemas"]["ID"][] | null;
14254
+ /** @description Optional namespace string to limit the scan scope. */
14255
+ namespace?: string | null;
14256
+ };
14171
14257
  };
14258
+ /** ExternalVolumesTask */
14259
+ ExternalVolumesTask: components["schemas"]["ExternalVolumesScanAction"];
14172
14260
  /**
14173
- * ExternalVolumeDetachAction
14174
- * @description A task to detach an external volume from an instance.
14261
+ * ExternalVolumeServersReconfigureAction
14262
+ * @description A task to reconfigure mountable destination servers for external volume.
14175
14263
  */
14176
- ExternalVolumeDetachAction: {
14264
+ ExternalVolumeServersReconfigureAction: {
14177
14265
  /**
14178
- * @description The name of the action to perform (detach). (enum property replaced by openapi-typescript)
14266
+ * @description The name of the action to perform (servers.reconfigure). (enum property replaced by openapi-typescript)
14179
14267
  * @enum {string}
14180
14268
  */
14181
- action: "detach";
14269
+ action: "servers.reconfigure";
14270
+ /** @description Contents contains an array of server ids to set as mountable destinations for the external volume. */
14271
+ contents?: components["schemas"]["ID"][];
14272
+ };
14273
+ /**
14274
+ * ExternalVolumeAttachmentReconfigureAction
14275
+ * @description A task to reconfigure the attachment for external volume.
14276
+ */
14277
+ ExternalVolumeAttachmentReconfigureAction: {
14278
+ /**
14279
+ * @description The name of the action to perform (attachment.reconfigure). (enum property replaced by openapi-typescript)
14280
+ * @enum {string}
14281
+ */
14282
+ action: "attachment.reconfigure";
14283
+ /** @description Attachment configuration details. */
14284
+ contents?: components["schemas"]["ExternalVolumeAttachment"];
14182
14285
  };
14183
14286
  /** ExternalVolumeTask */
14184
- ExternalVolumeTasks: components["schemas"]["ExternalVolumeAttachAction"] | components["schemas"]["ExternalVolumeDetachAction"];
14287
+ ExternalVolumeTask: components["schemas"]["ExternalVolumeServersReconfigureAction"] | components["schemas"]["ExternalVolumeAttachmentReconfigureAction"];
14185
14288
  /**
14186
14289
  * ServerModelsIncludes
14187
14290
  * @description A resource associated with a server models.
@@ -14318,7 +14421,10 @@ export interface components {
14318
14421
  [key: string]: {
14319
14422
  /** @description String describing the server mount type. */
14320
14423
  type: string;
14321
- /** @description Comma separated string describing the server mount options. */
14424
+ /**
14425
+ * @description Comma separated string describing the server mount options.
14426
+ * @example key1=value1,key2=value2
14427
+ */
14322
14428
  options: string;
14323
14429
  /** @description String describing the server mount source. */
14324
14430
  source: string;
@@ -14368,7 +14474,6 @@ export interface components {
14368
14474
  * ServerPowerOffAction
14369
14475
  * @description A job that powers the server off.
14370
14476
  * Only for servers deployed from a virtual provider.
14371
- *
14372
14477
  */
14373
14478
  ServerPowerOffAction: {
14374
14479
  /**
@@ -14381,7 +14486,6 @@ export interface components {
14381
14486
  * ServerAuthResetAction
14382
14487
  * @description A job that resets authentication for the server.
14383
14488
  * Only for servers deployed from a virtual provider.
14384
- *
14385
14489
  */
14386
14490
  ServerAuthResetAction: {
14387
14491
  /**
@@ -14614,7 +14718,8 @@ export interface components {
14614
14718
  points: (components["schemas"]["DateTime"] | number)[][];
14615
14719
  /** @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
14720
  metadata: {
14617
- /** @description The data this metric represents. Cycle provides several built-in metrics, and, tier allowing, hubs can submit custom metrics as well.
14721
+ /**
14722
+ * @description The data this metric represents. Cycle provides several built-in metrics, and, tier allowing, hubs can submit custom metrics as well.
14618
14723
  *
14619
14724
  * Here is a non-exhaustive list of some of the metrics provided by the platform automatically:
14620
14725
  * - container.instances.num
@@ -14663,7 +14768,7 @@ export interface components {
14663
14768
  * - memberships.num
14664
14769
  * - pipeline.runs.num
14665
14770
  * - stack.builds.num
14666
- * */
14771
+ */
14667
14772
  metric: string;
14668
14773
  /**
14669
14774
  * @description The type of data represented by the metric.
@@ -14674,7 +14779,6 @@ export interface components {
14674
14779
  * - **histogram**: tracks the statistical distribution of a set of values.
14675
14780
  * - **distribution**: aggregates data across multiple hosts and applications.
14676
14781
  * - **set**: tracks the number of unique elements in a group.
14677
- *
14678
14782
  * @enum {string}
14679
14783
  */
14680
14784
  type: "gauge" | "count" | "counter" | "rate" | "histogram" | "distribution" | "set";
@@ -14712,8 +14816,7 @@ export interface components {
14712
14816
  text?: string;
14713
14817
  /** @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
14818
  metadata: {
14715
- /** @description Describes what this event is.
14716
- * */
14819
+ /** @description Describes what this event is. */
14717
14820
  event: components["schemas"]["EventType"];
14718
14821
  /**
14719
14822
  * @description The type of event.
@@ -14724,7 +14827,6 @@ export interface components {
14724
14827
  * - **alert**: represents a critical message indicating a severe issue.
14725
14828
  * - **notice**: represents a notice message indicating a noteworthy event.
14726
14829
  * - **audit**: represents a notice message indicating a message that would be needed for audits
14727
- *
14728
14830
  * @enum {string}
14729
14831
  */
14730
14832
  type: "info" | "warning" | "error" | "success" | "alert" | "notice" | "audit";
@@ -14752,22 +14854,25 @@ export interface components {
14752
14854
  LogLine: {
14753
14855
  /** @description The time the log line occurred. */
14754
14856
  time: components["schemas"]["DateTime"];
14755
- /** @description The source that generated the log line. */
14857
+ /**
14858
+ * @description The source that generated the log line.
14859
+ * @example stdout
14860
+ */
14756
14861
  source: string;
14757
14862
  /** @description The message associated with the log line. */
14758
14863
  message: string;
14759
14864
  /** @description The container instance that the log line originated from. */
14760
14865
  instance_id?: string | null;
14761
- /** @description A randomly generated ID that is assigned to all lines in the same context window.
14866
+ /**
14867
+ * @description A randomly generated ID that is assigned to all lines in the same context window.
14762
14868
  * The first line with a specific ID is the log line that matches the query, and the following
14763
14869
  * log lines are included due to the the set context window in the aggregate.
14764
- * */
14870
+ */
14765
14871
  context_window?: string;
14766
14872
  };
14767
14873
  /**
14768
14874
  * Monitor
14769
14875
  * @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
14876
  */
14772
14877
  Monitor: {
14773
14878
  /** @description The ID of the node this monitor is running on. */
@@ -14820,9 +14925,10 @@ export interface components {
14820
14925
  advanced?: {
14821
14926
  /** @description Sub queue allows multiple concurrent pipeline runs. */
14822
14927
  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.
14928
+ /**
14929
+ * @description To enable skip locks, pass the current UNIX timestamp. Must be accurate within 10 minutes of the current UTC time.
14824
14930
  * 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
- * */
14931
+ */
14826
14932
  skip_locks?: number | null;
14827
14933
  };
14828
14934
  };
@@ -15115,8 +15221,7 @@ export interface components {
15115
15221
  * @enum {string}
15116
15222
  */
15117
15223
  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
- * */
15224
+ /** @description A map of volume objects where the key is the id and the value is the volume's config. */
15120
15225
  contents: {
15121
15226
  [key: string]: components["schemas"]["VirtualMachineVolumeConfig"];
15122
15227
  };
@@ -15126,7 +15231,6 @@ export interface components {
15126
15231
  /**
15127
15232
  * VirtualMachineBaseImage
15128
15233
  * @description Represents a virtual machine base OS image provided by Cycle.
15129
- *
15130
15234
  */
15131
15235
  VirtualMachineBaseImage: {
15132
15236
  /** @description The name of the base image (e.g., "Alpine Linux"). */
@@ -15140,9 +15244,15 @@ export interface components {
15140
15244
  homepage: string;
15141
15245
  /** @description A list of available versions for the base image, including details like version number and disk image URL. */
15142
15246
  versions: {
15143
- /** @description A unique identifier for the version. */
15247
+ /**
15248
+ * @description A unique identifier for the version.
15249
+ * @example alpine-3-19
15250
+ */
15144
15251
  identifier: string;
15145
- /** @description The version number of the base image. */
15252
+ /**
15253
+ * @description The version number of the base image.
15254
+ * @example 3.19
15255
+ */
15146
15256
  version: string;
15147
15257
  /**
15148
15258
  * Format: uri
@@ -15641,9 +15751,10 @@ export interface operations {
15641
15751
  sort?: components["parameters"]["SortParam"];
15642
15752
  /** @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
15753
  page?: components["parameters"]["PageParam"];
15644
- /** @description ## Filter Field
15754
+ /**
15755
+ * @description ## Filter Field
15645
15756
  * 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
- * */
15757
+ */
15647
15758
  filter?: {
15648
15759
  /**
15649
15760
  * @description Get only Announcements that have been resolved, or only those that have not.
@@ -15708,12 +15819,12 @@ export interface operations {
15708
15819
  query?: {
15709
15820
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
15710
15821
  sort?: components["parameters"]["SortParam"];
15711
- /** @description ## Filter Field
15822
+ /**
15823
+ * @description ## Filter Field
15712
15824
  * 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
- * */
15825
+ */
15714
15826
  filter?: {
15715
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the credit's current state.
15716
- * */
15827
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the credit's current state. */
15717
15828
  state?: string;
15718
15829
  /** @description Use a text-based search to filter the credits. */
15719
15830
  search?: string;
@@ -15805,15 +15916,14 @@ export interface operations {
15805
15916
  page?: components["parameters"]["PageParam"];
15806
15917
  /** @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
15918
  meta?: "due"[];
15808
- /** @description ## Filter Field
15919
+ /**
15920
+ * @description ## Filter Field
15809
15921
  * 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
- * */
15922
+ */
15811
15923
  filter?: {
15812
- /** @description `filter[search]=value` search for the specified text on supported fields.
15813
- * */
15924
+ /** @description `filter[search]=value` search for the specified text on supported fields. */
15814
15925
  search?: string;
15815
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the invoice's current state.
15816
- * */
15926
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the invoice's current state. */
15817
15927
  state?: string;
15818
15928
  /** @description The start date from when to pull the invoices */
15819
15929
  "range-start"?: components["schemas"]["DateTime"];
@@ -16459,52 +16569,40 @@ export interface operations {
16459
16569
  meta?: ("instances_count" | "domains" | "ips")[];
16460
16570
  /** @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
16571
  include?: ("creators" | "images" | "stack_builds" | "stacks" | "environments")[];
16462
- /** @description ## Filter Field
16572
+ /**
16573
+ * @description ## Filter Field
16463
16574
  * 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
- * */
16575
+ */
16465
16576
  filter?: {
16466
- /** @description `filter[creator]=account-ID` filter for containers matching a particular creator, such as `account-ID` or `environment-ID`
16467
- * */
16577
+ /** @description `filter[creator]=account-ID` filter for containers matching a particular creator, such as `account-ID` or `environment-ID` */
16468
16578
  creator?: string;
16469
- /** @description `filter[identifier]=value` List only those containers matching this identifier. May return multiple results.
16470
- * */
16579
+ /** @description `filter[identifier]=value` List only those containers matching this identifier. May return multiple results. */
16471
16580
  identifier?: string;
16472
- /** @description `filter[search]=value` search containers for a value associated with a field on the given container(s).
16473
- * */
16581
+ /** @description `filter[search]=value` search containers for a value associated with a field on the given container(s). */
16474
16582
  search?: string;
16475
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the container's current state.
16476
- * */
16583
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the container's current state. */
16477
16584
  state?: string;
16478
- /** @description `filter[deprecated]=true` filter for containers that are deprecated.
16479
- * */
16585
+ /** @description `filter[deprecated]=true` filter for containers that are deprecated. */
16480
16586
  deprecated?: string;
16481
- /** @description `filter[service]=value` service filtering will allow you to filter by service type: `loadbalancer`, `discovery`, `vpn`.
16482
- * */
16587
+ /** @description `filter[service]=value` service filtering will allow you to filter by service type: `loadbalancer`, `discovery`, `vpn`. */
16483
16588
  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
- * */
16589
+ /** @description `filter[public_network]=value` public network filtering will allow you to filter by the containers network settings: `enabled`, `disabled`, `egress-only`. */
16486
16590
  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
- * */
16591
+ /** @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
16592
  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
- * */
16593
+ /** @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
16594
  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
- * */
16595
+ /** @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
16596
  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
- * */
16597
+ /** @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
16598
  stack?: string;
16499
- /** @description `filter[deployment]=v1,v2` filter containers by deployment(s).
16500
- * */
16599
+ /** @description `filter[deployment]=v1,v2` filter containers by deployment(s). */
16501
16600
  deployment?: string;
16502
16601
  /** @description The start date from when to pull the containers */
16503
16602
  "range-start"?: components["schemas"]["DateTime"];
16504
16603
  /** @description The end date from when to pull the containers */
16505
16604
  "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
- * */
16605
+ /** @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
16606
  deployment_strategy?: string;
16509
16607
  };
16510
16608
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -16851,18 +16949,16 @@ export interface operations {
16851
16949
  include?: ("creators" | "servers" | "locations" | "integrations" | "containers" | "environments")[];
16852
16950
  /** @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
16951
  meta?: ("node" | "sdn_pool_ips")[];
16854
- /** @description ## Filter Field
16952
+ /**
16953
+ * @description ## Filter Field
16855
16954
  * 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
- * */
16955
+ */
16857
16956
  filter?: {
16858
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the instance's current state.
16859
- * */
16957
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the instance's current state. */
16860
16958
  state?: string;
16861
- /** @description `filter[search]=value` search instances for a value associated with a field on the given instance(s).
16862
- * */
16959
+ /** @description `filter[search]=value` search instances for a value associated with a field on the given instance(s). */
16863
16960
  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
- * */
16961
+ /** @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
16962
  server?: string;
16867
16963
  /** @description The start date from when to pull the instances */
16868
16964
  "range-start"?: components["schemas"]["DateTime"];
@@ -17150,9 +17246,10 @@ export interface operations {
17150
17246
  getInstanceTelemetryReport: {
17151
17247
  parameters: {
17152
17248
  query?: {
17153
- /** @description ## Filter Field
17249
+ /**
17250
+ * @description ## Filter Field
17154
17251
  * 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
- * */
17252
+ */
17156
17253
  filter?: {
17157
17254
  /** @description The start date from when to pull instance telemetry data */
17158
17255
  "range-start"?: components["schemas"]["DateTime"];
@@ -17454,12 +17551,12 @@ export interface operations {
17454
17551
  query?: {
17455
17552
  /** @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
17553
  include?: "creators"[];
17457
- /** @description ## Filter Field
17554
+ /**
17555
+ * @description ## Filter Field
17458
17556
  * 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
- * */
17557
+ */
17460
17558
  filter?: {
17461
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the DNS Zone's current state.
17462
- * */
17559
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the DNS Zone's current state. */
17463
17560
  state?: string;
17464
17561
  };
17465
17562
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -17691,12 +17788,12 @@ export interface operations {
17691
17788
  query?: {
17692
17789
  /** @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
17790
  include?: components["parameters"]["RecordIncludeParam"];
17694
- /** @description ## Filter Field
17791
+ /**
17792
+ * @description ## Filter Field
17695
17793
  * 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
- * */
17794
+ */
17697
17795
  filter?: {
17698
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the DNS record's current state.
17699
- * */
17796
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the DNS record's current state. */
17700
17797
  state?: string;
17701
17798
  };
17702
17799
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -17854,7 +17951,7 @@ export interface operations {
17854
17951
  * @description The action that the job will take.
17855
17952
  * @enum {string}
17856
17953
  */
17857
- action: "generateCert";
17954
+ action: "cert.generate";
17858
17955
  };
17859
17956
  };
17860
17957
  };
@@ -17876,12 +17973,12 @@ export interface operations {
17876
17973
  getTLSGenerationAttempts: {
17877
17974
  parameters: {
17878
17975
  query?: {
17879
- /** @description ## Filter Field
17976
+ /**
17977
+ * @description ## Filter Field
17880
17978
  * 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
- * */
17979
+ */
17882
17980
  filter?: {
17883
- /** @description `filter[domain]=value` filter the return for TLS attempts by domain.
17884
- * */
17981
+ /** @description `filter[domain]=value` filter the return for TLS attempts by domain. */
17885
17982
  domain?: string;
17886
17983
  };
17887
17984
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -17944,15 +18041,14 @@ export interface operations {
17944
18041
  getUserSuppliedCertificates: {
17945
18042
  parameters: {
17946
18043
  query?: {
17947
- /** @description ## Filter Field
18044
+ /**
18045
+ * @description ## Filter Field
17948
18046
  * 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
- * */
18047
+ */
17950
18048
  filter?: {
17951
- /** @description `filter[domain]=value1` filter user certificates by associated domain.
17952
- * */
18049
+ /** @description `filter[domain]=value1` filter user certificates by associated domain. */
17953
18050
  domain?: string;
17954
- /** @description `filter[state]=value1,value2` state filtering will allow filtering by the current state.
17955
- * */
18051
+ /** @description `filter[state]=value1,value2` state filtering will allow filtering by the current state. */
17956
18052
  state?: string;
17957
18053
  };
17958
18054
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -18058,7 +18154,6 @@ export interface operations {
18058
18154
  *
18059
18155
  * **deprecate**: Cycle will deprecate this certificate, and try to find another usable certificate. If none exists, it will generate a new one
18060
18156
  * for the applicable domains.
18061
- *
18062
18157
  * @enum {string}
18063
18158
  */
18064
18159
  action: "deprecate";
@@ -18087,24 +18182,20 @@ export interface operations {
18087
18182
  meta?: ("containers" | "containers_count" | "instances_count")[];
18088
18183
  /** @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
18184
  include?: ("creators" | "stacks")[];
18090
- /** @description ## Filter Field
18185
+ /**
18186
+ * @description ## Filter Field
18091
18187
  * 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
- * */
18188
+ */
18093
18189
  filter?: {
18094
- /** @description `filter[creator]=account-ID` filter for environments matching a particular creator, such as `account-ID`.
18095
- * */
18190
+ /** @description `filter[creator]=account-ID` filter for environments matching a particular creator, such as `account-ID`. */
18096
18191
  creator?: string;
18097
- /** @description `filter[identifier]=value` List only those environments matching this identifier. May return multiple results.
18098
- * */
18192
+ /** @description `filter[identifier]=value` List only those environments matching this identifier. May return multiple results. */
18099
18193
  identifier?: string;
18100
- /** @description `filter[search]=value` search for a value associated with a field on the given environment(s).
18101
- * */
18194
+ /** @description `filter[search]=value` search for a value associated with a field on the given environment(s). */
18102
18195
  search?: string;
18103
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the environment's current state.
18104
- * */
18196
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the environment's current state. */
18105
18197
  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
- * */
18198
+ /** @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
18199
  stack_build?: string;
18109
18200
  };
18110
18201
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -18411,15 +18502,15 @@ export interface operations {
18411
18502
  requestBody?: {
18412
18503
  content: {
18413
18504
  "application/json": {
18414
- /** @description Defines which deployment containers to include in the stack export. By default, no containers tagged in a deployment are exported.
18505
+ /**
18506
+ * @description Defines which deployment containers to include in the stack export. By default, no containers tagged in a deployment are exported.
18415
18507
  * This option includes all containers with the specific, comma separated deployment tags in the final output in addition to the
18416
18508
  * containers that are not part of any deployment.
18417
- * */
18509
+ */
18418
18510
  deployment_tags?: string[];
18419
18511
  /**
18420
18512
  * @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
18513
  * 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
18514
  * @default false
18424
18515
  */
18425
18516
  resolve_origins?: boolean;
@@ -18444,21 +18535,18 @@ export interface operations {
18444
18535
  getScopedVariables: {
18445
18536
  parameters: {
18446
18537
  query?: {
18447
- /** @description ## Filter Field
18538
+ /**
18539
+ * @description ## Filter Field
18448
18540
  * 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
- * */
18541
+ */
18450
18542
  filter?: {
18451
- /** @description `filter[identifier]=value` List only those scoped variables matching this identifier. May return multiple results.
18452
- * */
18543
+ /** @description `filter[identifier]=value` List only those scoped variables matching this identifier. May return multiple results. */
18453
18544
  identifier?: string;
18454
- /** @description `filter[container]=value` List only those scoped variables assigned to the specified container ID.
18455
- * */
18545
+ /** @description `filter[container]=value` List only those scoped variables assigned to the specified container ID. */
18456
18546
  container?: string;
18457
- /** @description `filter[search]=value` search for a value associated with a field on the given scoped variable(s).
18458
- * */
18547
+ /** @description `filter[search]=value` search for a value associated with a field on the given scoped variable(s). */
18459
18548
  search?: string;
18460
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the scoped variable's current state.
18461
- * */
18549
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the scoped variable's current state. */
18462
18550
  state?: string;
18463
18551
  };
18464
18552
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -18794,9 +18882,10 @@ export interface operations {
18794
18882
  getLoadBalancerTelemetryReport: {
18795
18883
  parameters: {
18796
18884
  query: {
18797
- /** @description ## Filter Field
18885
+ /**
18886
+ * @description ## Filter Field
18798
18887
  * 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
- * */
18888
+ */
18800
18889
  filter: {
18801
18890
  /** @description The start date from when to pull load balancer telemetry data */
18802
18891
  "range-start"?: components["schemas"]["DateTime"];
@@ -18832,14 +18921,14 @@ export interface operations {
18832
18921
  getLoadBalancerLatestTelemetryReport: {
18833
18922
  parameters: {
18834
18923
  query: {
18835
- /** @description ## Filter Field
18924
+ /**
18925
+ * @description ## Filter Field
18836
18926
  * 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
18927
  * ### Required Filter
18838
18928
  * On this endpoint, you MUST pass filter[controller].
18839
- * */
18929
+ */
18840
18930
  filter: {
18841
- /** @description `filter[controller]=port-123` filter for a specific controller to load telemetry for. THIS FILTER IS REQUIRED.
18842
- * */
18931
+ /** @description `filter[controller]=port-123` filter for a specific controller to load telemetry for. THIS FILTER IS REQUIRED. */
18843
18932
  controller?: string;
18844
18933
  };
18845
18934
  };
@@ -19119,18 +19208,16 @@ export interface operations {
19119
19208
  query?: {
19120
19209
  /** @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
19210
  page?: components["parameters"]["PageParam"];
19122
- /** @description ## Filter Field
19211
+ /**
19212
+ * @description ## Filter Field
19123
19213
  * 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
- * */
19214
+ */
19125
19215
  filter?: {
19126
- /** @description `filter[identifier]=value` List only those environments matching this identifier. May return multiple results.
19127
- * */
19216
+ /** @description `filter[identifier]=value` List only those environments matching this identifier. May return multiple results. */
19128
19217
  identifier?: string;
19129
- /** @description `filter[search]=value` search hubs for a value associated with a field on the given Hub(s).
19130
- * */
19218
+ /** @description `filter[search]=value` search hubs for a value associated with a field on the given Hub(s). */
19131
19219
  search?: string;
19132
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Hub's current state.
19133
- * */
19220
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Hub's current state. */
19134
19221
  state?: string;
19135
19222
  };
19136
19223
  };
@@ -19346,42 +19433,38 @@ export interface operations {
19346
19433
  query?: {
19347
19434
  /** @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
19435
  include?: ("users" | "components" | "creators" | "images" | "stack_builds" | "stacks" | "environments")[];
19349
- /** @description ## Filter Field
19436
+ /**
19437
+ * @description ## Filter Field
19350
19438
  * 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
- * */
19439
+ */
19352
19440
  filter?: {
19353
- /** @description `filter[search]=value` search activities for a value associated with a field on the given activity(s).
19354
- * */
19441
+ /** @description `filter[search]=value` search activities for a value associated with a field on the given activity(s). */
19355
19442
  search?: string;
19356
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the activity's current state.
19357
- * */
19443
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the activity's current state. */
19358
19444
  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
- * */
19445
+ /** @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
19446
  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
- * */
19447
+ /** @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
19448
  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
- * */
19449
+ /** @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
19450
  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
- * */
19451
+ /** @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
19452
  "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
- * */
19453
+ /** @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
19454
  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
- * */
19455
+ /** @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
19456
  server?: string;
19377
- /** @description `filter[events]=value` filter by event names.
19378
- * */
19457
+ /**
19458
+ * @description `filter[events]=value` filter by event names.
19459
+ * @example filter[events]=environment.services.vpn.login
19460
+ */
19379
19461
  events?: string;
19380
- /** @description `filter[verbosity]=integer` filter the activity return by verbosity. The verbosity can be:
19462
+ /**
19463
+ * @description `filter[verbosity]=integer` filter the activity return by verbosity. The verbosity can be:
19381
19464
  * `0` - Activity that users would find useful.
19382
19465
  * `1` - Activity that can be useful when tracking down how something happened.
19383
19466
  * `2` - Full activity, can be useful in debugging problems.
19384
- * */
19467
+ */
19385
19468
  verbosity?: number;
19386
19469
  };
19387
19470
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -19675,18 +19758,16 @@ export interface operations {
19675
19758
  sort?: components["parameters"]["SortParam"];
19676
19759
  /** @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
19760
  meta?: "definition"[];
19678
- /** @description ## Filter Field
19761
+ /**
19762
+ * @description ## Filter Field
19679
19763
  * 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
- * */
19764
+ */
19681
19765
  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
- * */
19766
+ /** @description `filter[state]=value` Filters integrations by their current state. For example, `filter[state]=active` would return only integrations in an active state. */
19684
19767
  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
- * */
19768
+ /** @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
19769
  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
- * */
19770
+ /** @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
19771
  category?: string;
19691
19772
  };
19692
19773
  };
@@ -20383,24 +20464,20 @@ export interface operations {
20383
20464
  meta?: "containers_count"[];
20384
20465
  /** @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
20466
  include?: ("creators" | "stack_builds" | "stacks" | "sources" | "integrations")[];
20386
- /** @description ## Filter Field
20467
+ /**
20468
+ * @description ## Filter Field
20387
20469
  * 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
- * */
20470
+ */
20389
20471
  filter?: {
20390
- /** @description `filter[identifier]=value` List only those images matching this identifier. May return multiple results.
20391
- * */
20472
+ /** @description `filter[identifier]=value` List only those images matching this identifier. May return multiple results. */
20392
20473
  identifier?: string;
20393
- /** @description `filter[search]=value` search for a value associated with a field on the given Image(s).
20394
- * */
20474
+ /** @description `filter[search]=value` search for a value associated with a field on the given Image(s). */
20395
20475
  search?: string;
20396
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Image's current state.
20397
- * */
20476
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Image's current state. */
20398
20477
  state?: string;
20399
- /** @description `filter[source_type]=value` filter images by the Image source's type. Can be: `direct`, `stack-build`, or `bucket`
20400
- * */
20478
+ /** @description `filter[source_type]=value` filter images by the Image source's type. Can be: `direct`, `stack-build`, or `bucket` */
20401
20479
  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
- * */
20480
+ /** @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
20481
  source_id?: string;
20405
20482
  };
20406
20483
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -20616,7 +20693,7 @@ export interface operations {
20616
20693
  * @enum {string}
20617
20694
  */
20618
20695
  action: "prune";
20619
- /** @description Additional contents needed by the platform to create the Job. */
20696
+ /** @description Additional contents needed by the platform to create the job. */
20620
20697
  contents: {
20621
20698
  /** @description A list of IDs to be pruned. */
20622
20699
  source_ids: string[];
@@ -20680,18 +20757,16 @@ export interface operations {
20680
20757
  meta?: "images_count"[];
20681
20758
  /** @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
20759
  include?: ("creators" | "integrations")[];
20683
- /** @description ## Filter Field
20760
+ /**
20761
+ * @description ## Filter Field
20684
20762
  * 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
- * */
20763
+ */
20686
20764
  filter?: {
20687
- /** @description `filter[identifier]=value` List only those image sources matching this identifier. May return multiple results.
20688
- * */
20765
+ /** @description `filter[identifier]=value` List only those image sources matching this identifier. May return multiple results. */
20689
20766
  identifier?: string;
20690
- /** @description `filter[search]=value` search for a value associated with a field on the given Image Source(s).
20691
- * */
20767
+ /** @description `filter[search]=value` search for a value associated with a field on the given Image Source(s). */
20692
20768
  search?: string;
20693
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Image Source's current state.
20694
- * */
20769
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Image Source's current state. */
20695
20770
  state?: string;
20696
20771
  };
20697
20772
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -20901,12 +20976,12 @@ export interface operations {
20901
20976
  getInfrastructureSummary: {
20902
20977
  parameters: {
20903
20978
  query?: {
20904
- /** @description ## Filter Field
20979
+ /**
20980
+ * @description ## Filter Field
20905
20981
  * 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
- * */
20982
+ */
20907
20983
  filter?: {
20908
- /** @description `filter[cluster]=value` return an infrastructure summary only for the specified cluster.
20909
- * */
20984
+ /** @description `filter[cluster]=value` return an infrastructure summary only for the specified cluster. */
20910
20985
  cluster?: string;
20911
20986
  };
20912
20987
  };
@@ -20992,21 +21067,23 @@ export interface operations {
20992
21067
  query?: {
20993
21068
  /** @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
21069
  meta?: "containers"[];
20995
- /** @description ## Filter Field
21070
+ /**
21071
+ * @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
21072
+ * 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.
21073
+ */
21074
+ include?: ("servers" | "locations")[];
21075
+ /**
21076
+ * @description ## Filter Field
20996
21077
  * 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
- * */
21078
+ */
20998
21079
  filter?: {
20999
- /** @description `filter[location]=value` List only those attached volumes available at the specified location.
21000
- * */
21080
+ /** @description `filter[location]=value` List only those attached volumes available at the specified location. */
21001
21081
  location?: string;
21002
- /** @description `filter[server-id]=value` List only those attached volumes attached to the specified server.
21003
- * */
21082
+ /** @description `filter[server-id]=value` List only those attached volumes attached to the specified server. */
21004
21083
  server?: string;
21005
- /** @description `filter[search]=value` List only those attached volumes within the specified cluster.
21006
- * */
21084
+ /** @description `filter[search]=value` List only those attached volumes within the specified cluster. */
21007
21085
  cluster?: string;
21008
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the attached volume's current state.
21009
- * */
21086
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the attached volume's current state. */
21010
21087
  state?: string;
21011
21088
  };
21012
21089
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -21028,9 +21105,7 @@ export interface operations {
21028
21105
  content: {
21029
21106
  "application/json": {
21030
21107
  data: components["schemas"]["ExternalVolume"][];
21031
- includes?: {
21032
- creators?: components["schemas"]["CreatorInclude"];
21033
- };
21108
+ includes?: components["schemas"]["ExternalVolumeIncludes"];
21034
21109
  };
21035
21110
  };
21036
21111
  };
@@ -21039,7 +21114,15 @@ export interface operations {
21039
21114
  };
21040
21115
  createExternalVolume: {
21041
21116
  parameters: {
21042
- query?: never;
21117
+ query?: {
21118
+ /** @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. */
21119
+ meta?: "containers"[];
21120
+ /**
21121
+ * @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
21122
+ * 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.
21123
+ */
21124
+ include?: ("servers" | "locations")[];
21125
+ };
21043
21126
  header?: never;
21044
21127
  path?: never;
21045
21128
  cookie?: never;
@@ -21075,6 +21158,35 @@ export interface operations {
21075
21158
  content: {
21076
21159
  "application/json": {
21077
21160
  data: components["schemas"]["ExternalVolume"];
21161
+ includes?: components["schemas"]["ExternalVolumeIncludes"];
21162
+ };
21163
+ };
21164
+ };
21165
+ default: components["responses"]["DefaultError"];
21166
+ };
21167
+ };
21168
+ createExternalVolumesJob: {
21169
+ parameters: {
21170
+ query?: never;
21171
+ header?: never;
21172
+ path?: never;
21173
+ cookie?: never;
21174
+ };
21175
+ /** @description Parameters for creating a new external volumes job. */
21176
+ requestBody?: {
21177
+ content: {
21178
+ "application/json": components["schemas"]["ExternalVolumesTask"];
21179
+ };
21180
+ };
21181
+ responses: {
21182
+ /** @description Returns a job descriptor. */
21183
+ 202: {
21184
+ headers: {
21185
+ [name: string]: unknown;
21186
+ };
21187
+ content: {
21188
+ "application/json": {
21189
+ data: components["schemas"]["JobDescriptor"];
21078
21190
  };
21079
21191
  };
21080
21192
  };
@@ -21084,11 +21196,17 @@ export interface operations {
21084
21196
  getExternalVolume: {
21085
21197
  parameters: {
21086
21198
  query?: {
21087
- /** @description A comma-separated list of meta values. Meta values will show up under a resource's `meta` field.
21199
+ /**
21200
+ * @description A comma-separated list of meta values. Meta values will show up under a resource's `meta` field.
21088
21201
  * In the case of applying a meta to a collection of resources, each resource will have its own relevant meta data.
21089
21202
  * In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
21090
- * */
21203
+ */
21091
21204
  meta?: "containers"[];
21205
+ /**
21206
+ * @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
21207
+ * 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.
21208
+ */
21209
+ include?: ("servers" | "locations")[];
21092
21210
  };
21093
21211
  header?: never;
21094
21212
  path: {
@@ -21107,6 +21225,7 @@ export interface operations {
21107
21225
  content: {
21108
21226
  "application/json": {
21109
21227
  data: components["schemas"]["ExternalVolume"];
21228
+ includes?: components["schemas"]["ExternalVolumeIncludes"];
21110
21229
  };
21111
21230
  };
21112
21231
  };
@@ -21123,7 +21242,17 @@ export interface operations {
21123
21242
  };
21124
21243
  cookie?: never;
21125
21244
  };
21126
- requestBody?: never;
21245
+ /** @description Parameters for deleting a external volume. */
21246
+ requestBody?: {
21247
+ content: {
21248
+ "application/json": {
21249
+ options?: {
21250
+ /** @description If source device is set to true, this will delete the underlying source device. */
21251
+ source_device?: boolean;
21252
+ };
21253
+ };
21254
+ };
21255
+ };
21127
21256
  responses: {
21128
21257
  /** @description Returns a job descriptor. */
21129
21258
  202: {
@@ -21141,7 +21270,15 @@ export interface operations {
21141
21270
  };
21142
21271
  updateExternalVolume: {
21143
21272
  parameters: {
21144
- query?: never;
21273
+ query?: {
21274
+ /** @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. */
21275
+ meta?: "containers"[];
21276
+ /**
21277
+ * @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
21278
+ * 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.
21279
+ */
21280
+ include?: ("servers" | "locations")[];
21281
+ };
21145
21282
  header?: never;
21146
21283
  path: {
21147
21284
  /** @description The ID of the external volume. */
@@ -21174,6 +21311,7 @@ export interface operations {
21174
21311
  content: {
21175
21312
  "application/json": {
21176
21313
  data: components["schemas"]["ExternalVolume"];
21314
+ includes?: components["schemas"]["ExternalVolumeIncludes"];
21177
21315
  };
21178
21316
  };
21179
21317
  };
@@ -21258,7 +21396,7 @@ export interface operations {
21258
21396
  /** @description Parameters for creating a new attached volume job. */
21259
21397
  requestBody?: {
21260
21398
  content: {
21261
- "application/json": components["schemas"]["ExternalVolumeTasks"];
21399
+ "application/json": components["schemas"]["ExternalVolumeTask"];
21262
21400
  };
21263
21401
  };
21264
21402
  responses: {
@@ -21283,21 +21421,18 @@ export interface operations {
21283
21421
  page?: components["parameters"]["PageParam"];
21284
21422
  /** @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
21423
  include?: ("integrations" | "models" | "locations")[];
21286
- /** @description ## Filter Field
21424
+ /**
21425
+ * @description ## Filter Field
21287
21426
  * 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
- * */
21427
+ */
21289
21428
  filter?: {
21290
- /** @description `filter[search]=value` search for a value associated with a field on the given auto-scale group(s).
21291
- * */
21429
+ /** @description `filter[search]=value` search for a value associated with a field on the given auto-scale group(s). */
21292
21430
  search?: string;
21293
- /** @description `filter[cluster]=value` return a list of auto-scale groups that are associated with the specified cluster.
21294
- * */
21431
+ /** @description `filter[cluster]=value` return a list of auto-scale groups that are associated with the specified cluster. */
21295
21432
  cluster?: string;
21296
- /** @description `filter[identifier]=value` list only those auto-scale groups matching this identifier. May return multiple results.
21297
- * */
21433
+ /** @description `filter[identifier]=value` list only those auto-scale groups matching this identifier. May return multiple results. */
21298
21434
  identifier?: string;
21299
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the provider's current state.
21300
- * */
21435
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the provider's current state. */
21301
21436
  state?: string;
21302
21437
  };
21303
21438
  };
@@ -21489,12 +21624,12 @@ export interface operations {
21489
21624
  sort?: components["parameters"]["SortParam"];
21490
21625
  /** @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
21626
  page?: components["parameters"]["PageParam"];
21492
- /** @description ## Filter Field
21627
+ /**
21628
+ * @description ## Filter Field
21493
21629
  * 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
- * */
21630
+ */
21495
21631
  filter?: {
21496
- /** @description `filter[location_ids]=value` List only those provider servers matching this location. May return multiple results.
21497
- * */
21632
+ /** @description `filter[location_ids]=value` List only those provider servers matching this location. May return multiple results. */
21498
21633
  location_ids?: string;
21499
21634
  };
21500
21635
  };
@@ -22050,24 +22185,20 @@ export interface operations {
22050
22185
  meta?: ("node" | "instances_count")[];
22051
22186
  /** @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
22187
  include?: ("locations" | "models" | "integrations" | "clusters")[];
22053
- /** @description ## Filter Field
22188
+ /**
22189
+ * @description ## Filter Field
22054
22190
  * 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
- * */
22191
+ */
22056
22192
  filter?: {
22057
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the provider's current state.
22058
- * */
22193
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the provider's current state. */
22059
22194
  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
- * */
22195
+ /** @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
22196
  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
- * */
22197
+ /** @description `filter[cluster]=clusterIdentifier` filtering by cluster. Enter the cluster identifier and the return will include servers belonging to the specified cluster. */
22065
22198
  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
- * */
22199
+ /** @description `filter[location]=location` filtering by location. Enter the location id and the return will include servers belonging to the specified location. */
22068
22200
  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
- * */
22201
+ /** @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
22202
  providers?: string;
22072
22203
  };
22073
22204
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -22199,7 +22330,7 @@ export interface operations {
22199
22330
  content: {
22200
22331
  "application/json": {
22201
22332
  options?: {
22202
- /** @description If force is set to true, this will force delete the hub, even if there are servers running on it. */
22333
+ /** @description If force is set to true, this will force delete the server, even if there are instances running on it. */
22203
22334
  force?: boolean;
22204
22335
  };
22205
22336
  };
@@ -22273,9 +22404,10 @@ export interface operations {
22273
22404
  getServerTelemetry: {
22274
22405
  parameters: {
22275
22406
  query?: {
22276
- /** @description ## Filter Field
22407
+ /**
22408
+ * @description ## Filter Field
22277
22409
  * 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
- * */
22410
+ */
22279
22411
  filter?: {
22280
22412
  /** @description The start date from when to pull Server telemetry data */
22281
22413
  "range-start"?: components["schemas"]["DateTime"];
@@ -22376,12 +22508,12 @@ export interface operations {
22376
22508
  getServerTags: {
22377
22509
  parameters: {
22378
22510
  query?: {
22379
- /** @description ## Filter Field
22511
+ /**
22512
+ * @description ## Filter Field
22380
22513
  * 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
- * */
22514
+ */
22382
22515
  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
- * */
22516
+ /** @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
22517
  cluster?: string;
22386
22518
  };
22387
22519
  };
@@ -22465,21 +22597,18 @@ export interface operations {
22465
22597
  query?: {
22466
22598
  /** @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
22599
  include?: ("servers" | "integrations" | "locations")[];
22468
- /** @description ## Filter Field
22600
+ /**
22601
+ * @description ## Filter Field
22469
22602
  * 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
- * */
22603
+ */
22471
22604
  filter?: {
22472
- /** @description `filter[available]=true` filter for IPs that are available for use.
22473
- * */
22605
+ /** @description `filter[available]=true` filter for IPs that are available for use. */
22474
22606
  available?: string;
22475
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the IP's current state.
22476
- * */
22607
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the IP's current state. */
22477
22608
  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
- * */
22609
+ /** @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
22610
  server?: string;
22481
- /** @description `filter[location]=ID` location filtering by ID. Submit the ID of the location you wish to filter by.
22482
- * */
22611
+ /** @description `filter[location]=ID` location filtering by ID. Submit the ID of the location you wish to filter by. */
22483
22612
  location?: string;
22484
22613
  };
22485
22614
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -22662,19 +22791,18 @@ export interface operations {
22662
22791
  query?: {
22663
22792
  /** @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
22793
  include?: "creators"[];
22665
- /** @description ## Filter Field
22794
+ /**
22795
+ * @description ## Filter Field
22666
22796
  * 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
- * */
22797
+ */
22668
22798
  filter?: {
22669
22799
  /** @description The start date from when to fetch Jobs */
22670
22800
  "range-start"?: components["schemas"]["DateTime"];
22671
22801
  /** @description The end date from when to fetch Jobs */
22672
22802
  "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
- * */
22803
+ /** @description `filter[search]=value` search jobs for a value associated with a field on the given job(s). */
22675
22804
  search?: string;
22676
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the job's current state.
22677
- * */
22805
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the job's current state. */
22678
22806
  state?: string;
22679
22807
  };
22680
22808
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -22755,11 +22883,12 @@ export interface operations {
22755
22883
  getMetrics: {
22756
22884
  parameters: {
22757
22885
  query?: {
22758
- /** @description ## Filter Field
22886
+ /**
22887
+ * @description ## Filter Field
22759
22888
  * 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
22889
  *
22761
22890
  * To search via labels, use `label:<label key>` as the filter. For example in URL parameters, `filter[label:test]=abc`.
22762
- * */
22891
+ */
22763
22892
  filter?: {
22764
22893
  /** @description Specify the environment associated with the metrics. */
22765
22894
  environment?: components["schemas"]["ID"];
@@ -22811,9 +22940,10 @@ export interface operations {
22811
22940
  generateAggregatedMetrics: {
22812
22941
  parameters: {
22813
22942
  query?: {
22814
- /** @description ## Filter Field
22943
+ /**
22944
+ * @description ## Filter Field
22815
22945
  * 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
- * */
22946
+ */
22817
22947
  filter?: {
22818
22948
  /** @description The start date from when to pull metrics. Providing 'time' in the post-body criteria field will override this filter. */
22819
22949
  "range-start"?: components["schemas"]["DateTime"];
@@ -22860,11 +22990,12 @@ export interface operations {
22860
22990
  getEvents: {
22861
22991
  parameters: {
22862
22992
  query?: {
22863
- /** @description ## Filter Field
22993
+ /**
22994
+ * @description ## Filter Field
22864
22995
  * 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
22996
  *
22866
22997
  * To search via labels, use `label:<label key>` as the filter. For example in URL parameters, `filter[label:test]=abc`.
22867
- * */
22998
+ */
22868
22999
  filter?: {
22869
23000
  /** @description Specify the environment associated with the events. */
22870
23001
  environment?: components["schemas"]["ID"];
@@ -22916,9 +23047,10 @@ export interface operations {
22916
23047
  generateAggregatedEvents: {
22917
23048
  parameters: {
22918
23049
  query?: {
22919
- /** @description ## Filter Field
23050
+ /**
23051
+ * @description ## Filter Field
22920
23052
  * 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
- * */
23053
+ */
22922
23054
  filter?: {
22923
23055
  /** @description The start date from when to pull events. Providing 'time' in the post-body criteria field will override this filter. */
22924
23056
  "range-start"?: components["schemas"]["DateTime"];
@@ -23000,15 +23132,17 @@ export interface operations {
23000
23132
  }[];
23001
23133
  /** @description Indicates that only locally cached log lines should be queried. If true, logs in object storage will not be returned. */
23002
23134
  local?: boolean | null;
23003
- /** @description Describes the maximum number of log lines the query will return. */
23135
+ /**
23136
+ * @description Describes the maximum number of log lines the query will return.
23137
+ * @example 1000
23138
+ */
23004
23139
  limit?: number | null;
23005
23140
  /**
23006
23141
  * @description Context window size indicates how many log lines after a match to return in the response.
23007
23142
  * This allows greater context around the matched lines.
23008
- *
23009
23143
  * @default 5
23010
23144
  */
23011
- context_window_size?: number;
23145
+ context_window_size?: number | null;
23012
23146
  };
23013
23147
  };
23014
23148
  };
@@ -23055,18 +23189,16 @@ export interface operations {
23055
23189
  query?: {
23056
23190
  /** @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
23191
  include?: ("creators" | "name" | "components")[];
23058
- /** @description ## Filter Field
23192
+ /**
23193
+ * @description ## Filter Field
23059
23194
  * 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
- * */
23195
+ */
23061
23196
  filter?: {
23062
- /** @description `filter[identifier]=value` List only those pipelines matching this identifier. May return multiple results.
23063
- * */
23197
+ /** @description `filter[identifier]=value` List only those pipelines matching this identifier. May return multiple results. */
23064
23198
  identifier?: string;
23065
- /** @description `filter[search]=value` search for a value associated with a field on the given pipelines(s).
23066
- * */
23199
+ /** @description `filter[search]=value` search for a value associated with a field on the given pipelines(s). */
23067
23200
  search?: string;
23068
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Pipeline's current state.
23069
- * */
23201
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Pipeline's current state. */
23070
23202
  state?: string;
23071
23203
  };
23072
23204
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -23420,9 +23552,10 @@ export interface operations {
23420
23552
  advanced?: {
23421
23553
  /** @description Sub queue allows multiple concurrent pipeline runs. */
23422
23554
  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.
23555
+ /**
23556
+ * @description To enable skip locks, pass the current UNIX timestamp. Must be accurate within 10 minutes of the current UTC time.
23424
23557
  * 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
- * */
23558
+ */
23426
23559
  skip_locks?: number | null;
23427
23560
  };
23428
23561
  };
@@ -23446,15 +23579,14 @@ export interface operations {
23446
23579
  getPipelineTriggerKeys: {
23447
23580
  parameters: {
23448
23581
  query?: {
23449
- /** @description ## Filter Field
23582
+ /**
23583
+ * @description ## Filter Field
23450
23584
  * 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
- * */
23585
+ */
23452
23586
  filter?: {
23453
- /** @description `filter[search]=value` search for a value associated with a field on the given Trigger Key(s).
23454
- * */
23587
+ /** @description `filter[search]=value` search for a value associated with a field on the given Trigger Key(s). */
23455
23588
  search?: string;
23456
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Trigger Key's current state.
23457
- * */
23589
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Trigger Key's current state. */
23458
23590
  state?: string;
23459
23591
  };
23460
23592
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -23619,18 +23751,16 @@ export interface operations {
23619
23751
  query?: {
23620
23752
  /** @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
23753
  include?: ("creators" | "environments")[];
23622
- /** @description ## Filter Field
23754
+ /**
23755
+ * @description ## Filter Field
23623
23756
  * 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
- * */
23757
+ */
23625
23758
  filter?: {
23626
- /** @description `filter[environment]=ID` Filter networks based on linked environment. Submit the ID of the environment you wish to filter for.
23627
- * */
23759
+ /** @description `filter[environment]=ID` Filter networks based on linked environment. Submit the ID of the environment you wish to filter for. */
23628
23760
  environment?: string;
23629
- /** @description `filter[search]=value` search for a value associated with a field on the given Network(s).
23630
- * */
23761
+ /** @description `filter[search]=value` search for a value associated with a field on the given Network(s). */
23631
23762
  search?: string;
23632
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the network's current state.
23633
- * */
23763
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the network's current state. */
23634
23764
  state?: string;
23635
23765
  };
23636
23766
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -23894,18 +24024,16 @@ export interface operations {
23894
24024
  meta?: ("containers_count" | "builds_count")[];
23895
24025
  /** @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
24026
  include?: "creators"[];
23897
- /** @description ## Filter Field
24027
+ /**
24028
+ * @description ## Filter Field
23898
24029
  * 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
- * */
24030
+ */
23900
24031
  filter?: {
23901
- /** @description `filter[identifier]=value` List only those stacks matching this identifier. May return multiple results.
23902
- * */
24032
+ /** @description `filter[identifier]=value` List only those stacks matching this identifier. May return multiple results. */
23903
24033
  identifier?: string;
23904
- /** @description `filter[search]=value` search for a value associated with a field on the given Stack(s).
23905
- * */
24034
+ /** @description `filter[search]=value` search for a value associated with a field on the given Stack(s). */
23906
24035
  search?: string;
23907
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Stack's current state.
23908
- * */
24036
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Stack's current state. */
23909
24037
  state?: string;
23910
24038
  };
23911
24039
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -24164,15 +24292,14 @@ export interface operations {
24164
24292
  query?: {
24165
24293
  /** @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
24294
  meta?: "containers_count"[];
24167
- /** @description ## Filter Field
24295
+ /**
24296
+ * @description ## Filter Field
24168
24297
  * 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
- * */
24298
+ */
24170
24299
  filter?: {
24171
- /** @description `filter[search]=value` search for a value associated with a field on the given Stack Build(s).
24172
- * */
24300
+ /** @description `filter[search]=value` search for a value associated with a field on the given Stack Build(s). */
24173
24301
  search?: string;
24174
- /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Stack Build's current state.
24175
- * */
24302
+ /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Stack Build's current state. */
24176
24303
  state?: string;
24177
24304
  };
24178
24305
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
@@ -24357,34 +24484,32 @@ export interface operations {
24357
24484
  getVirtualMachines: {
24358
24485
  parameters: {
24359
24486
  query?: {
24360
- /** @description A comma-separated list of meta values. Meta values will show up under a resource's `meta` field.
24487
+ /**
24488
+ * @description A comma-separated list of meta values. Meta values will show up under a resource's `meta` field.
24361
24489
  * In the case of applying a meta to a collection of resources, each resource will have its own relevant meta data.
24362
24490
  * In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
24363
- * */
24491
+ */
24364
24492
  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.
24493
+ /**
24494
+ * @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
24366
24495
  * 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
- * */
24496
+ */
24368
24497
  include?: ("creators" | "environments" | "clusters" | "containers")[];
24369
- /** @description ## Filter Field
24498
+ /**
24499
+ * @description ## Filter Field
24370
24500
  * 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
- * */
24501
+ */
24372
24502
  filter?: {
24373
- /** @description `filter[identifier]=value` List only those virtual machines matching this identifier. May return multiple results.
24374
- * */
24503
+ /** @description `filter[identifier]=value` List only those virtual machines matching this identifier. May return multiple results. */
24375
24504
  identifier?: string;
24376
- /** @description `filter[search]=value` Search virtual machines for a value associated with a field.
24377
- * */
24505
+ /** @description `filter[search]=value` Search virtual machines for a value associated with a field. */
24378
24506
  search?: string;
24379
- /** @description `filter[creator]=account-ID` Filter for virtual machines matching a particular creator, such as `account-<ID>` or `environment-<ID>`.
24380
- * */
24507
+ /** @description `filter[creator]=account-ID` Filter for virtual machines matching a particular creator, such as `account-<ID>` or `environment-<ID>`. */
24381
24508
  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
- * */
24509
+ /** @description `filter[environment]=ID` Filter virtual machines by environment ID. Submit the ID of the environment you wish to filter for. */
24384
24510
  environment?: string;
24385
24511
  /**
24386
24512
  * @description `filter[state]=value` Filter virtual machines by their current state.
24387
- *
24388
24513
  * @enum {string}
24389
24514
  */
24390
24515
  state?: "new" | "starting" | "running" | "stopping" | "stopped" | "deleting" | "deleted";
@@ -24392,12 +24517,10 @@ export interface operations {
24392
24517
  "range-start"?: components["schemas"]["DateTime"];
24393
24518
  /** @description The end date from when to pull the virtual machines. */
24394
24519
  "range-end"?: components["schemas"]["DateTime"];
24395
- /** @description `filter[tags]=value` Filter virtual machines by their tags.
24396
- * */
24520
+ /** @description `filter[tags]=value` Filter virtual machines by their tags. */
24397
24521
  tags?: string;
24398
24522
  /**
24399
24523
  * @description `filter[public_network]=value` Filter virtual machines by their public network status.
24400
- *
24401
24524
  * @enum {string}
24402
24525
  */
24403
24526
  public_network?: "enabled" | "disabled";
@@ -24431,14 +24554,16 @@ export interface operations {
24431
24554
  createVirtualMachine: {
24432
24555
  parameters: {
24433
24556
  query?: {
24434
- /** @description A comma-separated list of meta values. Meta values will show up under a resource's `meta` field.
24557
+ /**
24558
+ * @description A comma-separated list of meta values. Meta values will show up under a resource's `meta` field.
24435
24559
  * In the case of applying a meta to a collection of resources, each resource will have its own relevant meta data.
24436
24560
  * In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
24437
- * */
24561
+ */
24438
24562
  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.
24563
+ /**
24564
+ * @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
24440
24565
  * 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
- * */
24566
+ */
24442
24567
  include?: ("creators" | "environments" | "clusters")[];
24443
24568
  };
24444
24569
  header?: never;
@@ -24487,14 +24612,16 @@ export interface operations {
24487
24612
  getVirtualMachine: {
24488
24613
  parameters: {
24489
24614
  query?: {
24490
- /** @description A comma-separated list of meta values. Meta values will show up under a resource's `meta` field.
24615
+ /**
24616
+ * @description A comma-separated list of meta values. Meta values will show up under a resource's `meta` field.
24491
24617
  * In the case of applying a meta to a collection of resources, each resource will have its own relevant meta data.
24492
24618
  * In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
24493
- * */
24619
+ */
24494
24620
  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.
24621
+ /**
24622
+ * @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
24496
24623
  * 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
- * */
24624
+ */
24498
24625
  include?: ("creators" | "environments" | "clusters" | "containers")[];
24499
24626
  };
24500
24627
  header?: never;
@@ -24708,25 +24835,21 @@ export interface operations {
24708
24835
  getVirtualMachineSshKeys: {
24709
24836
  parameters: {
24710
24837
  query?: {
24711
- /** @description ## Filter Field
24838
+ /**
24839
+ * @description ## Filter Field
24712
24840
  * 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
- * */
24841
+ */
24714
24842
  filter?: {
24715
- /** @description `filter[identifier]=value` List only those SSH keys matching this identifier. May return multiple results.
24716
- * */
24843
+ /** @description `filter[identifier]=value` List only those SSH keys matching this identifier. May return multiple results. */
24717
24844
  identifier?: string;
24718
- /** @description `filter[search]=value` Search SSH keys for a value associated with a field.
24719
- * */
24845
+ /** @description `filter[search]=value` Search SSH keys for a value associated with a field. */
24720
24846
  search?: string;
24721
- /** @description `filter[creator]=account-ID` Filter for SSH keys matching a particular creator, such as `account-<ID>` or `environment-<ID>`.
24722
- * */
24847
+ /** @description `filter[creator]=account-ID` Filter for SSH keys matching a particular creator, such as `account-<ID>` or `environment-<ID>`. */
24723
24848
  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
- * */
24849
+ /** @description `filter[environment]=ID` Filter SSH keys by environment ID. Submit the ID of the environment you wish to filter for. */
24726
24850
  environment?: string;
24727
24851
  /**
24728
24852
  * @description `filter[state]=value` Filter virtual machines by their current state.
24729
- *
24730
24853
  * @enum {string}
24731
24854
  */
24732
24855
  state?: "live" | "deleting" | "deleted";
@@ -24735,9 +24858,10 @@ export interface operations {
24735
24858
  /** @description The end date from when to pull the virtual machines. */
24736
24859
  "range-end"?: components["schemas"]["DateTime"];
24737
24860
  };
24738
- /** @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
24861
+ /**
24862
+ * @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
24739
24863
  * 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
- * */
24864
+ */
24741
24865
  include?: ("creators" | "environments")[];
24742
24866
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
24743
24867
  sort?: components["parameters"]["SortParam"];
@@ -24768,9 +24892,10 @@ export interface operations {
24768
24892
  createVirtualMachineSshKey: {
24769
24893
  parameters: {
24770
24894
  query?: {
24771
- /** @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
24895
+ /**
24896
+ * @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
24772
24897
  * 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
- * */
24898
+ */
24774
24899
  include?: ("creators" | "environments")[];
24775
24900
  };
24776
24901
  header?: never;
@@ -24808,9 +24933,10 @@ export interface operations {
24808
24933
  getVirtualMachineSshKey: {
24809
24934
  parameters: {
24810
24935
  query?: {
24811
- /** @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
24936
+ /**
24937
+ * @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
24812
24938
  * 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
- * */
24939
+ */
24814
24940
  include?: ("creators" | "environments")[];
24815
24941
  };
24816
24942
  header?: never;
@@ -24866,9 +24992,10 @@ export interface operations {
24866
24992
  updateVirtualMachineSshKey: {
24867
24993
  parameters: {
24868
24994
  query?: {
24869
- /** @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
24995
+ /**
24996
+ * @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
24870
24997
  * 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
- * */
24998
+ */
24872
24999
  include?: ("creators" | "environments")[];
24873
25000
  };
24874
25001
  header?: never;
@@ -24969,9 +25096,10 @@ export interface operations {
24969
25096
  path?: never;
24970
25097
  cookie?: never;
24971
25098
  };
24972
- /** @description Accepts an array of component lookup objects. Consists of the type of resource to look up,
25099
+ /**
25100
+ * @description Accepts an array of component lookup objects. Consists of the type of resource to look up,
24973
25101
  * and the ID.
24974
- * */
25102
+ */
24975
25103
  requestBody?: {
24976
25104
  content: {
24977
25105
  "application/json": {