@townco/fly 0.1.69 → 0.1.70

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.
@@ -1,2592 +0,0 @@
1
- export type ClientOptions = {
2
- baseUrl: "https://api.machines.dev/v1" | (string & {});
3
- };
4
- export type App = {
5
- id?: string;
6
- internal_numeric_id?: number;
7
- machine_count?: number;
8
- name?: string;
9
- network?: string;
10
- organization?: AppOrganizationInfo;
11
- status?: string;
12
- volume_count?: number;
13
- };
14
- export type AppOrganizationInfo = {
15
- internal_numeric_id?: number;
16
- name?: string;
17
- slug?: string;
18
- };
19
- export type AppSecret = {
20
- created_at?: string;
21
- digest?: string;
22
- name?: string;
23
- updated_at?: string;
24
- value?: string;
25
- };
26
- export type AppSecrets = {
27
- secrets?: Array<AppSecret>;
28
- };
29
- export type AppSecretsUpdateRequest = {
30
- values?: {
31
- [key: string]: string;
32
- };
33
- };
34
- export type AppSecretsUpdateResp = {
35
- /**
36
- * DEPRECATED
37
- */
38
- Version?: number;
39
- secrets?: Array<AppSecret>;
40
- version?: number;
41
- };
42
- export type CheckStatus = {
43
- name?: string;
44
- output?: string;
45
- status?: string;
46
- updated_at?: string;
47
- };
48
- export type CreateAppDeployTokenRequest = {
49
- expiry?: string;
50
- };
51
- export type CreateAppRequest = {
52
- enable_subdomains?: boolean;
53
- name?: string;
54
- network?: string;
55
- org_slug?: string;
56
- };
57
- export type CreateAppResponse = {
58
- token?: string;
59
- };
60
- export type CreateLeaseRequest = {
61
- description?: string;
62
- /**
63
- * seconds lease will be valid
64
- */
65
- ttl?: number;
66
- };
67
- export type CreateMachineRequest = {
68
- /**
69
- * An object defining the Machine configuration
70
- */
71
- config?: FlyMachineConfig;
72
- lease_ttl?: number;
73
- lsvd?: boolean;
74
- min_secrets_version?: number;
75
- /**
76
- * Unique name for this Machine. If omitted, one is generated for you
77
- */
78
- name?: string;
79
- /**
80
- * The target region. Omitting this param launches in the same region as your WireGuard peer connection (somewhere near you).
81
- */
82
- region?: string;
83
- skip_launch?: boolean;
84
- skip_secrets?: boolean;
85
- skip_service_registration?: boolean;
86
- };
87
- /**
88
- * Optional parameters
89
- */
90
- export type CreateOidcTokenRequest = {
91
- aud?: string;
92
- aws_principal_tags?: boolean;
93
- };
94
- export type CreateVolumeRequest = {
95
- /**
96
- * enable scheduled automatic snapshots. Defaults to `true`
97
- */
98
- auto_backup_enabled?: boolean;
99
- compute?: FlyMachineGuest;
100
- compute_image?: string;
101
- encrypted?: boolean;
102
- fstype?: string;
103
- name?: string;
104
- region?: string;
105
- require_unique_zone?: boolean;
106
- size_gb?: number;
107
- /**
108
- * restore from snapshot
109
- */
110
- snapshot_id?: string;
111
- snapshot_retention?: number;
112
- /**
113
- * fork from remote volume
114
- */
115
- source_volume_id?: string;
116
- unique_zone_app_wide?: boolean;
117
- };
118
- export type CurrentTokenResponse = {
119
- tokens?: Array<MainTokenInfo>;
120
- };
121
- export type DecryptSecretkeyRequest = {
122
- associated_data?: Array<number>;
123
- ciphertext?: Array<number>;
124
- };
125
- export type DecryptSecretkeyResponse = {
126
- plaintext?: Array<number>;
127
- };
128
- export type DeleteAppSecretResponse = {
129
- /**
130
- * DEPRECATED
131
- */
132
- Version?: number;
133
- version?: number;
134
- };
135
- export type DeleteSecretkeyResponse = {
136
- /**
137
- * DEPRECATED
138
- */
139
- Version?: number;
140
- version?: number;
141
- };
142
- export type EncryptSecretkeyRequest = {
143
- associated_data?: Array<number>;
144
- plaintext?: Array<number>;
145
- };
146
- export type EncryptSecretkeyResponse = {
147
- ciphertext?: Array<number>;
148
- };
149
- export type ErrorResponse = {
150
- /**
151
- * Deprecated
152
- */
153
- details?: {
154
- [key: string]: unknown;
155
- };
156
- error?: string;
157
- status?: MainStatusCode;
158
- };
159
- export type ExtendVolumeRequest = {
160
- size_gb?: number;
161
- };
162
- export type ExtendVolumeResponse = {
163
- needs_restart?: boolean;
164
- volume?: Volume;
165
- };
166
- export type IpAssignment = {
167
- created_at?: string;
168
- ip?: string;
169
- region?: string;
170
- service_name?: string;
171
- shared?: boolean;
172
- };
173
- export type ImageRef = {
174
- digest?: string;
175
- labels?: {
176
- [key: string]: string;
177
- };
178
- registry?: string;
179
- repository?: string;
180
- tag?: string;
181
- };
182
- export type Lease = {
183
- /**
184
- * Description or reason for the Lease.
185
- */
186
- description?: string;
187
- /**
188
- * ExpiresAt is the unix timestamp in UTC to denote when the Lease will no longer be valid.
189
- */
190
- expires_at?: number;
191
- /**
192
- * Nonce is the unique ID autogenerated and associated with the Lease.
193
- */
194
- nonce?: string;
195
- /**
196
- * Owner is the user identifier which acquired the Lease.
197
- */
198
- owner?: string;
199
- /**
200
- * Machine version
201
- */
202
- version?: string;
203
- };
204
- export type ListAppsResponse = {
205
- apps?: Array<App>;
206
- total_apps?: number;
207
- };
208
- export type ListenSocket = {
209
- address?: string;
210
- proto?: string;
211
- };
212
- export type Machine = {
213
- checks?: Array<CheckStatus>;
214
- config?: FlyMachineConfig;
215
- created_at?: string;
216
- events?: Array<MachineEvent>;
217
- host_status?: "ok" | "unknown" | "unreachable";
218
- id?: string;
219
- image_ref?: ImageRef;
220
- incomplete_config?: FlyMachineConfig;
221
- /**
222
- * InstanceID is unique for each version of the machine
223
- */
224
- instance_id?: string;
225
- name?: string;
226
- /**
227
- * Nonce is only every returned on machine creation if a lease_duration was provided.
228
- */
229
- nonce?: string;
230
- /**
231
- * PrivateIP is the internal 6PN address of the machine.
232
- */
233
- private_ip?: string;
234
- region?: string;
235
- state?: string;
236
- updated_at?: string;
237
- };
238
- export type MachineEvent = {
239
- id?: string;
240
- request?: {
241
- [key: string]: unknown;
242
- };
243
- source?: string;
244
- status?: string;
245
- timestamp?: number;
246
- type?: string;
247
- };
248
- export type MachineExecRequest = {
249
- /**
250
- * Deprecated: use Command instead
251
- */
252
- cmd?: string;
253
- command?: Array<string>;
254
- container?: string;
255
- stdin?: string;
256
- timeout?: number;
257
- };
258
- export type MachineVersion = {
259
- user_config?: FlyMachineConfig;
260
- version?: string;
261
- };
262
- export type ProcessStat = {
263
- command?: string;
264
- cpu?: number;
265
- directory?: string;
266
- listen_sockets?: Array<ListenSocket>;
267
- pid?: number;
268
- rss?: number;
269
- rtime?: number;
270
- stime?: number;
271
- };
272
- export type SecretKey = {
273
- created_at?: string;
274
- name?: string;
275
- public_key?: Array<number>;
276
- type?: string;
277
- updated_at?: string;
278
- };
279
- export type SecretKeys = {
280
- secret_keys?: Array<SecretKey>;
281
- };
282
- export type SetAppSecretRequest = {
283
- value?: string;
284
- };
285
- export type SetAppSecretResponse = {
286
- /**
287
- * DEPRECATED
288
- */
289
- Version?: number;
290
- created_at?: string;
291
- digest?: string;
292
- name?: string;
293
- updated_at?: string;
294
- value?: string;
295
- version?: number;
296
- };
297
- export type SetSecretkeyRequest = {
298
- type?: string;
299
- value?: Array<number>;
300
- };
301
- export type SetSecretkeyResponse = {
302
- /**
303
- * DEPRECATED
304
- */
305
- Version?: number;
306
- created_at?: string;
307
- name?: string;
308
- public_key?: Array<number>;
309
- type?: string;
310
- updated_at?: string;
311
- version?: number;
312
- };
313
- export type SignSecretkeyRequest = {
314
- plaintext?: Array<number>;
315
- };
316
- export type SignSecretkeyResponse = {
317
- signature?: Array<number>;
318
- };
319
- export type SignalRequest = {
320
- signal?: "SIGABRT" | "SIGALRM" | "SIGFPE" | "SIGHUP" | "SIGILL" | "SIGINT" | "SIGKILL" | "SIGPIPE" | "SIGQUIT" | "SIGSEGV" | "SIGTERM" | "SIGTRAP" | "SIGUSR1";
321
- };
322
- export type StopRequest = {
323
- signal?: string;
324
- timeout?: FlyDuration;
325
- };
326
- export type UpdateMachineRequest = {
327
- /**
328
- * An object defining the Machine configuration
329
- */
330
- config?: FlyMachineConfig;
331
- current_version?: string;
332
- lease_ttl?: number;
333
- lsvd?: boolean;
334
- min_secrets_version?: number;
335
- /**
336
- * Unique name for this Machine. If omitted, one is generated for you
337
- */
338
- name?: string;
339
- /**
340
- * The target region. Omitting this param launches in the same region as your WireGuard peer connection (somewhere near you).
341
- */
342
- region?: string;
343
- skip_launch?: boolean;
344
- skip_secrets?: boolean;
345
- skip_service_registration?: boolean;
346
- };
347
- export type UpdateVolumeRequest = {
348
- auto_backup_enabled?: boolean;
349
- snapshot_retention?: number;
350
- };
351
- export type VerifySecretkeyRequest = {
352
- plaintext?: Array<number>;
353
- signature?: Array<number>;
354
- };
355
- export type Volume = {
356
- attached_alloc_id?: string;
357
- attached_machine_id?: string;
358
- auto_backup_enabled?: boolean;
359
- block_size?: number;
360
- blocks?: number;
361
- blocks_avail?: number;
362
- blocks_free?: number;
363
- bytes_total?: number;
364
- bytes_used?: number;
365
- created_at?: string;
366
- encrypted?: boolean;
367
- fstype?: string;
368
- host_status?: "ok" | "unknown" | "unreachable";
369
- id?: string;
370
- name?: string;
371
- region?: string;
372
- size_gb?: number;
373
- snapshot_retention?: number;
374
- state?: string;
375
- zone?: string;
376
- };
377
- export type VolumeSnapshot = {
378
- created_at?: string;
379
- digest?: string;
380
- id?: string;
381
- retention_days?: number;
382
- size?: number;
383
- status?: string;
384
- volume_size?: number;
385
- };
386
- export type AssignIpRequest = {
387
- network?: string;
388
- org_slug?: string;
389
- region?: string;
390
- service_name?: string;
391
- type?: string;
392
- };
393
- export type FlyContainerConfig = {
394
- /**
395
- * CmdOverride is used to override the default command of the image.
396
- */
397
- cmd?: Array<string>;
398
- /**
399
- * DependsOn can be used to define dependencies between containers. The container will only be
400
- * started after all of its dependent conditions have been satisfied.
401
- */
402
- depends_on?: Array<FlyContainerDependency>;
403
- /**
404
- * EntrypointOverride is used to override the default entrypoint of the image.
405
- */
406
- entrypoint?: Array<string>;
407
- /**
408
- * ExtraEnv is used to add additional environment variables to the container.
409
- */
410
- env?: {
411
- [key: string]: string;
412
- };
413
- /**
414
- * EnvFrom can be provided to set environment variables from machine fields.
415
- */
416
- env_from?: Array<FlyEnvFrom>;
417
- /**
418
- * Image Config overrides - these fields are used to override the image configuration.
419
- * If not provided, the image configuration will be used.
420
- * ExecOverride is used to override the default command of the image.
421
- */
422
- exec?: Array<string>;
423
- /**
424
- * Files are files that will be written to the container file system.
425
- */
426
- files?: Array<FlyFile>;
427
- /**
428
- * Healthchecks determine the health of your containers. Healthchecks can use HTTP, TCP or an Exec command.
429
- */
430
- healthchecks?: Array<FlyContainerHealthcheck>;
431
- /**
432
- * Image is the docker image to run.
433
- */
434
- image?: string;
435
- /**
436
- * Name is used to identify the container in the machine.
437
- */
438
- name?: string;
439
- /**
440
- * Restart is used to define the restart policy for the container. NOTE: spot-price is not
441
- * supported for containers.
442
- */
443
- restart?: FlyMachineRestart;
444
- /**
445
- * Secrets can be provided at the process level to explicitly indicate which secrets should be
446
- * used for the process. If not provided, the secrets provided at the machine level will be used.
447
- */
448
- secrets?: Array<FlyMachineSecret>;
449
- /**
450
- * Stop is used to define the signal and timeout for stopping the container.
451
- */
452
- stop?: FlyStopConfig;
453
- /**
454
- * UserOverride is used to override the default user of the image.
455
- */
456
- user?: string;
457
- };
458
- export type FlyContainerDependency = {
459
- condition?: FlyContainerDependencyCondition;
460
- name?: string;
461
- };
462
- export type FlyContainerDependencyCondition = "exited_successfully" | "healthy" | "started";
463
- export type FlyContainerHealthcheck = {
464
- exec?: FlyExecHealthcheck;
465
- /**
466
- * The number of times the check must fail before considering the container unhealthy.
467
- */
468
- failure_threshold?: number;
469
- /**
470
- * The time in seconds to wait after a container starts before checking its health.
471
- */
472
- grace_period?: number;
473
- http?: FlyHttpHealthcheck;
474
- /**
475
- * The time in seconds between executing the defined check.
476
- */
477
- interval?: number;
478
- /**
479
- * Kind of healthcheck (readiness, liveness)
480
- */
481
- kind?: FlyContainerHealthcheckKind;
482
- /**
483
- * The name of the check. Must be unique within the container.
484
- */
485
- name?: string;
486
- /**
487
- * The number of times the check must succeeed before considering the container healthy.
488
- */
489
- success_threshold?: number;
490
- tcp?: FlyTcpHealthcheck;
491
- /**
492
- * The time in seconds to wait for the check to complete.
493
- */
494
- timeout?: number;
495
- /**
496
- * Unhealthy policy that determines what action to take if a container is deemed unhealthy
497
- */
498
- unhealthy?: FlyUnhealthyPolicy;
499
- };
500
- export type FlyContainerHealthcheckKind = "readiness" | "liveness";
501
- export type FlyContainerHealthcheckScheme = "http" | "https";
502
- export type FlyDnsConfig = {
503
- dns_forward_rules?: Array<FlyDnsForwardRule>;
504
- hostname?: string;
505
- hostname_fqdn?: string;
506
- nameservers?: Array<string>;
507
- options?: Array<FlyDnsOption>;
508
- searches?: Array<string>;
509
- skip_registration?: boolean;
510
- };
511
- export type FlyDuration = {
512
- "time.Duration"?: number;
513
- };
514
- /**
515
- * EnvVar defines an environment variable to be populated from a machine field, env_var
516
- */
517
- export type FlyEnvFrom = {
518
- /**
519
- * EnvVar is required and is the name of the environment variable that will be set from the
520
- * secret. It must be a valid environment variable name.
521
- */
522
- env_var?: string;
523
- /**
524
- * FieldRef selects a field of the Machine: supports id, version, app_name, private_ip, region, image.
525
- */
526
- field_ref?: "id" | "version" | "app_name" | "private_ip" | "region" | "image";
527
- };
528
- export type FlyExecHealthcheck = {
529
- /**
530
- * The command to run to check the health of the container (e.g. ["cat", "/tmp/healthy"])
531
- */
532
- command?: Array<string>;
533
- };
534
- /**
535
- * A file that will be written to the Machine. One of RawValue or SecretName must be set.
536
- */
537
- export type FlyFile = {
538
- /**
539
- * GuestPath is the path on the machine where the file will be written and must be an absolute path.
540
- * For example: /full/path/to/file.json
541
- */
542
- guest_path?: string;
543
- /**
544
- * The name of an image to use the OCI image config as the file contents.
545
- */
546
- image_config?: string;
547
- /**
548
- * Mode bits used to set permissions on this file as accepted by chmod(2).
549
- */
550
- mode?: number;
551
- /**
552
- * The base64 encoded string of the file contents.
553
- */
554
- raw_value?: string;
555
- /**
556
- * The name of the secret that contains the base64 encoded file contents.
557
- */
558
- secret_name?: string;
559
- };
560
- export type FlyHttpHealthcheck = {
561
- /**
562
- * Additional headers to send with the request
563
- */
564
- headers?: Array<FlyMachineHttpHeader>;
565
- /**
566
- * The HTTP method to use to when making the request
567
- */
568
- method?: string;
569
- /**
570
- * The path to send the request to
571
- */
572
- path?: string;
573
- /**
574
- * The port to connect to, often the same as internal_port
575
- */
576
- port?: number;
577
- /**
578
- * Whether to use http or https
579
- */
580
- scheme?: FlyContainerHealthcheckScheme;
581
- /**
582
- * If the protocol is https, the hostname to use for TLS certificate validation
583
- */
584
- tls_server_name?: string;
585
- /**
586
- * If the protocol is https, whether or not to verify the TLS certificate
587
- */
588
- tls_skip_verify?: boolean;
589
- };
590
- export type FlyHttpOptions = {
591
- compress?: boolean;
592
- h2_backend?: boolean;
593
- headers_read_timeout?: number;
594
- idle_timeout?: number;
595
- replay_cache?: Array<FlyReplayCache>;
596
- response?: FlyHttpResponseOptions;
597
- };
598
- export type FlyHttpResponseOptions = {
599
- headers?: {
600
- [key: string]: {
601
- [key: string]: unknown;
602
- };
603
- };
604
- pristine?: boolean;
605
- };
606
- export type FlyMachineCheck = {
607
- /**
608
- * The time to wait after a VM starts before checking its health
609
- */
610
- grace_period?: FlyDuration;
611
- headers?: Array<FlyMachineHttpHeader>;
612
- /**
613
- * The time between connectivity checks
614
- */
615
- interval?: FlyDuration;
616
- /**
617
- * Kind of the check (informational, readiness)
618
- */
619
- kind?: "informational" | "readiness";
620
- /**
621
- * For http checks, the HTTP method to use to when making the request
622
- */
623
- method?: string;
624
- /**
625
- * For http checks, the path to send the request to
626
- */
627
- path?: string;
628
- /**
629
- * The port to connect to, often the same as internal_port
630
- */
631
- port?: number;
632
- /**
633
- * For http checks, whether to use http or https
634
- */
635
- protocol?: string;
636
- /**
637
- * The maximum time a connection can take before being reported as failing its health check
638
- */
639
- timeout?: FlyDuration;
640
- /**
641
- * If the protocol is https, the hostname to use for TLS certificate validation
642
- */
643
- tls_server_name?: string;
644
- /**
645
- * For http checks with https protocol, whether or not to verify the TLS certificate
646
- */
647
- tls_skip_verify?: boolean;
648
- /**
649
- * tcp or http
650
- */
651
- type?: string;
652
- };
653
- export type FlyMachineConfig = {
654
- /**
655
- * Optional boolean telling the Machine to destroy itself once it’s complete (default false)
656
- */
657
- auto_destroy?: boolean;
658
- /**
659
- * An optional object that defines one or more named top-level checks. The key for each check is the check name.
660
- */
661
- checks?: {
662
- [key: string]: FlyMachineCheck;
663
- };
664
- /**
665
- * Containers are a list of containers that will run in the machine. Currently restricted to
666
- * only specific organizations.
667
- */
668
- containers?: Array<FlyContainerConfig>;
669
- /**
670
- * Deprecated: use Service.Autostart instead
671
- */
672
- disable_machine_autostart?: boolean;
673
- dns?: FlyDnsConfig;
674
- /**
675
- * An object filled with key/value pairs to be set as environment variables
676
- */
677
- env?: {
678
- [key: string]: string;
679
- };
680
- files?: Array<FlyFile>;
681
- guest?: FlyMachineGuest;
682
- /**
683
- * The docker image to run
684
- */
685
- image?: string;
686
- init?: FlyMachineInit;
687
- metadata?: {
688
- [key: string]: string;
689
- };
690
- metrics?: FlyMachineMetrics;
691
- mounts?: Array<FlyMachineMount>;
692
- processes?: Array<FlyMachineProcess>;
693
- restart?: FlyMachineRestart;
694
- schedule?: string;
695
- services?: Array<FlyMachineService>;
696
- /**
697
- * Deprecated: use Guest instead
698
- */
699
- size?: string;
700
- /**
701
- * Standbys enable a machine to be a standby for another. In the event of a hardware failure,
702
- * the standby machine will be started.
703
- */
704
- standbys?: Array<string>;
705
- statics?: Array<FlyStatic>;
706
- stop_config?: FlyStopConfig;
707
- };
708
- export type FlyMachineGuest = {
709
- cpu_kind?: string;
710
- cpus?: number;
711
- gpu_kind?: string;
712
- gpus?: number;
713
- host_dedication_id?: string;
714
- kernel_args?: Array<string>;
715
- memory_mb?: number;
716
- persist_rootfs?: "never" | "always" | "restart";
717
- };
718
- /**
719
- * For http checks, an array of objects with string field Name and array of strings field Values. The key/value pairs specify header and header values that will get passed with the check call.
720
- */
721
- export type FlyMachineHttpHeader = {
722
- /**
723
- * The header name
724
- */
725
- name?: string;
726
- /**
727
- * The header value
728
- */
729
- values?: Array<string>;
730
- };
731
- export type FlyMachineInit = {
732
- cmd?: Array<string>;
733
- entrypoint?: Array<string>;
734
- exec?: Array<string>;
735
- kernel_args?: Array<string>;
736
- swap_size_mb?: number;
737
- tty?: boolean;
738
- };
739
- export type FlyMachineMetrics = {
740
- https?: boolean;
741
- path?: string;
742
- port?: number;
743
- };
744
- export type FlyMachineMount = {
745
- add_size_gb?: number;
746
- encrypted?: boolean;
747
- extend_threshold_percent?: number;
748
- name?: string;
749
- path?: string;
750
- size_gb?: number;
751
- size_gb_limit?: number;
752
- volume?: string;
753
- };
754
- export type FlyMachinePort = {
755
- end_port?: number;
756
- force_https?: boolean;
757
- handlers?: Array<string>;
758
- http_options?: FlyHttpOptions;
759
- port?: number;
760
- proxy_proto_options?: FlyProxyProtoOptions;
761
- start_port?: number;
762
- tls_options?: FlyTlsOptions;
763
- };
764
- export type FlyMachineProcess = {
765
- cmd?: Array<string>;
766
- entrypoint?: Array<string>;
767
- env?: {
768
- [key: string]: string;
769
- };
770
- /**
771
- * EnvFrom can be provided to set environment variables from machine fields.
772
- */
773
- env_from?: Array<FlyEnvFrom>;
774
- exec?: Array<string>;
775
- /**
776
- * IgnoreAppSecrets can be set to true to ignore the secrets for the App the Machine belongs to
777
- * and only use the secrets provided at the process level. The default/legacy behavior is to use
778
- * the secrets provided at the App level.
779
- */
780
- ignore_app_secrets?: boolean;
781
- /**
782
- * Secrets can be provided at the process level to explicitly indicate which secrets should be
783
- * used for the process. If not provided, the secrets provided at the machine level will be used.
784
- */
785
- secrets?: Array<FlyMachineSecret>;
786
- user?: string;
787
- };
788
- /**
789
- * The Machine restart policy defines whether and how flyd restarts a Machine after its main process exits. See https://fly.io/docs/machines/guides-examples/machine-restart-policy/.
790
- */
791
- export type FlyMachineRestart = {
792
- /**
793
- * GPU bid price for spot Machines.
794
- */
795
- gpu_bid_price?: number;
796
- /**
797
- * When policy is on-failure, the maximum number of times to attempt to restart the Machine before letting it stop.
798
- */
799
- max_retries?: number;
800
- /**
801
- * * no - Never try to restart a Machine automatically when its main process exits, whether that’s on purpose or on a crash.
802
- * * always - Always restart a Machine automatically and never let it enter a stopped state, even when the main process exits cleanly.
803
- * * on-failure - Try up to MaxRetries times to automatically restart the Machine if it exits with a non-zero exit code. Default when no explicit policy is set, and for Machines with schedules.
804
- * * spot-price - Starts the Machine only when there is capacity and the spot price is less than or equal to the bid price.
805
- */
806
- policy?: "no" | "always" | "on-failure" | "spot-price";
807
- };
808
- /**
809
- * A Secret needing to be set in the environment of the Machine. env_var is required
810
- */
811
- export type FlyMachineSecret = {
812
- /**
813
- * EnvVar is required and is the name of the environment variable that will be set from the
814
- * secret. It must be a valid environment variable name.
815
- */
816
- env_var?: string;
817
- /**
818
- * Name is optional and when provided is used to reference a secret name where the EnvVar is
819
- * different from what was set as the secret name.
820
- */
821
- name?: string;
822
- };
823
- export type FlyMachineService = {
824
- autostart?: boolean;
825
- /**
826
- * Accepts a string (new format) or a boolean (old format). For backward compatibility with older clients, the API continues to use booleans for "off" and "stop" in responses.
827
- * * "off" or false - Do not autostop the Machine.
828
- * * "stop" or true - Automatically stop the Machine.
829
- * * "suspend" - Automatically suspend the Machine, falling back to a full stop if this is not possible.
830
- */
831
- autostop?: "off" | "stop" | "suspend";
832
- /**
833
- * An optional list of service checks
834
- */
835
- checks?: Array<FlyMachineServiceCheck>;
836
- concurrency?: FlyMachineServiceConcurrency;
837
- force_instance_description?: string;
838
- force_instance_key?: string;
839
- internal_port?: number;
840
- min_machines_running?: number;
841
- ports?: Array<FlyMachinePort>;
842
- protocol?: string;
843
- };
844
- export type FlyMachineServiceCheck = {
845
- /**
846
- * The time to wait after a VM starts before checking its health
847
- */
848
- grace_period?: FlyDuration;
849
- headers?: Array<FlyMachineHttpHeader>;
850
- /**
851
- * The time between connectivity checks
852
- */
853
- interval?: FlyDuration;
854
- /**
855
- * For http checks, the HTTP method to use to when making the request
856
- */
857
- method?: string;
858
- /**
859
- * For http checks, the path to send the request to
860
- */
861
- path?: string;
862
- /**
863
- * The port to connect to, often the same as internal_port
864
- */
865
- port?: number;
866
- /**
867
- * For http checks, whether to use http or https
868
- */
869
- protocol?: string;
870
- /**
871
- * The maximum time a connection can take before being reported as failing its health check
872
- */
873
- timeout?: FlyDuration;
874
- /**
875
- * If the protocol is https, the hostname to use for TLS certificate validation
876
- */
877
- tls_server_name?: string;
878
- /**
879
- * For http checks with https protocol, whether or not to verify the TLS certificate
880
- */
881
- tls_skip_verify?: boolean;
882
- /**
883
- * tcp or http
884
- */
885
- type?: string;
886
- };
887
- export type FlyMachineServiceConcurrency = {
888
- hard_limit?: number;
889
- soft_limit?: number;
890
- type?: string;
891
- };
892
- export type FlyProxyProtoOptions = {
893
- version?: string;
894
- };
895
- export type FlyReplayCache = {
896
- allow_bypass?: boolean;
897
- /**
898
- * Name of the cookie or header to key the cache on
899
- */
900
- name?: string;
901
- path_prefix?: string;
902
- ttl_seconds?: number;
903
- /**
904
- * Currently either "cookie" or "header"
905
- */
906
- type?: "cookie" | "header";
907
- };
908
- export type FlyStatic = {
909
- guest_path: string;
910
- index_document?: string;
911
- tigris_bucket?: string;
912
- url_prefix: string;
913
- };
914
- export type FlyStopConfig = {
915
- signal?: string;
916
- timeout?: FlyDuration;
917
- };
918
- export type FlyTcpHealthcheck = {
919
- /**
920
- * The port to connect to, often the same as internal_port
921
- */
922
- port?: number;
923
- };
924
- export type FlyTlsOptions = {
925
- alpn?: Array<string>;
926
- default_self_signed?: boolean;
927
- versions?: Array<string>;
928
- };
929
- export type FlyUnhealthyPolicy = "stop";
930
- export type FlyDnsForwardRule = {
931
- addr?: string;
932
- basename?: string;
933
- };
934
- export type FlyDnsOption = {
935
- name?: string;
936
- value?: string;
937
- };
938
- export type Flydv1ExecResponse = {
939
- exit_code?: number;
940
- exit_signal?: number;
941
- stderr?: string;
942
- stdout?: string;
943
- };
944
- export type ListIpAssignmentsResponse = {
945
- ips?: Array<IpAssignment>;
946
- };
947
- export type MainGetPlacementsRequest = {
948
- /**
949
- * Resource requirements for the Machine to simulate. Defaults to a performance-1x machine
950
- */
951
- compute?: FlyMachineGuest;
952
- /**
953
- * Number of machines to simulate placement.
954
- * Defaults to 0, which returns the org-specific limit for each region.
955
- */
956
- count?: number;
957
- org_slug: string;
958
- /**
959
- * Region expression for placement as a comma-delimited set of regions or aliases.
960
- * Defaults to "[region],any", to prefer the API endpoint's local region with any other region as fallback.
961
- */
962
- region?: string;
963
- volume_name?: string;
964
- volume_size_bytes?: number;
965
- /**
966
- * Optional weights to override default placement preferences.
967
- */
968
- weights?: PlacementWeights;
969
- };
970
- export type MainGetPlacementsResponse = {
971
- regions?: Array<PlacementRegionPlacement>;
972
- };
973
- export type MainReclaimMemoryRequest = {
974
- amount_mb?: number;
975
- };
976
- export type MainReclaimMemoryResponse = {
977
- actual_mb?: number;
978
- };
979
- export type MainRegionResponse = {
980
- nearest?: string;
981
- regions?: Array<ReadsGetCapacityPerRegionRow>;
982
- };
983
- export type MainStatusCode = "unknown" | "insufficient_capacity";
984
- export type MainTokenInfo = {
985
- apps?: Array<string>;
986
- org_slug?: string;
987
- organization?: string;
988
- /**
989
- * Machine the token is restricted to (FromMachine caveat)
990
- */
991
- restricted_to_machine?: string;
992
- /**
993
- * Machine making the request
994
- */
995
- source_machine_id?: string;
996
- token_id?: string;
997
- /**
998
- * User identifier if token is for a user
999
- */
1000
- user?: string;
1001
- };
1002
- export type PlacementRegionPlacement = {
1003
- /**
1004
- * Hint on the number of machines in this region can be created concurrently.
1005
- * Equal to the number of unique hosts selected for placement.
1006
- */
1007
- concurrency?: number;
1008
- count?: number;
1009
- region?: string;
1010
- };
1011
- export type PlacementWeights = {
1012
- [key: string]: number;
1013
- };
1014
- export type ReadsGetCapacityPerRegionRow = {
1015
- capacity?: number;
1016
- code?: string;
1017
- deprecated?: boolean;
1018
- gateway_available?: boolean;
1019
- geo_region?: string;
1020
- latitude?: number;
1021
- longitude?: number;
1022
- name?: string;
1023
- requires_paid_plan?: boolean;
1024
- };
1025
- export type AppsListData = {
1026
- body?: never;
1027
- path?: never;
1028
- query: {
1029
- /**
1030
- * The org slug, or 'personal', to filter apps
1031
- */
1032
- org_slug: string;
1033
- /**
1034
- * Filter apps by role
1035
- */
1036
- app_role?: string;
1037
- };
1038
- url: "/apps";
1039
- };
1040
- export type AppsListResponses = {
1041
- /**
1042
- * OK
1043
- */
1044
- 200: ListAppsResponse;
1045
- };
1046
- export type AppsListResponse = AppsListResponses[keyof AppsListResponses];
1047
- export type AppsCreateData = {
1048
- /**
1049
- * App body
1050
- */
1051
- body: CreateAppRequest;
1052
- path?: never;
1053
- query?: never;
1054
- url: "/apps";
1055
- };
1056
- export type AppsCreateErrors = {
1057
- /**
1058
- * Bad Request
1059
- */
1060
- 400: ErrorResponse;
1061
- };
1062
- export type AppsCreateError = AppsCreateErrors[keyof AppsCreateErrors];
1063
- export type AppsCreateResponses = {
1064
- /**
1065
- * Created
1066
- */
1067
- 201: unknown;
1068
- };
1069
- export type AppsDeleteData = {
1070
- body?: never;
1071
- path: {
1072
- /**
1073
- * Fly App Name
1074
- */
1075
- app_name: string;
1076
- };
1077
- query?: never;
1078
- url: "/apps/{app_name}";
1079
- };
1080
- export type AppsDeleteResponses = {
1081
- /**
1082
- * Accepted
1083
- */
1084
- 202: unknown;
1085
- };
1086
- export type AppsShowData = {
1087
- body?: never;
1088
- path: {
1089
- /**
1090
- * Fly App Name
1091
- */
1092
- app_name: string;
1093
- };
1094
- query?: never;
1095
- url: "/apps/{app_name}";
1096
- };
1097
- export type AppsShowResponses = {
1098
- /**
1099
- * OK
1100
- */
1101
- 200: App;
1102
- };
1103
- export type AppsShowResponse = AppsShowResponses[keyof AppsShowResponses];
1104
- export type AppCreateDeployTokenData = {
1105
- /**
1106
- * Request body
1107
- */
1108
- body: CreateAppDeployTokenRequest;
1109
- path: {
1110
- /**
1111
- * Fly App Name
1112
- */
1113
- app_name: string;
1114
- };
1115
- query?: never;
1116
- url: "/apps/{app_name}/deploy_token";
1117
- };
1118
- export type AppCreateDeployTokenResponses = {
1119
- /**
1120
- * OK
1121
- */
1122
- 200: CreateAppResponse;
1123
- };
1124
- export type AppCreateDeployTokenResponse = AppCreateDeployTokenResponses[keyof AppCreateDeployTokenResponses];
1125
- export type AppIpAssignmentsListData = {
1126
- body?: never;
1127
- path?: never;
1128
- query?: never;
1129
- url: "/apps/{app_name}/ip_assignments";
1130
- };
1131
- export type AppIpAssignmentsListResponses = {
1132
- /**
1133
- * OK
1134
- */
1135
- 200: ListIpAssignmentsResponse;
1136
- };
1137
- export type AppIpAssignmentsListResponse = AppIpAssignmentsListResponses[keyof AppIpAssignmentsListResponses];
1138
- export type AppIpAssignmentsCreateData = {
1139
- /**
1140
- * Assign IP request
1141
- */
1142
- body: AssignIpRequest;
1143
- path?: never;
1144
- query?: never;
1145
- url: "/apps/{app_name}/ip_assignments";
1146
- };
1147
- export type AppIpAssignmentsCreateResponses = {
1148
- /**
1149
- * OK
1150
- */
1151
- 200: IpAssignment;
1152
- };
1153
- export type AppIpAssignmentsCreateResponse = AppIpAssignmentsCreateResponses[keyof AppIpAssignmentsCreateResponses];
1154
- export type AppIpAssignmentsDeleteData = {
1155
- body?: never;
1156
- path?: never;
1157
- query?: never;
1158
- url: "/apps/{app_name}/ip_assignments/{ip}";
1159
- };
1160
- export type AppIpAssignmentsDeleteResponses = {
1161
- /**
1162
- * No Content
1163
- */
1164
- 204: void;
1165
- };
1166
- export type AppIpAssignmentsDeleteResponse = AppIpAssignmentsDeleteResponses[keyof AppIpAssignmentsDeleteResponses];
1167
- export type MachinesListData = {
1168
- body?: never;
1169
- path: {
1170
- /**
1171
- * Fly App Name
1172
- */
1173
- app_name: string;
1174
- };
1175
- query?: {
1176
- /**
1177
- * Include deleted machines
1178
- */
1179
- include_deleted?: boolean;
1180
- /**
1181
- * Region filter
1182
- */
1183
- region?: string;
1184
- /**
1185
- * comma separated list of states to filter (created, started, stopped, suspended)
1186
- */
1187
- state?: string;
1188
- /**
1189
- * Only return summary info about machines (omit config, checks, events, host_status, nonce, etc.)
1190
- */
1191
- summary?: boolean;
1192
- };
1193
- url: "/apps/{app_name}/machines";
1194
- };
1195
- export type MachinesListResponses = {
1196
- /**
1197
- * OK
1198
- */
1199
- 200: Array<Machine>;
1200
- };
1201
- export type MachinesListResponse = MachinesListResponses[keyof MachinesListResponses];
1202
- export type MachinesCreateData = {
1203
- /**
1204
- * Create machine request
1205
- */
1206
- body: CreateMachineRequest;
1207
- path: {
1208
- /**
1209
- * Fly App Name
1210
- */
1211
- app_name: string;
1212
- };
1213
- query?: never;
1214
- url: "/apps/{app_name}/machines";
1215
- };
1216
- export type MachinesCreateResponses = {
1217
- /**
1218
- * OK
1219
- */
1220
- 200: Machine;
1221
- };
1222
- export type MachinesCreateResponse = MachinesCreateResponses[keyof MachinesCreateResponses];
1223
- export type MachinesDeleteData = {
1224
- body?: never;
1225
- path: {
1226
- /**
1227
- * Fly App Name
1228
- */
1229
- app_name: string;
1230
- /**
1231
- * Machine ID
1232
- */
1233
- machine_id: string;
1234
- };
1235
- query?: {
1236
- /**
1237
- * Force kill the machine if it's running
1238
- */
1239
- force?: boolean;
1240
- };
1241
- url: "/apps/{app_name}/machines/{machine_id}";
1242
- };
1243
- export type MachinesDeleteResponses = {
1244
- /**
1245
- * OK
1246
- */
1247
- 200: unknown;
1248
- };
1249
- export type MachinesShowData = {
1250
- body?: never;
1251
- path: {
1252
- /**
1253
- * Fly App Name
1254
- */
1255
- app_name: string;
1256
- /**
1257
- * Machine ID
1258
- */
1259
- machine_id: string;
1260
- };
1261
- query?: never;
1262
- url: "/apps/{app_name}/machines/{machine_id}";
1263
- };
1264
- export type MachinesShowResponses = {
1265
- /**
1266
- * OK
1267
- */
1268
- 200: Machine;
1269
- };
1270
- export type MachinesShowResponse = MachinesShowResponses[keyof MachinesShowResponses];
1271
- export type MachinesUpdateData = {
1272
- /**
1273
- * Request body
1274
- */
1275
- body: UpdateMachineRequest;
1276
- path: {
1277
- /**
1278
- * Fly App Name
1279
- */
1280
- app_name: string;
1281
- /**
1282
- * Machine ID
1283
- */
1284
- machine_id: string;
1285
- };
1286
- query?: never;
1287
- url: "/apps/{app_name}/machines/{machine_id}";
1288
- };
1289
- export type MachinesUpdateErrors = {
1290
- /**
1291
- * Bad Request
1292
- */
1293
- 400: ErrorResponse;
1294
- };
1295
- export type MachinesUpdateError = MachinesUpdateErrors[keyof MachinesUpdateErrors];
1296
- export type MachinesUpdateResponses = {
1297
- /**
1298
- * OK
1299
- */
1300
- 200: Machine;
1301
- };
1302
- export type MachinesUpdateResponse = MachinesUpdateResponses[keyof MachinesUpdateResponses];
1303
- export type MachinesCordonData = {
1304
- body?: never;
1305
- path: {
1306
- /**
1307
- * Fly App Name
1308
- */
1309
- app_name: string;
1310
- /**
1311
- * Machine ID
1312
- */
1313
- machine_id: string;
1314
- };
1315
- query?: never;
1316
- url: "/apps/{app_name}/machines/{machine_id}/cordon";
1317
- };
1318
- export type MachinesCordonResponses = {
1319
- /**
1320
- * OK
1321
- */
1322
- 200: unknown;
1323
- };
1324
- export type MachinesListEventsData = {
1325
- body?: never;
1326
- path: {
1327
- /**
1328
- * Fly App Name
1329
- */
1330
- app_name: string;
1331
- /**
1332
- * Machine ID
1333
- */
1334
- machine_id: string;
1335
- };
1336
- query?: {
1337
- /**
1338
- * The number of events to fetch (max of 50). If omitted, this is set to 20 by default.
1339
- */
1340
- limit?: number;
1341
- };
1342
- url: "/apps/{app_name}/machines/{machine_id}/events";
1343
- };
1344
- export type MachinesListEventsResponses = {
1345
- /**
1346
- * OK
1347
- */
1348
- 200: Array<MachineEvent>;
1349
- };
1350
- export type MachinesListEventsResponse = MachinesListEventsResponses[keyof MachinesListEventsResponses];
1351
- export type MachinesExecData = {
1352
- /**
1353
- * Request body
1354
- */
1355
- body: MachineExecRequest;
1356
- path: {
1357
- /**
1358
- * Fly App Name
1359
- */
1360
- app_name: string;
1361
- /**
1362
- * Machine ID
1363
- */
1364
- machine_id: string;
1365
- };
1366
- query?: never;
1367
- url: "/apps/{app_name}/machines/{machine_id}/exec";
1368
- };
1369
- export type MachinesExecErrors = {
1370
- /**
1371
- * Bad Request
1372
- */
1373
- 400: ErrorResponse;
1374
- };
1375
- export type MachinesExecError = MachinesExecErrors[keyof MachinesExecErrors];
1376
- export type MachinesExecResponses = {
1377
- /**
1378
- * stdout, stderr, exit code, and exit signal are returned
1379
- */
1380
- 200: Flydv1ExecResponse;
1381
- };
1382
- export type MachinesExecResponse = MachinesExecResponses[keyof MachinesExecResponses];
1383
- export type MachinesReleaseLeaseData = {
1384
- body?: never;
1385
- headers: {
1386
- /**
1387
- * Existing lease nonce
1388
- */
1389
- "fly-machine-lease-nonce": string;
1390
- };
1391
- path: {
1392
- /**
1393
- * Fly App Name
1394
- */
1395
- app_name: string;
1396
- /**
1397
- * Machine ID
1398
- */
1399
- machine_id: string;
1400
- };
1401
- query?: never;
1402
- url: "/apps/{app_name}/machines/{machine_id}/lease";
1403
- };
1404
- export type MachinesReleaseLeaseResponses = {
1405
- /**
1406
- * OK
1407
- */
1408
- 200: unknown;
1409
- };
1410
- export type MachinesShowLeaseData = {
1411
- body?: never;
1412
- path: {
1413
- /**
1414
- * Fly App Name
1415
- */
1416
- app_name: string;
1417
- /**
1418
- * Machine ID
1419
- */
1420
- machine_id: string;
1421
- };
1422
- query?: never;
1423
- url: "/apps/{app_name}/machines/{machine_id}/lease";
1424
- };
1425
- export type MachinesShowLeaseResponses = {
1426
- /**
1427
- * OK
1428
- */
1429
- 200: Lease;
1430
- };
1431
- export type MachinesShowLeaseResponse = MachinesShowLeaseResponses[keyof MachinesShowLeaseResponses];
1432
- export type MachinesCreateLeaseData = {
1433
- /**
1434
- * Request body
1435
- */
1436
- body: CreateLeaseRequest;
1437
- headers?: {
1438
- /**
1439
- * Existing lease nonce to refresh by ttl, empty or non-existent to create a new lease
1440
- */
1441
- "fly-machine-lease-nonce"?: string;
1442
- };
1443
- path: {
1444
- /**
1445
- * Fly App Name
1446
- */
1447
- app_name: string;
1448
- /**
1449
- * Machine ID
1450
- */
1451
- machine_id: string;
1452
- };
1453
- query?: never;
1454
- url: "/apps/{app_name}/machines/{machine_id}/lease";
1455
- };
1456
- export type MachinesCreateLeaseResponses = {
1457
- /**
1458
- * OK
1459
- */
1460
- 200: Lease;
1461
- };
1462
- export type MachinesCreateLeaseResponse = MachinesCreateLeaseResponses[keyof MachinesCreateLeaseResponses];
1463
- export type MachinesReclaimMemoryData = {
1464
- /**
1465
- * Reclaim memory request
1466
- */
1467
- body: MainReclaimMemoryRequest;
1468
- path: {
1469
- /**
1470
- * Fly App Name
1471
- */
1472
- app_name: string;
1473
- /**
1474
- * Machine ID
1475
- */
1476
- machine_id: string;
1477
- };
1478
- query?: never;
1479
- url: "/apps/{app_name}/machines/{machine_id}/memory/reclaim";
1480
- };
1481
- export type MachinesReclaimMemoryResponses = {
1482
- /**
1483
- * OK
1484
- */
1485
- 200: MainReclaimMemoryResponse;
1486
- };
1487
- export type MachinesReclaimMemoryResponse = MachinesReclaimMemoryResponses[keyof MachinesReclaimMemoryResponses];
1488
- export type MachinesShowMetadataData = {
1489
- body?: never;
1490
- path: {
1491
- /**
1492
- * Fly App Name
1493
- */
1494
- app_name: string;
1495
- /**
1496
- * Machine ID
1497
- */
1498
- machine_id: string;
1499
- };
1500
- query?: never;
1501
- url: "/apps/{app_name}/machines/{machine_id}/metadata";
1502
- };
1503
- export type MachinesShowMetadataResponses = {
1504
- /**
1505
- * OK
1506
- */
1507
- 200: {
1508
- [key: string]: string;
1509
- };
1510
- };
1511
- export type MachinesShowMetadataResponse = MachinesShowMetadataResponses[keyof MachinesShowMetadataResponses];
1512
- export type MachinesPatchMetadataData = {
1513
- body?: never;
1514
- path: {
1515
- /**
1516
- * Fly App Name
1517
- */
1518
- app_name: string;
1519
- /**
1520
- * Machine ID
1521
- */
1522
- machine_id: string;
1523
- };
1524
- query?: never;
1525
- url: "/apps/{app_name}/machines/{machine_id}/metadata";
1526
- };
1527
- export type MachinesPatchMetadataErrors = {
1528
- /**
1529
- * Bad Request
1530
- */
1531
- 400: ErrorResponse;
1532
- };
1533
- export type MachinesPatchMetadataError = MachinesPatchMetadataErrors[keyof MachinesPatchMetadataErrors];
1534
- export type MachinesPatchMetadataResponses = {
1535
- /**
1536
- * No Content
1537
- */
1538
- 204: void;
1539
- };
1540
- export type MachinesPatchMetadataResponse = MachinesPatchMetadataResponses[keyof MachinesPatchMetadataResponses];
1541
- export type MachinesDeleteMetadataData = {
1542
- body?: never;
1543
- path: {
1544
- /**
1545
- * Fly App Name
1546
- */
1547
- app_name: string;
1548
- /**
1549
- * Machine ID
1550
- */
1551
- machine_id: string;
1552
- /**
1553
- * Metadata Key
1554
- */
1555
- key: string;
1556
- };
1557
- query?: never;
1558
- url: "/apps/{app_name}/machines/{machine_id}/metadata/{key}";
1559
- };
1560
- export type MachinesDeleteMetadataResponses = {
1561
- /**
1562
- * No Content
1563
- */
1564
- 204: void;
1565
- };
1566
- export type MachinesDeleteMetadataResponse = MachinesDeleteMetadataResponses[keyof MachinesDeleteMetadataResponses];
1567
- export type MachinesUpdateMetadataData = {
1568
- body?: never;
1569
- path: {
1570
- /**
1571
- * Fly App Name
1572
- */
1573
- app_name: string;
1574
- /**
1575
- * Machine ID
1576
- */
1577
- machine_id: string;
1578
- /**
1579
- * Metadata Key
1580
- */
1581
- key: string;
1582
- };
1583
- query?: never;
1584
- url: "/apps/{app_name}/machines/{machine_id}/metadata/{key}";
1585
- };
1586
- export type MachinesUpdateMetadataErrors = {
1587
- /**
1588
- * Bad Request
1589
- */
1590
- 400: ErrorResponse;
1591
- };
1592
- export type MachinesUpdateMetadataError = MachinesUpdateMetadataErrors[keyof MachinesUpdateMetadataErrors];
1593
- export type MachinesUpdateMetadataResponses = {
1594
- /**
1595
- * No Content
1596
- */
1597
- 204: void;
1598
- };
1599
- export type MachinesUpdateMetadataResponse = MachinesUpdateMetadataResponses[keyof MachinesUpdateMetadataResponses];
1600
- export type MachinesListProcessesData = {
1601
- body?: never;
1602
- path: {
1603
- /**
1604
- * Fly App Name
1605
- */
1606
- app_name: string;
1607
- /**
1608
- * Machine ID
1609
- */
1610
- machine_id: string;
1611
- };
1612
- query?: {
1613
- /**
1614
- * Sort by
1615
- */
1616
- sort_by?: string;
1617
- /**
1618
- * Order
1619
- */
1620
- order?: string;
1621
- };
1622
- url: "/apps/{app_name}/machines/{machine_id}/ps";
1623
- };
1624
- export type MachinesListProcessesErrors = {
1625
- /**
1626
- * Bad Request
1627
- */
1628
- 400: ErrorResponse;
1629
- };
1630
- export type MachinesListProcessesError = MachinesListProcessesErrors[keyof MachinesListProcessesErrors];
1631
- export type MachinesListProcessesResponses = {
1632
- /**
1633
- * OK
1634
- */
1635
- 200: Array<ProcessStat>;
1636
- };
1637
- export type MachinesListProcessesResponse = MachinesListProcessesResponses[keyof MachinesListProcessesResponses];
1638
- export type MachinesRestartData = {
1639
- body?: never;
1640
- path: {
1641
- /**
1642
- * Fly App Name
1643
- */
1644
- app_name: string;
1645
- /**
1646
- * Machine ID
1647
- */
1648
- machine_id: string;
1649
- };
1650
- query?: {
1651
- /**
1652
- * Restart timeout as a Go duration string or number of seconds
1653
- */
1654
- timeout?: string;
1655
- /**
1656
- * Unix signal name
1657
- */
1658
- signal?: string;
1659
- };
1660
- url: "/apps/{app_name}/machines/{machine_id}/restart";
1661
- };
1662
- export type MachinesRestartErrors = {
1663
- /**
1664
- * Bad Request
1665
- */
1666
- 400: ErrorResponse;
1667
- };
1668
- export type MachinesRestartError = MachinesRestartErrors[keyof MachinesRestartErrors];
1669
- export type MachinesRestartResponses = {
1670
- /**
1671
- * OK
1672
- */
1673
- 200: unknown;
1674
- };
1675
- export type MachinesSignalData = {
1676
- /**
1677
- * Request body
1678
- */
1679
- body: SignalRequest;
1680
- path: {
1681
- /**
1682
- * Fly App Name
1683
- */
1684
- app_name: string;
1685
- /**
1686
- * Machine ID
1687
- */
1688
- machine_id: string;
1689
- };
1690
- query?: never;
1691
- url: "/apps/{app_name}/machines/{machine_id}/signal";
1692
- };
1693
- export type MachinesSignalErrors = {
1694
- /**
1695
- * Bad Request
1696
- */
1697
- 400: ErrorResponse;
1698
- };
1699
- export type MachinesSignalError = MachinesSignalErrors[keyof MachinesSignalErrors];
1700
- export type MachinesSignalResponses = {
1701
- /**
1702
- * OK
1703
- */
1704
- 200: unknown;
1705
- };
1706
- export type MachinesStartData = {
1707
- body?: never;
1708
- path: {
1709
- /**
1710
- * Fly App Name
1711
- */
1712
- app_name: string;
1713
- /**
1714
- * Machine ID
1715
- */
1716
- machine_id: string;
1717
- };
1718
- query?: never;
1719
- url: "/apps/{app_name}/machines/{machine_id}/start";
1720
- };
1721
- export type MachinesStartResponses = {
1722
- /**
1723
- * OK
1724
- */
1725
- 200: unknown;
1726
- };
1727
- export type MachinesStopData = {
1728
- /**
1729
- * Optional request body
1730
- */
1731
- body?: StopRequest;
1732
- path: {
1733
- /**
1734
- * Fly App Name
1735
- */
1736
- app_name: string;
1737
- /**
1738
- * Machine ID
1739
- */
1740
- machine_id: string;
1741
- };
1742
- query?: never;
1743
- url: "/apps/{app_name}/machines/{machine_id}/stop";
1744
- };
1745
- export type MachinesStopErrors = {
1746
- /**
1747
- * Bad Request
1748
- */
1749
- 400: ErrorResponse;
1750
- };
1751
- export type MachinesStopError = MachinesStopErrors[keyof MachinesStopErrors];
1752
- export type MachinesStopResponses = {
1753
- /**
1754
- * OK
1755
- */
1756
- 200: unknown;
1757
- };
1758
- export type MachinesSuspendData = {
1759
- body?: never;
1760
- path: {
1761
- /**
1762
- * Fly App Name
1763
- */
1764
- app_name: string;
1765
- /**
1766
- * Machine ID
1767
- */
1768
- machine_id: string;
1769
- };
1770
- query?: never;
1771
- url: "/apps/{app_name}/machines/{machine_id}/suspend";
1772
- };
1773
- export type MachinesSuspendResponses = {
1774
- /**
1775
- * OK
1776
- */
1777
- 200: unknown;
1778
- };
1779
- export type MachinesUncordonData = {
1780
- body?: never;
1781
- path: {
1782
- /**
1783
- * Fly App Name
1784
- */
1785
- app_name: string;
1786
- /**
1787
- * Machine ID
1788
- */
1789
- machine_id: string;
1790
- };
1791
- query?: never;
1792
- url: "/apps/{app_name}/machines/{machine_id}/uncordon";
1793
- };
1794
- export type MachinesUncordonResponses = {
1795
- /**
1796
- * OK
1797
- */
1798
- 200: unknown;
1799
- };
1800
- export type MachinesListVersionsData = {
1801
- body?: never;
1802
- path: {
1803
- /**
1804
- * Fly App Name
1805
- */
1806
- app_name: string;
1807
- /**
1808
- * Machine ID
1809
- */
1810
- machine_id: string;
1811
- };
1812
- query?: never;
1813
- url: "/apps/{app_name}/machines/{machine_id}/versions";
1814
- };
1815
- export type MachinesListVersionsResponses = {
1816
- /**
1817
- * OK
1818
- */
1819
- 200: Array<MachineVersion>;
1820
- };
1821
- export type MachinesListVersionsResponse = MachinesListVersionsResponses[keyof MachinesListVersionsResponses];
1822
- export type MachinesWaitData = {
1823
- body?: never;
1824
- path: {
1825
- /**
1826
- * Fly App Name
1827
- */
1828
- app_name: string;
1829
- /**
1830
- * Machine ID
1831
- */
1832
- machine_id: string;
1833
- };
1834
- query?: {
1835
- /**
1836
- * 26-character Machine version ID
1837
- */
1838
- instance_id?: string;
1839
- /**
1840
- * wait timeout. default 60s
1841
- */
1842
- timeout?: number;
1843
- /**
1844
- * desired state
1845
- */
1846
- state?: "started" | "stopped" | "suspended" | "destroyed";
1847
- };
1848
- url: "/apps/{app_name}/machines/{machine_id}/wait";
1849
- };
1850
- export type MachinesWaitErrors = {
1851
- /**
1852
- * Bad Request
1853
- */
1854
- 400: ErrorResponse;
1855
- };
1856
- export type MachinesWaitError = MachinesWaitErrors[keyof MachinesWaitErrors];
1857
- export type MachinesWaitResponses = {
1858
- /**
1859
- * OK
1860
- */
1861
- 200: unknown;
1862
- };
1863
- export type SecretkeysListData = {
1864
- body?: never;
1865
- path: {
1866
- /**
1867
- * Fly App Name
1868
- */
1869
- app_name: string;
1870
- };
1871
- query?: {
1872
- /**
1873
- * Minimum secrets version to return. Returned when setting a new secret
1874
- */
1875
- min_version?: string;
1876
- /**
1877
- * Comma-seperated list of secret keys to list
1878
- */
1879
- types?: string;
1880
- };
1881
- url: "/apps/{app_name}/secretkeys";
1882
- };
1883
- export type SecretkeysListResponses = {
1884
- /**
1885
- * OK
1886
- */
1887
- 200: SecretKeys;
1888
- };
1889
- export type SecretkeysListResponse = SecretkeysListResponses[keyof SecretkeysListResponses];
1890
- export type SecretkeyDeleteData = {
1891
- body?: never;
1892
- path: {
1893
- /**
1894
- * Fly App Name
1895
- */
1896
- app_name: string;
1897
- /**
1898
- * Secret key name
1899
- */
1900
- secret_name: string;
1901
- };
1902
- query?: never;
1903
- url: "/apps/{app_name}/secretkeys/{secret_name}";
1904
- };
1905
- export type SecretkeyDeleteResponses = {
1906
- /**
1907
- * OK
1908
- */
1909
- 200: DeleteSecretkeyResponse;
1910
- };
1911
- export type SecretkeyDeleteResponse = SecretkeyDeleteResponses[keyof SecretkeyDeleteResponses];
1912
- export type SecretkeyGetData = {
1913
- body?: never;
1914
- path: {
1915
- /**
1916
- * Fly App Name
1917
- */
1918
- app_name: string;
1919
- /**
1920
- * Secret key name
1921
- */
1922
- secret_name: string;
1923
- };
1924
- query?: {
1925
- /**
1926
- * Minimum secrets version to return. Returned when setting a new secret
1927
- */
1928
- min_version?: string;
1929
- };
1930
- url: "/apps/{app_name}/secretkeys/{secret_name}";
1931
- };
1932
- export type SecretkeyGetResponses = {
1933
- /**
1934
- * OK
1935
- */
1936
- 200: SecretKey;
1937
- };
1938
- export type SecretkeyGetResponse = SecretkeyGetResponses[keyof SecretkeyGetResponses];
1939
- export type SecretkeySetData = {
1940
- /**
1941
- * Create secret key request
1942
- */
1943
- body: SetSecretkeyRequest;
1944
- path: {
1945
- /**
1946
- * Fly App Name
1947
- */
1948
- app_name: string;
1949
- /**
1950
- * Secret key name
1951
- */
1952
- secret_name: string;
1953
- };
1954
- query?: never;
1955
- url: "/apps/{app_name}/secretkeys/{secret_name}";
1956
- };
1957
- export type SecretkeySetErrors = {
1958
- /**
1959
- * Bad Request
1960
- */
1961
- 400: ErrorResponse;
1962
- };
1963
- export type SecretkeySetError = SecretkeySetErrors[keyof SecretkeySetErrors];
1964
- export type SecretkeySetResponses = {
1965
- /**
1966
- * Created
1967
- */
1968
- 201: SetSecretkeyResponse;
1969
- };
1970
- export type SecretkeySetResponse = SecretkeySetResponses[keyof SecretkeySetResponses];
1971
- export type SecretkeyDecryptData = {
1972
- /**
1973
- * Decrypt with secret key request
1974
- */
1975
- body: DecryptSecretkeyRequest;
1976
- path: {
1977
- /**
1978
- * Fly App Name
1979
- */
1980
- app_name: string;
1981
- /**
1982
- * Secret key name
1983
- */
1984
- secret_name: string;
1985
- };
1986
- query?: {
1987
- /**
1988
- * Minimum secrets version to return. Returned when setting a new secret
1989
- */
1990
- min_version?: string;
1991
- };
1992
- url: "/apps/{app_name}/secretkeys/{secret_name}/decrypt";
1993
- };
1994
- export type SecretkeyDecryptErrors = {
1995
- /**
1996
- * Bad Request
1997
- */
1998
- 400: ErrorResponse;
1999
- };
2000
- export type SecretkeyDecryptError = SecretkeyDecryptErrors[keyof SecretkeyDecryptErrors];
2001
- export type SecretkeyDecryptResponses = {
2002
- /**
2003
- * OK
2004
- */
2005
- 200: DecryptSecretkeyResponse;
2006
- };
2007
- export type SecretkeyDecryptResponse = SecretkeyDecryptResponses[keyof SecretkeyDecryptResponses];
2008
- export type SecretkeyEncryptData = {
2009
- /**
2010
- * Encrypt with secret key request
2011
- */
2012
- body: EncryptSecretkeyRequest;
2013
- path: {
2014
- /**
2015
- * Fly App Name
2016
- */
2017
- app_name: string;
2018
- /**
2019
- * Secret key name
2020
- */
2021
- secret_name: string;
2022
- };
2023
- query?: {
2024
- /**
2025
- * Minimum secrets version to return. Returned when setting a new secret
2026
- */
2027
- min_version?: string;
2028
- };
2029
- url: "/apps/{app_name}/secretkeys/{secret_name}/encrypt";
2030
- };
2031
- export type SecretkeyEncryptErrors = {
2032
- /**
2033
- * Bad Request
2034
- */
2035
- 400: ErrorResponse;
2036
- };
2037
- export type SecretkeyEncryptError = SecretkeyEncryptErrors[keyof SecretkeyEncryptErrors];
2038
- export type SecretkeyEncryptResponses = {
2039
- /**
2040
- * OK
2041
- */
2042
- 200: EncryptSecretkeyResponse;
2043
- };
2044
- export type SecretkeyEncryptResponse = SecretkeyEncryptResponses[keyof SecretkeyEncryptResponses];
2045
- export type SecretkeyGenerateData = {
2046
- /**
2047
- * generate secret key request
2048
- */
2049
- body: SetSecretkeyRequest;
2050
- path: {
2051
- /**
2052
- * Fly App Name
2053
- */
2054
- app_name: string;
2055
- /**
2056
- * Secret key name
2057
- */
2058
- secret_name: string;
2059
- };
2060
- query?: never;
2061
- url: "/apps/{app_name}/secretkeys/{secret_name}/generate";
2062
- };
2063
- export type SecretkeyGenerateErrors = {
2064
- /**
2065
- * Bad Request
2066
- */
2067
- 400: ErrorResponse;
2068
- };
2069
- export type SecretkeyGenerateError = SecretkeyGenerateErrors[keyof SecretkeyGenerateErrors];
2070
- export type SecretkeyGenerateResponses = {
2071
- /**
2072
- * Created
2073
- */
2074
- 201: SetSecretkeyResponse;
2075
- };
2076
- export type SecretkeyGenerateResponse = SecretkeyGenerateResponses[keyof SecretkeyGenerateResponses];
2077
- export type SecretkeySignData = {
2078
- /**
2079
- * Sign with secret key request
2080
- */
2081
- body: SignSecretkeyRequest;
2082
- path: {
2083
- /**
2084
- * Fly App Name
2085
- */
2086
- app_name: string;
2087
- /**
2088
- * Secret key name
2089
- */
2090
- secret_name: string;
2091
- };
2092
- query?: {
2093
- /**
2094
- * Minimum secrets version to return. Returned when setting a new secret
2095
- */
2096
- min_version?: string;
2097
- };
2098
- url: "/apps/{app_name}/secretkeys/{secret_name}/sign";
2099
- };
2100
- export type SecretkeySignErrors = {
2101
- /**
2102
- * Bad Request
2103
- */
2104
- 400: ErrorResponse;
2105
- };
2106
- export type SecretkeySignError = SecretkeySignErrors[keyof SecretkeySignErrors];
2107
- export type SecretkeySignResponses = {
2108
- /**
2109
- * OK
2110
- */
2111
- 200: SignSecretkeyResponse;
2112
- };
2113
- export type SecretkeySignResponse = SecretkeySignResponses[keyof SecretkeySignResponses];
2114
- export type SecretkeyVerifyData = {
2115
- /**
2116
- * Verify with secret key request
2117
- */
2118
- body: VerifySecretkeyRequest;
2119
- path: {
2120
- /**
2121
- * Fly App Name
2122
- */
2123
- app_name: string;
2124
- /**
2125
- * Secret key name
2126
- */
2127
- secret_name: string;
2128
- };
2129
- query?: {
2130
- /**
2131
- * Minimum secrets version to return. Returned when setting a new secret
2132
- */
2133
- min_version?: string;
2134
- };
2135
- url: "/apps/{app_name}/secretkeys/{secret_name}/verify";
2136
- };
2137
- export type SecretkeyVerifyErrors = {
2138
- /**
2139
- * Bad Request
2140
- */
2141
- 400: ErrorResponse;
2142
- };
2143
- export type SecretkeyVerifyError = SecretkeyVerifyErrors[keyof SecretkeyVerifyErrors];
2144
- export type SecretkeyVerifyResponses = {
2145
- /**
2146
- * No Content
2147
- */
2148
- 204: void;
2149
- };
2150
- export type SecretkeyVerifyResponse = SecretkeyVerifyResponses[keyof SecretkeyVerifyResponses];
2151
- export type SecretsListData = {
2152
- body?: never;
2153
- path: {
2154
- /**
2155
- * Fly App Name
2156
- */
2157
- app_name: string;
2158
- };
2159
- query?: {
2160
- /**
2161
- * Minimum secrets version to return. Returned when setting a new secret
2162
- */
2163
- min_version?: string;
2164
- /**
2165
- * Show the secret values.
2166
- */
2167
- show_secrets?: boolean;
2168
- };
2169
- url: "/apps/{app_name}/secrets";
2170
- };
2171
- export type SecretsListResponses = {
2172
- /**
2173
- * OK
2174
- */
2175
- 200: AppSecrets;
2176
- };
2177
- export type SecretsListResponse = SecretsListResponses[keyof SecretsListResponses];
2178
- export type SecretsUpdateData = {
2179
- /**
2180
- * Update app secret request, with values to set, or nil to unset
2181
- */
2182
- body: AppSecretsUpdateRequest;
2183
- path: {
2184
- /**
2185
- * Fly App Name
2186
- */
2187
- app_name: string;
2188
- };
2189
- query?: never;
2190
- url: "/apps/{app_name}/secrets";
2191
- };
2192
- export type SecretsUpdateErrors = {
2193
- /**
2194
- * Bad Request
2195
- */
2196
- 400: ErrorResponse;
2197
- };
2198
- export type SecretsUpdateError = SecretsUpdateErrors[keyof SecretsUpdateErrors];
2199
- export type SecretsUpdateResponses = {
2200
- /**
2201
- * OK
2202
- */
2203
- 200: AppSecretsUpdateResp;
2204
- };
2205
- export type SecretsUpdateResponse = SecretsUpdateResponses[keyof SecretsUpdateResponses];
2206
- export type SecretDeleteData = {
2207
- body?: never;
2208
- path: {
2209
- /**
2210
- * Fly App Name
2211
- */
2212
- app_name: string;
2213
- /**
2214
- * App secret name
2215
- */
2216
- secret_name: string;
2217
- };
2218
- query?: never;
2219
- url: "/apps/{app_name}/secrets/{secret_name}";
2220
- };
2221
- export type SecretDeleteResponses = {
2222
- /**
2223
- * OK
2224
- */
2225
- 200: DeleteAppSecretResponse;
2226
- };
2227
- export type SecretDeleteResponse = SecretDeleteResponses[keyof SecretDeleteResponses];
2228
- export type SecretGetData = {
2229
- body?: never;
2230
- path: {
2231
- /**
2232
- * Fly App Name
2233
- */
2234
- app_name: string;
2235
- /**
2236
- * App secret name
2237
- */
2238
- secret_name: string;
2239
- };
2240
- query?: {
2241
- /**
2242
- * Minimum secrets version to return. Returned when setting a new secret
2243
- */
2244
- min_version?: string;
2245
- /**
2246
- * Show the secret value.
2247
- */
2248
- show_secrets?: boolean;
2249
- };
2250
- url: "/apps/{app_name}/secrets/{secret_name}";
2251
- };
2252
- export type SecretGetResponses = {
2253
- /**
2254
- * OK
2255
- */
2256
- 200: AppSecret;
2257
- };
2258
- export type SecretGetResponse = SecretGetResponses[keyof SecretGetResponses];
2259
- export type SecretCreateData = {
2260
- /**
2261
- * Create app secret request
2262
- */
2263
- body: SetAppSecretRequest;
2264
- path: {
2265
- /**
2266
- * Fly App Name
2267
- */
2268
- app_name: string;
2269
- /**
2270
- * App secret name
2271
- */
2272
- secret_name: string;
2273
- };
2274
- query?: never;
2275
- url: "/apps/{app_name}/secrets/{secret_name}";
2276
- };
2277
- export type SecretCreateErrors = {
2278
- /**
2279
- * Bad Request
2280
- */
2281
- 400: ErrorResponse;
2282
- };
2283
- export type SecretCreateError = SecretCreateErrors[keyof SecretCreateErrors];
2284
- export type SecretCreateResponses = {
2285
- /**
2286
- * Created
2287
- */
2288
- 201: SetAppSecretResponse;
2289
- };
2290
- export type SecretCreateResponse = SecretCreateResponses[keyof SecretCreateResponses];
2291
- export type VolumesListData = {
2292
- body?: never;
2293
- path: {
2294
- /**
2295
- * Fly App Name
2296
- */
2297
- app_name: string;
2298
- };
2299
- query?: {
2300
- /**
2301
- * Only return summary info about volumes (omit blocks, block size, etc)
2302
- */
2303
- summary?: boolean;
2304
- };
2305
- url: "/apps/{app_name}/volumes";
2306
- };
2307
- export type VolumesListResponses = {
2308
- /**
2309
- * OK
2310
- */
2311
- 200: Array<Volume>;
2312
- };
2313
- export type VolumesListResponse = VolumesListResponses[keyof VolumesListResponses];
2314
- export type VolumesCreateData = {
2315
- /**
2316
- * Request body
2317
- */
2318
- body: CreateVolumeRequest;
2319
- path: {
2320
- /**
2321
- * Fly App Name
2322
- */
2323
- app_name: string;
2324
- };
2325
- query?: never;
2326
- url: "/apps/{app_name}/volumes";
2327
- };
2328
- export type VolumesCreateResponses = {
2329
- /**
2330
- * OK
2331
- */
2332
- 200: Volume;
2333
- };
2334
- export type VolumesCreateResponse = VolumesCreateResponses[keyof VolumesCreateResponses];
2335
- export type VolumeDeleteData = {
2336
- body?: never;
2337
- path: {
2338
- /**
2339
- * Fly App Name
2340
- */
2341
- app_name: string;
2342
- /**
2343
- * Volume ID
2344
- */
2345
- volume_id: string;
2346
- };
2347
- query?: never;
2348
- url: "/apps/{app_name}/volumes/{volume_id}";
2349
- };
2350
- export type VolumeDeleteResponses = {
2351
- /**
2352
- * OK
2353
- */
2354
- 200: Volume;
2355
- };
2356
- export type VolumeDeleteResponse = VolumeDeleteResponses[keyof VolumeDeleteResponses];
2357
- export type VolumesGetByIdData = {
2358
- body?: never;
2359
- path: {
2360
- /**
2361
- * Fly App Name
2362
- */
2363
- app_name: string;
2364
- /**
2365
- * Volume ID
2366
- */
2367
- volume_id: string;
2368
- };
2369
- query?: never;
2370
- url: "/apps/{app_name}/volumes/{volume_id}";
2371
- };
2372
- export type VolumesGetByIdResponses = {
2373
- /**
2374
- * OK
2375
- */
2376
- 200: Volume;
2377
- };
2378
- export type VolumesGetByIdResponse = VolumesGetByIdResponses[keyof VolumesGetByIdResponses];
2379
- export type VolumesUpdateData = {
2380
- /**
2381
- * Request body
2382
- */
2383
- body: UpdateVolumeRequest;
2384
- path: {
2385
- /**
2386
- * Fly App Name
2387
- */
2388
- app_name: string;
2389
- /**
2390
- * Volume ID
2391
- */
2392
- volume_id: string;
2393
- };
2394
- query?: never;
2395
- url: "/apps/{app_name}/volumes/{volume_id}";
2396
- };
2397
- export type VolumesUpdateErrors = {
2398
- /**
2399
- * Bad Request
2400
- */
2401
- 400: ErrorResponse;
2402
- };
2403
- export type VolumesUpdateError = VolumesUpdateErrors[keyof VolumesUpdateErrors];
2404
- export type VolumesUpdateResponses = {
2405
- /**
2406
- * OK
2407
- */
2408
- 200: Volume;
2409
- };
2410
- export type VolumesUpdateResponse = VolumesUpdateResponses[keyof VolumesUpdateResponses];
2411
- export type VolumesExtendData = {
2412
- /**
2413
- * Request body
2414
- */
2415
- body: ExtendVolumeRequest;
2416
- path: {
2417
- /**
2418
- * Fly App Name
2419
- */
2420
- app_name: string;
2421
- /**
2422
- * Volume ID
2423
- */
2424
- volume_id: string;
2425
- };
2426
- query?: never;
2427
- url: "/apps/{app_name}/volumes/{volume_id}/extend";
2428
- };
2429
- export type VolumesExtendResponses = {
2430
- /**
2431
- * OK
2432
- */
2433
- 200: ExtendVolumeResponse;
2434
- };
2435
- export type VolumesExtendResponse = VolumesExtendResponses[keyof VolumesExtendResponses];
2436
- export type VolumesListSnapshotsData = {
2437
- body?: never;
2438
- path: {
2439
- /**
2440
- * Fly App Name
2441
- */
2442
- app_name: string;
2443
- /**
2444
- * Volume ID
2445
- */
2446
- volume_id: string;
2447
- };
2448
- query?: never;
2449
- url: "/apps/{app_name}/volumes/{volume_id}/snapshots";
2450
- };
2451
- export type VolumesListSnapshotsResponses = {
2452
- /**
2453
- * OK
2454
- */
2455
- 200: Array<VolumeSnapshot>;
2456
- };
2457
- export type VolumesListSnapshotsResponse = VolumesListSnapshotsResponses[keyof VolumesListSnapshotsResponses];
2458
- export type CreateVolumeSnapshotData = {
2459
- body?: never;
2460
- path: {
2461
- /**
2462
- * Fly App Name
2463
- */
2464
- app_name: string;
2465
- /**
2466
- * Volume ID
2467
- */
2468
- volume_id: string;
2469
- };
2470
- query?: never;
2471
- url: "/apps/{app_name}/volumes/{volume_id}/snapshots";
2472
- };
2473
- export type CreateVolumeSnapshotResponses = {
2474
- /**
2475
- * OK
2476
- */
2477
- 200: unknown;
2478
- };
2479
- export type PlatformPlacementsPostData = {
2480
- /**
2481
- * Get placements request
2482
- */
2483
- body: MainGetPlacementsRequest;
2484
- path?: never;
2485
- query?: never;
2486
- url: "/platform/placements";
2487
- };
2488
- export type PlatformPlacementsPostResponses = {
2489
- /**
2490
- * OK
2491
- */
2492
- 200: MainGetPlacementsResponse;
2493
- };
2494
- export type PlatformPlacementsPostResponse = PlatformPlacementsPostResponses[keyof PlatformPlacementsPostResponses];
2495
- export type PlatformRegionsGetData = {
2496
- body?: never;
2497
- path?: never;
2498
- query?: {
2499
- /**
2500
- * guest machine size preset. default performance-1x
2501
- */
2502
- size?: string;
2503
- /**
2504
- * guest CPU kind
2505
- */
2506
- cpu_kind?: string;
2507
- /**
2508
- * guest memory in megabytes
2509
- */
2510
- memory_mb?: number;
2511
- /**
2512
- * guest CPU count
2513
- */
2514
- cpus?: number;
2515
- /**
2516
- * guest GPU count
2517
- */
2518
- gpus?: number;
2519
- /**
2520
- * guest GPU kind
2521
- */
2522
- gpu_kind?: string;
2523
- };
2524
- url: "/platform/regions";
2525
- };
2526
- export type PlatformRegionsGetResponses = {
2527
- /**
2528
- * OK
2529
- */
2530
- 200: MainRegionResponse;
2531
- };
2532
- export type PlatformRegionsGetResponse = PlatformRegionsGetResponses[keyof PlatformRegionsGetResponses];
2533
- export type TokensRequestKmsData = {
2534
- body?: never;
2535
- path?: never;
2536
- query?: never;
2537
- url: "/tokens/kms";
2538
- };
2539
- export type TokensRequestKmsResponses = {
2540
- /**
2541
- * KMS token
2542
- */
2543
- 200: string;
2544
- };
2545
- export type TokensRequestKmsResponse = TokensRequestKmsResponses[keyof TokensRequestKmsResponses];
2546
- export type TokensRequestOidcData = {
2547
- /**
2548
- * Optional request body
2549
- */
2550
- body: CreateOidcTokenRequest;
2551
- path?: never;
2552
- query?: never;
2553
- url: "/tokens/oidc";
2554
- };
2555
- export type TokensRequestOidcErrors = {
2556
- /**
2557
- * Bad Request
2558
- */
2559
- 400: ErrorResponse;
2560
- };
2561
- export type TokensRequestOidcError = TokensRequestOidcErrors[keyof TokensRequestOidcErrors];
2562
- export type TokensRequestOidcResponses = {
2563
- /**
2564
- * OIDC token
2565
- */
2566
- 200: string;
2567
- };
2568
- export type TokensRequestOidcResponse = TokensRequestOidcResponses[keyof TokensRequestOidcResponses];
2569
- export type CurrentTokenShowData = {
2570
- body?: never;
2571
- path?: never;
2572
- query?: never;
2573
- url: "/v1/tokens/current";
2574
- };
2575
- export type CurrentTokenShowErrors = {
2576
- /**
2577
- * Unauthorized
2578
- */
2579
- 401: ErrorResponse;
2580
- /**
2581
- * Internal Server Error
2582
- */
2583
- 500: ErrorResponse;
2584
- };
2585
- export type CurrentTokenShowError = CurrentTokenShowErrors[keyof CurrentTokenShowErrors];
2586
- export type CurrentTokenShowResponses = {
2587
- /**
2588
- * OK
2589
- */
2590
- 200: CurrentTokenResponse;
2591
- };
2592
- export type CurrentTokenShowResponse = CurrentTokenShowResponses[keyof CurrentTokenShowResponses];