@cycleplatform/api-client-typescript 0.3.8 → 0.3.11

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.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/src/generated/types.ts +1471 -560
@@ -236,6 +236,28 @@ export interface paths {
236
236
  patch?: never;
237
237
  trace?: never;
238
238
  };
239
+ "/v1/billing/status": {
240
+ parameters: {
241
+ query?: never;
242
+ header?: never;
243
+ path?: never;
244
+ cookie?: never;
245
+ };
246
+ /**
247
+ * Get Billing Status
248
+ * @description Retrieve meta details about the billing status of this Cycle core. It is unlikely that someone would need this endpoint outside
249
+ * of Cycle's internal teams.
250
+ *
251
+ */
252
+ get: operations["getBillingStatus"];
253
+ put?: never;
254
+ post?: never;
255
+ delete?: never;
256
+ options?: never;
257
+ head?: never;
258
+ patch?: never;
259
+ trace?: never;
260
+ };
239
261
  "/v1/billing/credits": {
240
262
  parameters: {
241
263
  query?: never;
@@ -687,6 +709,7 @@ export interface paths {
687
709
  * Requires the following capabilities based on the task:
688
710
  * `start`: `containers-manage`
689
711
  * `stop`: `containers-manage`
712
+ * `restart`: `containers-manage`
690
713
  * `reconfigure`: `containers-manage`
691
714
  * `volumes.reconfigure`: `containers-volumes-manage`
692
715
  * `reimage`: `containers-manage`
@@ -2732,6 +2755,107 @@ export interface paths {
2732
2755
  patch?: never;
2733
2756
  trace?: never;
2734
2757
  };
2758
+ "/v1/infrastructure/virtual-providers/{integrationId}/isos": {
2759
+ parameters: {
2760
+ query?: never;
2761
+ header?: never;
2762
+ path?: never;
2763
+ cookie?: never;
2764
+ };
2765
+ /**
2766
+ * Get ISOs for a virtual provider
2767
+ * @description Get ISOs for a virtual provider.
2768
+ *
2769
+ * Requires the `servers-manage` capability.
2770
+ *
2771
+ */
2772
+ get: operations["getVirtualProviderIsos"];
2773
+ put?: never;
2774
+ /**
2775
+ * Create Virtual Provider Iso
2776
+ * @description Create an ISO for a virtual provider.
2777
+ *
2778
+ * Requires the `servers-manage` capability.
2779
+ *
2780
+ */
2781
+ post: operations["createVirtualProviderIso"];
2782
+ delete?: never;
2783
+ options?: never;
2784
+ head?: never;
2785
+ patch?: never;
2786
+ trace?: never;
2787
+ };
2788
+ "/v1/infrastructure/virtual-providers/{integrationId}/isos/{isoId}": {
2789
+ parameters: {
2790
+ query?: never;
2791
+ header?: never;
2792
+ path?: never;
2793
+ cookie?: never;
2794
+ };
2795
+ /**
2796
+ * Get ISO
2797
+ * @description Requires the `servers-manage` capability.
2798
+ */
2799
+ get: operations["getVirtualProviderIso"];
2800
+ put?: never;
2801
+ post?: never;
2802
+ /**
2803
+ * Delete ISO
2804
+ * @description Requires the `servers-manage` capability.
2805
+ */
2806
+ delete: operations["deleteVirtualProviderIso"];
2807
+ options?: never;
2808
+ head?: never;
2809
+ /**
2810
+ * Update ISO
2811
+ * @description Requires the `servers-manage` capability.
2812
+ */
2813
+ patch: operations["updateVirtualProviderIso"];
2814
+ trace?: never;
2815
+ };
2816
+ "/v1/infrastructure/virtual-providers/{integrationId}/isos/{isoId}/tasks": {
2817
+ parameters: {
2818
+ query?: never;
2819
+ header?: never;
2820
+ path?: never;
2821
+ cookie?: never;
2822
+ };
2823
+ get?: never;
2824
+ put?: never;
2825
+ /**
2826
+ * Create Virtual Provider Iso Job
2827
+ * @description Create a job for a virtual provider iso.
2828
+ *
2829
+ * Requires the `servers-manage` capability.
2830
+ *
2831
+ */
2832
+ post: operations["createVirtualProviderIsoJob"];
2833
+ delete?: never;
2834
+ options?: never;
2835
+ head?: never;
2836
+ patch?: never;
2837
+ trace?: never;
2838
+ };
2839
+ "/v1/infrastructure/virtual-providers/{integrationId}/isos/{isoId}/download": {
2840
+ parameters: {
2841
+ query?: never;
2842
+ header?: never;
2843
+ path?: never;
2844
+ cookie?: never;
2845
+ };
2846
+ /**
2847
+ * Delete ISO
2848
+ * @description Requires the `servers-manage` capability.
2849
+ */
2850
+ get: operations["getVirtualProviderIsoDownloadUrl"];
2851
+ put?: never;
2852
+ post?: never;
2853
+ delete?: never;
2854
+ options?: never;
2855
+ head?: never;
2856
+ patch?: never;
2857
+ trace?: never;
2858
+ };
2735
2859
  "/v1/infrastructure/clusters": {
2736
2860
  parameters: {
2737
2861
  query?: never;
@@ -2993,11 +3117,18 @@ export interface paths {
2993
3117
  };
2994
3118
  /**
2995
3119
  * List IP Pools
2996
- * @description Requires the `infrastructure-ips-manage` capability.
3120
+ * @description Requires the `ips-manage` capability.
2997
3121
  */
2998
- get: operations["getInfrastructureIPPools"];
3122
+ get: operations["getIpPools"];
2999
3123
  put?: never;
3000
- post?: never;
3124
+ /**
3125
+ * Create IP Pool
3126
+ * @description Create an infrastructure IP Pool
3127
+ *
3128
+ * Requires the 'ips-manage' capability.
3129
+ *
3130
+ */
3131
+ post: operations["createIpPool"];
3001
3132
  delete?: never;
3002
3133
  options?: never;
3003
3134
  head?: never;
@@ -3013,14 +3144,14 @@ export interface paths {
3013
3144
  };
3014
3145
  /**
3015
3146
  * Get IP Pool
3016
- * @description Requires the `infrastructure-ips-manage` capability.
3147
+ * @description Requires the `ips-manage` capability.
3017
3148
  */
3018
3149
  get: operations["getIPPool"];
3019
3150
  put?: never;
3020
3151
  post?: never;
3021
3152
  /**
3022
3153
  * Delete IP Pool
3023
- * @description Requires the `infrastructure-ips-manage` capability.
3154
+ * @description Requires the `ips-manage` capability.
3024
3155
  */
3025
3156
  delete: operations["deleteIPPool"];
3026
3157
  options?: never;
@@ -4534,6 +4665,8 @@ export interface components {
4534
4665
  term: components["schemas"]["Term"];
4535
4666
  /** @description A boolean where true represents this account being approved to use a prepaid card for billing transactions. */
4536
4667
  allow_prepaid?: boolean;
4668
+ /** @description When true, this hub is allowed to create 'direct' payment methods. */
4669
+ allow_direct_payments?: boolean;
4537
4670
  /** @description A boolean where true represents invoices have been paused on this hub for one reason or another. */
4538
4671
  pause_invoices: boolean;
4539
4672
  /** @description A boolean where true means this billing is disabled on this hub. */
@@ -4837,7 +4970,7 @@ export interface components {
4837
4970
  * @description The status of a payment.
4838
4971
  * @enum {string}
4839
4972
  */
4840
- status: "success" | "processing" | "cancelled" | "error";
4973
+ status: "success" | "awaiting-direct-payment" | "processing" | "cancelled" | "error";
4841
4974
  /** @description A description of the error that took place when processing the payment. */
4842
4975
  error: string;
4843
4976
  };
@@ -5008,11 +5141,31 @@ export interface components {
5008
5141
  last_4: string;
5009
5142
  };
5010
5143
  };
5144
+ /**
5145
+ * DirectPayment
5146
+ * @description A payment method that must be enabled by Cycle staff, solely for telling us they're going to send us checks, wires, ach, outside of Cycle.
5147
+ */
5148
+ DirectPayment: {
5149
+ /**
5150
+ * @description discriminator enum property added by openapi-typescript
5151
+ * @enum {string}
5152
+ */
5153
+ type: "direct-payment";
5154
+ details: {
5155
+ /**
5156
+ * @description The preference for how the payment will be sent.
5157
+ * @enum {string}
5158
+ */
5159
+ preference: "check" | "wire" | "ach";
5160
+ /** @description Any additional instructions for an organization's billing dept., etc. that should be known about this payment method. */
5161
+ instructions: string;
5162
+ };
5163
+ };
5011
5164
  /**
5012
5165
  * MethodSource
5013
5166
  * @description The underlying source (credit card, bank account, etc) used by a payment method.
5014
5167
  */
5015
- MethodSource: components["schemas"]["StripeCreditCard"] | components["schemas"]["StripeUsBankAcct"];
5168
+ MethodSource: components["schemas"]["StripeCreditCard"] | components["schemas"]["StripeUsBankAcct"] | components["schemas"]["DirectPayment"];
5016
5169
  /**
5017
5170
  * Mandate
5018
5171
  * @description Information about the creator of a payment method for compliance purposes.
@@ -5512,12 +5665,18 @@ export interface components {
5512
5665
  * DeploymentStrategyName
5513
5666
  * @enum {string}
5514
5667
  */
5515
- DeploymentStrategyName: "resource-density" | "high-availability" | "first-available" | "node" | "edge" | "manual" | "function";
5668
+ DeploymentStrategyName: "resource-density" | "high-availability" | "distributed" | "first-available" | "manual" | "node" | "edge" | "function";
5516
5669
  /**
5517
5670
  * Duration
5518
5671
  * @description A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
5519
5672
  */
5520
5673
  Duration: string;
5674
+ /**
5675
+ * ShutdownSignal
5676
+ * @description Process signals that Cycle can be configured to send to the container on a shutdown event.
5677
+ * @enum {string}
5678
+ */
5679
+ ShutdownSignal: "SIGTERM" | "SIGINT" | "SIGUSR1" | "SIGUSR2" | "SIGHUP" | "SIGQUIT";
5521
5680
  /**
5522
5681
  * ContainerDeploy
5523
5682
  * @description Deployment configuration for the given container.
@@ -5562,7 +5721,7 @@ export interface components {
5562
5721
  /** @description How long the platform will wait for a container to stop gracefully. */
5563
5722
  graceful_timeout?: components["schemas"]["Duration"] | null;
5564
5723
  /** @description Process signal sent to the container process. */
5565
- signals?: ("SIGTERM" | "SIGINT" | "SIGUSR1" | "SIGUSR2" | "SIGHUP" | "SIGQUIT")[] | null;
5724
+ signals?: components["schemas"]["ShutdownSignal"][] | null;
5566
5725
  };
5567
5726
  /** @description Configurations for container startup. */
5568
5727
  startup?: {
@@ -5794,7 +5953,12 @@ export interface components {
5794
5953
  rules?: components["schemas"]["SeccompRule"][];
5795
5954
  } | null;
5796
5955
  host?: {
5956
+ /** @description If true, Cycle will mount the `/proc` directory into the container, giving it access to the host metrics. This is useful if you're running i.e. a monitoring agent. */
5797
5957
  expose_proc?: boolean | null;
5958
+ /** @description If true, Cycle will mount the host's `/sys/fs/cgroups` directory into the container at `/var/run/cycle/host/cgroups`. */
5959
+ expose_cgroups?: boolean | null;
5960
+ /** @description If true, Cycle will give the container instances access via internal api to power off or reboot the host server. */
5961
+ power_management?: boolean | null;
5798
5962
  } | null;
5799
5963
  rootfs?: {
5800
5964
  /** @description Enabling this option will set the containers filesystem to readonly. Volumes associated with the container will not be affected by this. */
@@ -6036,10 +6200,10 @@ export interface components {
6036
6200
  available: number;
6037
6201
  };
6038
6202
  /**
6039
- * DNSRecordTypes
6203
+ * DnsRecordTypes
6040
6204
  * @description DNS record types the platform supports.
6041
6205
  */
6042
- RecordTypes: {
6206
+ DnsRecordTypes: {
6043
6207
  /** @description A DNS A record */
6044
6208
  a?: {
6045
6209
  /** @description The IPv4 address that the A record should map to. */
@@ -6120,6 +6284,14 @@ export interface components {
6120
6284
  } & ({
6121
6285
  /** @description The ID of the container this record is related to. */
6122
6286
  container_id?: string;
6287
+ } | {
6288
+ virtual_machine: {
6289
+ id: components["schemas"]["ID"];
6290
+ /** @description If true, traffic to this domain will skip the load balancer and go directly to the virtual machine
6291
+ * via the gateway service.
6292
+ * */
6293
+ dmz: boolean;
6294
+ };
6123
6295
  } | {
6124
6296
  /** @description Information about the deployment this record points to. */
6125
6297
  deployment?: {
@@ -6132,14 +6304,14 @@ export interface components {
6132
6304
  /** @description The deployment tag that this record should point to. The tags are set on the root of an environment and map to a deployment version. */
6133
6305
  tag?: components["schemas"]["Identifier"] | null;
6134
6306
  };
6135
- } | null;
6307
+ };
6136
6308
  });
6137
6309
  };
6138
6310
  /**
6139
- * RecordTlsCertificate
6311
+ * DnsRecordTlsCertificate
6140
6312
  * @description A TLS certificate assigned to a DNS record.
6141
6313
  */
6142
- RecordTlsCertificate: {
6314
+ DnsRecordTlsCertificate: {
6143
6315
  id: components["schemas"]["ID"];
6144
6316
  generated: components["schemas"]["DateTime"];
6145
6317
  /** @description A value where true represents that the certificate is using a shared wildcard cert. */
@@ -6149,8 +6321,8 @@ export interface components {
6149
6321
  /** @description The time that this certificate expires. */
6150
6322
  expires?: components["schemas"]["DateTime"];
6151
6323
  };
6152
- /** DNSRecordState */
6153
- RecordState: {
6324
+ /** DnsRecordState */
6325
+ DnsRecordState: {
6154
6326
  /**
6155
6327
  * @description The current state of the record.
6156
6328
  * @enum {string}
@@ -6158,10 +6330,10 @@ export interface components {
6158
6330
  current: "pending" | "live" | "deleting" | "deleted";
6159
6331
  } & components["schemas"]["State"];
6160
6332
  /**
6161
- * DNSRecord
6333
+ * DnsRecord
6162
6334
  * @description A DNS record.
6163
6335
  */
6164
- Record: {
6336
+ DnsRecord: {
6165
6337
  id: components["schemas"]["ID"];
6166
6338
  hub_id: components["schemas"]["HubID"];
6167
6339
  creator: components["schemas"]["CreatorScope"];
@@ -6171,14 +6343,22 @@ export interface components {
6171
6343
  name: string;
6172
6344
  /** @description The name of the record and the origin as a domain name. */
6173
6345
  resolved_domain: string;
6174
- type: components["schemas"]["RecordTypes"];
6346
+ type: components["schemas"]["DnsRecordTypes"];
6175
6347
  /** @description TLS features for the record. */
6176
6348
  features: {
6177
- certificate: components["schemas"]["RecordTlsCertificate"] | null;
6349
+ certificate: components["schemas"]["DnsRecordTlsCertificate"] | null;
6178
6350
  } | null;
6179
- state: components["schemas"]["RecordState"];
6351
+ state: components["schemas"]["DnsRecordState"];
6180
6352
  events: components["schemas"]["Events"];
6181
6353
  };
6354
+ /**
6355
+ * Cidr
6356
+ * Format: cidr
6357
+ * @description A CIDR (Classless Inter-Domain Routing) string is a notation used to represent an IP address and its associated network prefix.
6358
+ * It combines an IP address with a suffix that indicates how many bits are fixed for routing.
6359
+ *
6360
+ */
6361
+ Cidr: string;
6182
6362
  /** IpState */
6183
6363
  IpState: {
6184
6364
  /**
@@ -6215,6 +6395,7 @@ export interface components {
6215
6395
  address: string;
6216
6396
  /** @description The IP gateway. */
6217
6397
  gateway: string;
6398
+ network?: components["schemas"]["Cidr"] | null;
6218
6399
  /** @description The CIDR for the IP. */
6219
6400
  cidr: string;
6220
6401
  state: components["schemas"]["IpState"];
@@ -6228,7 +6409,7 @@ export interface components {
6228
6409
  domains?: {
6229
6410
  /** @description The fully qualified domain name. */
6230
6411
  fqdn: string;
6231
- record?: components["schemas"]["Record"];
6412
+ record?: components["schemas"]["DnsRecord"];
6232
6413
  }[] | null;
6233
6414
  /** @description An array of IP resources. */
6234
6415
  ips?: components["schemas"]["Ip"][];
@@ -6300,6 +6481,12 @@ export interface components {
6300
6481
  */
6301
6482
  current: "new" | "live" | "cloning" | "deleting" | "deleted";
6302
6483
  } & components["schemas"]["State"];
6484
+ /**
6485
+ * MonitoringTier
6486
+ * @description The tier of monitoring, that determines the frequency that metrics are aggregated by the platform, on a per-environment basis.
6487
+ * @enum {string}
6488
+ */
6489
+ MonitoringTier: "limited" | "basic" | "premium" | "enterprise";
6303
6490
  /**
6304
6491
  * EnvironmentFeatures
6305
6492
  * @description An object representing specialized features configured for this environment.
@@ -6309,8 +6496,7 @@ export interface components {
6309
6496
  legacy_networking: boolean;
6310
6497
  /** @description The level of monitoring to enable for this environment. There is a cost associated with higher levels of monitoring. */
6311
6498
  monitoring?: {
6312
- /** @enum {string} */
6313
- tier: "limited" | "standard" | "premium" | "enterprise";
6499
+ tier: components["schemas"]["MonitoringTier"];
6314
6500
  } | null;
6315
6501
  };
6316
6502
  /** HAProxyConfigSet */
@@ -6389,13 +6575,6 @@ export interface components {
6389
6575
  */
6390
6576
  type: "haproxy";
6391
6577
  details: components["schemas"]["HaProxyConfig"] | null;
6392
- /** @description Binds the load balancer to the host server IP address.
6393
- *
6394
- * **Pros**: This allows for significantly lower cost (utilizing fewer IPv4 addresses), and enables building out a true edge network with lower latency.
6395
- * **Cons**: Only 1 environment is allowed on the host. This is because the load balancer is the only ingress point for an environment, and if it is sharing
6396
- * the same IP as the host, that host can only operate under that environment.
6397
- * */
6398
- bind_host?: boolean | null;
6399
6578
  };
6400
6579
  /**
6401
6580
  * WafConfig
@@ -6412,11 +6591,13 @@ export interface components {
6412
6591
  * @enum {string}
6413
6592
  */
6414
6593
  type: "allow" | "deny";
6594
+ /** @description The expiration date of the WAF config, if present. */
6595
+ expires?: components["schemas"]["DateTime"] | null;
6415
6596
  /**
6416
6597
  * @description A string that describes if both attributes need to be true (match all) or if only one of the conditions needs to be true (match any).
6417
6598
  * @enum {string}
6418
6599
  */
6419
- match: "any" | "all";
6600
+ match: "any" | "all" | "";
6420
6601
  /** @description An array of the specific conditions for the rule. */
6421
6602
  conditions: {
6422
6603
  /**
@@ -6566,7 +6747,7 @@ export interface components {
6566
6747
  *
6567
6748
  * Given a path match of `^/example/(.*)$`, a route such as `/example/wow.jpg` would be forwarded as /wow.jpg.
6568
6749
  * */
6569
- url?: string;
6750
+ url?: string | null;
6570
6751
  } | null;
6571
6752
  proxy?: {
6572
6753
  /** @description The domain that this router will proxy. */
@@ -6618,17 +6799,17 @@ export interface components {
6618
6799
  * @description How to route the traffic to the destination.
6619
6800
  * `random`: Pick a valid destination at random.
6620
6801
  * `round-robin`: Send each request to the 'next' destination on the list, restarting from the beginning when the last destination is used.
6802
+ * `source-ip`: Utilizes a hash function to ensure traffic from an IP will always hit the same destination instance.
6621
6803
  *
6622
6804
  * @enum {string}
6623
6805
  */
6624
- mode: "random" | "round-robin";
6806
+ mode: "random" | "round-robin" | "source-ip";
6625
6807
  config: {
6626
6808
  /** @description If a request comes in from the same origin, ensure it hits the same destination. */
6627
6809
  sticky_sessions: boolean;
6628
6810
  /** @description If a destination is unavailable, retry up to [x] times, instead of immediately failing with a 503/504 error. */
6629
6811
  destination_retries: number;
6630
- /** @default null */
6631
- destination_prioritization: ("latency" | "random") | null;
6812
+ destination_prioritization?: ("latency" | "random") | null;
6632
6813
  /** @description TLS termination configuration. If null, the platform will use the default configuration. Port 443 by default has TLS termination enabled. */
6633
6814
  tls?: {
6634
6815
  /** @description [Advanced] Change the domain the controller listens on.
@@ -6722,13 +6903,6 @@ export interface components {
6722
6903
  */
6723
6904
  type: "v1";
6724
6905
  details: components["schemas"]["V1LbConfig"];
6725
- /** @description Binds the load balancer to the host server IP address.
6726
- *
6727
- * **Pros**: This allows for significantly lower cost (utilizing fewer IPv4 addresses), and enables building out a true edge network with lower latency.
6728
- * **Cons**: Only 1 environment is allowed on the host. This is because the load balancer is the only ingress point for an environment, and if it is sharing
6729
- * the same IP as the host, that host can only operate under that environment.
6730
- * */
6731
- bind_host?: boolean | null;
6732
6906
  };
6733
6907
  /** DefaultLbType */
6734
6908
  DefaultLbType: {
@@ -6761,7 +6935,7 @@ export interface components {
6761
6935
  high_availability: boolean;
6762
6936
  /** @description A boolean representing if this service container is set to autoupdate or not */
6763
6937
  auto_update?: boolean;
6764
- config: components["schemas"]["LoadBalancerConfig"] | null;
6938
+ config?: components["schemas"]["LoadBalancerConfig"] | null;
6765
6939
  };
6766
6940
  /**
6767
6941
  * DiscoveryConfig
@@ -6769,6 +6943,8 @@ export interface components {
6769
6943
  */
6770
6944
  DiscoveryConfig: {
6771
6945
  empty_set_delay?: components["schemas"]["Duration"] | null;
6946
+ /** @description When enabled, discovery will return both IPv6 and IPv4 when in legacy mode. Otherwise, only IPv4 will be returned. */
6947
+ dual_stack_legacy?: boolean | null;
6772
6948
  /** @description A mapping of hostnames to IP addresses for custom internal resolutions. Acts as a custom /etc/resolv.conf file that works environment wide. */
6773
6949
  hosts?: {
6774
6950
  [key: string]: {
@@ -6779,7 +6955,7 @@ export interface components {
6779
6955
  };
6780
6956
  } | null;
6781
6957
  /** @description A list of custom DNS resolver strings. Can specifify domains or ips. */
6782
- custom_resolvers?: string[];
6958
+ custom_resolvers?: string[] | null;
6783
6959
  };
6784
6960
  /**
6785
6961
  * DiscoveryEnvironmentService
@@ -6795,7 +6971,7 @@ export interface components {
6795
6971
  /** @description A boolean where `true` represents the desire to automatically update the environment discovery service. */
6796
6972
  auto_update?: boolean;
6797
6973
  /** @description The config object for the discovery service. */
6798
- config: components["schemas"]["DiscoveryConfig"] | null;
6974
+ config?: components["schemas"]["DiscoveryConfig"] | null;
6799
6975
  };
6800
6976
  /**
6801
6977
  * VpnEnvironmentService
@@ -6809,7 +6985,7 @@ export interface components {
6809
6985
  /** @description A boolean representing if this service container is set to autoupdate or not */
6810
6986
  auto_update?: boolean;
6811
6987
  /** @description The config object for the VPN service. */
6812
- config: {
6988
+ config?: {
6813
6989
  /** @description If true, routes all traffic through the VPN, even non-Cycle traffic. */
6814
6990
  allow_internet: boolean;
6815
6991
  /** @description Auth configuration for the VPN. */
@@ -7281,7 +7457,7 @@ export interface components {
7281
7457
  * @enum {string}
7282
7458
  */
7283
7459
  type: "cycle-upload";
7284
- details?: {
7460
+ details: {
7285
7461
  /** @description The date-time at which the authorization token for uploading this image expires. */
7286
7462
  expires: components["schemas"]["DateTime"];
7287
7463
  /** @description The token that is required by the factory to accept an upload for this image. */
@@ -7329,7 +7505,7 @@ export interface components {
7329
7505
  * @enum {string}
7330
7506
  */
7331
7507
  type: "stack-build";
7332
- details?: {
7508
+ details: {
7333
7509
  id: string;
7334
7510
  stack_id: string;
7335
7511
  containers: components["schemas"]["Identifier"][];
@@ -7347,7 +7523,7 @@ export interface components {
7347
7523
  * @enum {string}
7348
7524
  */
7349
7525
  type: "direct";
7350
- details?: {
7526
+ details: {
7351
7527
  id: string;
7352
7528
  origin: components["schemas"]["ImageOrigin"];
7353
7529
  };
@@ -7363,7 +7539,7 @@ export interface components {
7363
7539
  * @enum {string}
7364
7540
  */
7365
7541
  type: "bucket";
7366
- details?: {
7542
+ details: {
7367
7543
  id: string;
7368
7544
  origin: components["schemas"]["ImageOrigin"];
7369
7545
  };
@@ -7581,6 +7757,12 @@ export interface components {
7581
7757
  decode: boolean | components["schemas"]["StackVariable"];
7582
7758
  /** @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}`. */
7583
7759
  path: (string | null) | components["schemas"]["StackVariable"];
7760
+ /** @description A linux file mode that will be set on the injected file. */
7761
+ permissions?: (string | null) | components["schemas"]["StackVariable"];
7762
+ /** @description The linux UID to set on the file. */
7763
+ uid?: (number | null) | components["schemas"]["StackVariable"];
7764
+ /** @description The linux GID to set on the file. */
7765
+ gid?: (number | null) | components["schemas"]["StackVariable"];
7584
7766
  } | null) | components["schemas"]["StackVariable"];
7585
7767
  } | components["schemas"]["StackVariable"];
7586
7768
  source?: (components["schemas"]["StackSpecScopedVariableUrlSource"] | components["schemas"]["StackSpecScopedVariableRawSource"]) | components["schemas"]["StackVariable"] | null;
@@ -7631,9 +7813,10 @@ export interface components {
7631
7813
  /** @description The strategy Cycle will apply when deploying instances of this container.
7632
7814
  *
7633
7815
  * - ** resource-density **: Cycle will distribute instances across servers to maintain balanced resource usage.
7634
- * - ** high-availability **: Cycle will deploy instances over servers with an emphasis on geographic and physical separation
7635
- * - ** first-available **: Cycle will deploy one instance to every node that matches the specified criteria. (default)
7636
- * - ** node **: Cycle will deploy one instance to every node that matches the specified criteria.
7816
+ * - ** high-availability **: Cycle will deploy instances across servers with an emphasis on geographic and physical separation. Requires multiple locations.
7817
+ * - ** distributed **: Cycle will deploy instances across servers with an emphasis on physical separation. Does not require multiple locations.
7818
+ * - ** first-available **: Cycle will deploy one instance to every server that matches the specified criteria. (default)
7819
+ * - ** node **: Cycle will deploy one instance to every server that matches the specified criteria.
7637
7820
  * - ** edge **: Cycle will prioritize geographic distribution of instances.
7638
7821
  * - ** function **: Every ingress request/connection receives its own instance.
7639
7822
  * - ** manual **: Cycle will not make any decisions on where instances are deployed. Instead, instances must be deployed manually using the portal or API.
@@ -7674,7 +7857,7 @@ export interface components {
7674
7857
  shutdown?: ({
7675
7858
  /** @description How long the platform will wait for a container to stop gracefully. */
7676
7859
  graceful_timeout?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"] | null;
7677
- signals?: ("SIGTERM" | "SIGINT" | "SIGUSR1" | "SIGUSR2" | "SIGHUB" | "SIGKILL" | "SIGQUIT")[] | components["schemas"]["StackVariable"];
7860
+ signals?: components["schemas"]["ShutdownSignal"][] | components["schemas"]["StackVariable"];
7678
7861
  } | null) | components["schemas"]["StackVariable"];
7679
7862
  /** @description Configuration options for how this container behaves during startup. */
7680
7863
  startup?: ({
@@ -7893,6 +8076,10 @@ export interface components {
7893
8076
  host?: ({
7894
8077
  /** @description If true, Cycle will mount the `/proc` directory into the container, giving it access to the host metrics. This is useful if you're running i.e. a monitoring agent. */
7895
8078
  expose_proc?: (boolean | null) | components["schemas"]["StackVariable"];
8079
+ /** @description If true, Cycle will mount the host's `/sys/fs/cgroups` directory into the container at `/var/run/cycle/host/cgroups`. */
8080
+ expose_cgroups?: (boolean | null) | components["schemas"]["StackVariable"];
8081
+ /** @description If true, Cycle will give the container instances access via internal api to power off or reboot the host server. */
8082
+ power_management?: (boolean | null) | components["schemas"]["StackVariable"];
7896
8083
  } | null) | components["schemas"]["StackVariable"];
7897
8084
  /** @description If true, the container process will run in fully-privileged mode. **WARNING** This is considered insecure, and should only be done if you know what you're doing. */
7898
8085
  privileged?: boolean | components["schemas"]["StackVariable"];
@@ -8083,6 +8270,8 @@ export interface components {
8083
8270
  /** StackSpecDiscoveryConfig */
8084
8271
  StackSpecDiscoveryConfig: {
8085
8272
  empty_set_delay?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"] | null;
8273
+ /** @description When enabled, discovery will return both IPv6 and IPv4 when in legacy mode. Otherwise, only IPv4 will be returned. */
8274
+ dual_stack_legacy?: boolean | components["schemas"]["StackVariable"] | null;
8086
8275
  /** @description A custom mapping of hosts - for forced resolution of specific IPs for a domain. */
8087
8276
  hosts?: ({
8088
8277
  [key: string]: {
@@ -8169,13 +8358,6 @@ export interface components {
8169
8358
  */
8170
8359
  type: "haproxy";
8171
8360
  details: components["schemas"]["StackSpecHaProxyConfig"] | components["schemas"]["StackVariable"] | null;
8172
- /** @description Binds the load balancer to the host server IP address.
8173
- *
8174
- * **Pros**: This allows for significantly lower cost (utilizing fewer IPv4 addresses), and enables building out a true edge network with lower latency.
8175
- * **Cons**: Only 1 environment is allowed on the host. This is because the load balancer is the only ingress point for an environment, and if it is sharing
8176
- * the same IP as the host, that host can only operate under that environment.
8177
- * */
8178
- bind_host?: (boolean | null) | components["schemas"]["StackVariable"];
8179
8361
  };
8180
8362
  /**
8181
8363
  * StackSpecWafConfig
@@ -8189,6 +8371,8 @@ export interface components {
8189
8371
  skip: boolean | components["schemas"]["StackVariable"];
8190
8372
  /** @description A string that describes if the role should allow or deny traffic based on the conditions. */
8191
8373
  type: ("allow" | "deny") | components["schemas"]["StackVariable"];
8374
+ /** @description The expiration date of the WAF config, if present. */
8375
+ expires?: string | components["schemas"]["StackVariable"] | null;
8192
8376
  /** @description A string that describes if both attributes need to be true (match all) or if only one of the conditions needs to be true (match any). */
8193
8377
  match?: ("any" | "all") | components["schemas"]["StackVariable"];
8194
8378
  /** @description An array of the specific conditions for the rule. */
@@ -8381,15 +8565,15 @@ export interface components {
8381
8565
  /** @description How to route the traffic to the destination.
8382
8566
  * `random`: Pick a valid destination at random.
8383
8567
  * `round-robin`: Send each request to the 'next' destination on the list, restarting from the beginning when the last destination is used.
8568
+ * `source-ip`: Utilizes a hash function to ensure traffic from an IP will always hit the same destination instance.
8384
8569
  * */
8385
- mode: ("random" | "round-robin") | components["schemas"]["StackVariable"];
8570
+ mode: ("random" | "round-robin" | "source-ip") | components["schemas"]["StackVariable"];
8386
8571
  config: {
8387
8572
  /** @description If a request comes in from the same origin, ensure it hits the same destination. */
8388
8573
  sticky_sessions: boolean | components["schemas"]["StackVariable"];
8389
8574
  /** @description If a destination is unavailable, retry up to [x] times, instead of immediately failing with a 503/504 error. */
8390
8575
  destination_retries: number | components["schemas"]["StackVariable"];
8391
- /** @default null */
8392
- destination_prioritization: ("latency" | "random") | components["schemas"]["StackVariable"] | null;
8576
+ destination_prioritization?: ("latency" | "random") | components["schemas"]["StackVariable"] | null;
8393
8577
  /** @description TLS termination configuration. If null, the platform will use the default configuration. Port 443 by default has TLS termination enabled. */
8394
8578
  tls?: ({
8395
8579
  /** @description [Advanced] Change the domain the controller listens on.
@@ -8477,13 +8661,6 @@ export interface components {
8477
8661
  */
8478
8662
  type: "v1";
8479
8663
  details: components["schemas"]["StackSpecV1LbConfig"] | components["schemas"]["StackVariable"];
8480
- /** @description Binds the load balancer to the host server IP address.
8481
- *
8482
- * **Pros**: This allows for significantly lower cost (utilizing fewer IPv4 addresses), and enables building out a true edge network with lower latency.
8483
- * **Cons**: Only 1 environment is allowed on the host. This is because the load balancer is the only ingress point for an environment, and if it is sharing
8484
- * the same IP as the host, that host can only operate under that environment.
8485
- * */
8486
- bind_host?: (boolean | null) | components["schemas"]["StackVariable"];
8487
8664
  };
8488
8665
  /** StackSpecDefaultLbType */
8489
8666
  StackSpecDefaultLbType: {
@@ -8839,8 +9016,16 @@ export interface components {
8839
9016
  */
8840
9017
  action: "stop";
8841
9018
  };
8842
- /** ReconfigureContainer */
8843
- ReconfigureContainer: {
9019
+ /** ContainerRetartActionTask */
9020
+ ContainerRestartAction: {
9021
+ /**
9022
+ * @description The name of the action to perform. (enum property replaced by openapi-typescript)
9023
+ * @enum {string}
9024
+ */
9025
+ action: "restart";
9026
+ };
9027
+ /** ContainerReconfigureAction */
9028
+ ContainerReconfigureAction: {
8844
9029
  /**
8845
9030
  * @description The action to take. (enum property replaced by openapi-typescript)
8846
9031
  * @enum {string}
@@ -8848,8 +9033,8 @@ export interface components {
8848
9033
  action: "reconfigure";
8849
9034
  contents: components["schemas"]["Config"];
8850
9035
  };
8851
- /** ReconfigureVolumeTask */
8852
- ReconfigureVolumes: {
9036
+ /** ContainerReconfigureVolumesAction */
9037
+ ContainerReconfigureVolumesAction: {
8853
9038
  /**
8854
9039
  * @description The action to take. (enum property replaced by openapi-typescript)
8855
9040
  * @enum {string}
@@ -8858,8 +9043,8 @@ export interface components {
8858
9043
  /** @description An array of volume objects to be reconfigured. */
8859
9044
  contents: components["schemas"]["VolumeSummary"][];
8860
9045
  };
8861
- /** ReimageContainer */
8862
- Reimage: {
9046
+ /** ContainerReimageAction */
9047
+ ContainerReimageAction: {
8863
9048
  /**
8864
9049
  * @description The action to take. (enum property replaced by openapi-typescript)
8865
9050
  * @enum {string}
@@ -8875,8 +9060,8 @@ export interface components {
8875
9060
  overwrite_runtime_config?: boolean;
8876
9061
  };
8877
9062
  };
8878
- /** ScaleContainer */
8879
- Scale: {
9063
+ /** ContainerScaleAction */
9064
+ ContainerScaleAction: {
8880
9065
  /**
8881
9066
  * @description The action to take. (enum property replaced by openapi-typescript)
8882
9067
  * @enum {string}
@@ -8888,6 +9073,8 @@ export interface components {
8888
9073
  instances: number;
8889
9074
  };
8890
9075
  };
9076
+ /** ContainerTask */
9077
+ ContainerTask: components["schemas"]["ContainerStartAction"] | components["schemas"]["ContainerStopAction"] | components["schemas"]["ContainerRestartAction"] | components["schemas"]["ContainerReconfigureAction"] | components["schemas"]["ContainerReconfigureVolumesAction"] | components["schemas"]["ContainerReimageAction"] | components["schemas"]["ContainerScaleAction"];
8891
9078
  /**
8892
9079
  * ServerInstancesSummary
8893
9080
  * @description A Server ID and number of Instances of a specific Container it hosts.
@@ -8983,7 +9170,7 @@ export interface components {
8983
9170
  * @description The current state of the server.
8984
9171
  * @enum {string}
8985
9172
  */
8986
- current: "new" | "provisioning" | "configuring" | "live" | "deleting" | "deleted";
9173
+ current: "new" | "provisioning" | "configuring" | "quarantined" | "live" | "deleting" | "deleted";
8987
9174
  } & components["schemas"]["State"];
8988
9175
  /** NodeState */
8989
9176
  NodeState: {
@@ -9003,15 +9190,21 @@ export interface components {
9003
9190
  interfaces?: {
9004
9191
  [key: string]: {
9005
9192
  /** @description The interface name. */
9006
- interface?: string;
9193
+ interface: string;
9007
9194
  /** @description Flags for the given interface. */
9008
- flags?: string;
9195
+ flags: string;
9009
9196
  /** @description The maximum transmission unit for the interface. */
9010
- mtu?: number;
9197
+ mtu: number;
9011
9198
  /** @description The mac address for the interface. */
9012
- mac_addr?: string;
9199
+ mac_addr: string;
9013
9200
  /** @description An array of IP addresses associated with the interface. */
9014
9201
  addrs?: string[] | null;
9202
+ /** @description The link speed for the interface in megabits. */
9203
+ speed: number;
9204
+ /** @description The bytes received over the interface. */
9205
+ rx_bytes: number;
9206
+ /** @description The bytes transmitted over the interface. */
9207
+ tx_bytes: number;
9015
9208
  };
9016
9209
  };
9017
9210
  /** @description The public IPv4 address used to connect to this server. */
@@ -9060,6 +9253,8 @@ export interface components {
9060
9253
  speed?: number;
9061
9254
  }[];
9062
9255
  usage?: components["schemas"]["ServerStatsCpuUsage"];
9256
+ /** @description A true value indicates the server supports virtualization. */
9257
+ virtualization?: boolean;
9063
9258
  };
9064
9259
  /**
9065
9260
  * ServerStatsLoad
@@ -9153,6 +9348,22 @@ export interface components {
9153
9348
  /** @description The hostname as set by the given server's OS. */
9154
9349
  hostname?: string;
9155
9350
  };
9351
+ /**
9352
+ * ServerStatsVendor
9353
+ * @description Details about the vendors for the server.
9354
+ */
9355
+ ServerStatsVendor: {
9356
+ /** @description The system vendor of the server. */
9357
+ system_vendor?: string;
9358
+ /** @description The board vendor of the server. */
9359
+ board_vendor?: string;
9360
+ /** @description The board name of the server. */
9361
+ board_name?: string;
9362
+ /** @description The board serial number of the server. */
9363
+ board_serial?: string;
9364
+ /** @description The bios vendor of the server. */
9365
+ bios_vendor?: string;
9366
+ };
9156
9367
  /**
9157
9368
  * ServerStatsVersions
9158
9369
  * @description Information about the versions of Cycle services on a given server.
@@ -9175,6 +9386,7 @@ export interface components {
9175
9386
  ram: components["schemas"]["ServerStatsRam"];
9176
9387
  storage: components["schemas"]["ServerStatsStorage"];
9177
9388
  os: components["schemas"]["ServerStatsOS"];
9389
+ vendor: components["schemas"]["ServerStatsVendor"];
9178
9390
  versions: components["schemas"]["ServerStatsVersions"];
9179
9391
  };
9180
9392
  /**
@@ -9225,6 +9437,8 @@ export interface components {
9225
9437
  shared_file_systems: components["schemas"]["ServerSharedFileSystems"];
9226
9438
  /** @description The server hostname. */
9227
9439
  hostname: string;
9440
+ /** @description A custom name given to the server for identification purposes. Does not affect server hostname. */
9441
+ nickname?: string | null;
9228
9442
  creator: components["schemas"]["CreatorScope"];
9229
9443
  provider: components["schemas"]["ServerProvider"];
9230
9444
  /** @description The cluster the given server is deployed to. */
@@ -9298,6 +9512,7 @@ export interface components {
9298
9512
  location: string;
9299
9513
  /** @description A location code returned from the provider. */
9300
9514
  code: string;
9515
+ vendor: string;
9301
9516
  availability_zones?: string[];
9302
9517
  };
9303
9518
  /**
@@ -9586,44 +9801,45 @@ export interface components {
9586
9801
  type: "string";
9587
9802
  default?: string | null;
9588
9803
  };
9804
+ /** IntegrationDefinitionField */
9805
+ IntegrationDefinitionField: {
9806
+ regex?: string | null;
9807
+ required: boolean;
9808
+ description: string;
9809
+ /** @enum {string} */
9810
+ type?: "select" | "string" | "int" | "blob";
9811
+ options?: string[] | null;
9812
+ };
9589
9813
  /**
9590
9814
  * IntegrationDefinition
9591
- * @description Describes an integration for a Cycle Hub that can be enabled by the Hub owner.
9815
+ * @description Describes an integration for a Cycle hub that can be enabled by the hub owner.
9592
9816
  */
9593
9817
  IntegrationDefinition: {
9594
9818
  vendor: string;
9595
9819
  name: string;
9596
9820
  supports_verification: boolean;
9597
9821
  supports_multiple: boolean;
9598
- /** @description A list of additional features supported by this Integration. */
9599
9822
  features?: string[] | null;
9600
- /** @description A list of functionality that this integration extends. i.e. ["backups"] */
9601
9823
  extends?: string[] | null;
9602
- /** @description Additional configuration options that are available when using this Integration. These describe additional functionality that Cycle may utilize. */
9603
9824
  extended_configuration?: {
9604
9825
  options?: (components["schemas"]["IntegrationAdvancedOptionBoolean"] | components["schemas"]["IntegrationAdvancedOptionInt"] | components["schemas"]["IntegrationAdvancedOptionString"])[] | null;
9605
9826
  } | null;
9606
9827
  fields?: {
9607
9828
  extra?: {
9608
- [key: string]: {
9609
- regex?: string | null;
9610
- required: boolean;
9611
- description: string;
9612
- };
9829
+ [key: string]: components["schemas"]["IntegrationDefinitionField"];
9613
9830
  } | null;
9614
9831
  auth?: {
9615
- [key: string]: {
9616
- regex?: string | null;
9617
- required: boolean;
9618
- description: string;
9619
- };
9832
+ [key: string]: components["schemas"]["IntegrationDefinitionField"];
9620
9833
  } | null;
9621
9834
  };
9622
9835
  /** Format: uri */
9623
9836
  url: string;
9624
9837
  public: boolean;
9838
+ /** @description Whether or not this integration can be used at this time. */
9625
9839
  usable: boolean;
9626
- /** @description If true, the Integration can be edited. Otherwise, to make a change it will need to be deleted and recreated. */
9840
+ /** @description If true, this integration is no longer being supported and may be removed in the future. New instances of this integration will not be able to be created. */
9841
+ deprecated?: boolean;
9842
+ /** @description If true, the integration can be edited. Otherwise, to make a change it will need to be deleted and recreated. */
9627
9843
  editable: boolean;
9628
9844
  };
9629
9845
  /**
@@ -9740,6 +9956,13 @@ export interface components {
9740
9956
  InstanceAutoScale: {
9741
9957
  min_ttl: components["schemas"]["DateTime"];
9742
9958
  };
9959
+ /**
9960
+ * InstanceTrafficDrain
9961
+ * @description Traffic drain details for instance.
9962
+ */
9963
+ InstanceTrafficDrain: {
9964
+ started: components["schemas"]["DateTime"];
9965
+ };
9743
9966
  /**
9744
9967
  * MigrationInstance
9745
9968
  * @description Information about a migrated instance.
@@ -9766,6 +9989,18 @@ export interface components {
9766
9989
  /** @description A boolean where true represents the volumes for the instance should be copied to the new server as well. */
9767
9990
  copy_volumes: boolean;
9768
9991
  };
9992
+ /**
9993
+ * InstanceMeta
9994
+ * @description A list of meta fields that can be applied to an instance.
9995
+ */
9996
+ InstanceMeta: {
9997
+ node?: {
9998
+ healthy?: boolean;
9999
+ online?: boolean;
10000
+ last_checkin?: components["schemas"]["DateTime"];
10001
+ state?: components["schemas"]["NodeState"];
10002
+ };
10003
+ };
9769
10004
  /**
9770
10005
  * Instance
9771
10006
  * @description An instance of a Container.
@@ -9807,6 +10042,7 @@ export interface components {
9807
10042
  extension?: components["schemas"]["ContainerExtension"] | null;
9808
10043
  state: components["schemas"]["InstanceState"];
9809
10044
  autoscale?: components["schemas"]["InstanceAutoScale"] | null;
10045
+ traffic_drain?: components["schemas"]["InstanceTrafficDrain"] | null;
9810
10046
  migration?: components["schemas"]["InstanceMigration"] | null;
9811
10047
  deployment?: components["schemas"]["Deployment"] | null;
9812
10048
  /**
@@ -9821,6 +10057,7 @@ export interface components {
9821
10057
  /** @description The timestamp of when the instance was deleted. */
9822
10058
  deleted: components["schemas"]["DateTime"];
9823
10059
  };
10060
+ meta?: components["schemas"]["InstanceMeta"] | null;
9824
10061
  };
9825
10062
  /**
9826
10063
  * ServerIncludes
@@ -9889,8 +10126,8 @@ export interface components {
9889
10126
  /** @description The SSH connection response address. */
9890
10127
  address: string;
9891
10128
  };
9892
- /** MigrateAction */
9893
- Migrate: {
10129
+ /** InstanceMigrateAction */
10130
+ InstanceMigrateAction: {
9894
10131
  /**
9895
10132
  * @description The name of the action to perform. (enum property replaced by openapi-typescript)
9896
10133
  * @enum {string}
@@ -9906,16 +10143,16 @@ export interface components {
9906
10143
  };
9907
10144
  };
9908
10145
  };
9909
- /** RevertMigrationAction */
9910
- RevertMigration: {
10146
+ /** InstanceRevertMigrationAction */
10147
+ InstanceRevertMigrationAction: {
9911
10148
  /**
9912
10149
  * @description The name of the action to perform. (enum property replaced by openapi-typescript)
9913
10150
  * @enum {string}
9914
10151
  */
9915
10152
  action: "migration.revert";
9916
10153
  };
9917
- /** ExtendVolumeAction */
9918
- ExtendVolume: {
10154
+ /** InstanceExtendVolumeAction */
10155
+ InstanceExtendVolumeAction: {
9919
10156
  /**
9920
10157
  * @description The name of the action to perform. (enum property replaced by openapi-typescript)
9921
10158
  * @enum {string}
@@ -9928,6 +10165,20 @@ export interface components {
9928
10165
  extend_size: string;
9929
10166
  };
9930
10167
  };
10168
+ /** InstanceTrafficDrainReconfigure */
10169
+ InstanceTrafficDrainReconfigure: {
10170
+ /**
10171
+ * @description The name of the action to perform. (enum property replaced by openapi-typescript)
10172
+ * @enum {string}
10173
+ */
10174
+ action: "traffic-drain.reconfigure";
10175
+ contents: {
10176
+ /** @description Enable or disable traffic drain for the instance. */
10177
+ enable: boolean;
10178
+ };
10179
+ };
10180
+ /** InstanceTask */
10181
+ InstanceTask: components["schemas"]["InstanceMigrateAction"] | components["schemas"]["InstanceRevertMigrationAction"] | components["schemas"]["InstanceExtendVolumeAction"] | components["schemas"]["InstanceTrafficDrainReconfigure"];
9931
10182
  /**
9932
10183
  * DeployedVolume
9933
10184
  * @description A deployed volume resource.
@@ -10114,18 +10365,8 @@ export interface components {
10114
10365
  /** @description An array of telemetry snapshots. */
10115
10366
  snapshots: components["schemas"]["ResourceSnapshot"][];
10116
10367
  };
10117
- /**
10118
- * FunctionRuntimeVariables
10119
- * @description Variables that affect the runtime of a function container.
10120
- */
10121
- FunctionRuntimeVariables: {
10122
- /** @description Environment variables to inject into the container. */
10123
- environment_variables?: {
10124
- [key: string]: string;
10125
- } | null;
10126
- };
10127
- /** TriggerAction */
10128
- trigger: {
10368
+ /** FunctionTriggerAction */
10369
+ FunctionTriggerAction: {
10129
10370
  /**
10130
10371
  * @description The name of the action to perform. (enum property replaced by openapi-typescript)
10131
10372
  * @enum {string}
@@ -10137,6 +10378,18 @@ export interface components {
10137
10378
  runtime_variables: components["schemas"]["FunctionRuntimeVariables"];
10138
10379
  };
10139
10380
  };
10381
+ /**
10382
+ * FunctionRuntimeVariables
10383
+ * @description Variables that affect the runtime of a function container.
10384
+ */
10385
+ FunctionRuntimeVariables: {
10386
+ /** @description Environment variables to inject into the container. */
10387
+ environment_variables?: {
10388
+ [key: string]: string;
10389
+ } | null;
10390
+ };
10391
+ /** FunctionTask */
10392
+ FunctionTask: components["schemas"]["FunctionTriggerAction"];
10140
10393
  /**
10141
10394
  * ContainerBackupTarget
10142
10395
  * @description A target for the given Container Backup.
@@ -10232,8 +10485,8 @@ export interface components {
10232
10485
  deleted: components["schemas"]["DateTime"];
10233
10486
  };
10234
10487
  };
10235
- /** DNSZoneState */
10236
- ZoneState: {
10488
+ /** DnsZoneState */
10489
+ DnsZoneState: {
10237
10490
  /**
10238
10491
  * @description The current state of the zone.
10239
10492
  * @enum {string}
@@ -10241,10 +10494,10 @@ export interface components {
10241
10494
  current: "new" | "pending" | "verifying" | "live" | "disabled" | "deleting" | "deleted";
10242
10495
  } & components["schemas"]["State"];
10243
10496
  /**
10244
- * DNSZone
10497
+ * DnsZone
10245
10498
  * @description DNS (Domain Name System), in short, is a decentralized naming system for computers, services, or other resources connected to the internet or a private network. It is what allows the translation of a URL, such as http://example.com, to an IP address.
10246
10499
  */
10247
- Zone: {
10500
+ DnsZone: {
10248
10501
  id: components["schemas"]["ID"];
10249
10502
  hub_id: components["schemas"]["HubID"];
10250
10503
  creator: components["schemas"]["CreatorScope"];
@@ -10253,7 +10506,7 @@ export interface components {
10253
10506
  /** @description A boolean where true represents this zone is a hosted zone. */
10254
10507
  hosted: boolean;
10255
10508
  acl?: components["schemas"]["ACL"] | null;
10256
- state: components["schemas"]["ZoneState"];
10509
+ state: components["schemas"]["DnsZoneState"];
10257
10510
  /**
10258
10511
  * ZoneEvents
10259
10512
  * @description A collection of timestamps for each event in the DNS zone's lifetime.
@@ -10272,53 +10525,361 @@ export interface components {
10272
10525
  };
10273
10526
  };
10274
10527
  /**
10275
- * ZoneIncludes
10528
+ * DnsZoneIncludes
10276
10529
  * @description All includable resources linkable to the given Zone.
10277
10530
  */
10278
- ZoneIncludes: {
10531
+ DnsZoneIncludes: {
10279
10532
  creators?: components["schemas"]["CreatorInclude"];
10280
10533
  };
10281
10534
  /**
10282
- * RecordIncludes
10283
- * @description All includable resources linkable to the given records.
10535
+ * VirtualMachineNetworkConfig
10536
+ * @description Defines the network settings for a virtual machine, including public access mode, hostname, and ports.
10537
+ *
10284
10538
  */
10285
- RecordIncludes: {
10286
- creators?: components["schemas"]["CreatorInclude"];
10287
- containers?: components["schemas"]["ContainersIncludes"];
10288
- "containers:identifiers"?: components["schemas"]["IdentifierIncludes"];
10539
+ VirtualMachineNetworkConfig: {
10540
+ /**
10541
+ * @description Controls the public network mode for the virtual machine.
10542
+ * @enum {string}
10543
+ */
10544
+ public: "enable" | "disable" | "egress-only";
10545
+ /** @description The hostname assigned to the virtual machine. */
10546
+ hostname: string;
10547
+ /** @description Port configurations for the virtual machine. */
10548
+ ports?: string[] | null;
10289
10549
  };
10290
10550
  /**
10291
- * DNSTLSAttempt
10292
- * @description A DNS TLS certificate generation attempt resource.
10551
+ * VirtualMachineDeployTags
10552
+ * @description Tags that define node requirements for the deployment. The `any` tag must match at least one condition, while `all` must match all conditions.
10553
+ *
10293
10554
  */
10294
- Attempt: {
10295
- id: components["schemas"]["ID"];
10296
- hub_id: components["schemas"]["HubID"];
10297
- /** @description A list of domains associated with the attempt. */
10298
- domains: string[];
10299
- /** @description A timestamp for when the attempt took place. */
10300
- time: components["schemas"]["DateTime"];
10301
- /** @description A boolean where true means the attept was successful at creating the TLS certificate. */
10302
- success: boolean;
10303
- /** @description If success is false this property will be populated with an error. */
10304
- error?: string;
10555
+ VirtualMachineDeployTags: {
10556
+ any?: string[] | null;
10557
+ all?: string[] | null;
10305
10558
  };
10306
10559
  /**
10307
- * TlsCertificate
10308
- * @description A TLS certificate.
10560
+ * VirtualMachineNodeConstraints
10561
+ * @description Node-level constraints for the virtual machine deployment, specifying tags that must or must not be present.
10562
+ *
10309
10563
  */
10310
- TlsCertificate: {
10311
- id: components["schemas"]["ID"];
10312
- /** @description Whether or not this certificate was uploaded instead of generated by the platform. */
10313
- user_supplied: boolean;
10314
- domains: string[] | null;
10315
- hub_id?: components["schemas"]["ID"] | null;
10316
- expires: components["schemas"]["DateTime"];
10317
- state: {
10318
- /**
10319
- * @description The current state of the TLS certificate.
10320
- * @enum {string}
10321
- */
10564
+ VirtualMachineNodeConstraints: {
10565
+ tags: components["schemas"]["VirtualMachineDeployTags"];
10566
+ };
10567
+ /**
10568
+ * VirtualMachineDeployConstraints
10569
+ * @description Constraints define node-level and resource restrictions for the virtual machine deployment.
10570
+ *
10571
+ */
10572
+ VirtualMachineDeployConstraints: {
10573
+ node?: components["schemas"]["VirtualMachineNodeConstraints"] | null;
10574
+ secrets?: string[] | null;
10575
+ containers?: string[] | null;
10576
+ };
10577
+ /**
10578
+ * VirtualMachineShutdownPolicy
10579
+ * @description The shutdown policy defines how the virtual machine should handle shutdown, including a timeout and signals to be sent during shutdown.
10580
+ *
10581
+ */
10582
+ VirtualMachineShutdownPolicy: {
10583
+ /** @description The timeout period for graceful shutdown. */
10584
+ graceful_timeout?: components["schemas"]["Duration"] | null;
10585
+ };
10586
+ /**
10587
+ * VirtualMachineStartupPolicy
10588
+ * @description The startup policy defines how the virtual machine should handle startup, including a possible delay before starting the machine.
10589
+ *
10590
+ */
10591
+ VirtualMachineStartupPolicy: {
10592
+ /** @description Delay before startup. */
10593
+ delay?: components["schemas"]["Duration"] | null;
10594
+ };
10595
+ /**
10596
+ * VirtualMachineTelemetryConfig
10597
+ * @description The telemetry configuration defines how telemetry data is handled, including retention, interval, and whether telemetry is disabled.
10598
+ *
10599
+ */
10600
+ VirtualMachineTelemetryConfig: {
10601
+ /** @description Data retention duration for telemetry. */
10602
+ retention?: components["schemas"]["Duration"] | null;
10603
+ /** @description Telemetry collection interval. */
10604
+ interval?: components["schemas"]["Duration"] | null;
10605
+ /** @description Whether telemetry collection is disabled. */
10606
+ disable: boolean;
10607
+ };
10608
+ /**
10609
+ * VirtualMachineDeployConfig
10610
+ * @description Represents the deployment configuration for a virtual machine, including constraints, shutdown/startup policies, restart conditions, and telemetry settings.
10611
+ *
10612
+ */
10613
+ VirtualMachineDeployConfig: {
10614
+ constraints?: components["schemas"]["VirtualMachineDeployConstraints"] | null;
10615
+ shutdown?: components["schemas"]["VirtualMachineShutdownPolicy"] | null;
10616
+ startup?: components["schemas"]["VirtualMachineStartupPolicy"] | null;
10617
+ telemetry?: components["schemas"]["VirtualMachineTelemetryConfig"] | null;
10618
+ };
10619
+ /**
10620
+ * VirtualMachineRamResources
10621
+ * @description Defines the RAM configuration of a virtual machine.
10622
+ *
10623
+ */
10624
+ VirtualMachineRamResources: {
10625
+ /** @description The limit (maximum) amount of RAM the virtual machine can consume. Must be at least 512M and less than 65GB. */
10626
+ limit: string;
10627
+ /** @description Whether or not the RAM set in limit should be preallocated. */
10628
+ allocate?: boolean | null;
10629
+ };
10630
+ /**
10631
+ * VirtualMachineCpuResources
10632
+ * @description Defines the CPU configuration of a virtual machine. Set **either** `cores` or `cpus`.
10633
+ *
10634
+ */
10635
+ VirtualMachineCpuResources: {
10636
+ cores?: {
10637
+ /** @description The number of cores to assign to this virtual machine. Must be between 1 and 32. */
10638
+ number: number;
10639
+ /** @description If true, reserves the cores so they cannot be used by any other virtual machine. */
10640
+ allocate?: boolean | null;
10641
+ } | null;
10642
+ /** @description The specific cores/range of cores to allocate to the virtual machine. An 'x' indicates the maximum core for a given machine. */
10643
+ cpus?: string | null;
10644
+ };
10645
+ /**
10646
+ * VirtualMachineResourcesConfig
10647
+ * @description Defines the resource settings for a virtual machine, including CPU and RAM.
10648
+ *
10649
+ */
10650
+ VirtualMachineResourcesConfig: {
10651
+ ram: components["schemas"]["VirtualMachineRamResources"];
10652
+ cpu: components["schemas"]["VirtualMachineCpuResources"];
10653
+ };
10654
+ /**
10655
+ * VirtualMachineConfig
10656
+ * @description Defines the network and deployment configurations for a virtual machine.
10657
+ *
10658
+ */
10659
+ VirtualMachineConfig: {
10660
+ network: components["schemas"]["VirtualMachineNetworkConfig"];
10661
+ deploy: components["schemas"]["VirtualMachineDeployConfig"];
10662
+ resources: components["schemas"]["VirtualMachineResourcesConfig"];
10663
+ };
10664
+ /**
10665
+ * VirtualMachineImageSourceUrl
10666
+ * @description A virtual machine image sourced from a URL.
10667
+ */
10668
+ VirtualMachineImageSourceUrl: {
10669
+ /**
10670
+ * @description discriminator enum property added by openapi-typescript
10671
+ * @enum {string}
10672
+ */
10673
+ type: "url";
10674
+ details: {
10675
+ /** @description The URL where a custom image is located. */
10676
+ url: string;
10677
+ };
10678
+ };
10679
+ /**
10680
+ * VirtualMachineImageSourceIpxe
10681
+ * @description A virtual machine image sourced from an IPXE script.
10682
+ */
10683
+ VirtualMachineImageSourceIpxe: {
10684
+ /**
10685
+ * @description discriminator enum property added by openapi-typescript
10686
+ * @enum {string}
10687
+ */
10688
+ type: "ipxe";
10689
+ details: {
10690
+ /** @description A URL that points to an IPXE script. */
10691
+ chain_url?: string | null;
10692
+ /** @description An inline IPXE script. */
10693
+ script?: string | null;
10694
+ };
10695
+ };
10696
+ /**
10697
+ * VirtualMachineImageSourceBase
10698
+ * @description A virtual machine image sourced from a Cycle base image.
10699
+ */
10700
+ VirtualMachineImageSourceBase: {
10701
+ /**
10702
+ * @description discriminator enum property added by openapi-typescript
10703
+ * @enum {string}
10704
+ */
10705
+ type: "base";
10706
+ details: {
10707
+ /** @description The base image identifier. */
10708
+ identifier: string;
10709
+ };
10710
+ };
10711
+ /**
10712
+ * VirtualMachineImage
10713
+ * @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. The `base` field allows users to specify the name of a desired Cycle-hosted base image, removing the need for a custom image URL.
10714
+ *
10715
+ */
10716
+ VirtualMachineImage: components["schemas"]["VirtualMachineImageSourceUrl"] | components["schemas"]["VirtualMachineImageSourceIpxe"] | components["schemas"]["VirtualMachineImageSourceBase"];
10717
+ /**
10718
+ * VirtualMachineVolumeConfig
10719
+ * @description Represents the configuration for a volume attached to a virtual machine.
10720
+ *
10721
+ */
10722
+ VirtualMachineVolumeConfig: {
10723
+ /** @description Configuration details for a local volume, if applicable. */
10724
+ local?: {
10725
+ /** @description The maximum size allowed for the local volume. */
10726
+ max_size: string;
10727
+ /** @description Indicates if the volume is part of a storage pool. */
10728
+ storage_pool?: boolean | null;
10729
+ } | null;
10730
+ identifier: components["schemas"]["Identifier"];
10731
+ /** @description Specifies if the volume is mounted as read-only. */
10732
+ read_only: boolean;
10733
+ };
10734
+ /**
10735
+ * VirtualMachineVolume
10736
+ * @description Represents a storage volume attached to a virtual machine.
10737
+ *
10738
+ */
10739
+ VirtualMachineVolume: {
10740
+ id: components["schemas"]["ID"];
10741
+ /** @description A unique hash identifying the volume for the virtual machine. */
10742
+ hash: string;
10743
+ /** @description The configuration details for the virtual machine's volume. */
10744
+ config: components["schemas"]["VirtualMachineVolumeConfig"];
10745
+ };
10746
+ /** VirtualMachineState */
10747
+ VirtualMachineState: {
10748
+ /**
10749
+ * @description The current state of the virtual machine.
10750
+ * @enum {string}
10751
+ */
10752
+ current: "new" | "starting" | "running" | "stopping" | "stopped" | "deleting" | "deleted";
10753
+ } & components["schemas"]["State"];
10754
+ /**
10755
+ * VirtualMachineMeta
10756
+ * @description Fields that can be included on a per-virtual machine basis, specific to that virtual machine.
10757
+ */
10758
+ VirtualMachineMeta: {
10759
+ domains?: {
10760
+ /** @description The fully qualified domain name. */
10761
+ fqdn: string;
10762
+ record?: components["schemas"]["DnsRecord"] | null;
10763
+ }[] | null;
10764
+ /** @description An array of public IP addresses associated with this virtual machine. */
10765
+ ips?: components["schemas"]["Ip"][] | null;
10766
+ /** @description The server the virtual machine is deployed to. */
10767
+ server?: components["schemas"]["Server"] | null;
10768
+ /** @description An array of private IP addresses associated with this virtual machine. */
10769
+ vm_priv_ips?: {
10770
+ ipv4?: string;
10771
+ ipv6?: string;
10772
+ } | null;
10773
+ };
10774
+ /**
10775
+ * VirtualMachine
10776
+ * @description Describes a virtual machine running on the Cycle Platform.
10777
+ *
10778
+ */
10779
+ VirtualMachine: {
10780
+ id: components["schemas"]["ID"];
10781
+ /** @description A user-defined name for the virtual machine. */
10782
+ name: string;
10783
+ identifier: components["schemas"]["Identifier"];
10784
+ creator: components["schemas"]["CreatorScope"];
10785
+ /** @description Basic information about the environment this virtual machine is in.
10786
+ * */
10787
+ environment: {
10788
+ id: components["schemas"]["ID"];
10789
+ /** @description The cluster this environment is associated with. */
10790
+ cluster: components["schemas"]["Identifier"];
10791
+ };
10792
+ hub_id: components["schemas"]["HubID"];
10793
+ config: components["schemas"]["VirtualMachineConfig"];
10794
+ image: components["schemas"]["VirtualMachineImage"];
10795
+ container_id?: components["schemas"]["ID"];
10796
+ volumes?: components["schemas"]["VirtualMachineVolume"][] | null;
10797
+ /** @description Metadata annotations for the virtual machine. */
10798
+ annotations?: {
10799
+ [key: string]: unknown;
10800
+ } | null;
10801
+ /** @description The size of the base disk. Must be between 10G and 100G. */
10802
+ base_disk_size?: string;
10803
+ /** @description The generated root password for the virtual machine. Only visible by the owner, or if it was created in the last ten minutes. */
10804
+ root_password?: {
10805
+ changed: components["schemas"]["DateTime"];
10806
+ /** @description The root password. */
10807
+ current: string | null;
10808
+ };
10809
+ /** @description An array of IDs corresponding to SSH keys that have been assigned to this virtual machine. */
10810
+ ssh_keys?: components["schemas"]["ID"][] | null;
10811
+ state: components["schemas"]["VirtualMachineState"];
10812
+ /**
10813
+ * VirtualMachineEvents
10814
+ * @description A collection of timestamps for each event in the virtual machine's lifetime.
10815
+ */
10816
+ events: {
10817
+ /** @description The timestamp of when the virtual machine was created. */
10818
+ created: components["schemas"]["DateTime"];
10819
+ /** @description The timestamp of when the virtual machine was updated. */
10820
+ updated: components["schemas"]["DateTime"];
10821
+ /** @description The timestamp of when the virtual machine was deleted. */
10822
+ deleted: components["schemas"]["DateTime"];
10823
+ /** @description The timestamp of when the virtual machine was started. */
10824
+ started: components["schemas"]["DateTime"];
10825
+ };
10826
+ /** @description A boolean flag indicating if this virtual machine is deprecated. */
10827
+ deprecate: boolean;
10828
+ /** @description Prevents this virtual machine from being deleted when true. */
10829
+ lock: boolean;
10830
+ meta?: components["schemas"]["VirtualMachineMeta"] | null;
10831
+ };
10832
+ /**
10833
+ * RecordIncludes
10834
+ * @description All includable resources linkable to the given records.
10835
+ */
10836
+ RecordIncludes: {
10837
+ creators?: components["schemas"]["CreatorInclude"];
10838
+ containers?: {
10839
+ [key: string]: components["schemas"]["Container"];
10840
+ };
10841
+ "containers:identifiers"?: {
10842
+ [key: string]: components["schemas"]["ID"];
10843
+ };
10844
+ "virtual-machines"?: {
10845
+ [key: string]: components["schemas"]["VirtualMachine"];
10846
+ };
10847
+ "virtual-machines:identifiers"?: {
10848
+ [key: string]: components["schemas"]["ID"];
10849
+ };
10850
+ };
10851
+ /**
10852
+ * DNSTLSAttempt
10853
+ * @description A DNS TLS certificate generation attempt resource.
10854
+ */
10855
+ Attempt: {
10856
+ id: components["schemas"]["ID"];
10857
+ hub_id: components["schemas"]["HubID"];
10858
+ /** @description A list of domains associated with the attempt. */
10859
+ domains: string[];
10860
+ /** @description A timestamp for when the attempt took place. */
10861
+ time: components["schemas"]["DateTime"];
10862
+ /** @description A boolean where true means the attept was successful at creating the TLS certificate. */
10863
+ success: boolean;
10864
+ /** @description If success is false this property will be populated with an error. */
10865
+ error?: string;
10866
+ };
10867
+ /**
10868
+ * TlsCertificate
10869
+ * @description A TLS certificate.
10870
+ */
10871
+ TlsCertificate: {
10872
+ id: components["schemas"]["ID"];
10873
+ /** @description Whether or not this certificate was uploaded instead of generated by the platform. */
10874
+ user_supplied: boolean;
10875
+ domains: string[] | null;
10876
+ hub_id?: components["schemas"]["ID"] | null;
10877
+ expires: components["schemas"]["DateTime"];
10878
+ state: {
10879
+ /**
10880
+ * @description The current state of the TLS certificate.
10881
+ * @enum {string}
10882
+ */
10322
10883
  current: "new" | "processing" | "live" | "deprecated";
10323
10884
  } & components["schemas"]["State"];
10324
10885
  /**
@@ -10373,6 +10934,13 @@ export interface components {
10373
10934
  /** @description The monthly cost (in mills) of enabling this tier on an environment. */
10374
10935
  cost_mills: number;
10375
10936
  };
10937
+ /**
10938
+ * ClusterIncludes
10939
+ * @description A resource associated with a cluster.
10940
+ */
10941
+ ClusterIncludes: {
10942
+ [key: string]: components["schemas"]["Cluster"];
10943
+ };
10376
10944
  /**
10377
10945
  * EnvironmentStartAction
10378
10946
  * @description A task to start an environment.
@@ -10420,6 +10988,8 @@ export interface components {
10420
10988
  tags: components["schemas"]["EnvironmentDeploymentTags"];
10421
10989
  };
10422
10990
  };
10991
+ /** EnvironmentTask */
10992
+ EnvironmentTask: components["schemas"]["EnvironmentStartAction"] | components["schemas"]["EnvironmentStopAction"] | components["schemas"]["EnvironmentInitializeAction"] | components["schemas"]["EnvironmentReconfigureDeploymentsAction"];
10423
10993
  /**
10424
10994
  * EnvironmentServiceContainerSummary
10425
10995
  * @description An object containing information about a service container associated with this environment.
@@ -10501,6 +11071,12 @@ export interface components {
10501
11071
  decode: boolean;
10502
11072
  /** @description The path to mount the file to inside the container. */
10503
11073
  path: string | null;
11074
+ /** @description A linux file mode that will be set on the injected file. */
11075
+ permissions?: string | null;
11076
+ /** @description The linux UID to set on the file. */
11077
+ uid?: number | null;
11078
+ /** @description The linux GID to set on the file. */
11079
+ gid?: number | null;
10504
11080
  } | null;
10505
11081
  };
10506
11082
  /**
@@ -10905,18 +11481,18 @@ export interface components {
10905
11481
  };
10906
11482
  };
10907
11483
  /**
10908
- * VpnResetTask
11484
+ * VpnResetAction
10909
11485
  * @description This will reset the VPN certificates and restart the container. Should be done when the certificates expire, every 1000 days. Then, you will need to redownload the VPN config in order to connect.
10910
11486
  */
10911
- VpnResetTask: {
11487
+ VpnResetAction: {
10912
11488
  /**
10913
11489
  * @description The name of the action to perform. (enum property replaced by openapi-typescript)
10914
11490
  * @enum {string}
10915
11491
  */
10916
11492
  action: "reset";
10917
11493
  };
10918
- /** VpnReconfigureTask */
10919
- VpnReconfigureTask: {
11494
+ /** VpnReconfigureAction */
11495
+ VpnReconfigureAction: {
10920
11496
  /**
10921
11497
  * @description The action to take. (enum property replaced by openapi-typescript)
10922
11498
  * @enum {string}
@@ -10946,6 +11522,7 @@ export interface components {
10946
11522
  } | null;
10947
11523
  };
10948
11524
  };
11525
+ VpnTask: components["schemas"]["VpnResetAction"] | components["schemas"]["VpnReconfigureAction"];
10949
11526
  /**
10950
11527
  * HubUsageDatum
10951
11528
  * @description A hub usage data point
@@ -11005,6 +11582,8 @@ export interface components {
11005
11582
  number?: number;
11006
11583
  /** @description Additional information. */
11007
11584
  string?: string;
11585
+ /** @description A boolean describing if a resource exists or not. */
11586
+ boolean?: string;
11008
11587
  };
11009
11588
  /**
11010
11589
  * ActivityChange
@@ -11077,353 +11656,183 @@ export interface components {
11077
11656
  /**
11078
11657
  * @description The type of user.
11079
11658
  * @enum {string}
11080
- */
11081
- type: "account" | "environment" | "platform" | "platform-pipeline" | "employee" | "api-key" | "visitor";
11082
- /** @description The given user's ID. */
11083
- id: string;
11084
- };
11085
- /** @description A number representing the detail level (verbosity) of this activity.
11086
- *
11087
- * ## Levels
11088
- * - 0: activity that other users would find useful
11089
- * - 1: activity that can be useful in tracking down how a user did something
11090
- * - 2: full activity, can be useful in debugging problems
11091
- * */
11092
- verbosity: number;
11093
- context: components["schemas"]["Context"];
11094
- session: components["schemas"]["Session"] | null;
11095
- /** @description An array of changes. */
11096
- changes: components["schemas"]["Change"][];
11097
- /** @description A record of additional annotations for the activity. */
11098
- annotations: {
11099
- [key: string]: unknown;
11100
- };
11101
- /** @description An object describing a given activity error. */
11102
- error: {
11103
- /** @description The error message. */
11104
- message: string;
11105
- } | null;
11106
- /** @description An object holding information about a component. */
11107
- component: {
11108
- id: components["schemas"]["ID"];
11109
- /** @description The type of component. */
11110
- type: string;
11111
- } | null;
11112
- /** @description An array of tags that denote things such as a type of security event, or can be user-provided. */
11113
- tags?: string[];
11114
- /**
11115
- * @description A status for the given activity.
11116
- * @enum {string}
11117
- */
11118
- status: "info" | "warn" | "request" | "success" | "error" | "alert";
11119
- security?: components["schemas"]["ActivitySecurity"];
11120
- monitor?: components["schemas"]["ActivityMonitor"];
11121
- /**
11122
- * @description The activity event.
11123
- * @enum {string}
11124
- */
11125
- 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.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.inactive" | "container.initialize" | "container.task.start" | "container.start" | "container.task.stop" | "container.stop" | "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.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.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.server.task.delete" | "infrastructure.server.task.restart" | "infrastructure.server.services.sftp.auth" | "infrastructure.server.live" | "infrastructure.server.delete" | "infrastructure.server.restart" | "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.autoscale.group.create" | "infrastructure.autoscale.group.update" | "infrastructure.autoscale.group.task.delete" | "infrastructure.autoscale.group.delete" | "infrastructure.cluster.create" | "infrastructure.cluster.update" | "infrastructure.cluster.delete" | "infrastructure.ips.pool.task.delete" | "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.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";
11126
- /** @description A timestamp for when the activity took place. */
11127
- time: components["schemas"]["DateTime"];
11128
- };
11129
- /**
11130
- * VirtualMachineNetworkConfig
11131
- * @description Defines the network settings for a virtual machine, including public access mode, hostname, and ports.
11132
- *
11133
- */
11134
- VirtualMachineNetworkConfig: {
11135
- /**
11136
- * @description Controls the public network mode for the virtual machine.
11137
- * @enum {string}
11138
- */
11139
- public: "enable" | "disable" | "egress-only";
11140
- /** @description The hostname assigned to the virtual machine. */
11141
- hostname: string;
11142
- /** @description Port configurations for the virtual machine. */
11143
- ports?: string[] | null;
11144
- };
11145
- /**
11146
- * VirtualMachineDeployTags
11147
- * @description Tags that define node requirements for the deployment. The `any` tag must match at least one condition, while `all` must match all conditions.
11148
- *
11149
- */
11150
- VirtualMachineDeployTags: {
11151
- any?: string[] | null;
11152
- all?: string[] | null;
11153
- };
11154
- /**
11155
- * VirtualMachineNodeConstraints
11156
- * @description Node-level constraints for the virtual machine deployment, specifying tags that must or must not be present.
11157
- *
11158
- */
11159
- VirtualMachineNodeConstraints: {
11160
- tags: components["schemas"]["VirtualMachineDeployTags"];
11161
- };
11162
- /**
11163
- * VirtualMachineDeployConstraints
11164
- * @description Constraints define node-level and resource restrictions for the virtual machine deployment.
11165
- *
11166
- */
11167
- VirtualMachineDeployConstraints: {
11168
- node?: components["schemas"]["VirtualMachineNodeConstraints"] | null;
11169
- secrets?: string[] | null;
11170
- containers?: string[] | null;
11171
- };
11172
- /**
11173
- * VirtualMachineShutdownPolicy
11174
- * @description The shutdown policy defines how the virtual machine should handle shutdown, including a timeout and signals to be sent during shutdown.
11175
- *
11176
- */
11177
- VirtualMachineShutdownPolicy: {
11178
- /** @description The timeout period for graceful shutdown. */
11179
- graceful_timeout?: components["schemas"]["Duration"] | null;
11180
- };
11181
- /**
11182
- * VirtualMachineStartupPolicy
11183
- * @description The startup policy defines how the virtual machine should handle startup, including a possible delay before starting the machine.
11184
- *
11185
- */
11186
- VirtualMachineStartupPolicy: {
11187
- /** @description Delay before startup. */
11188
- delay?: components["schemas"]["Duration"] | null;
11189
- };
11190
- /**
11191
- * VirtualMachineTelemetryConfig
11192
- * @description The telemetry configuration defines how telemetry data is handled, including retention, interval, and whether telemetry is disabled.
11193
- *
11194
- */
11195
- VirtualMachineTelemetryConfig: {
11196
- /** @description Data retention duration for telemetry. */
11197
- retention?: components["schemas"]["Duration"] | null;
11198
- /** @description Telemetry collection interval. */
11199
- interval?: components["schemas"]["Duration"] | null;
11200
- /** @description Whether telemetry collection is disabled. */
11201
- disable: boolean;
11202
- };
11203
- /**
11204
- * VirtualMachineDeployConfig
11205
- * @description Represents the deployment configuration for a virtual machine, including constraints, shutdown/startup policies, restart conditions, and telemetry settings.
11206
- *
11207
- */
11208
- VirtualMachineDeployConfig: {
11209
- constraints?: components["schemas"]["VirtualMachineDeployConstraints"] | null;
11210
- shutdown?: components["schemas"]["VirtualMachineShutdownPolicy"] | null;
11211
- startup?: components["schemas"]["VirtualMachineStartupPolicy"] | null;
11212
- telemetry?: components["schemas"]["VirtualMachineTelemetryConfig"] | null;
11213
- };
11214
- /**
11215
- * VirtualMachineRamResources
11216
- * @description Defines the RAM configuration of a virtual machine.
11217
- *
11218
- */
11219
- VirtualMachineRamResources: {
11220
- /** @description The limit (maximum) amount of RAM the virtual machine can consume. Must be at least 512M and less than 65GB. */
11221
- limit: string;
11222
- /** @description Whether or not the RAM set in limit should be preallocated. */
11223
- allocate?: boolean | null;
11224
- };
11225
- /**
11226
- * VirtualMachineCpuResources
11227
- * @description Defines the CPU configuration of a virtual machine. Set **either** `cores` or `cpus`.
11228
- *
11229
- */
11230
- VirtualMachineCpuResources: {
11231
- cores?: {
11232
- /** @description The number of cores to assign to this virtual machine. Must be between 1 and 32. */
11233
- number: number;
11234
- /** @description If true, reserves the cores so they cannot be used by any other virtual machine. */
11235
- allocate?: boolean | null;
11236
- } | null;
11237
- /** @description The specific cores/range of cores to allocate to the virtual machine. An 'x' indicates the maximum core for a given machine. */
11238
- cpus?: string | null;
11239
- };
11240
- /**
11241
- * VirtualMachineResourcesConfig
11242
- * @description Defines the resource settings for a virtual machine, including CPU and RAM.
11243
- *
11244
- */
11245
- VirtualMachineResourcesConfig: {
11246
- ram: components["schemas"]["VirtualMachineRamResources"];
11247
- cpu: components["schemas"]["VirtualMachineCpuResources"];
11248
- };
11249
- /**
11250
- * VirtualMachineConfig
11251
- * @description Defines the network and deployment configurations for a virtual machine.
11252
- *
11253
- */
11254
- VirtualMachineConfig: {
11255
- network: components["schemas"]["VirtualMachineNetworkConfig"];
11256
- deploy: components["schemas"]["VirtualMachineDeployConfig"];
11257
- resources: components["schemas"]["VirtualMachineResourcesConfig"];
11258
- };
11259
- /**
11260
- * VirtualMachineImageSourceUrl
11261
- * @description A virtual machine image sourced from a URL.
11262
- */
11263
- VirtualMachineImageSourceUrl: {
11264
- /**
11265
- * @description discriminator enum property added by openapi-typescript
11266
- * @enum {string}
11267
- */
11268
- type: "url";
11269
- details: {
11270
- /** @description The URL where a custom image is located. */
11271
- url: string;
11659
+ */
11660
+ type: "account" | "environment" | "platform" | "platform-pipeline" | "employee" | "api-key" | "visitor";
11661
+ /** @description The given user's ID. */
11662
+ id: string;
11272
11663
  };
11273
- };
11274
- /**
11275
- * VirtualMachineImageSourceIpxe
11276
- * @description A virtual machine image sourced from an IPXE script.
11277
- */
11278
- VirtualMachineImageSourceIpxe: {
11664
+ /** @description A number representing the detail level (verbosity) of this activity.
11665
+ *
11666
+ * ## Levels
11667
+ * - 0: activity that other users would find useful
11668
+ * - 1: activity that can be useful in tracking down how a user did something
11669
+ * - 2: full activity, can be useful in debugging problems
11670
+ * */
11671
+ verbosity: number;
11672
+ context: components["schemas"]["Context"];
11673
+ session: components["schemas"]["Session"] | null;
11674
+ /** @description An array of changes. */
11675
+ changes: components["schemas"]["Change"][];
11676
+ /** @description A record of additional annotations for the activity. */
11677
+ annotations: {
11678
+ [key: string]: unknown;
11679
+ };
11680
+ /** @description An object describing a given activity error. */
11681
+ error: {
11682
+ /** @description The error message. */
11683
+ message: string;
11684
+ } | null;
11685
+ /** @description An object holding information about a component. */
11686
+ component: {
11687
+ id: components["schemas"]["ID"];
11688
+ /** @description The type of component. */
11689
+ type: string;
11690
+ } | null;
11691
+ /** @description An array of tags that denote things such as a type of security event, or can be user-provided. */
11692
+ tags?: string[];
11279
11693
  /**
11280
- * @description discriminator enum property added by openapi-typescript
11694
+ * @description A status for the given activity.
11281
11695
  * @enum {string}
11282
11696
  */
11283
- type: "ipxe";
11284
- details: {
11285
- /** @description A URL that points to an IPXE script. */
11286
- chain_url?: string | null;
11287
- /** @description An inline IPXE script. */
11288
- script?: string | null;
11289
- };
11290
- };
11291
- /**
11292
- * VirtualMachineImageSourceBase
11293
- * @description A virtual machine image sourced from a Cycle base image.
11294
- */
11295
- VirtualMachineImageSourceBase: {
11697
+ status: "info" | "warn" | "request" | "success" | "error" | "alert";
11698
+ security?: components["schemas"]["ActivitySecurity"];
11699
+ monitor?: components["schemas"]["ActivityMonitor"];
11296
11700
  /**
11297
- * @description discriminator enum property added by openapi-typescript
11701
+ * @description The activity event.
11298
11702
  * @enum {string}
11299
11703
  */
11300
- type: "base";
11301
- details: {
11302
- /** @description The base image identifier. */
11303
- identifier: string;
11304
- };
11704
+ 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.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.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.cluster.create" | "infrastructure.cluster.update" | "infrastructure.cluster.delete" | "infrastructure.ips.pool.task.delete" | "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.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";
11705
+ /** @description A timestamp for when the activity took place. */
11706
+ time: components["schemas"]["DateTime"];
11305
11707
  };
11306
11708
  /**
11307
- * VirtualMachineImage
11308
- * @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. The `base` field allows users to specify the name of a desired Cycle-hosted base image, removing the need for a custom image URL.
11709
+ * IpAddress
11710
+ * Format: ip-address
11711
+ * @description An IP address is a numerical label that uniquely identifies a device on a network and enables it to send and receive data.
11309
11712
  *
11310
11713
  */
11311
- VirtualMachineImage: components["schemas"]["VirtualMachineImageSourceUrl"] | components["schemas"]["VirtualMachineImageSourceIpxe"] | components["schemas"]["VirtualMachineImageSourceBase"];
11714
+ IpAddress: string;
11312
11715
  /**
11313
- * VirtualMachineVolumeConfig
11314
- * @description Represents the configuration for a volume attached to a virtual machine.
11315
- *
11716
+ * VirtualProviderIsoNic
11717
+ * @description Server ISO network interface.
11316
11718
  */
11317
- VirtualMachineVolumeConfig: {
11318
- /** @description Configuration details for a local volume, if applicable. */
11319
- local?: {
11320
- /** @description The maximum size allowed for the local volume. */
11321
- max_size: string;
11322
- /** @description Indicates if the volume is part of a storage pool. */
11323
- storage_pool?: boolean | null;
11719
+ VirtualProviderIsoNic: {
11720
+ /** @description The criteria used to match the server to the interface. */
11721
+ match: {
11722
+ /** @description The name of the interface on the server. */
11723
+ interface_name?: string | null;
11724
+ /** @description The mac address of the server. */
11725
+ mac_address?: string | null;
11726
+ };
11727
+ /** @description VLAN ID for the serer. */
11728
+ vlan_id?: number | null;
11729
+ /** @description The static configuration for the network interface. */
11730
+ static?: {
11731
+ /** @description Static IP assigned to the server. */
11732
+ static_ip: components["schemas"]["IpAddress"];
11733
+ /** @description Network assigned to the server */
11734
+ network: components["schemas"]["Cidr"];
11735
+ /** @description Gateway IP assigned to the server. */
11736
+ gateway_ip?: components["schemas"]["IpAddress"] | null;
11737
+ } | null;
11738
+ /** @description The DHCP configuration for the network interface. */
11739
+ dhcp?: {
11740
+ /** @enum {string} */
11741
+ mode: "all" | "none" | "ipv4" | "ipv6";
11324
11742
  } | null;
11325
- identifier: components["schemas"]["Identifier"];
11326
- /** @description Specifies if the volume is mounted as read-only. */
11327
- read_only: boolean;
11328
- };
11329
- /**
11330
- * VirtualMachineVolume
11331
- * @description Represents a storage volume attached to a virtual machine.
11332
- *
11333
- */
11334
- VirtualMachineVolume: {
11335
- id: components["schemas"]["ID"];
11336
- /** @description A unique hash identifying the volume for the virtual machine. */
11337
- hash: string;
11338
- /** @description The configuration details for the virtual machine's volume. */
11339
- config: components["schemas"]["VirtualMachineVolumeConfig"];
11340
11743
  };
11341
- /** VirtualMachineState */
11342
- VirtualMachineState: {
11343
- /**
11344
- * @description The current state of the virtual machine.
11345
- * @enum {string}
11346
- */
11347
- current: "new" | "starting" | "running" | "stopping" | "stopped" | "deleting" | "deleted";
11348
- } & components["schemas"]["State"];
11349
11744
  /**
11350
- * VirtualMachineMeta
11351
- * @description Fields that can be included on a per-virtual machine basis, specific to that virtual machine.
11745
+ * VirtualProviderIsoBond
11746
+ * @description Server ISO bond.
11352
11747
  */
11353
- VirtualMachineMeta: {
11354
- domains?: {
11355
- /** @description The fully qualified domain name. */
11356
- fqdn: string;
11357
- record?: components["schemas"]["Record"] | null;
11358
- }[] | null;
11359
- /** @description An array of IP addresses associated with this virtual machine. */
11360
- ips?: components["schemas"]["Ip"][] | null;
11361
- /** @description The server the virtual machine is deployed to. */
11362
- server?: components["schemas"]["Server"] | null;
11748
+ VirtualProviderIsoBond: {
11749
+ interface_name: string;
11750
+ interfaces?: {
11751
+ /** @description The name of the interface on the server. */
11752
+ interface_name?: string | null;
11753
+ /** @description The mac address of the server. */
11754
+ mac_address?: string | null;
11755
+ }[];
11756
+ /** @enum {string} */
11757
+ mode: "round-robin" | "active-backup" | "lacp";
11363
11758
  };
11364
11759
  /**
11365
- * VirtualMachine
11366
- * @description Describes a virtual machine running on the Cycle Platform.
11367
- *
11760
+ * VirtualProviderIso
11761
+ * @description The ISO image for a virtual provider.
11368
11762
  */
11369
- VirtualMachine: {
11763
+ VirtualProviderIso: {
11370
11764
  id: components["schemas"]["ID"];
11371
- /** @description A user-defined name for the virtual machine. */
11765
+ /** @description The name of the ISO. */
11372
11766
  name: string;
11373
- identifier: components["schemas"]["Identifier"];
11374
11767
  creator: components["schemas"]["CreatorScope"];
11375
- /** @description Basic information about the environment this virtual machine is in.
11376
- * */
11377
- environment: {
11378
- id: components["schemas"]["ID"];
11379
- /** @description The cluster this environment is associated with. */
11380
- cluster: components["schemas"]["Identifier"];
11768
+ hub_id: components["schemas"]["ID"];
11769
+ integration_id: components["schemas"]["ID"];
11770
+ config: {
11771
+ /** @description Authentication token for the ISO. */
11772
+ token: string;
11773
+ ipxe?: {
11774
+ /** @description VLAN ID for the IPXE boot. */
11775
+ vlan_id?: number | null;
11776
+ /** @description Network interface for the IPXE boot. */
11777
+ network_interface?: number | null;
11778
+ /** @description Static IP assigned to the IPXE boot. */
11779
+ static_ip?: string | null;
11780
+ /** @description Netmask assigned to the IPXE boot. */
11781
+ netmask?: string | null;
11782
+ /** @description Gateway IP assigned to the IPXE boot. */
11783
+ gateway_ip?: string | null;
11784
+ /** @description DNS IP assigned to the IPXE boot. */
11785
+ dns_ip?: string | null;
11786
+ } | null;
11787
+ server?: {
11788
+ storage?: {
11789
+ conditional_format?: boolean;
11790
+ } | null;
11791
+ sdn_neighbor_preference?: ("ipv4" | "ipv6") | null;
11792
+ /** @description An array of server network interfaces. */
11793
+ nics: components["schemas"]["VirtualProviderIsoNic"][];
11794
+ /** @description An array of bonds */
11795
+ bonds?: components["schemas"]["VirtualProviderIsoBond"][];
11796
+ } | null;
11381
11797
  };
11382
- hub_id: components["schemas"]["HubID"];
11383
- config: components["schemas"]["VirtualMachineConfig"];
11384
- image: components["schemas"]["VirtualMachineImage"];
11385
- container_id?: components["schemas"]["ID"];
11386
- volumes?: components["schemas"]["VirtualMachineVolume"][] | null;
11387
- /** @description Metadata annotations for the virtual machine. */
11388
- annotations?: {
11389
- [key: string]: unknown;
11798
+ backend?: {
11799
+ /**
11800
+ * @description The provider responsible for storing the ISO.
11801
+ * @enum {string}
11802
+ */
11803
+ provider?: "AWS" | "Azure" | "GCP" | "Local";
11804
+ /** @description Name of the ISO file. */
11805
+ file_name?: string;
11806
+ /** @description Unique identifier for the ISO file. */
11807
+ file_id?: string;
11808
+ /**
11809
+ * Format: int64
11810
+ * @description Size of the ISO file in bytes.
11811
+ */
11812
+ size?: number;
11390
11813
  } | null;
11391
- /** @description The size of the base disk. Must be between 10G and 100G. */
11392
- base_disk_size?: string;
11393
- /** @description The generated root password for the virtual machine. Only visible by the owner, or if it was created in the last ten minutes. */
11394
- root_password?: {
11395
- changed: components["schemas"]["DateTime"];
11396
- /** @description The root password. */
11397
- current: string | null;
11398
- };
11399
- /** @description An array of IDs corresponding to SSH keys that have been assigned to this virtual machine. */
11400
- ssh_keys?: components["schemas"]["ID"][] | null;
11401
- state: components["schemas"]["VirtualMachineState"];
11402
- /**
11403
- * VirtualMachineEvents
11404
- * @description A collection of timestamps for each event in the virtual machine's lifetime.
11405
- */
11814
+ state: {
11815
+ /**
11816
+ * @description The current state of the environment.
11817
+ * @enum {string}
11818
+ */
11819
+ current: "new" | "building" | "live" | "deleting" | "deleted";
11820
+ } & components["schemas"]["State"];
11821
+ /** @description A collection of timestamps for each event in the ISO's lifetime. */
11406
11822
  events: {
11407
- /** @description The timestamp of when the virtual machine was created. */
11823
+ /** @description The timestamp of when the ISO was created. */
11408
11824
  created: components["schemas"]["DateTime"];
11409
- /** @description The timestamp of when the virtual machine was updated. */
11825
+ /** @description The timestamp of when the ISO was updated. */
11410
11826
  updated: components["schemas"]["DateTime"];
11411
- /** @description The timestamp of when the virtual machine was deleted. */
11827
+ /** @description The timestamp of when the ISO was deleted. */
11412
11828
  deleted: components["schemas"]["DateTime"];
11413
- /** @description The timestamp of when the virtual machine was started. */
11414
- started: components["schemas"]["DateTime"];
11415
11829
  };
11416
- /** @description A boolean flag indicating if this virtual machine is deprecated. */
11417
- deprecate: boolean;
11418
- /** @description Prevents this virtual machine from being deleted when true. */
11419
- lock: boolean;
11420
- meta?: components["schemas"]["VirtualMachineMeta"] | null;
11421
11830
  };
11422
11831
  /**
11423
11832
  * IPPoolProvider
11424
11833
  * @description A IP Pool provider.
11425
11834
  */
11426
- PoolProvider: {
11835
+ IpPoolProvider: {
11427
11836
  /** @description A vendor for a provider. */
11428
11837
  vendor: string;
11429
11838
  /** @description ID of the provider integration used to provision the IP. */
@@ -11437,8 +11846,8 @@ export interface components {
11437
11846
  /** @description An identifier linked to the server assingment of the IP pool. */
11438
11847
  server_assignment: string;
11439
11848
  };
11440
- /** PoolState */
11441
- PoolState: {
11849
+ /** IpPoolState */
11850
+ IpPoolState: {
11442
11851
  /**
11443
11852
  * @description The current state of the pool.
11444
11853
  * @enum {string}
@@ -11446,10 +11855,10 @@ export interface components {
11446
11855
  current: "live" | "releasing" | "released";
11447
11856
  } & components["schemas"]["State"];
11448
11857
  /**
11449
- * InfrastructureIPPool
11858
+ * IPPool
11450
11859
  * @description An IP Pool
11451
11860
  */
11452
- Pool: {
11861
+ IpPool: {
11453
11862
  id: components["schemas"]["ID"];
11454
11863
  hub_id: components["schemas"]["HubID"];
11455
11864
  /** @description An ID associated with a server resource. */
@@ -11461,7 +11870,7 @@ export interface components {
11461
11870
  * @enum {string}
11462
11871
  */
11463
11872
  kind: "ipv4" | "ipv6";
11464
- provider: components["schemas"]["PoolProvider"];
11873
+ provider: components["schemas"]["IpPoolProvider"];
11465
11874
  /** @description A boolean where true represents the pool as a floating IP pool. */
11466
11875
  floating: boolean;
11467
11876
  /** @description Data about IPs in the pool. */
@@ -11477,12 +11886,9 @@ export interface components {
11477
11886
  cidr: string;
11478
11887
  /** @description A gateway for the pool. */
11479
11888
  gateway: string;
11480
- /** @description A netmask for the pool. */
11481
- netmask: string;
11482
- /** @description A network for the pool. */
11483
- network: string;
11889
+ network?: components["schemas"]["Cidr"] | null;
11484
11890
  };
11485
- state: components["schemas"]["PoolState"];
11891
+ state: components["schemas"]["IpPoolState"];
11486
11892
  };
11487
11893
  /** ApiKeyState */
11488
11894
  ApiKeyState: {
@@ -11529,6 +11935,56 @@ export interface components {
11529
11935
  */
11530
11936
  current: "live" | "deleting" | "deleted";
11531
11937
  } & components["schemas"]["State"];
11938
+ /** NetworkVlanDhcpDetails */
11939
+ NetworkVlanDhcpDetails: {
11940
+ /**
11941
+ * @description discriminator enum property added by openapi-typescript
11942
+ * @enum {string}
11943
+ */
11944
+ method: "dhcp";
11945
+ details?: Record<string, never>;
11946
+ };
11947
+ /** NetworkVlanStaticDetails */
11948
+ NetworkVlanStaticDetails: {
11949
+ /**
11950
+ * @description discriminator enum property added by openapi-typescript
11951
+ * @enum {string}
11952
+ */
11953
+ method: "static";
11954
+ details: {
11955
+ ipv4?: {
11956
+ /** @description The CIDR for the network. */
11957
+ network: string;
11958
+ /** @description The usable CIDR. */
11959
+ usable: string;
11960
+ /** @description The IP of the gateway */
11961
+ gateway?: string | null;
11962
+ } | null;
11963
+ ipv6?: {
11964
+ /** @description The CIDR for the network. */
11965
+ network: string;
11966
+ /** @description The usable CIDR. */
11967
+ usable: string;
11968
+ /** @description The IP of the gateway */
11969
+ gateway?: string | null;
11970
+ } | null;
11971
+ };
11972
+ };
11973
+ /**
11974
+ * NetworkVlan
11975
+ * @description VLAN information for a Cycle SDN.
11976
+ */
11977
+ NetworkVlan: {
11978
+ location_ids: components["schemas"]["ID"][];
11979
+ vid: number;
11980
+ host_interface?: string | null;
11981
+ /** @description An array of defined VLAN routes */
11982
+ routes?: {
11983
+ network: components["schemas"]["Cidr"];
11984
+ gateway?: components["schemas"]["IpAddress"];
11985
+ }[];
11986
+ ips: components["schemas"]["NetworkVlanDhcpDetails"] | components["schemas"]["NetworkVlanStaticDetails"];
11987
+ };
11532
11988
  /**
11533
11989
  * NetworkPrivacySettings
11534
11990
  * @description Private network information for a Cycle SDN.
@@ -11563,6 +12019,7 @@ export interface components {
11563
12019
  creator: components["schemas"]["CreatorScope"];
11564
12020
  hub_id: components["schemas"]["HubID"];
11565
12021
  state: components["schemas"]["NetworkState"];
12022
+ vlan?: components["schemas"]["NetworkVlan"] | null;
11566
12023
  private_network?: components["schemas"]["NetworkPrivacySettings"] | null;
11567
12024
  /** @description An array of environments and timestamps. */
11568
12025
  environments?: {
@@ -11788,6 +12245,26 @@ export interface components {
11788
12245
  container: components["schemas"]["FluidIdentifier"];
11789
12246
  };
11790
12247
  };
12248
+ /**
12249
+ * ContainerDeprecateStep
12250
+ * @description Settings for restarting a container in a pipeline
12251
+ */
12252
+ ContainerDeprecateStep: {
12253
+ /** @description An identifier for the step. */
12254
+ identifier?: string;
12255
+ options?: {
12256
+ skip?: boolean;
12257
+ };
12258
+ /**
12259
+ * @description The action that the step takes. (enum property replaced by openapi-typescript)
12260
+ * @enum {string}
12261
+ */
12262
+ action: "container.deprecate";
12263
+ details: {
12264
+ container: components["schemas"]["FluidIdentifier"];
12265
+ unset?: boolean;
12266
+ };
12267
+ };
11791
12268
  /**
11792
12269
  * ContainerReimageStep
11793
12270
  * @description Settings for reimaging a container in a pipeline
@@ -12462,7 +12939,7 @@ export interface components {
12462
12939
  PipelineRunStep: {
12463
12940
  identifier: string;
12464
12941
  /** @enum {string} */
12465
- action: "environment.create" | "environment.start" | "environment.stop" | "environment.delete" | "environment.deployments.prune" | "environment.deployments.tag" | "environment.deployment.start" | "environment.deployment.stop" | "environment.deployment.healthy.watch" | "image.create" | "image.import" | "images.prune" | "image.create-import" | "container.create" | "container.reimage" | "container.start" | "container.stop" | "container.restart" | "container.delete" | "container.function.trigger" | "stack.build.create" | "stack.build.deploy" | "stack.build.generate" | "stack.prune" | "sleep" | "webhook.post" | "webhook.get";
12942
+ action: "environment.create" | "environment.start" | "environment.stop" | "environment.delete" | "environment.deployments.prune" | "environment.deployments.tag" | "environment.deployment.start" | "environment.deployment.stop" | "environment.deployment.healthy.watch" | "image.create" | "image.import" | "images.prune" | "image.create-import" | "container.create" | "container.reimage" | "container.deprecate" | "container.start" | "container.stop" | "container.restart" | "container.delete" | "container.function.trigger" | "stack.build.create" | "stack.build.deploy" | "stack.build.generate" | "stack.prune" | "sleep" | "webhook.post" | "webhook.get";
12466
12943
  /** @description A collection of timestamps for each event in the pipeline run's lifetime. */
12467
12944
  events: {
12468
12945
  /** @description The timestamp of when the pipeline step was started. */
@@ -12562,7 +13039,7 @@ export interface components {
12562
13039
  * @description A resource that is associated with activity.
12563
13040
  */
12564
13041
  ComponentsIncludes: {
12565
- [key: string]: components["schemas"]["Container"] | components["schemas"]["VirtualMachine"] | components["schemas"]["Instance"] | components["schemas"]["Environment"] | components["schemas"]["Image"] | components["schemas"]["ImageSource"] | components["schemas"]["Server"] | components["schemas"]["Pool"] | components["schemas"]["Integration"] | components["schemas"]["Stack"] | components["schemas"]["StackBuild"] | components["schemas"]["Zone"] | components["schemas"]["Record"] | components["schemas"]["TlsCertificate"] | components["schemas"]["ApiKey"] | components["schemas"]["Network"] | components["schemas"]["HubMembership"] | components["schemas"]["Pipeline"] | components["schemas"]["TriggerKey"] | components["schemas"]["ScopedVariable"] | components["schemas"]["Hub"] | components["schemas"]["Invoice"] | components["schemas"]["Method"] | components["schemas"]["AutoScaleGroup"] | components["schemas"]["PipelineRun"] | components["schemas"]["Role"] | components["schemas"]["PublicAccount"] | components["schemas"]["VirtualMachineSshKey"];
13042
+ [key: string]: components["schemas"]["Container"] | components["schemas"]["VirtualMachine"] | components["schemas"]["Instance"] | components["schemas"]["Environment"] | components["schemas"]["Image"] | components["schemas"]["ImageSource"] | components["schemas"]["Server"] | components["schemas"]["VirtualProviderIso"] | components["schemas"]["IpPool"] | components["schemas"]["Integration"] | components["schemas"]["Stack"] | components["schemas"]["StackBuild"] | components["schemas"]["DnsZone"] | components["schemas"]["DnsRecord"] | components["schemas"]["TlsCertificate"] | components["schemas"]["ApiKey"] | components["schemas"]["Network"] | components["schemas"]["HubMembership"] | components["schemas"]["Pipeline"] | components["schemas"]["TriggerKey"] | components["schemas"]["ScopedVariable"] | components["schemas"]["Hub"] | components["schemas"]["Invoice"] | components["schemas"]["Method"] | components["schemas"]["AutoScaleGroup"] | components["schemas"]["PipelineRun"] | components["schemas"]["Role"] | components["schemas"]["PublicAccount"] | components["schemas"]["VirtualMachineSshKey"];
12566
13043
  };
12567
13044
  /**
12568
13045
  * ActivityIncludes
@@ -12802,6 +13279,25 @@ export interface components {
12802
13279
  models?: components["schemas"]["ServerModelsIncludes"];
12803
13280
  locations?: components["schemas"]["LocationsIncludes"];
12804
13281
  };
13282
+ /**
13283
+ * VirtualProviderIsoIncludes
13284
+ * @description A resource that is associated with an ISO.
13285
+ */
13286
+ VirtualProviderIsoIncludes: {
13287
+ integrations?: {
13288
+ [key: string]: components["schemas"]["Integration"];
13289
+ };
13290
+ };
13291
+ /** VirtualProviderGenerateIsoAction */
13292
+ VirtualProviderGenerateIsoAction: {
13293
+ /**
13294
+ * @description The action to take. (enum property replaced by openapi-typescript)
13295
+ * @enum {string}
13296
+ */
13297
+ action: "generate";
13298
+ };
13299
+ /** VirtualProviderIsoTask */
13300
+ VirtualProviderIsoTask: components["schemas"]["VirtualProviderGenerateIsoAction"];
12805
13301
  /** ServerStatsCpuUsageTelemetry */
12806
13302
  ServerStatsCpuUsageTelemetry: {
12807
13303
  /** Format: float */
@@ -12875,8 +13371,8 @@ export interface components {
12875
13371
  total: number;
12876
13372
  };
12877
13373
  };
12878
- /** ReconfigureSharedFsTask */
12879
- ReconfigureSharedFsTask: {
13374
+ /** ServerReconfigureSharedFsAction */
13375
+ ServerReconfigureSharedFsAction: {
12880
13376
  /**
12881
13377
  * @description The action to take. (enum property replaced by openapi-typescript)
12882
13378
  * @enum {string}
@@ -12899,8 +13395,8 @@ export interface components {
12899
13395
  } | null;
12900
13396
  };
12901
13397
  };
12902
- /** ReconfigureServerFeaturesTask */
12903
- ReconfigureServerFeaturesTask: {
13398
+ /** ServerReconfigureFeaturesAction */
13399
+ ServerReconfigureFeaturesAction: {
12904
13400
  /**
12905
13401
  * @description The action to take. (enum property replaced by openapi-typescript)
12906
13402
  * @enum {string}
@@ -12923,10 +13419,10 @@ export interface components {
12923
13419
  };
12924
13420
  };
12925
13421
  /**
12926
- * RestartServerTask
13422
+ * ServerRestartAction
12927
13423
  * @description A job that restarts the server.
12928
13424
  */
12929
- RestartServerTask: {
13425
+ ServerRestartAction: {
12930
13426
  /**
12931
13427
  * @description The action to take. (enum property replaced by openapi-typescript)
12932
13428
  * @enum {string}
@@ -12934,10 +13430,36 @@ export interface components {
12934
13430
  action: "restart";
12935
13431
  };
12936
13432
  /**
12937
- * RestartComputeServiceTask
13433
+ * ServerPowerOffAction
13434
+ * @description A job that powers the server off.
13435
+ * Only for servers deployed from a virtual provider.
13436
+ *
13437
+ */
13438
+ ServerPowerOffAction: {
13439
+ /**
13440
+ * @description The action to take. (enum property replaced by openapi-typescript)
13441
+ * @enum {string}
13442
+ */
13443
+ action: "power-off";
13444
+ };
13445
+ /**
13446
+ * ServerAuthResetAction
13447
+ * @description A job that resets authentication for the server.
13448
+ * Only for servers deployed from a virtual provider.
13449
+ *
13450
+ */
13451
+ ServerAuthResetAction: {
13452
+ /**
13453
+ * @description The action to take. (enum property replaced by openapi-typescript)
13454
+ * @enum {string}
13455
+ */
13456
+ action: "auth.reset";
13457
+ };
13458
+ /**
13459
+ * ServerRestartComputeAction
12938
13460
  * @description A job that restarts compute service on a given server.
12939
13461
  */
12940
- RestartComputeTask: {
13462
+ ServerRestartComputeAction: {
12941
13463
  /**
12942
13464
  * @description The action to take. (enum property replaced by openapi-typescript)
12943
13465
  * @enum {string}
@@ -12945,18 +13467,18 @@ export interface components {
12945
13467
  action: "compute.restart";
12946
13468
  };
12947
13469
  /**
12948
- * RestartComputeSpawnerTask
13470
+ * ServerRestartComputeSpawnerAction
12949
13471
  * @description A job that restarts compute service on a given server.
12950
13472
  */
12951
- RestartComputeSpawnerTask: {
13473
+ ServerRestartComputeSpawnerAction: {
12952
13474
  /**
12953
13475
  * @description The action to take. (enum property replaced by openapi-typescript)
12954
13476
  * @enum {string}
12955
13477
  */
12956
13478
  action: "compute.spawner.restart";
12957
13479
  };
12958
- /** EvacuateServerTask */
12959
- EvacuateServerTask: {
13480
+ /** ServerEvacuateAction */
13481
+ ServerEvacuateAction: {
12960
13482
  /**
12961
13483
  * @description The action to take. (enum property replaced by openapi-typescript)
12962
13484
  * @enum {string}
@@ -12968,14 +13490,27 @@ export interface components {
12968
13490
  };
12969
13491
  };
12970
13492
  };
12971
- /** EvacuateServerResetTask */
12972
- EvacuateServerResetTask: {
13493
+ /** ServerEvacuateResetAction */
13494
+ ServerEvacuateResetAction: {
12973
13495
  /**
12974
13496
  * @description The action to take. (enum property replaced by openapi-typescript)
12975
13497
  * @enum {string}
12976
13498
  */
12977
13499
  action: "evacuation.reset";
12978
13500
  };
13501
+ /** ServerUnquarantineAction */
13502
+ ServerUnquarantineAction: {
13503
+ /**
13504
+ * @description The action to take. (enum property replaced by openapi-typescript)
13505
+ * @enum {string}
13506
+ */
13507
+ action: "unquarantine";
13508
+ contents: {
13509
+ cluster: string;
13510
+ };
13511
+ };
13512
+ /** ServerTask */
13513
+ ServerTask: components["schemas"]["ServerReconfigureSharedFsAction"] | components["schemas"]["ServerReconfigureFeaturesAction"] | components["schemas"]["ServerRestartAction"] | components["schemas"]["ServerPowerOffAction"] | components["schemas"]["ServerAuthResetAction"] | components["schemas"]["ServerRestartComputeAction"] | components["schemas"]["ServerRestartComputeSpawnerAction"] | components["schemas"]["ServerEvacuateAction"] | components["schemas"]["ServerEvacuateResetAction"] | components["schemas"]["ServerUnquarantineAction"];
12979
13514
  /**
12980
13515
  * ServerTags
12981
13516
  * @description Tags for a given server.
@@ -12997,10 +13532,10 @@ export interface components {
12997
13532
  memory_gb: number;
12998
13533
  };
12999
13534
  /**
13000
- * PoolIncludes
13535
+ * IpPoolIncludes
13001
13536
  * @description Resources associated with an IP Pool.
13002
13537
  */
13003
- PoolIncludes: {
13538
+ IpPoolIncludes: {
13004
13539
  creators?: components["schemas"]["CreatorInclude"];
13005
13540
  servers?: components["schemas"]["ServersIncludes"];
13006
13541
  integrations?: components["schemas"]["IntegrationsIncludes"];
@@ -13205,7 +13740,7 @@ export interface components {
13205
13740
  * EventType
13206
13741
  * @enum {string}
13207
13742
  */
13208
- EventType: "api.security_violation" | "console.ssh.login" | "console.ssh.login.failed" | "console.sos.login" | "console.sos.login.failed" | "container.instance.backup.completed" | "container.instance.backup.failed" | "container.instance.delete.failed" | "container.instance.error" | "container.instance.restart.max_restarts" | "container.instance.function.max_runtime" | "container.instance.healthcheck.failed" | "container.instance.healthcheck.recovered" | "container.instance.volume.extend.failed" | "container.instance.healthcheck.restarted" | "container.instance.migration.failed" | "container.instance.migration.completed" | "container.instance.migration.failed" | "container.instance.network.interfaces.create.failed" | "container.instance.restart.failed" | "container.instance.start.failed" | "container.instance.start.privileged" | "container.instance.stop.failed" | "container.instances.autoscale.down" | "container.instances.autoscale.up" | "container.reconfigured.privileged" | "container.volumes.base.create.failed" | "container.volumes.create.failed" | "environment.service.auto_update" | "environment.service.lb.ips.sync.failed" | "environment.service.vpn.login.failed" | "infrastructure.cluster.resources.ram.full" | "infrastructure.server.compute.volumes.base.reconfigured" | "infrastructure.server.compute.full_restart" | "infrastructure.server.compute.sharedfs.mounts.mount" | "infrastructure.server.compute.sharedfs.mounts.mount.failed" | "infrastructure.server.compute.soft_restart" | "infrastructure.server.image.download.failed" | "infrastructure.server.internal_api.throttled" | "infrastructure.server.manifest.sync.failed" | "infrastructure.server.mesh.connect.failed" | "infrastructure.server.neighbor.reachable" | "infrastructure.server.neighbor.rebuild" | "infrastructure.server.neighbor.unreachable" | "infrastructure.server.neighbor.upgraded" | "infrastructure.server.resources.load.high" | "infrastructure.server.resources.ram.full" | "infrastructure.server.resources.storage.volumes.base.full" | "infrastructure.server.resources.storage.cycle_pool.full" | "infrastructure.server.sftp.lockdown" | "infrastructure.server.sftp.login" | "infrastructure.server.sftp.login.failed" | "infrastructure.server.evacuation.failed" | "infrastructure.server.evacuation.completed";
13743
+ EventType: "api.security_violation" | "console.ssh.login" | "console.ssh.login.failed" | "console.sos.login" | "console.sos.login.failed" | "container.instance.backup.completed" | "container.instance.backup.failed" | "container.instance.delete.failed" | "container.instance.error" | "container.instance.restart.max_restarts" | "container.instance.function.max_runtime" | "container.instance.healthcheck.failed" | "container.instance.healthcheck.recovered" | "container.instance.volume.extend.failed" | "container.instance.healthcheck.restarted" | "container.instance.migration.completed" | "container.instance.migration.failed" | "container.instance.network.interfaces.create.failed" | "container.instance.restart.failed" | "container.instance.start.failed" | "container.instance.start.privileged" | "container.instance.stop.failed" | "container.instances.autoscale.down" | "container.instances.autoscale.up" | "container.reconfigured.privileged" | "container.volumes.base.create.failed" | "container.volumes.create.failed" | "environment.service.auto_update" | "environment.service.lb.ips.sync.failed" | "environment.service.vpn.login.failed" | "infrastructure.cluster.resources.ram.full" | "infrastructure.server.compute.volumes.base.reconfigured" | "infrastructure.server.compute.full_restart" | "infrastructure.server.compute.sharedfs.mounts.mount" | "infrastructure.server.compute.sharedfs.mounts.mount.failed" | "infrastructure.server.compute.soft_restart" | "infrastructure.server.image.download.failed" | "infrastructure.server.internal_api.throttled" | "infrastructure.server.manifest.sync.failed" | "infrastructure.server.mesh.connect.failed" | "infrastructure.server.neighbor.reachable" | "infrastructure.server.neighbor.rebuild" | "infrastructure.server.neighbors.rebuild" | "infrastructure.server.neighbor.unreachable" | "infrastructure.server.neighbor.upgraded" | "infrastructure.server.resources.load.high" | "infrastructure.server.resources.ram.full" | "infrastructure.server.resources.storage.volumes.base.full" | "infrastructure.server.resources.storage.cycle_pool.full" | "infrastructure.server.sftp.lockdown" | "infrastructure.server.sftp.login" | "infrastructure.server.sftp.login.failed" | "infrastructure.server.evacuation.failed" | "infrastructure.server.evacuation.completed" | "infrastructure.server.checkin.missed" | "infrastructure.server.checkin.resumed" | "infrastructure.server.power.reboot" | "infrastructure.server.power.power-off";
13209
13744
  /**
13210
13745
  * Event
13211
13746
  * @description A platform-generated event. Describes something happening on the platform at a specific time. Can be informational, security related, or a notice of something important.
@@ -13317,7 +13852,7 @@ export interface components {
13317
13852
  "components:identifiers"?: components["schemas"]["IdentifierIncludes"];
13318
13853
  };
13319
13854
  /** TriggerPipelineAction */
13320
- TriggerPipelineAction: {
13855
+ PipelineTriggerAction: {
13321
13856
  /**
13322
13857
  * @description The requested action to perform. (enum property replaced by openapi-typescript)
13323
13858
  * @enum {string}
@@ -13338,8 +13873,8 @@ export interface components {
13338
13873
  };
13339
13874
  };
13340
13875
  };
13341
- /** RerunPipelineAction */
13342
- RerunPipelineAction: {
13876
+ /** PipelineTriggerAction */
13877
+ PipelineRerunAction: {
13343
13878
  /**
13344
13879
  * @description The requested action to perform. (enum property replaced by openapi-typescript)
13345
13880
  * @enum {string}
@@ -13350,6 +13885,8 @@ export interface components {
13350
13885
  run_id?: components["schemas"]["ID"];
13351
13886
  };
13352
13887
  };
13888
+ /** PipelineTask */
13889
+ PipelineTask: components["schemas"]["PipelineTriggerAction"] | components["schemas"]["PipelineRerunAction"];
13353
13890
  /**
13354
13891
  * NetworkIncludes
13355
13892
  * @description All includable resource linkable to the given network.
@@ -13473,16 +14010,16 @@ export interface components {
13473
14010
  deleted: components["schemas"]["DateTime"];
13474
14011
  };
13475
14012
  };
13476
- /** GenerateStackBuild */
13477
- GenerateStackBuildAction: {
14013
+ /** StackBuildGenerateAction */
14014
+ StackBuildGenerateAction: {
13478
14015
  /**
13479
14016
  * @description The job to do. (enum property replaced by openapi-typescript)
13480
14017
  * @enum {string}
13481
14018
  */
13482
14019
  action: "generate";
13483
14020
  };
13484
- /** DeployStackBuild */
13485
- DeployStackBuildAction: {
14021
+ /** StackBuildDeployAction */
14022
+ StackBuildDeployAction: {
13486
14023
  /**
13487
14024
  * @description The action the job takes. (enum property replaced by openapi-typescript)
13488
14025
  * @enum {string}
@@ -13496,6 +14033,8 @@ export interface components {
13496
14033
  update?: components["schemas"]["StackBuildDeploymentUpdates"] | null;
13497
14034
  };
13498
14035
  };
14036
+ /** StackBuildTask */
14037
+ StackBuildTask: components["schemas"]["StackBuildGenerateAction"] | components["schemas"]["StackBuildDeployAction"];
13499
14038
  /**
13500
14039
  * VirtualMachineIncludes
13501
14040
  * @description All includable resources linkable to the given virtual machine.
@@ -13515,24 +14054,24 @@ export interface components {
13515
14054
  [key: string]: components["schemas"]["Container"];
13516
14055
  };
13517
14056
  };
13518
- /** VirtualMachineStartTask */
13519
- VirtualMachineStartTask: {
14057
+ /** VirtualMachineStartAction */
14058
+ VirtualMachineStartAction: {
13520
14059
  /**
13521
14060
  * @description discriminator enum property added by openapi-typescript
13522
14061
  * @enum {string}
13523
14062
  */
13524
14063
  action: "start";
13525
14064
  };
13526
- /** VirtualMachineStopTask */
13527
- VirtualMachineStopTask: {
14065
+ /** VirtualMachineStopAction */
14066
+ VirtualMachineStopAction: {
13528
14067
  /**
13529
14068
  * @description discriminator enum property added by openapi-typescript
13530
14069
  * @enum {string}
13531
14070
  */
13532
14071
  action: "stop";
13533
14072
  };
13534
- /** VirtualMachineReconfigureTask */
13535
- VirtualMachineReconfigureTask: {
14073
+ /** VirtualMachineReconfigureAction */
14074
+ VirtualMachineReconfigureAction: {
13536
14075
  /**
13537
14076
  * @description The action to take. (enum property replaced by openapi-typescript)
13538
14077
  * @enum {string}
@@ -13540,8 +14079,8 @@ export interface components {
13540
14079
  action: "reconfigure";
13541
14080
  contents: components["schemas"]["VirtualMachineConfig"];
13542
14081
  };
13543
- /** VirtualMachineRootPwChangeTask */
13544
- VirtualMachineRootPwChangeTask: {
14082
+ /** VirtualMachineRootPwChangeAction */
14083
+ VirtualMachineRootPwChangeAction: {
13545
14084
  /**
13546
14085
  * @description The action to take. (enum property replaced by openapi-typescript)
13547
14086
  * @enum {string}
@@ -13552,8 +14091,8 @@ export interface components {
13552
14091
  password: string;
13553
14092
  };
13554
14093
  };
13555
- /** VirtualMachineIpAllocateTask */
13556
- VirtualMachineIpAllocateTask: {
14094
+ /** VirtualMachineIpAllocateAction */
14095
+ VirtualMachineIpAllocateAction: {
13557
14096
  /**
13558
14097
  * @description The action to take. (enum property replaced by openapi-typescript)
13559
14098
  * @enum {string}
@@ -13564,8 +14103,8 @@ export interface components {
13564
14103
  ip_id?: components["schemas"]["ID"];
13565
14104
  };
13566
14105
  };
13567
- /** VirtualMachineIpUnallocateTask */
13568
- VirtualMachineIpUnallocateTask: {
14106
+ /** VirtualMachineIpUnallocateAction */
14107
+ VirtualMachineIpUnallocateAction: {
13569
14108
  /**
13570
14109
  * @description The action to take. (enum property replaced by openapi-typescript)
13571
14110
  * @enum {string}
@@ -13576,6 +14115,8 @@ export interface components {
13576
14115
  ip_id: components["schemas"]["ID"];
13577
14116
  };
13578
14117
  };
14118
+ /** VirtualMachineStopTask.yml */
14119
+ VirtualMachineTask: components["schemas"]["VirtualMachineStartAction"] | components["schemas"]["VirtualMachineStopAction"] | components["schemas"]["VirtualMachineReconfigureAction"] | components["schemas"]["VirtualMachineRootPwChangeAction"] | components["schemas"]["VirtualMachineIpAllocateAction"] | components["schemas"]["VirtualMachineIpUnallocateAction"];
13579
14120
  /**
13580
14121
  * VirtualMachineBaseImage
13581
14122
  * @description Represents a virtual machine base OS image provided by Cycle.
@@ -13682,6 +14223,8 @@ export interface components {
13682
14223
  };
13683
14224
  MembershipIncludeParam: ("senders" | "hubs" | "roles")[];
13684
14225
  OrderIncludeParam: "promo_codes"[];
14226
+ /** @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. */
14227
+ RecordIncludeParam: ("creators" | "containers" | "containers:identifiers" | "virtual-machines" | "virtual-machines:identifiers")[];
13685
14228
  };
13686
14229
  requestBodies: never;
13687
14230
  headers: never;
@@ -14114,14 +14657,40 @@ export interface operations {
14114
14657
  };
14115
14658
  requestBody?: never;
14116
14659
  responses: {
14117
- /** @description List of announcements. */
14660
+ /** @description List of announcements. */
14661
+ 200: {
14662
+ headers: {
14663
+ [name: string]: unknown;
14664
+ };
14665
+ content: {
14666
+ "application/json": {
14667
+ data: components["schemas"]["Announcement"][];
14668
+ };
14669
+ };
14670
+ };
14671
+ default: components["responses"]["DefaultError"];
14672
+ };
14673
+ };
14674
+ getBillingStatus: {
14675
+ parameters: {
14676
+ query?: never;
14677
+ header?: never;
14678
+ path?: never;
14679
+ cookie?: never;
14680
+ };
14681
+ requestBody?: never;
14682
+ responses: {
14683
+ /** @description Returns details about the billing status of this Cycle core. */
14118
14684
  200: {
14119
14685
  headers: {
14120
14686
  [name: string]: unknown;
14121
14687
  };
14122
14688
  content: {
14123
14689
  "application/json": {
14124
- data: components["schemas"]["Announcement"][];
14690
+ data: {
14691
+ /** @description Whether billing is enabled for this core. Generally, this will only be false for dedicated cores. */
14692
+ enabled?: boolean;
14693
+ };
14125
14694
  };
14126
14695
  };
14127
14696
  };
@@ -14369,6 +14938,15 @@ export interface operations {
14369
14938
  /** @description The number of the bank account. */
14370
14939
  account_number: string;
14371
14940
  } | null;
14941
+ direct_payment?: {
14942
+ /**
14943
+ * @description The preference for how the payment will be sent.
14944
+ * @enum {string}
14945
+ */
14946
+ preference: "check" | "wire" | "ach";
14947
+ /** @description Any additional instructions for an organization's billing dept., etc. that should be known about this payment method. */
14948
+ instructions: string;
14949
+ } | null;
14372
14950
  };
14373
14951
  };
14374
14952
  };
@@ -14860,6 +15438,9 @@ export interface operations {
14860
15438
  /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the container's current state.
14861
15439
  * */
14862
15440
  state?: string;
15441
+ /** @description `filter[deprecated]=true` filter for containers that are deprecated.
15442
+ * */
15443
+ deprecated?: string;
14863
15444
  /** @description `filter[service]=value` service filtering will allow you to filter by service type: `loadbalancer`, `discovery`, `vpn`.
14864
15445
  * */
14865
15446
  service?: string;
@@ -15108,7 +15689,7 @@ export interface operations {
15108
15689
  /** @description Parameters for creating a new container job. */
15109
15690
  requestBody?: {
15110
15691
  content: {
15111
- "application/json": components["schemas"]["ContainerStartAction"] | components["schemas"]["ContainerStopAction"] | components["schemas"]["ReconfigureContainer"] | components["schemas"]["ReconfigureVolumes"] | components["schemas"]["Reimage"] | components["schemas"]["Scale"];
15692
+ "application/json": components["schemas"]["ContainerTask"];
15112
15693
  };
15113
15694
  };
15114
15695
  responses: {
@@ -15231,6 +15812,8 @@ export interface operations {
15231
15812
  query?: {
15232
15813
  /** @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. */
15233
15814
  include?: ("creators" | "servers" | "locations" | "integrations" | "containers" | "environments")[];
15815
+ /** @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. */
15816
+ meta?: "node"[];
15234
15817
  /** @description ## Filter Field
15235
15818
  * 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.
15236
15819
  * */
@@ -15342,6 +15925,8 @@ export interface operations {
15342
15925
  getInstance: {
15343
15926
  parameters: {
15344
15927
  query?: {
15928
+ /** @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. */
15929
+ meta?: "node"[];
15345
15930
  /** @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. */
15346
15931
  include?: ("creators" | "servers" | "locations" | "integrations" | "containers" | "environments")[];
15347
15932
  };
@@ -15474,7 +16059,7 @@ export interface operations {
15474
16059
  /** @description Parameters for creating a new container instance job. */
15475
16060
  requestBody?: {
15476
16061
  content: {
15477
- "application/json": components["schemas"]["Migrate"] | components["schemas"]["RevertMigration"] | components["schemas"]["ExtendVolume"];
16062
+ "application/json": components["schemas"]["InstanceTask"];
15478
16063
  };
15479
16064
  };
15480
16065
  responses: {
@@ -15644,7 +16229,7 @@ export interface operations {
15644
16229
  /** @description Parameters for creating a new container function job. */
15645
16230
  requestBody?: {
15646
16231
  content: {
15647
- "application/json": components["schemas"]["trigger"];
16232
+ "application/json": components["schemas"]["FunctionTask"];
15648
16233
  };
15649
16234
  };
15650
16235
  responses: {
@@ -15858,8 +16443,8 @@ export interface operations {
15858
16443
  };
15859
16444
  content: {
15860
16445
  "application/json": {
15861
- data: components["schemas"]["Zone"][];
15862
- includes?: components["schemas"]["ZoneIncludes"];
16446
+ data: components["schemas"]["DnsZone"][];
16447
+ includes?: components["schemas"]["DnsZoneIncludes"];
15863
16448
  };
15864
16449
  };
15865
16450
  };
@@ -15893,7 +16478,7 @@ export interface operations {
15893
16478
  };
15894
16479
  content: {
15895
16480
  "application/json": {
15896
- data: components["schemas"]["Zone"];
16481
+ data: components["schemas"]["DnsZone"];
15897
16482
  };
15898
16483
  };
15899
16484
  };
@@ -15919,7 +16504,7 @@ export interface operations {
15919
16504
  };
15920
16505
  content: {
15921
16506
  "application/json": {
15922
- data: components["schemas"]["Zone"];
16507
+ data: components["schemas"]["DnsZone"];
15923
16508
  };
15924
16509
  };
15925
16510
  };
@@ -15982,8 +16567,8 @@ export interface operations {
15982
16567
  };
15983
16568
  content: {
15984
16569
  "application/json": {
15985
- data: components["schemas"]["Zone"];
15986
- includes?: components["schemas"]["ZoneIncludes"];
16570
+ data: components["schemas"]["DnsZone"];
16571
+ includes?: components["schemas"]["DnsZoneIncludes"];
15987
16572
  };
15988
16573
  };
15989
16574
  };
@@ -16019,8 +16604,8 @@ export interface operations {
16019
16604
  };
16020
16605
  content: {
16021
16606
  "application/json": {
16022
- data: components["schemas"]["Zone"];
16023
- includes?: components["schemas"]["ZoneIncludes"];
16607
+ data: components["schemas"]["DnsZone"];
16608
+ includes?: components["schemas"]["DnsZoneIncludes"];
16024
16609
  };
16025
16610
  };
16026
16611
  };
@@ -16068,7 +16653,7 @@ export interface operations {
16068
16653
  parameters: {
16069
16654
  query?: {
16070
16655
  /** @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. */
16071
- include?: ("creators" | "containers")[];
16656
+ include?: components["parameters"]["RecordIncludeParam"];
16072
16657
  /** @description ## Filter Field
16073
16658
  * 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.
16074
16659
  * */
@@ -16098,7 +16683,7 @@ export interface operations {
16098
16683
  };
16099
16684
  content: {
16100
16685
  "application/json": {
16101
- data: components["schemas"]["Record"][];
16686
+ data: components["schemas"]["DnsRecord"][];
16102
16687
  includes?: components["schemas"]["RecordIncludes"];
16103
16688
  };
16104
16689
  };
@@ -16108,7 +16693,10 @@ export interface operations {
16108
16693
  };
16109
16694
  createDNSZoneRecord: {
16110
16695
  parameters: {
16111
- query?: never;
16696
+ query?: {
16697
+ /** @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. */
16698
+ include?: components["parameters"]["RecordIncludeParam"];
16699
+ };
16112
16700
  header?: never;
16113
16701
  path: {
16114
16702
  /** @description The ID of the Zone. */
@@ -16120,7 +16708,7 @@ export interface operations {
16120
16708
  requestBody?: {
16121
16709
  content: {
16122
16710
  "application/json": {
16123
- type: components["schemas"]["RecordTypes"];
16711
+ type: components["schemas"]["DnsRecordTypes"];
16124
16712
  /** @description A name for the given record where `@` represents the desire to use the root of the origin. */
16125
16713
  name: string;
16126
16714
  };
@@ -16134,7 +16722,8 @@ export interface operations {
16134
16722
  };
16135
16723
  content: {
16136
16724
  "application/json": {
16137
- data: components["schemas"]["Record"];
16725
+ data: components["schemas"]["DnsRecord"];
16726
+ includes?: components["schemas"]["RecordIncludes"];
16138
16727
  };
16139
16728
  };
16140
16729
  };
@@ -16171,7 +16760,10 @@ export interface operations {
16171
16760
  };
16172
16761
  updateDNSZoneRecord: {
16173
16762
  parameters: {
16174
- query?: never;
16763
+ query?: {
16764
+ /** @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. */
16765
+ include?: components["parameters"]["RecordIncludeParam"];
16766
+ };
16175
16767
  header?: never;
16176
16768
  path: {
16177
16769
  /** @description The ID of the Zone. */
@@ -16185,7 +16777,7 @@ export interface operations {
16185
16777
  requestBody?: {
16186
16778
  content: {
16187
16779
  "application/json": {
16188
- type: components["schemas"]["RecordTypes"];
16780
+ type: components["schemas"]["DnsRecordTypes"];
16189
16781
  };
16190
16782
  };
16191
16783
  };
@@ -16197,7 +16789,8 @@ export interface operations {
16197
16789
  };
16198
16790
  content: {
16199
16791
  "application/json": {
16200
- data: components["schemas"]["Record"];
16792
+ data: components["schemas"]["DnsRecord"];
16793
+ includes?: components["schemas"]["RecordIncludes"];
16201
16794
  };
16202
16795
  };
16203
16796
  };
@@ -16590,7 +17183,7 @@ export interface operations {
16590
17183
  /** @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. */
16591
17184
  meta?: ("containers" | "containers_count" | "instances_count")[];
16592
17185
  /** @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. */
16593
- include?: ("creators" | "stacks")[];
17186
+ include?: ("creators" | "stacks" | "clusters")[];
16594
17187
  };
16595
17188
  header?: never;
16596
17189
  path: {
@@ -16611,6 +17204,7 @@ export interface operations {
16611
17204
  data: components["schemas"]["Environment"];
16612
17205
  includes?: {
16613
17206
  creators?: components["schemas"]["CreatorInclude"];
17207
+ clusters?: components["schemas"]["ClusterIncludes"];
16614
17208
  };
16615
17209
  };
16616
17210
  };
@@ -16664,8 +17258,7 @@ export interface operations {
16664
17258
  about?: components["schemas"]["EnvironmentAbout"] | null;
16665
17259
  /** @description The level of monitoring to enable for this environment. There is a cost associated with higher levels of monitoring. */
16666
17260
  monitoring?: {
16667
- /** @enum {string} */
16668
- tier: "limited" | "standard" | "premium" | "enterprise";
17261
+ tier: components["schemas"]["MonitoringTier"];
16669
17262
  } | null;
16670
17263
  };
16671
17264
  };
@@ -16731,7 +17324,7 @@ export interface operations {
16731
17324
  /** @description Parameters for creating a new Environment job. */
16732
17325
  requestBody?: {
16733
17326
  content: {
16734
- "application/json": components["schemas"]["EnvironmentStartAction"] | components["schemas"]["EnvironmentStopAction"] | components["schemas"]["EnvironmentInitializeAction"] | components["schemas"]["EnvironmentReconfigureDeploymentsAction"];
17327
+ "application/json": components["schemas"]["EnvironmentTask"];
16735
17328
  };
16736
17329
  };
16737
17330
  responses: {
@@ -17508,7 +18101,7 @@ export interface operations {
17508
18101
  /** @description The task contents used to build the Environment VPN Job. */
17509
18102
  requestBody?: {
17510
18103
  content: {
17511
- "application/json": components["schemas"]["VpnResetTask"] | components["schemas"]["VpnReconfigureTask"];
18104
+ "application/json": components["schemas"]["VpnTask"];
17512
18105
  };
17513
18106
  };
17514
18107
  responses: {
@@ -17674,6 +18267,8 @@ export interface operations {
17674
18267
  webhooks?: components["schemas"]["HubWebhooks"];
17675
18268
  security?: components["schemas"]["HubSecurity"];
17676
18269
  identifier?: string;
18270
+ /** @description Email addresses that will receive any invoices or billing related correspondence. */
18271
+ billing_emails?: string[];
17677
18272
  billing_contact?: {
17678
18273
  name?: string | null;
17679
18274
  legal_business_name?: string | null;
@@ -19357,6 +19952,7 @@ export interface operations {
19357
19952
  data: {
19358
19953
  "resource-density"?: components["schemas"]["DeploymentStrategy"];
19359
19954
  "high-availability"?: components["schemas"]["DeploymentStrategy"];
19955
+ distributed?: components["schemas"]["DeploymentStrategy"];
19360
19956
  "first-available"?: components["schemas"]["DeploymentStrategy"];
19361
19957
  node?: components["schemas"]["DeploymentStrategy"];
19362
19958
  edge?: components["schemas"]["DeploymentStrategy"];
@@ -19645,6 +20241,268 @@ export interface operations {
19645
20241
  default: components["responses"]["DefaultError"];
19646
20242
  };
19647
20243
  };
20244
+ getVirtualProviderIsos: {
20245
+ parameters: {
20246
+ query?: {
20247
+ /** @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. */
20248
+ include?: "integrations"[];
20249
+ };
20250
+ header?: never;
20251
+ path: {
20252
+ /** @description The ID of the integration. */
20253
+ integrationId: string;
20254
+ };
20255
+ cookie?: never;
20256
+ };
20257
+ requestBody?: never;
20258
+ responses: {
20259
+ /** @description Returns an a list of ISOs. */
20260
+ 200: {
20261
+ headers: {
20262
+ [name: string]: unknown;
20263
+ };
20264
+ content: {
20265
+ "application/json": {
20266
+ data: components["schemas"]["VirtualProviderIso"][];
20267
+ includes?: components["schemas"]["VirtualProviderIsoIncludes"];
20268
+ };
20269
+ };
20270
+ };
20271
+ };
20272
+ };
20273
+ createVirtualProviderIso: {
20274
+ parameters: {
20275
+ query?: never;
20276
+ header?: never;
20277
+ path: {
20278
+ /** @description The ID of the virtual provider integration to execute the job on. */
20279
+ integrationId: string;
20280
+ };
20281
+ cookie?: never;
20282
+ };
20283
+ /** @description Parameters for creating a new virtual provider job. */
20284
+ requestBody?: {
20285
+ content: {
20286
+ "application/json": {
20287
+ /** @description The name of the ISO. */
20288
+ name: string;
20289
+ config: {
20290
+ /** @description Authentication token for the ISO. */
20291
+ token: string;
20292
+ ipxe?: {
20293
+ /** @description VLAN ID for the IPXE boot. */
20294
+ vlan_id?: number | null;
20295
+ /** @description Network interface for the IPXE boot. */
20296
+ network_interface?: number | null;
20297
+ /** @description Static IP assigned to the IPXE boot. */
20298
+ static_ip?: string | null;
20299
+ /** @description Netmask assigned to the IPXE boot. */
20300
+ netmask?: string | null;
20301
+ /** @description Gateway IP assigned to the IPXE boot. */
20302
+ gateway_ip?: string | null;
20303
+ /** @description DNS IP assigned to the IPXE boot. */
20304
+ dns_ip?: string | null;
20305
+ } | null;
20306
+ server?: {
20307
+ storage?: {
20308
+ conditional_format?: boolean;
20309
+ } | null;
20310
+ sdn_neighbor_preference?: ("ipv4" | "ipv6") | null;
20311
+ /** @description An array of server network interfaces. */
20312
+ nics?: components["schemas"]["VirtualProviderIsoNic"][];
20313
+ /** @description An array of bonds */
20314
+ bonds?: components["schemas"]["VirtualProviderIsoBond"][];
20315
+ } | null;
20316
+ };
20317
+ };
20318
+ };
20319
+ };
20320
+ responses: {
20321
+ /** @description Returns an ISO. */
20322
+ 201: {
20323
+ headers: {
20324
+ [name: string]: unknown;
20325
+ };
20326
+ content: {
20327
+ "application/json": {
20328
+ data: components["schemas"]["VirtualProviderIso"];
20329
+ };
20330
+ };
20331
+ };
20332
+ default: components["responses"]["DefaultError"];
20333
+ };
20334
+ };
20335
+ getVirtualProviderIso: {
20336
+ parameters: {
20337
+ query?: {
20338
+ /** @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. */
20339
+ include?: "integrations"[];
20340
+ };
20341
+ header?: never;
20342
+ path: {
20343
+ /** @description The ID of the virtual provider integration. */
20344
+ integrationId: string;
20345
+ /** @description The ID for the virtual provider ISO. */
20346
+ isoId: string;
20347
+ };
20348
+ cookie?: never;
20349
+ };
20350
+ requestBody?: never;
20351
+ responses: {
20352
+ /** @description Returns a virtual provider ISO. */
20353
+ 202: {
20354
+ headers: {
20355
+ [name: string]: unknown;
20356
+ };
20357
+ content: {
20358
+ "application/json": {
20359
+ data: components["schemas"]["VirtualProviderIso"];
20360
+ includes?: components["schemas"]["VirtualProviderIsoIncludes"];
20361
+ };
20362
+ };
20363
+ };
20364
+ default: components["responses"]["DefaultError"];
20365
+ };
20366
+ };
20367
+ deleteVirtualProviderIso: {
20368
+ parameters: {
20369
+ query?: never;
20370
+ header?: never;
20371
+ path: {
20372
+ /** @description The ID of the virtual provider integration. */
20373
+ integrationId: string;
20374
+ /** @description The ID for the virtual provider ISO. */
20375
+ isoId: string;
20376
+ };
20377
+ cookie?: never;
20378
+ };
20379
+ requestBody?: never;
20380
+ responses: {
20381
+ /** @description Returns a Job Descriptor. */
20382
+ 202: {
20383
+ headers: {
20384
+ [name: string]: unknown;
20385
+ };
20386
+ content: {
20387
+ "application/json": {
20388
+ data: components["schemas"]["JobDescriptor"];
20389
+ };
20390
+ };
20391
+ };
20392
+ default: components["responses"]["DefaultError"];
20393
+ };
20394
+ };
20395
+ updateVirtualProviderIso: {
20396
+ parameters: {
20397
+ query?: never;
20398
+ header?: never;
20399
+ path: {
20400
+ /** @description The ID of the virtual provider integration. */
20401
+ integrationId: string;
20402
+ /** @description The ID for the virtual provider ISO. */
20403
+ isoId: string;
20404
+ };
20405
+ cookie?: never;
20406
+ };
20407
+ /** @description Parameters for updating an ISO. */
20408
+ requestBody?: {
20409
+ content: {
20410
+ "application/json": {
20411
+ /** @description The name of the ISO. */
20412
+ name?: string;
20413
+ config?: {
20414
+ server?: {
20415
+ storage?: {
20416
+ conditional_format?: boolean;
20417
+ } | null;
20418
+ sdn_neighbor_preference?: ("ipv4" | "ipv6") | null;
20419
+ /** @description An array of server network interfaces. */
20420
+ nics: components["schemas"]["VirtualProviderIsoNic"][];
20421
+ /** @description An array of bonds */
20422
+ bonds?: components["schemas"]["VirtualProviderIsoBond"][];
20423
+ } | null;
20424
+ };
20425
+ };
20426
+ };
20427
+ };
20428
+ responses: {
20429
+ /** @description Returns a virtual provider ISO. */
20430
+ 202: {
20431
+ headers: {
20432
+ [name: string]: unknown;
20433
+ };
20434
+ content: {
20435
+ "application/json": {
20436
+ data: components["schemas"]["VirtualProviderIso"];
20437
+ };
20438
+ };
20439
+ };
20440
+ default: components["responses"]["DefaultError"];
20441
+ };
20442
+ };
20443
+ createVirtualProviderIsoJob: {
20444
+ parameters: {
20445
+ query?: never;
20446
+ header?: never;
20447
+ path: {
20448
+ /** @description The ID of the virtual provider integration. */
20449
+ integrationId: string;
20450
+ /** @description The ID for the virtual provider ISO. */
20451
+ isoId: string;
20452
+ };
20453
+ cookie?: never;
20454
+ };
20455
+ /** @description Parameters for creating a new virtual provider iso job. */
20456
+ requestBody?: {
20457
+ content: {
20458
+ "application/json": components["schemas"]["VirtualProviderIsoTask"];
20459
+ };
20460
+ };
20461
+ responses: {
20462
+ /** @description Returns a job descriptor. */
20463
+ 202: {
20464
+ headers: {
20465
+ [name: string]: unknown;
20466
+ };
20467
+ content: {
20468
+ "application/json": {
20469
+ data: components["schemas"]["JobDescriptor"];
20470
+ };
20471
+ };
20472
+ };
20473
+ default: components["responses"]["DefaultError"];
20474
+ };
20475
+ };
20476
+ getVirtualProviderIsoDownloadUrl: {
20477
+ parameters: {
20478
+ query?: never;
20479
+ header?: never;
20480
+ path: {
20481
+ /** @description The ID of the virtual provider integration. */
20482
+ integrationId: string;
20483
+ /** @description The ID for the virtual provider ISO. */
20484
+ isoId: string;
20485
+ };
20486
+ cookie?: never;
20487
+ };
20488
+ requestBody?: never;
20489
+ responses: {
20490
+ /** @description Returns a download URL. */
20491
+ 202: {
20492
+ headers: {
20493
+ [name: string]: unknown;
20494
+ };
20495
+ content: {
20496
+ "application/json": {
20497
+ data: {
20498
+ url: string;
20499
+ };
20500
+ };
20501
+ };
20502
+ };
20503
+ default: components["responses"]["DefaultError"];
20504
+ };
20505
+ };
19648
20506
  getClusters: {
19649
20507
  parameters: {
19650
20508
  query?: {
@@ -20006,6 +20864,8 @@ export interface operations {
20006
20864
  requestBody?: {
20007
20865
  content: {
20008
20866
  "application/json": {
20867
+ /** @description A custom name given to the server for identification purposes. Does not affect server hostname. */
20868
+ nickname?: string | null;
20009
20869
  /** @description Server constriants. */
20010
20870
  constraints: {
20011
20871
  /** @description A list of Server tags. */
@@ -20125,7 +20985,7 @@ export interface operations {
20125
20985
  /** @description Parameters for creating the new Server Job. */
20126
20986
  requestBody?: {
20127
20987
  content: {
20128
- "application/json": components["schemas"]["ReconfigureSharedFsTask"] | components["schemas"]["ReconfigureServerFeaturesTask"] | components["schemas"]["RestartServerTask"] | components["schemas"]["RestartComputeTask"] | components["schemas"]["RestartComputeSpawnerTask"] | components["schemas"]["EvacuateServerTask"] | components["schemas"]["EvacuateServerResetTask"];
20988
+ "application/json": components["schemas"]["ServerTask"];
20129
20989
  };
20130
20990
  };
20131
20991
  responses: {
@@ -20230,7 +21090,7 @@ export interface operations {
20230
21090
  default: components["responses"]["DefaultError"];
20231
21091
  };
20232
21092
  };
20233
- getInfrastructureIPPools: {
21093
+ getIpPools: {
20234
21094
  parameters: {
20235
21095
  query?: {
20236
21096
  /** @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. */
@@ -20245,6 +21105,12 @@ export interface operations {
20245
21105
  /** @description `filter[state]=value1,value2` state filtering will allow you to filter by the IP's current state.
20246
21106
  * */
20247
21107
  state?: string;
21108
+ /** @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.
21109
+ * */
21110
+ server?: string;
21111
+ /** @description `filter[location]=ID` location filtering by ID. Submit the ID of the location you wish to filter by.
21112
+ * */
21113
+ location?: string;
20248
21114
  };
20249
21115
  /** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
20250
21116
  sort?: components["parameters"]["SortParam"];
@@ -20264,8 +21130,43 @@ export interface operations {
20264
21130
  };
20265
21131
  content: {
20266
21132
  "application/json": {
20267
- data: components["schemas"]["Pool"][];
20268
- includes?: components["schemas"]["PoolIncludes"];
21133
+ data: components["schemas"]["IpPool"][];
21134
+ includes?: components["schemas"]["IpPoolIncludes"];
21135
+ };
21136
+ };
21137
+ };
21138
+ default: components["responses"]["DefaultError"];
21139
+ };
21140
+ };
21141
+ createIpPool: {
21142
+ parameters: {
21143
+ query?: never;
21144
+ header?: never;
21145
+ path?: never;
21146
+ cookie?: never;
21147
+ };
21148
+ /** @description Parameters for creating a new IP pool. */
21149
+ requestBody?: {
21150
+ content: {
21151
+ "application/json": {
21152
+ server_id: components["schemas"]["ID"];
21153
+ block: {
21154
+ network?: components["schemas"]["Cidr"] | null;
21155
+ cidr: components["schemas"]["Cidr"];
21156
+ gateway: components["schemas"]["IpAddress"] | null;
21157
+ };
21158
+ };
21159
+ };
21160
+ };
21161
+ responses: {
21162
+ /** @description Returns an IP Pool. */
21163
+ 201: {
21164
+ headers: {
21165
+ [name: string]: unknown;
21166
+ };
21167
+ content: {
21168
+ "application/json": {
21169
+ data: components["schemas"]["IpPool"];
20269
21170
  };
20270
21171
  };
20271
21172
  };
@@ -20294,8 +21195,8 @@ export interface operations {
20294
21195
  };
20295
21196
  content: {
20296
21197
  "application/json": {
20297
- data: components["schemas"]["Pool"];
20298
- includes?: components["schemas"]["PoolIncludes"];
21198
+ data: components["schemas"]["IpPool"];
21199
+ includes?: components["schemas"]["IpPoolIncludes"];
20299
21200
  };
20300
21201
  };
20301
21202
  };
@@ -20307,7 +21208,7 @@ export interface operations {
20307
21208
  query?: never;
20308
21209
  header?: never;
20309
21210
  path: {
20310
- /** @description The ID for the given IP Pool. */
21211
+ /** @description The ID for the given IP pool. */
20311
21212
  poolId: string;
20312
21213
  };
20313
21214
  cookie?: never;
@@ -21041,7 +21942,7 @@ export interface operations {
21041
21942
  /** @description Parameters for creating a new Pipeline job. */
21042
21943
  requestBody?: {
21043
21944
  content: {
21044
- "application/json": components["schemas"]["TriggerPipelineAction"] | components["schemas"]["RerunPipelineAction"];
21945
+ "application/json": components["schemas"]["PipelineTask"];
21045
21946
  };
21046
21947
  };
21047
21948
  responses: {
@@ -21369,6 +22270,7 @@ export interface operations {
21369
22270
  name: string;
21370
22271
  /** @description A network identifier used to construct http calls that specifically use this network over another. */
21371
22272
  identifier: string;
22273
+ vlan?: components["schemas"]["NetworkVlan"] | null;
21372
22274
  acl?: components["schemas"]["ACL"] | null;
21373
22275
  /** @description The infrastructure cluster the environments belonging to this network belong to. */
21374
22276
  cluster: string;
@@ -21468,6 +22370,15 @@ export interface operations {
21468
22370
  "application/json": {
21469
22371
  /** @description The name of the network. */
21470
22372
  name?: string;
22373
+ vlan?: {
22374
+ location_ids?: components["schemas"]["ID"][];
22375
+ host_interface?: string | null;
22376
+ /** @description An array of defined VLAN routes */
22377
+ routes?: {
22378
+ usable?: components["schemas"]["Cidr"];
22379
+ gateway?: components["schemas"]["IpAddress"];
22380
+ }[];
22381
+ } | null;
21471
22382
  };
21472
22383
  };
21473
22384
  };
@@ -22038,7 +22949,7 @@ export interface operations {
22038
22949
  /** @description Parameters for creating a new Stack Build Job. */
22039
22950
  requestBody?: {
22040
22951
  content: {
22041
- "application/json": components["schemas"]["GenerateStackBuildAction"] | components["schemas"]["DeployStackBuildAction"];
22952
+ "application/json": components["schemas"]["StackBuildTask"];
22042
22953
  };
22043
22954
  };
22044
22955
  responses: {
@@ -22063,7 +22974,7 @@ export interface operations {
22063
22974
  * In the case of applying a meta to a collection of resources, each resource will have its own relevant meta data.
22064
22975
  * In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
22065
22976
  * */
22066
- meta?: ("domains" | "ips")[];
22977
+ meta?: ("domains" | "ips" | "vm_priv_ips" | "server")[];
22067
22978
  /** @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
22068
22979
  * 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.
22069
22980
  * */
@@ -22195,7 +23106,7 @@ export interface operations {
22195
23106
  * In the case of applying a meta to a collection of resources, each resource will have its own relevant meta data.
22196
23107
  * In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
22197
23108
  * */
22198
- meta?: ("domains" | "ips" | "server")[];
23109
+ meta?: ("domains" | "ips" | "server" | "vm_priv_ips")[];
22199
23110
  /** @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
22200
23111
  * 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.
22201
23112
  * */
@@ -22310,7 +23221,7 @@ export interface operations {
22310
23221
  /** @description Parameters for creating a new virtual machine job. */
22311
23222
  requestBody?: {
22312
23223
  content: {
22313
- "application/json": components["schemas"]["VirtualMachineStartTask"] | components["schemas"]["VirtualMachineStopTask"] | components["schemas"]["VirtualMachineReconfigureTask"] | components["schemas"]["VirtualMachineRootPwChangeTask"] | components["schemas"]["VirtualMachineIpAllocateTask"] | components["schemas"]["VirtualMachineIpUnallocateTask"];
23224
+ "application/json": components["schemas"]["VirtualMachineTask"];
22314
23225
  };
22315
23226
  };
22316
23227
  responses: {