@zocomputer/system-api 0.1.0 → 0.1.2
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.
- package/dist/generated/catalog.js +53 -41
- package/dist/generated/manifest.json +53 -43
- package/dist/generated/operations.d.ts +344 -16
- package/dist/generated/schema.json +1877 -414
- package/openapi.json +1877 -414
- package/package.json +1 -1
|
@@ -105,6 +105,10 @@ export interface ZoAgentCancelOutputV1 {
|
|
|
105
105
|
export interface ZoAgentCreateInputV1 {
|
|
106
106
|
workspace_id: string;
|
|
107
107
|
display_name: string;
|
|
108
|
+
/**
|
|
109
|
+
* Describe what this Agent is for in the user's terms.
|
|
110
|
+
*/
|
|
111
|
+
description?: string;
|
|
108
112
|
visibility?: ("workspace" | "protected");
|
|
109
113
|
implementation: "zo.native";
|
|
110
114
|
configuration: ZoAgentCreateInputV1NativeConfiguration;
|
|
@@ -139,6 +143,7 @@ export interface ZoAgentCreateOutputV1 {
|
|
|
139
143
|
type: "agent";
|
|
140
144
|
type_version: number;
|
|
141
145
|
display_name: string;
|
|
146
|
+
description: string;
|
|
142
147
|
revision: number;
|
|
143
148
|
implementation: "zo.native";
|
|
144
149
|
configuration: ZoAgentCreateOutputV1NativeConfiguration;
|
|
@@ -222,6 +227,7 @@ export interface ZoAgentGetOutputV1 {
|
|
|
222
227
|
type: "agent";
|
|
223
228
|
type_version: number;
|
|
224
229
|
display_name: string;
|
|
230
|
+
description: string;
|
|
225
231
|
revision: number;
|
|
226
232
|
implementation: "zo.native";
|
|
227
233
|
configuration: ZoAgentGetOutputV1NativeConfiguration;
|
|
@@ -301,6 +307,7 @@ export interface ZoAgentListOutputV1Agent {
|
|
|
301
307
|
type: "agent";
|
|
302
308
|
type_version: number;
|
|
303
309
|
display_name: string;
|
|
310
|
+
description: string;
|
|
304
311
|
revision: number;
|
|
305
312
|
implementation: "zo.native";
|
|
306
313
|
configuration: ZoAgentListOutputV1NativeConfiguration;
|
|
@@ -526,6 +533,10 @@ export interface ZoAgentUpdateInputV1 {
|
|
|
526
533
|
agent_id: string;
|
|
527
534
|
expected_revision: number;
|
|
528
535
|
display_name?: (string | null);
|
|
536
|
+
/**
|
|
537
|
+
* Describe what this Agent is for in the user's terms.
|
|
538
|
+
*/
|
|
539
|
+
description?: (string | null);
|
|
529
540
|
configuration?: (ZoAgentUpdateInputV1NativeConfiguration | null);
|
|
530
541
|
}
|
|
531
542
|
/**
|
|
@@ -558,6 +569,7 @@ export interface ZoAgentUpdateOutputV1 {
|
|
|
558
569
|
type: "agent";
|
|
559
570
|
type_version: number;
|
|
560
571
|
display_name: string;
|
|
572
|
+
description: string;
|
|
561
573
|
revision: number;
|
|
562
574
|
implementation: "zo.native";
|
|
563
575
|
configuration: ZoAgentUpdateOutputV1NativeConfiguration;
|
|
@@ -789,18 +801,47 @@ export interface ZoConnectionAuthorizeOutputV1KeyAttached {
|
|
|
789
801
|
}
|
|
790
802
|
export interface ZoConnectionCreateInputV1 {
|
|
791
803
|
workspace_id: string;
|
|
792
|
-
|
|
793
|
-
|
|
804
|
+
/**
|
|
805
|
+
* The published definition to connect to. Give it, or `values`, not both.
|
|
806
|
+
*/
|
|
807
|
+
definition_id?: (string | null);
|
|
808
|
+
/**
|
|
809
|
+
* The version of `definition_id` to connect to; required with it.
|
|
810
|
+
*/
|
|
811
|
+
definition_version?: (number | null);
|
|
794
812
|
display_name: string;
|
|
795
|
-
|
|
813
|
+
/**
|
|
814
|
+
* Describe what this connection is for in the user's terms.
|
|
815
|
+
*/
|
|
816
|
+
description?: string;
|
|
817
|
+
/**
|
|
818
|
+
* The connection's configuration; required with `definition_id`.
|
|
819
|
+
*/
|
|
820
|
+
configuration?: ({
|
|
796
821
|
[k: string]: JsonValue;
|
|
797
|
-
};
|
|
822
|
+
} | null);
|
|
798
823
|
visibility?: ("workspace" | "protected");
|
|
824
|
+
/**
|
|
825
|
+
* Named values to store, in place of a definition: Zo publishes a private definition named after `display_name`, with one required key credential per name delivered as the environment variable of that name, creates the connection and stores every value. A definition name already taken in the workspace returns `conflict`. A name Zo refuses as an environment variable returns `invalid_input` with the `invalid_environment` violation.
|
|
826
|
+
*/
|
|
827
|
+
values?: ({
|
|
828
|
+
/**
|
|
829
|
+
* Secret: the value. Stored sealed and never returned.
|
|
830
|
+
*/
|
|
831
|
+
[k: string]: string;
|
|
832
|
+
} | null);
|
|
833
|
+
/**
|
|
834
|
+
* Environment variables delivered, exactly as written, to machines that list this connection, beside its credential and the variables its definition sets. Plain strings, not secrets: put a secret in the vault. Names are upper-case letters, digits and underscores; at most 64 variables of at most 4096 characters each.
|
|
835
|
+
*/
|
|
836
|
+
environment?: {
|
|
837
|
+
[k: string]: string;
|
|
838
|
+
};
|
|
799
839
|
}
|
|
800
840
|
export interface ZoConnectionCreateOutputV1 {
|
|
801
841
|
id: string;
|
|
802
842
|
workspace_id: string;
|
|
803
843
|
display_name: string;
|
|
844
|
+
description: string;
|
|
804
845
|
definition_id: string;
|
|
805
846
|
definition_version: number;
|
|
806
847
|
visibility: ("workspace" | "protected");
|
|
@@ -824,6 +865,7 @@ export interface ZoConnectionDisconnectOutputV1 {
|
|
|
824
865
|
id: string;
|
|
825
866
|
workspace_id: string;
|
|
826
867
|
display_name: string;
|
|
868
|
+
description: string;
|
|
827
869
|
definition_id: string;
|
|
828
870
|
definition_version: number;
|
|
829
871
|
visibility: ("workspace" | "protected");
|
|
@@ -838,6 +880,7 @@ export interface ZoConnectionGetOutputV1 {
|
|
|
838
880
|
id: string;
|
|
839
881
|
workspace_id: string;
|
|
840
882
|
display_name: string;
|
|
883
|
+
description: string;
|
|
841
884
|
definition_id: string;
|
|
842
885
|
definition_version: number;
|
|
843
886
|
visibility: ("workspace" | "protected");
|
|
@@ -847,6 +890,9 @@ export interface ZoConnectionGetOutputV1 {
|
|
|
847
890
|
account_labels: {
|
|
848
891
|
[k: string]: string;
|
|
849
892
|
};
|
|
893
|
+
environment: {
|
|
894
|
+
[k: string]: string;
|
|
895
|
+
};
|
|
850
896
|
}
|
|
851
897
|
export interface ZoConnectionListInputV1 {
|
|
852
898
|
workspace_id: string;
|
|
@@ -859,6 +905,7 @@ export interface ZoConnectionListOutputV1ConnectionWithAccountsResource {
|
|
|
859
905
|
id: string;
|
|
860
906
|
workspace_id: string;
|
|
861
907
|
display_name: string;
|
|
908
|
+
description: string;
|
|
862
909
|
definition_id: string;
|
|
863
910
|
definition_version: number;
|
|
864
911
|
visibility: ("workspace" | "protected");
|
|
@@ -868,6 +915,9 @@ export interface ZoConnectionListOutputV1ConnectionWithAccountsResource {
|
|
|
868
915
|
account_labels: {
|
|
869
916
|
[k: string]: string;
|
|
870
917
|
};
|
|
918
|
+
environment: {
|
|
919
|
+
[k: string]: string;
|
|
920
|
+
};
|
|
871
921
|
}
|
|
872
922
|
export interface ZoConnectionListQueryV1 {
|
|
873
923
|
/**
|
|
@@ -894,6 +944,39 @@ export interface ZoConnectionRegisterResourceInputV1 {
|
|
|
894
944
|
export interface ZoConnectionRegisterResourceOutputV1 {
|
|
895
945
|
resource_id: string;
|
|
896
946
|
}
|
|
947
|
+
export interface ZoConnectionSlackCompleteAuthorizationInputV1 {
|
|
948
|
+
connection_id: string;
|
|
949
|
+
expected_revision: number;
|
|
950
|
+
attempt_id: string;
|
|
951
|
+
code: string;
|
|
952
|
+
}
|
|
953
|
+
export interface ZoConnectionSlackCompleteAuthorizationOutputV1 {
|
|
954
|
+
id: string;
|
|
955
|
+
workspace_id: string;
|
|
956
|
+
display_name: string;
|
|
957
|
+
description: string;
|
|
958
|
+
definition_id: string;
|
|
959
|
+
definition_version: number;
|
|
960
|
+
visibility: ("workspace" | "protected");
|
|
961
|
+
owner_user_id: (string | null);
|
|
962
|
+
status: ("configuring" | "ready" | "reauthorization_required" | "disabled" | "deleted");
|
|
963
|
+
revision: number;
|
|
964
|
+
account_labels: {
|
|
965
|
+
[k: string]: string;
|
|
966
|
+
};
|
|
967
|
+
environment: {
|
|
968
|
+
[k: string]: string;
|
|
969
|
+
};
|
|
970
|
+
}
|
|
971
|
+
export interface ZoConnectionSlackStartAuthorizationInputV1 {
|
|
972
|
+
connection_id: string;
|
|
973
|
+
expected_revision: number;
|
|
974
|
+
}
|
|
975
|
+
export interface ZoConnectionSlackStartAuthorizationOutputV1 {
|
|
976
|
+
attempt_id: string;
|
|
977
|
+
command: string;
|
|
978
|
+
expires_at: string;
|
|
979
|
+
}
|
|
897
980
|
export interface ZoConnectionUpdateInputV1 {
|
|
898
981
|
connection_id: string;
|
|
899
982
|
expected_revision: number;
|
|
@@ -907,11 +990,32 @@ export interface ZoConnectionUpdateInputV1 {
|
|
|
907
990
|
* A new name for the connection; omit it to keep the current name.
|
|
908
991
|
*/
|
|
909
992
|
display_name?: (string | null);
|
|
993
|
+
/**
|
|
994
|
+
* Describe what this connection is for in the user's terms.
|
|
995
|
+
*/
|
|
996
|
+
description?: (string | null);
|
|
997
|
+
/**
|
|
998
|
+
* Move the connection to this version of its definition, keeping its id and grants. Credentials in both versions keep their values, credentials only the current version has are erased, and credentials only the new version has start empty. Omit it to stay on the current version.
|
|
999
|
+
*/
|
|
1000
|
+
definition_version?: (number | null);
|
|
1001
|
+
/**
|
|
1002
|
+
* Named values to set, or `null` to remove a name, on a connection whose definition is private to its workspace and holds only single-value key credentials, as one created from `values` does. Changing a value replaces that credential. Adding or removing a name publishes the definition's next version from the connection's own version and moves the connection to it, keeping its id and grants; other connections to the definition stay on their versions. A connection keeps at least one name. Any other connection returns `invalid_input`.
|
|
1003
|
+
*/
|
|
1004
|
+
values?: ({
|
|
1005
|
+
[k: string]: string | null;
|
|
1006
|
+
} | null);
|
|
1007
|
+
/**
|
|
1008
|
+
* The environment that replaces the stored one; omit it to keep the stored environment. Environment variables delivered, exactly as written, to machines that list this connection, beside its credential and the variables its definition sets. Plain strings, not secrets: put a secret in the vault. Names are upper-case letters, digits and underscores; at most 64 variables of at most 4096 characters each.
|
|
1009
|
+
*/
|
|
1010
|
+
environment?: ({
|
|
1011
|
+
[k: string]: string;
|
|
1012
|
+
} | null);
|
|
910
1013
|
}
|
|
911
1014
|
export interface ZoConnectionUpdateOutputV1 {
|
|
912
1015
|
id: string;
|
|
913
1016
|
workspace_id: string;
|
|
914
1017
|
display_name: string;
|
|
1018
|
+
description: string;
|
|
915
1019
|
definition_id: string;
|
|
916
1020
|
definition_version: number;
|
|
917
1021
|
visibility: ("workspace" | "protected");
|
|
@@ -2098,6 +2202,10 @@ export interface ZoFunctionCancelRunOutputV1 {
|
|
|
2098
2202
|
export interface ZoFunctionCreateInputV1 {
|
|
2099
2203
|
workspace_id: string;
|
|
2100
2204
|
display_name: string;
|
|
2205
|
+
/**
|
|
2206
|
+
* Describe what this function is for in the user's terms.
|
|
2207
|
+
*/
|
|
2208
|
+
description?: string;
|
|
2101
2209
|
visibility?: ("workspace" | "protected");
|
|
2102
2210
|
}
|
|
2103
2211
|
export interface ZoFunctionCreateOutputV1 {
|
|
@@ -2106,6 +2214,7 @@ export interface ZoFunctionCreateOutputV1 {
|
|
|
2106
2214
|
type: "function";
|
|
2107
2215
|
type_version: number;
|
|
2108
2216
|
display_name: string;
|
|
2217
|
+
description: string;
|
|
2109
2218
|
revision: number;
|
|
2110
2219
|
properties: ZoFunctionCreateOutputV1FunctionProperties;
|
|
2111
2220
|
active_deployment_id: (string | null);
|
|
@@ -2174,6 +2283,7 @@ export interface ZoFunctionGetOutputV1 {
|
|
|
2174
2283
|
type: "function";
|
|
2175
2284
|
type_version: number;
|
|
2176
2285
|
display_name: string;
|
|
2286
|
+
description: string;
|
|
2177
2287
|
revision: number;
|
|
2178
2288
|
properties: ZoFunctionGetOutputV1FunctionProperties;
|
|
2179
2289
|
active_deployment_id: (string | null);
|
|
@@ -2294,6 +2404,7 @@ export interface ZoFunctionListOutputV1VisibleFunctionResource {
|
|
|
2294
2404
|
type: "function";
|
|
2295
2405
|
type_version: number;
|
|
2296
2406
|
display_name: string;
|
|
2407
|
+
description: string;
|
|
2297
2408
|
revision: number;
|
|
2298
2409
|
properties: ZoFunctionListOutputV1FunctionProperties;
|
|
2299
2410
|
active_deployment_id: (string | null);
|
|
@@ -2377,22 +2488,39 @@ export interface ZoMachineApplyPatchOutputV1 {
|
|
|
2377
2488
|
size: number;
|
|
2378
2489
|
sha256: string;
|
|
2379
2490
|
}
|
|
2491
|
+
export type ZoMachineCreateInputV1GpuType = ("T4" | "L4" | "A10" | "L40S" | "A100" | "A100-40GB" | "A100-80GB" | "RTX-PRO-6000" | "H100" | "H100!" | "H200" | "B200" | "B200+" | "B300");
|
|
2380
2492
|
export interface ZoMachineCreateInputV1 {
|
|
2381
2493
|
workspace_id: string;
|
|
2382
2494
|
idempotency_key: string;
|
|
2383
2495
|
display_name: string;
|
|
2496
|
+
/**
|
|
2497
|
+
* Describe what this machine is for in the user's terms.
|
|
2498
|
+
*/
|
|
2499
|
+
description?: string;
|
|
2384
2500
|
source: ZoMachineCreateInputV1MachineSourceInput;
|
|
2385
2501
|
resources: ZoMachineCreateInputV1MachineResourcesInput;
|
|
2386
2502
|
lifecycle: ZoMachineCreateInputV1MachineLifecycleInput;
|
|
2387
2503
|
region?: string;
|
|
2388
2504
|
/**
|
|
2389
|
-
* Which process runs first at boot. `none` (default): nothing; the machine waits for exec. `image`: the init system inside the machine's image (systemd, OpenRC) becomes PID 1 and starts the services enabled on its disk. This does not choose the image; `source.machine_image_id` does. Debian and Ubuntu images need `systemd systemd-sysv` installed first. A unit restarts after a crash only when it sets `Restart=`.
|
|
2505
|
+
* Which process runs first at boot. `none` (default): nothing; the machine waits for exec. `image`: the init system inside the machine's image (systemd, OpenRC) becomes PID 1 and starts the services enabled on its disk. This does not choose the image; `source.machine_image_id` does. Debian and Ubuntu images need `systemd systemd-sysv` installed first. A unit restarts after a crash only when it sets `Restart=`. GPU machines require `none`.
|
|
2390
2506
|
*/
|
|
2391
2507
|
init?: ("none" | "image");
|
|
2392
2508
|
/**
|
|
2393
|
-
* Run these arguments as the main process on every boot, without a shell. Use ["sh", "-c", ...] for shell syntax. Find ENTRYPOINT and CMD on the image's registry page; Zo does not return them. Pass ENTRYPOINT then CMD. With `init: image`, the command must wait for services it needs. The machine stops when it exits; resume runs it again. It may run more than once after a lost create or resume response, so make it safe to rerun. Each argument is at most 4,096 UTF-8 bytes and all arguments total at most 65,536 bytes. A running command is not activity: set `idle_timeout_seconds` at least as long as the job. The maximum is published by `zo.machine.list_configurations
|
|
2509
|
+
* Run these arguments as the main process on every boot, without a shell. Use ["sh", "-c", ...] for shell syntax. Find ENTRYPOINT and CMD on the image's registry page; Zo does not return them. Pass ENTRYPOINT then CMD. With `init: image`, the command must wait for services it needs. The machine stops when it exits; resume runs it again. It may run more than once after a lost create or resume response, so make it safe to rerun. Each argument is at most 4,096 UTF-8 bytes and all arguments total at most 65,536 bytes. A running command is not activity: set `idle_timeout_seconds` at least as long as the job. The maximum is published by `zo.machine.list_configurations`: 3,600 s for CPU machines and 86,400 s for GPU machines. Longer CPU jobs need Zo exec or file calls, or HTTP through a tunnel or connect token. After exit, `get` may show `running` for a few minutes until the stop is recorded. Zo reports no exit reason or code. Write a job's result to disk. A resume runs the command again, so to read it, clear the command, resume, then use `zo.machine.read_bytes`. With `init: image` and a command, a missing `/sbin/init` ends the generation as an exit stop, without `incompatible_image`.
|
|
2394
2510
|
*/
|
|
2395
2511
|
command?: ([string, ...(string)[]] | null);
|
|
2512
|
+
/**
|
|
2513
|
+
* Environment variables set, exactly as written, in the boot process and every command run on the machine. Plain strings, not secrets: they are part of the machine's configuration, which anyone who can read the machine sees. Names are upper-case letters, digits and underscores, and reserved names such as `PATH` or ones starting with `ZO_` are refused; at most 64 variables of at most 4096 characters each. A variable here wins over a connection in `credentials` that sets the same name.
|
|
2514
|
+
*/
|
|
2515
|
+
environment?: {
|
|
2516
|
+
[k: string]: string;
|
|
2517
|
+
};
|
|
2518
|
+
/**
|
|
2519
|
+
* Connection IDs whose credentials the machine receives as environment variables, in the boot process and every command. Each slot of a listed connection sets the variable its definition names, with the variables the slot and the connection declare. The machine also needs a use grant on each connection (`zo.grant.create` with the machine as assignee); a listed connection without one delivers nothing. When two listed connections set the same variable, the later one in the list wins. At most 100 connections, each listed once.
|
|
2520
|
+
*
|
|
2521
|
+
* @maxItems 100
|
|
2522
|
+
*/
|
|
2523
|
+
credentials?: string[];
|
|
2396
2524
|
/**
|
|
2397
2525
|
* `workspace` (default): every member can see and use it. `protected`: only you, and whoever you share it with; workspace-wide grants don't reach it. Fixed at creation.
|
|
2398
2526
|
*/
|
|
@@ -2410,11 +2538,20 @@ export interface ZoMachineCreateInputV1MachineResourcesInput {
|
|
|
2410
2538
|
*/
|
|
2411
2539
|
vcpus: number;
|
|
2412
2540
|
memory_mib: number;
|
|
2541
|
+
gpu?: (ZoMachineCreateInputV1MachineGpu | null);
|
|
2542
|
+
}
|
|
2543
|
+
export interface ZoMachineCreateInputV1MachineGpu {
|
|
2544
|
+
type: ZoMachineCreateInputV1GpuType;
|
|
2545
|
+
count: number;
|
|
2413
2546
|
}
|
|
2414
2547
|
export interface ZoMachineCreateInputV1MachineLifecycleInput {
|
|
2415
|
-
|
|
2548
|
+
/**
|
|
2549
|
+
* Omit for 900 seconds on CPU. For GPU, the default is the smaller of 300 seconds and max_run_seconds. An explicit GPU idle timeout must not exceed max_run_seconds.
|
|
2550
|
+
*/
|
|
2551
|
+
idle_timeout_seconds?: (number | null);
|
|
2416
2552
|
max_run_seconds: number;
|
|
2417
2553
|
}
|
|
2554
|
+
export type ZoMachineCreateOutputV1GpuType = ("T4" | "L4" | "A10" | "L40S" | "A100" | "A100-40GB" | "A100-80GB" | "RTX-PRO-6000" | "H100" | "H100!" | "H200" | "B200" | "B200+" | "B300");
|
|
2418
2555
|
export type ZoMachineCreateOutputV1ObservedState = ("creating" | "running" | "stopping" | "stopped" | "resuming" | "destroying" | "destroyed" | "failed");
|
|
2419
2556
|
/**
|
|
2420
2557
|
* A machine's registry envelope, boot settings and row-owned lifecycle state.
|
|
@@ -2425,6 +2562,7 @@ export interface ZoMachineCreateOutputV1 {
|
|
|
2425
2562
|
type: "machine";
|
|
2426
2563
|
type_version: 1;
|
|
2427
2564
|
display_name: string;
|
|
2565
|
+
description: string;
|
|
2428
2566
|
visibility: ("workspace" | "protected");
|
|
2429
2567
|
revision: number;
|
|
2430
2568
|
properties: ZoMachineCreateOutputV1MachineProperties;
|
|
@@ -2436,6 +2574,8 @@ export interface ZoMachineCreateOutputV1 {
|
|
|
2436
2574
|
created_at: string;
|
|
2437
2575
|
updated_at: string;
|
|
2438
2576
|
destroyed_at: (string | null);
|
|
2577
|
+
recoverable_until?: (string | null);
|
|
2578
|
+
recovery_acceptance_required?: boolean;
|
|
2439
2579
|
}
|
|
2440
2580
|
/**
|
|
2441
2581
|
* Public properties of a `machine` resource.
|
|
@@ -2454,11 +2594,20 @@ export interface ZoMachineCreateOutputV1MachineProperties {
|
|
|
2454
2594
|
machine_image_id: (string | null);
|
|
2455
2595
|
vcpus: (number | null);
|
|
2456
2596
|
memory_mib: (number | null);
|
|
2597
|
+
gpu?: (ZoMachineCreateOutputV1MachineGpu | null);
|
|
2457
2598
|
region: (string | null);
|
|
2458
2599
|
idle_timeout_seconds: (number | null);
|
|
2459
2600
|
max_run_seconds: (number | null);
|
|
2460
2601
|
init?: (("none" | "image") | null);
|
|
2461
2602
|
command?: ([string, ...(string)[]] | null);
|
|
2603
|
+
environment?: ({
|
|
2604
|
+
[k: string]: string;
|
|
2605
|
+
} | null);
|
|
2606
|
+
credentials?: (string[] | null);
|
|
2607
|
+
}
|
|
2608
|
+
export interface ZoMachineCreateOutputV1MachineGpu {
|
|
2609
|
+
type: ZoMachineCreateOutputV1GpuType;
|
|
2610
|
+
count: number;
|
|
2462
2611
|
}
|
|
2463
2612
|
export interface ZoMachineCreateOutputV1MachineBootedView {
|
|
2464
2613
|
init: ("none" | "image");
|
|
@@ -2469,6 +2618,7 @@ export interface ZoMachineDestroyInputV1 {
|
|
|
2469
2618
|
expected_revision: number;
|
|
2470
2619
|
idempotency_key: string;
|
|
2471
2620
|
}
|
|
2621
|
+
export type ZoMachineDestroyOutputV1GpuType = ("T4" | "L4" | "A10" | "L40S" | "A100" | "A100-40GB" | "A100-80GB" | "RTX-PRO-6000" | "H100" | "H100!" | "H200" | "B200" | "B200+" | "B300");
|
|
2472
2622
|
export type ZoMachineDestroyOutputV1ObservedState = ("creating" | "running" | "stopping" | "stopped" | "resuming" | "destroying" | "destroyed" | "failed");
|
|
2473
2623
|
/**
|
|
2474
2624
|
* A machine's registry envelope, boot settings and row-owned lifecycle state.
|
|
@@ -2479,6 +2629,7 @@ export interface ZoMachineDestroyOutputV1 {
|
|
|
2479
2629
|
type: "machine";
|
|
2480
2630
|
type_version: 1;
|
|
2481
2631
|
display_name: string;
|
|
2632
|
+
description: string;
|
|
2482
2633
|
visibility: ("workspace" | "protected");
|
|
2483
2634
|
revision: number;
|
|
2484
2635
|
properties: ZoMachineDestroyOutputV1MachineProperties;
|
|
@@ -2490,6 +2641,8 @@ export interface ZoMachineDestroyOutputV1 {
|
|
|
2490
2641
|
created_at: string;
|
|
2491
2642
|
updated_at: string;
|
|
2492
2643
|
destroyed_at: (string | null);
|
|
2644
|
+
recoverable_until?: (string | null);
|
|
2645
|
+
recovery_acceptance_required?: boolean;
|
|
2493
2646
|
}
|
|
2494
2647
|
/**
|
|
2495
2648
|
* Public properties of a `machine` resource.
|
|
@@ -2508,11 +2661,20 @@ export interface ZoMachineDestroyOutputV1MachineProperties {
|
|
|
2508
2661
|
machine_image_id: (string | null);
|
|
2509
2662
|
vcpus: (number | null);
|
|
2510
2663
|
memory_mib: (number | null);
|
|
2664
|
+
gpu?: (ZoMachineDestroyOutputV1MachineGpu | null);
|
|
2511
2665
|
region: (string | null);
|
|
2512
2666
|
idle_timeout_seconds: (number | null);
|
|
2513
2667
|
max_run_seconds: (number | null);
|
|
2514
2668
|
init?: (("none" | "image") | null);
|
|
2515
2669
|
command?: ([string, ...(string)[]] | null);
|
|
2670
|
+
environment?: ({
|
|
2671
|
+
[k: string]: string;
|
|
2672
|
+
} | null);
|
|
2673
|
+
credentials?: (string[] | null);
|
|
2674
|
+
}
|
|
2675
|
+
export interface ZoMachineDestroyOutputV1MachineGpu {
|
|
2676
|
+
type: ZoMachineDestroyOutputV1GpuType;
|
|
2677
|
+
count: number;
|
|
2516
2678
|
}
|
|
2517
2679
|
export interface ZoMachineDestroyOutputV1MachineBootedView {
|
|
2518
2680
|
init: ("none" | "image");
|
|
@@ -2536,6 +2698,7 @@ export interface ZoMachineExecOutputV1 {
|
|
|
2536
2698
|
export interface ZoMachineGetInputV1 {
|
|
2537
2699
|
machine_id: string;
|
|
2538
2700
|
}
|
|
2701
|
+
export type ZoMachineGetOutputV1GpuType = ("T4" | "L4" | "A10" | "L40S" | "A100" | "A100-40GB" | "A100-80GB" | "RTX-PRO-6000" | "H100" | "H100!" | "H200" | "B200" | "B200+" | "B300");
|
|
2539
2702
|
export type ZoMachineGetOutputV1ObservedState = ("creating" | "running" | "stopping" | "stopped" | "resuming" | "destroying" | "destroyed" | "failed");
|
|
2540
2703
|
/**
|
|
2541
2704
|
* A machine's registry envelope, boot settings and row-owned lifecycle state.
|
|
@@ -2546,6 +2709,7 @@ export interface ZoMachineGetOutputV1 {
|
|
|
2546
2709
|
type: "machine";
|
|
2547
2710
|
type_version: 1;
|
|
2548
2711
|
display_name: string;
|
|
2712
|
+
description: string;
|
|
2549
2713
|
visibility: ("workspace" | "protected");
|
|
2550
2714
|
revision: number;
|
|
2551
2715
|
properties: ZoMachineGetOutputV1MachineProperties;
|
|
@@ -2557,6 +2721,8 @@ export interface ZoMachineGetOutputV1 {
|
|
|
2557
2721
|
created_at: string;
|
|
2558
2722
|
updated_at: string;
|
|
2559
2723
|
destroyed_at: (string | null);
|
|
2724
|
+
recoverable_until?: (string | null);
|
|
2725
|
+
recovery_acceptance_required?: boolean;
|
|
2560
2726
|
}
|
|
2561
2727
|
/**
|
|
2562
2728
|
* Public properties of a `machine` resource.
|
|
@@ -2575,11 +2741,20 @@ export interface ZoMachineGetOutputV1MachineProperties {
|
|
|
2575
2741
|
machine_image_id: (string | null);
|
|
2576
2742
|
vcpus: (number | null);
|
|
2577
2743
|
memory_mib: (number | null);
|
|
2744
|
+
gpu?: (ZoMachineGetOutputV1MachineGpu | null);
|
|
2578
2745
|
region: (string | null);
|
|
2579
2746
|
idle_timeout_seconds: (number | null);
|
|
2580
2747
|
max_run_seconds: (number | null);
|
|
2581
2748
|
init?: (("none" | "image") | null);
|
|
2582
2749
|
command?: ([string, ...(string)[]] | null);
|
|
2750
|
+
environment?: ({
|
|
2751
|
+
[k: string]: string;
|
|
2752
|
+
} | null);
|
|
2753
|
+
credentials?: (string[] | null);
|
|
2754
|
+
}
|
|
2755
|
+
export interface ZoMachineGetOutputV1MachineGpu {
|
|
2756
|
+
type: ZoMachineGetOutputV1GpuType;
|
|
2757
|
+
count: number;
|
|
2583
2758
|
}
|
|
2584
2759
|
export interface ZoMachineGetOutputV1MachineBootedView {
|
|
2585
2760
|
init: ("none" | "image");
|
|
@@ -2588,6 +2763,7 @@ export interface ZoMachineGetOutputV1MachineBootedView {
|
|
|
2588
2763
|
export interface ZoMachineListInputV1 {
|
|
2589
2764
|
workspace_id: string;
|
|
2590
2765
|
}
|
|
2766
|
+
export type ZoMachineListOutputV1GpuType = ("T4" | "L4" | "A10" | "L40S" | "A100" | "A100-40GB" | "A100-80GB" | "RTX-PRO-6000" | "H100" | "H100!" | "H200" | "B200" | "B200+" | "B300");
|
|
2591
2767
|
export type ZoMachineListOutputV1ObservedState = ("creating" | "running" | "stopping" | "stopped" | "resuming" | "destroying" | "destroyed" | "failed");
|
|
2592
2768
|
export interface ZoMachineListOutputV1 {
|
|
2593
2769
|
machines: ZoMachineListOutputV1ManagedMachineView[];
|
|
@@ -2602,6 +2778,7 @@ export interface ZoMachineListOutputV1ManagedMachineView {
|
|
|
2602
2778
|
type: "machine";
|
|
2603
2779
|
type_version: 1;
|
|
2604
2780
|
display_name: string;
|
|
2781
|
+
description: string;
|
|
2605
2782
|
visibility: ("workspace" | "protected");
|
|
2606
2783
|
revision: number;
|
|
2607
2784
|
properties: ZoMachineListOutputV1MachineProperties;
|
|
@@ -2613,6 +2790,8 @@ export interface ZoMachineListOutputV1ManagedMachineView {
|
|
|
2613
2790
|
created_at: string;
|
|
2614
2791
|
updated_at: string;
|
|
2615
2792
|
destroyed_at: (string | null);
|
|
2793
|
+
recoverable_until?: (string | null);
|
|
2794
|
+
recovery_acceptance_required?: boolean;
|
|
2616
2795
|
}
|
|
2617
2796
|
/**
|
|
2618
2797
|
* Public properties of a `machine` resource.
|
|
@@ -2631,11 +2810,20 @@ export interface ZoMachineListOutputV1MachineProperties {
|
|
|
2631
2810
|
machine_image_id: (string | null);
|
|
2632
2811
|
vcpus: (number | null);
|
|
2633
2812
|
memory_mib: (number | null);
|
|
2813
|
+
gpu?: (ZoMachineListOutputV1MachineGpu | null);
|
|
2634
2814
|
region: (string | null);
|
|
2635
2815
|
idle_timeout_seconds: (number | null);
|
|
2636
2816
|
max_run_seconds: (number | null);
|
|
2637
2817
|
init?: (("none" | "image") | null);
|
|
2638
2818
|
command?: ([string, ...(string)[]] | null);
|
|
2819
|
+
environment?: ({
|
|
2820
|
+
[k: string]: string;
|
|
2821
|
+
} | null);
|
|
2822
|
+
credentials?: (string[] | null);
|
|
2823
|
+
}
|
|
2824
|
+
export interface ZoMachineListOutputV1MachineGpu {
|
|
2825
|
+
type: ZoMachineListOutputV1GpuType;
|
|
2826
|
+
count: number;
|
|
2639
2827
|
}
|
|
2640
2828
|
export interface ZoMachineListOutputV1MachineBootedView {
|
|
2641
2829
|
init: ("none" | "image");
|
|
@@ -2662,6 +2850,8 @@ export interface ZoMachineListConfigurationsInputV1 {
|
|
|
2662
2850
|
*/
|
|
2663
2851
|
export interface ZoMachineListConfigurationsOutputV1 {
|
|
2664
2852
|
resources: ZoMachineListConfigurationsOutputV1MachineResourceBounds;
|
|
2853
|
+
gpus: ZoMachineListConfigurationsOutputV1MachineGpuOffer[];
|
|
2854
|
+
runtime: "vm";
|
|
2665
2855
|
vcpu_microusd_per_second: number;
|
|
2666
2856
|
memory_gib_microusd_per_second: number;
|
|
2667
2857
|
regions: string[];
|
|
@@ -2680,16 +2870,26 @@ export interface ZoMachineListConfigurationsOutputV1MachineRunBounds {
|
|
|
2680
2870
|
minimum: number;
|
|
2681
2871
|
maximum: number;
|
|
2682
2872
|
}
|
|
2683
|
-
export interface
|
|
2684
|
-
|
|
2685
|
-
|
|
2686
|
-
|
|
2873
|
+
export interface ZoMachineListConfigurationsOutputV1MachineGpuOffer {
|
|
2874
|
+
type: string;
|
|
2875
|
+
count: ZoMachineListConfigurationsOutputV1MachineRunBounds;
|
|
2876
|
+
vram_gb: number;
|
|
2877
|
+
gpu_microusd_per_second: number;
|
|
2878
|
+
runtime: "gvisor";
|
|
2879
|
+
init: ("none")[];
|
|
2880
|
+
idle_timeout_seconds: ZoMachineListConfigurationsOutputV1MachineIdleTimeoutBounds;
|
|
2881
|
+
max_run_seconds: ZoMachineListConfigurationsOutputV1MachineRunBounds;
|
|
2687
2882
|
}
|
|
2688
2883
|
export interface ZoMachineListConfigurationsOutputV1MachineIdleTimeoutBounds {
|
|
2689
2884
|
minimum: number;
|
|
2690
2885
|
maximum: number;
|
|
2691
2886
|
default: number;
|
|
2692
2887
|
}
|
|
2888
|
+
export interface ZoMachineListConfigurationsOutputV1MachineCommandOffer {
|
|
2889
|
+
supported: boolean;
|
|
2890
|
+
max_args: number;
|
|
2891
|
+
max_arg_bytes: number;
|
|
2892
|
+
}
|
|
2693
2893
|
export interface ZoMachineListFilesInputV1 {
|
|
2694
2894
|
machine_id: string;
|
|
2695
2895
|
path: string;
|
|
@@ -2735,6 +2935,7 @@ export interface ZoMachineResumeInputV1 {
|
|
|
2735
2935
|
idempotency_key: string;
|
|
2736
2936
|
accept_recovery?: boolean;
|
|
2737
2937
|
}
|
|
2938
|
+
export type ZoMachineResumeOutputV1GpuType = ("T4" | "L4" | "A10" | "L40S" | "A100" | "A100-40GB" | "A100-80GB" | "RTX-PRO-6000" | "H100" | "H100!" | "H200" | "B200" | "B200+" | "B300");
|
|
2738
2939
|
export type ZoMachineResumeOutputV1ObservedState = ("creating" | "running" | "stopping" | "stopped" | "resuming" | "destroying" | "destroyed" | "failed");
|
|
2739
2940
|
/**
|
|
2740
2941
|
* A machine's registry envelope, boot settings and row-owned lifecycle state.
|
|
@@ -2745,6 +2946,7 @@ export interface ZoMachineResumeOutputV1 {
|
|
|
2745
2946
|
type: "machine";
|
|
2746
2947
|
type_version: 1;
|
|
2747
2948
|
display_name: string;
|
|
2949
|
+
description: string;
|
|
2748
2950
|
visibility: ("workspace" | "protected");
|
|
2749
2951
|
revision: number;
|
|
2750
2952
|
properties: ZoMachineResumeOutputV1MachineProperties;
|
|
@@ -2756,6 +2958,8 @@ export interface ZoMachineResumeOutputV1 {
|
|
|
2756
2958
|
created_at: string;
|
|
2757
2959
|
updated_at: string;
|
|
2758
2960
|
destroyed_at: (string | null);
|
|
2961
|
+
recoverable_until?: (string | null);
|
|
2962
|
+
recovery_acceptance_required?: boolean;
|
|
2759
2963
|
}
|
|
2760
2964
|
/**
|
|
2761
2965
|
* Public properties of a `machine` resource.
|
|
@@ -2774,11 +2978,20 @@ export interface ZoMachineResumeOutputV1MachineProperties {
|
|
|
2774
2978
|
machine_image_id: (string | null);
|
|
2775
2979
|
vcpus: (number | null);
|
|
2776
2980
|
memory_mib: (number | null);
|
|
2981
|
+
gpu?: (ZoMachineResumeOutputV1MachineGpu | null);
|
|
2777
2982
|
region: (string | null);
|
|
2778
2983
|
idle_timeout_seconds: (number | null);
|
|
2779
2984
|
max_run_seconds: (number | null);
|
|
2780
2985
|
init?: (("none" | "image") | null);
|
|
2781
2986
|
command?: ([string, ...(string)[]] | null);
|
|
2987
|
+
environment?: ({
|
|
2988
|
+
[k: string]: string;
|
|
2989
|
+
} | null);
|
|
2990
|
+
credentials?: (string[] | null);
|
|
2991
|
+
}
|
|
2992
|
+
export interface ZoMachineResumeOutputV1MachineGpu {
|
|
2993
|
+
type: ZoMachineResumeOutputV1GpuType;
|
|
2994
|
+
count: number;
|
|
2782
2995
|
}
|
|
2783
2996
|
export interface ZoMachineResumeOutputV1MachineBootedView {
|
|
2784
2997
|
init: ("none" | "image");
|
|
@@ -2795,6 +3008,10 @@ export interface ZoMachineSnapshotInputV1 {
|
|
|
2795
3008
|
}
|
|
2796
3009
|
export interface ZoMachineSnapshotInputV1MachineImageCreateOptions {
|
|
2797
3010
|
display_name: string;
|
|
3011
|
+
/**
|
|
3012
|
+
* Describe what this machine image is for in the user's terms.
|
|
3013
|
+
*/
|
|
3014
|
+
description?: string;
|
|
2798
3015
|
/**
|
|
2799
3016
|
* Image visibility. Omit or pass null to use the creating operation's default. Protected images use ordinary verified-human creator ownership.
|
|
2800
3017
|
*/
|
|
@@ -2813,6 +3030,7 @@ export interface ZoMachineSnapshotOutputV1 {
|
|
|
2813
3030
|
type: "machine_image";
|
|
2814
3031
|
type_version: number;
|
|
2815
3032
|
display_name: string;
|
|
3033
|
+
description: string;
|
|
2816
3034
|
visibility: ("workspace" | "protected");
|
|
2817
3035
|
revision: number;
|
|
2818
3036
|
properties: ZoMachineSnapshotOutputV1MachineImageProperties;
|
|
@@ -2839,6 +3057,7 @@ export interface ZoMachineStopInputV1 {
|
|
|
2839
3057
|
expected_revision: number;
|
|
2840
3058
|
idempotency_key: string;
|
|
2841
3059
|
}
|
|
3060
|
+
export type ZoMachineStopOutputV1GpuType = ("T4" | "L4" | "A10" | "L40S" | "A100" | "A100-40GB" | "A100-80GB" | "RTX-PRO-6000" | "H100" | "H100!" | "H200" | "B200" | "B200+" | "B300");
|
|
2842
3061
|
export type ZoMachineStopOutputV1ObservedState = ("creating" | "running" | "stopping" | "stopped" | "resuming" | "destroying" | "destroyed" | "failed");
|
|
2843
3062
|
/**
|
|
2844
3063
|
* A machine's registry envelope, boot settings and row-owned lifecycle state.
|
|
@@ -2849,6 +3068,7 @@ export interface ZoMachineStopOutputV1 {
|
|
|
2849
3068
|
type: "machine";
|
|
2850
3069
|
type_version: 1;
|
|
2851
3070
|
display_name: string;
|
|
3071
|
+
description: string;
|
|
2852
3072
|
visibility: ("workspace" | "protected");
|
|
2853
3073
|
revision: number;
|
|
2854
3074
|
properties: ZoMachineStopOutputV1MachineProperties;
|
|
@@ -2860,6 +3080,8 @@ export interface ZoMachineStopOutputV1 {
|
|
|
2860
3080
|
created_at: string;
|
|
2861
3081
|
updated_at: string;
|
|
2862
3082
|
destroyed_at: (string | null);
|
|
3083
|
+
recoverable_until?: (string | null);
|
|
3084
|
+
recovery_acceptance_required?: boolean;
|
|
2863
3085
|
}
|
|
2864
3086
|
/**
|
|
2865
3087
|
* Public properties of a `machine` resource.
|
|
@@ -2878,11 +3100,20 @@ export interface ZoMachineStopOutputV1MachineProperties {
|
|
|
2878
3100
|
machine_image_id: (string | null);
|
|
2879
3101
|
vcpus: (number | null);
|
|
2880
3102
|
memory_mib: (number | null);
|
|
3103
|
+
gpu?: (ZoMachineStopOutputV1MachineGpu | null);
|
|
2881
3104
|
region: (string | null);
|
|
2882
3105
|
idle_timeout_seconds: (number | null);
|
|
2883
3106
|
max_run_seconds: (number | null);
|
|
2884
3107
|
init?: (("none" | "image") | null);
|
|
2885
3108
|
command?: ([string, ...(string)[]] | null);
|
|
3109
|
+
environment?: ({
|
|
3110
|
+
[k: string]: string;
|
|
3111
|
+
} | null);
|
|
3112
|
+
credentials?: (string[] | null);
|
|
3113
|
+
}
|
|
3114
|
+
export interface ZoMachineStopOutputV1MachineGpu {
|
|
3115
|
+
type: ZoMachineStopOutputV1GpuType;
|
|
3116
|
+
count: number;
|
|
2886
3117
|
}
|
|
2887
3118
|
export interface ZoMachineStopOutputV1MachineBootedView {
|
|
2888
3119
|
init: ("none" | "image");
|
|
@@ -2894,6 +3125,7 @@ export interface ZoMachineSystemInfoInputV1 {
|
|
|
2894
3125
|
export type ZoMachineSystemInfoOutputV1DesiredState = ("running" | "stopped" | "destroyed");
|
|
2895
3126
|
export type ZoMachineSystemInfoOutputV1ObservedState = ("creating" | "running" | "stopping" | "stopped" | "resuming" | "destroying" | "destroyed" | "failed");
|
|
2896
3127
|
export type ZoMachineSystemInfoOutputV1InfoSource = ("provider" | "zo_control");
|
|
3128
|
+
export type ZoMachineSystemInfoOutputV1GpuType = ("T4" | "L4" | "A10" | "L40S" | "A100" | "A100-40GB" | "A100-80GB" | "RTX-PRO-6000" | "H100" | "H100!" | "H200" | "B200" | "B200+" | "B300");
|
|
2897
3129
|
export type ZoMachineSystemInfoOutputV1InfoGroup = ("architecture" | "os" | "allocation" | "guest" | "disk" | "network" | "accelerators" | "capabilities");
|
|
2898
3130
|
export type ZoMachineSystemInfoOutputV1InfoUnknownReason = ("not_observed" | "driver_unavailable");
|
|
2899
3131
|
/**
|
|
@@ -2942,9 +3174,14 @@ export interface ZoMachineSystemInfoOutputV1MachineInfoAllocation {
|
|
|
2942
3174
|
observed_at: string;
|
|
2943
3175
|
requested_vcpus: number;
|
|
2944
3176
|
requested_memory_mib: number;
|
|
3177
|
+
requested_gpu?: (ZoMachineSystemInfoOutputV1MachineGpu | null);
|
|
2945
3178
|
verified_vcpus: (number | null);
|
|
2946
3179
|
verified_memory_mib: (number | null);
|
|
2947
3180
|
}
|
|
3181
|
+
export interface ZoMachineSystemInfoOutputV1MachineGpu {
|
|
3182
|
+
type: ZoMachineSystemInfoOutputV1GpuType;
|
|
3183
|
+
count: number;
|
|
3184
|
+
}
|
|
2948
3185
|
/**
|
|
2949
3186
|
* What the machine's driver supports, not what the caller may do.
|
|
2950
3187
|
* ``stop`` keeps the filesystem; ``pause`` keeps memory too.
|
|
@@ -2975,19 +3212,33 @@ export interface ZoMachineUpdateInputV1 {
|
|
|
2975
3212
|
machine_id: string;
|
|
2976
3213
|
expected_revision: number;
|
|
2977
3214
|
display_name?: (string | null);
|
|
3215
|
+
/**
|
|
3216
|
+
* Describe what this machine is for in the user's terms.
|
|
3217
|
+
*/
|
|
3218
|
+
description?: (string | null);
|
|
2978
3219
|
lifecycle?: (ZoMachineUpdateInputV1MachineLifecycleUpdate | null);
|
|
2979
3220
|
/**
|
|
2980
|
-
* Which process runs first at boot. `none` (default): nothing; the machine waits for exec. `image`: the image's init system (systemd, OpenRC) becomes PID 1 and starts enabled services. `source.machine_image_id` chooses the image. Debian and Ubuntu need `systemd systemd-sysv`.
|
|
3221
|
+
* Which process runs first at boot. `none` (default): nothing; the machine waits for exec. `image`: the image's init system (systemd, OpenRC) becomes PID 1 and starts enabled services. `source.machine_image_id` chooses the image. Debian and Ubuntu need `systemd systemd-sysv`. Write access to boot files can run code as root at next boot.
|
|
2981
3222
|
*/
|
|
2982
3223
|
init?: (("none" | "image") | null);
|
|
2983
3224
|
/**
|
|
2984
|
-
* Set the main process for the next resume. Arguments run without a shell; use ["sh", "-c", ...] for shell syntax. Find ENTRYPOINT and CMD on the image's registry page; Zo does not return them. Pass ENTRYPOINT then CMD. With `init: image`, wait for needed services. The machine stops when the command exits; resume runs it again. It may run more than once after a lost create or resume response, so make it safe to rerun. Each argument is at most 4,096 UTF-8 bytes and all arguments total at most 65,536 bytes. A running command is not activity: set `idle_timeout_seconds` at least as long as the job. The maximum is published by `zo.machine.list_configurations
|
|
3225
|
+
* Set the main process for the next resume. Arguments run without a shell; use ["sh", "-c", ...] for shell syntax. Find ENTRYPOINT and CMD on the image's registry page; Zo does not return them. Pass ENTRYPOINT then CMD. With `init: image`, wait for needed services. The machine stops when the command exits; resume runs it again. It may run more than once after a lost create or resume response, so make it safe to rerun. Each argument is at most 4,096 UTF-8 bytes and all arguments total at most 65,536 bytes. A running command is not activity: set `idle_timeout_seconds` at least as long as the job. The maximum is published by `zo.machine.list_configurations`: 3,600 s for CPU machines and 86,400 s for GPU machines. Longer CPU jobs need Zo exec or file calls, or HTTP through a tunnel or connect token. After exit, `get` may show `running` for a few minutes. Zo reports no exit reason or code. Write a job's result to disk. A resume runs the command again, so to read it, clear the command, resume, then use `zo.machine.read_bytes`. With `init: image` and a command, a missing `/sbin/init` ends the generation as an exit stop, without `incompatible_image`. Write access to its script can run code as root at next boot.
|
|
2985
3226
|
*/
|
|
2986
3227
|
command?: ([string, ...(string)[]] | null);
|
|
2987
3228
|
/**
|
|
2988
|
-
* Remove the main process on the next resume.
|
|
3229
|
+
* Remove the main process on the next resume.
|
|
2989
3230
|
*/
|
|
2990
3231
|
clear_command?: boolean;
|
|
3232
|
+
/**
|
|
3233
|
+
* The environment that replaces the stored one; omit it to keep it. Environment variables set, exactly as written, in the boot process and every command run on the machine. Plain strings, not secrets: they are part of the machine's configuration, which anyone who can read the machine sees. Names are upper-case letters, digits and underscores, and reserved names such as `PATH` or ones starting with `ZO_` are refused; at most 64 variables of at most 4096 characters each. A variable here wins over a connection in `credentials` that sets the same name.
|
|
3234
|
+
*/
|
|
3235
|
+
environment?: ({
|
|
3236
|
+
[k: string]: string;
|
|
3237
|
+
} | null);
|
|
3238
|
+
/**
|
|
3239
|
+
* The list that replaces the stored one; omit it to keep it. Connection IDs whose credentials the machine receives as environment variables, in the boot process and every command. Each slot of a listed connection sets the variable its definition names, with the variables the slot and the connection declare. The machine also needs a use grant on each connection (`zo.grant.create` with the machine as assignee); a listed connection without one delivers nothing. When two listed connections set the same variable, the later one in the list wins. At most 100 connections, each listed once.
|
|
3240
|
+
*/
|
|
3241
|
+
credentials?: (string[] | null);
|
|
2991
3242
|
}
|
|
2992
3243
|
/**
|
|
2993
3244
|
* The timers a caller may change after create. Modal fixes them at
|
|
@@ -3001,6 +3252,7 @@ export interface ZoMachineUpdateOutputV1 {
|
|
|
3001
3252
|
machine_id: string;
|
|
3002
3253
|
revision: number;
|
|
3003
3254
|
display_name: string;
|
|
3255
|
+
description: string;
|
|
3004
3256
|
idle_timeout_seconds: number;
|
|
3005
3257
|
max_run_seconds: (number | null);
|
|
3006
3258
|
}
|
|
@@ -3034,6 +3286,7 @@ export interface ZoMachineImageDeleteOutputV1 {
|
|
|
3034
3286
|
type: "machine_image";
|
|
3035
3287
|
type_version: number;
|
|
3036
3288
|
display_name: string;
|
|
3289
|
+
description: string;
|
|
3037
3290
|
visibility: ("workspace" | "protected");
|
|
3038
3291
|
revision: number;
|
|
3039
3292
|
properties: ZoMachineImageDeleteOutputV1MachineImageProperties;
|
|
@@ -3071,6 +3324,7 @@ export interface ZoMachineImageGetOutputV1 {
|
|
|
3071
3324
|
type: "machine_image";
|
|
3072
3325
|
type_version: number;
|
|
3073
3326
|
display_name: string;
|
|
3327
|
+
description: string;
|
|
3074
3328
|
visibility: ("workspace" | "protected");
|
|
3075
3329
|
revision: number;
|
|
3076
3330
|
properties: ZoMachineImageGetOutputV1MachineImageProperties;
|
|
@@ -3094,6 +3348,10 @@ export interface ZoMachineImageGetOutputV1MachineImageProperties {
|
|
|
3094
3348
|
}
|
|
3095
3349
|
export interface ZoMachineImageImportInputV1 {
|
|
3096
3350
|
display_name: string;
|
|
3351
|
+
/**
|
|
3352
|
+
* Describe what this machine image is for in the user's terms.
|
|
3353
|
+
*/
|
|
3354
|
+
description?: string;
|
|
3097
3355
|
/**
|
|
3098
3356
|
* `workspace` (default): every member can see and use it. `protected`: only you, and whoever you share it with; workspace-wide grants don't reach it. Fixed at creation.
|
|
3099
3357
|
*/
|
|
@@ -3120,6 +3378,7 @@ export interface ZoMachineImageImportOutputV1 {
|
|
|
3120
3378
|
type: "machine_image";
|
|
3121
3379
|
type_version: number;
|
|
3122
3380
|
display_name: string;
|
|
3381
|
+
description: string;
|
|
3123
3382
|
visibility: ("workspace" | "protected");
|
|
3124
3383
|
revision: number;
|
|
3125
3384
|
properties: ZoMachineImageImportOutputV1MachineImageProperties;
|
|
@@ -3161,6 +3420,7 @@ export interface ZoMachineImageListOutputV1MachineImageView {
|
|
|
3161
3420
|
type: "machine_image";
|
|
3162
3421
|
type_version: number;
|
|
3163
3422
|
display_name: string;
|
|
3423
|
+
description: string;
|
|
3164
3424
|
visibility: ("workspace" | "protected");
|
|
3165
3425
|
revision: number;
|
|
3166
3426
|
properties: ZoMachineImageListOutputV1MachineImageProperties;
|
|
@@ -3401,6 +3661,10 @@ export interface ZoOauthAppUpdateOutputV1 {
|
|
|
3401
3661
|
export interface ZoScheduleCreateInputV1 {
|
|
3402
3662
|
workspace_id: string;
|
|
3403
3663
|
display_name: string;
|
|
3664
|
+
/**
|
|
3665
|
+
* Describe what this schedule is for in the user's terms.
|
|
3666
|
+
*/
|
|
3667
|
+
description?: string;
|
|
3404
3668
|
rrule: string;
|
|
3405
3669
|
start_at: string;
|
|
3406
3670
|
timezone: string;
|
|
@@ -3415,6 +3679,7 @@ export interface ZoScheduleCreateOutputV1 {
|
|
|
3415
3679
|
type: "schedule";
|
|
3416
3680
|
type_version: number;
|
|
3417
3681
|
display_name: string;
|
|
3682
|
+
description: string;
|
|
3418
3683
|
revision: number;
|
|
3419
3684
|
visibility: ("workspace" | "protected");
|
|
3420
3685
|
owner_user_id: (string | null);
|
|
@@ -3454,6 +3719,7 @@ export interface ZoScheduleGetOutputV1 {
|
|
|
3454
3719
|
type: "schedule";
|
|
3455
3720
|
type_version: number;
|
|
3456
3721
|
display_name: string;
|
|
3722
|
+
description: string;
|
|
3457
3723
|
revision: number;
|
|
3458
3724
|
visibility: ("workspace" | "protected");
|
|
3459
3725
|
owner_user_id: (string | null);
|
|
@@ -3489,6 +3755,7 @@ export interface ZoScheduleListOutputV1ScheduleView {
|
|
|
3489
3755
|
type: "schedule";
|
|
3490
3756
|
type_version: number;
|
|
3491
3757
|
display_name: string;
|
|
3758
|
+
description: string;
|
|
3492
3759
|
revision: number;
|
|
3493
3760
|
visibility: ("workspace" | "protected");
|
|
3494
3761
|
owner_user_id: (string | null);
|
|
@@ -3522,6 +3789,10 @@ export interface ZoScheduleUpdateInputV1 {
|
|
|
3522
3789
|
schedule_id: string;
|
|
3523
3790
|
expected_revision: number;
|
|
3524
3791
|
display_name: string;
|
|
3792
|
+
/**
|
|
3793
|
+
* Describe what this schedule is for in the user's terms.
|
|
3794
|
+
*/
|
|
3795
|
+
description?: (string | null);
|
|
3525
3796
|
rrule: string;
|
|
3526
3797
|
start_at: string;
|
|
3527
3798
|
timezone: string;
|
|
@@ -3536,6 +3807,7 @@ export interface ZoScheduleUpdateOutputV1 {
|
|
|
3536
3807
|
type: "schedule";
|
|
3537
3808
|
type_version: number;
|
|
3538
3809
|
display_name: string;
|
|
3810
|
+
description: string;
|
|
3539
3811
|
revision: number;
|
|
3540
3812
|
visibility: ("workspace" | "protected");
|
|
3541
3813
|
owner_user_id: (string | null);
|
|
@@ -3805,6 +4077,10 @@ export interface ZoSubscriptionCreateInputV2 {
|
|
|
3805
4077
|
workspace_id: string;
|
|
3806
4078
|
event_id: string;
|
|
3807
4079
|
display_name: string;
|
|
4080
|
+
/**
|
|
4081
|
+
* Describe what this subscription is for in the user's terms.
|
|
4082
|
+
*/
|
|
4083
|
+
description?: string;
|
|
3808
4084
|
filter?: ((ZoSubscriptionCreateInputV2EqFilter | ZoSubscriptionCreateInputV2InFilter | ZoSubscriptionCreateInputV2ExistsFilter | ZoSubscriptionCreateInputV2All1 | ZoSubscriptionCreateInputV2Any1) | null);
|
|
3809
4085
|
handler_resource_type: ("function" | "workflow" | "agent");
|
|
3810
4086
|
handler_resource_id?: (string | null);
|
|
@@ -3911,6 +4187,7 @@ export interface ZoSubscriptionCreateOutputV2 {
|
|
|
3911
4187
|
type: "event_subscription";
|
|
3912
4188
|
type_version: number;
|
|
3913
4189
|
display_name: string;
|
|
4190
|
+
description: string;
|
|
3914
4191
|
revision: number;
|
|
3915
4192
|
properties: ZoSubscriptionCreateOutputV2EventSubscriptionProperties;
|
|
3916
4193
|
event_type: string;
|
|
@@ -4184,6 +4461,7 @@ export interface ZoSubscriptionGetOutputV2 {
|
|
|
4184
4461
|
type: "event_subscription";
|
|
4185
4462
|
type_version: number;
|
|
4186
4463
|
display_name: string;
|
|
4464
|
+
description: string;
|
|
4187
4465
|
revision: number;
|
|
4188
4466
|
properties: ZoSubscriptionGetOutputV2EventSubscriptionProperties;
|
|
4189
4467
|
event_type: string;
|
|
@@ -4487,6 +4765,7 @@ export interface ZoSubscriptionListOutputV2SubscriptionResourceV2 {
|
|
|
4487
4765
|
type: "event_subscription";
|
|
4488
4766
|
type_version: number;
|
|
4489
4767
|
display_name: string;
|
|
4768
|
+
description: string;
|
|
4490
4769
|
revision: number;
|
|
4491
4770
|
properties: ZoSubscriptionListOutputV2EventSubscriptionProperties;
|
|
4492
4771
|
event_type: string;
|
|
@@ -4805,8 +5084,9 @@ export interface ZoSubscriptionUpdateOutputV1PrincipalRef {
|
|
|
4805
5084
|
}
|
|
4806
5085
|
export type ZoSubscriptionUpdateInputV2InputContractKind = ("exact_event" | "generic_envelope");
|
|
4807
5086
|
/**
|
|
4808
|
-
*
|
|
4809
|
-
* definition or version
|
|
5087
|
+
* Replace create fields except workspace, event and optional description.
|
|
5088
|
+
* A new event definition or version requires a new subscription.
|
|
5089
|
+
* Omitted or null description keeps its value. ``lifecycle``: ``active``
|
|
4810
5090
|
* resumes a paused or suspended subscription, ``paused`` pauses it;
|
|
4811
5091
|
* ``zo.subscription.delete`` retires. ``handler_resource_type`` must be the
|
|
4812
5092
|
* subscription's own: a different handler type is a new subscription.
|
|
@@ -4815,6 +5095,10 @@ export interface ZoSubscriptionUpdateInputV2 {
|
|
|
4815
5095
|
subscription_id: string;
|
|
4816
5096
|
expected_revision: number;
|
|
4817
5097
|
display_name: string;
|
|
5098
|
+
/**
|
|
5099
|
+
* Describe what this subscription is for in the user's terms.
|
|
5100
|
+
*/
|
|
5101
|
+
description?: (string | null);
|
|
4818
5102
|
filter?: ((ZoSubscriptionUpdateInputV2EqFilter | ZoSubscriptionUpdateInputV2InFilter | ZoSubscriptionUpdateInputV2ExistsFilter | ZoSubscriptionUpdateInputV2All1 | ZoSubscriptionUpdateInputV2Any1) | null);
|
|
4819
5103
|
handler_resource_type: ("function" | "workflow" | "agent");
|
|
4820
5104
|
handler_resource_id?: (string | null);
|
|
@@ -4921,6 +5205,7 @@ export interface ZoSubscriptionUpdateOutputV2 {
|
|
|
4921
5205
|
type: "event_subscription";
|
|
4922
5206
|
type_version: number;
|
|
4923
5207
|
display_name: string;
|
|
5208
|
+
description: string;
|
|
4924
5209
|
revision: number;
|
|
4925
5210
|
properties: ZoSubscriptionUpdateOutputV2EventSubscriptionProperties;
|
|
4926
5211
|
event_type: string;
|
|
@@ -6560,6 +6845,10 @@ export interface ZoWebsiteCreateInputV1 {
|
|
|
6560
6845
|
workspace_id: string;
|
|
6561
6846
|
slug: string;
|
|
6562
6847
|
display_name: string;
|
|
6848
|
+
/**
|
|
6849
|
+
* Describe what this Website is for in the user's terms.
|
|
6850
|
+
*/
|
|
6851
|
+
description?: string;
|
|
6563
6852
|
visibility?: ("workspace" | "protected");
|
|
6564
6853
|
}
|
|
6565
6854
|
export interface ZoWebsiteCreateOutputV1 {
|
|
@@ -6567,6 +6856,7 @@ export interface ZoWebsiteCreateOutputV1 {
|
|
|
6567
6856
|
workspace_id: string;
|
|
6568
6857
|
slug: string;
|
|
6569
6858
|
display_name: string;
|
|
6859
|
+
description: string;
|
|
6570
6860
|
generated_hostname: string;
|
|
6571
6861
|
custom_hostname: (ZoWebsiteCreateOutputV1WebsiteHostname | null);
|
|
6572
6862
|
access: "public";
|
|
@@ -6596,6 +6886,7 @@ export interface ZoWebsiteGetOutputV1 {
|
|
|
6596
6886
|
workspace_id: string;
|
|
6597
6887
|
slug: string;
|
|
6598
6888
|
display_name: string;
|
|
6889
|
+
description: string;
|
|
6599
6890
|
generated_hostname: string;
|
|
6600
6891
|
custom_hostname: (ZoWebsiteGetOutputV1WebsiteHostname | null);
|
|
6601
6892
|
access: "public";
|
|
@@ -6621,6 +6912,7 @@ export interface ZoWebsiteListOutputV1WebsiteListItem {
|
|
|
6621
6912
|
workspace_id: string;
|
|
6622
6913
|
slug: string;
|
|
6623
6914
|
display_name: string;
|
|
6915
|
+
description: string;
|
|
6624
6916
|
generated_hostname: string;
|
|
6625
6917
|
custom_hostname: (ZoWebsiteListOutputV1WebsiteHostname | null);
|
|
6626
6918
|
access: "public";
|
|
@@ -6682,6 +6974,10 @@ export interface ZoWebsiteUpdateInputV1 {
|
|
|
6682
6974
|
website_id: string;
|
|
6683
6975
|
expected_revision: number;
|
|
6684
6976
|
display_name?: (string | null);
|
|
6977
|
+
/**
|
|
6978
|
+
* Describe what this Website is for in the user's terms.
|
|
6979
|
+
*/
|
|
6980
|
+
description?: (string | null);
|
|
6685
6981
|
custom_hostname?: (ZoWebsiteUpdateInputV1CustomHostnameChange | null);
|
|
6686
6982
|
}
|
|
6687
6983
|
export interface ZoWebsiteUpdateInputV1CustomHostnameChange {
|
|
@@ -6692,6 +6988,7 @@ export interface ZoWebsiteUpdateOutputV1 {
|
|
|
6692
6988
|
workspace_id: string;
|
|
6693
6989
|
slug: string;
|
|
6694
6990
|
display_name: string;
|
|
6991
|
+
description: string;
|
|
6695
6992
|
generated_hostname: string;
|
|
6696
6993
|
custom_hostname: (ZoWebsiteUpdateOutputV1WebsiteHostname | null);
|
|
6697
6994
|
access: "public";
|
|
@@ -7029,6 +7326,10 @@ export interface ZoWorkflowCancelRunOutputV1 {
|
|
|
7029
7326
|
export interface ZoWorkflowCreateInputV1 {
|
|
7030
7327
|
workspace_id: string;
|
|
7031
7328
|
display_name: string;
|
|
7329
|
+
/**
|
|
7330
|
+
* Describe what this workflow is for in the user's terms.
|
|
7331
|
+
*/
|
|
7332
|
+
description?: string;
|
|
7032
7333
|
visibility?: ("workspace" | "protected");
|
|
7033
7334
|
}
|
|
7034
7335
|
export interface ZoWorkflowCreateOutputV1 {
|
|
@@ -7037,6 +7338,7 @@ export interface ZoWorkflowCreateOutputV1 {
|
|
|
7037
7338
|
type: "workflow";
|
|
7038
7339
|
type_version: number;
|
|
7039
7340
|
display_name: string;
|
|
7341
|
+
description: string;
|
|
7040
7342
|
revision: number;
|
|
7041
7343
|
active_revision_id: (string | null);
|
|
7042
7344
|
latest_revision_id: (string | null);
|
|
@@ -7061,6 +7363,7 @@ export interface ZoWorkflowGetOutputV1 {
|
|
|
7061
7363
|
type: "workflow";
|
|
7062
7364
|
type_version: number;
|
|
7063
7365
|
display_name: string;
|
|
7366
|
+
description: string;
|
|
7064
7367
|
revision: number;
|
|
7065
7368
|
active_revision_id: (string | null);
|
|
7066
7369
|
latest_revision_id: (string | null);
|
|
@@ -7138,6 +7441,7 @@ export interface ZoWorkflowListOutputV1VisibleWorkflowResource {
|
|
|
7138
7441
|
type: "workflow";
|
|
7139
7442
|
type_version: number;
|
|
7140
7443
|
display_name: string;
|
|
7444
|
+
description: string;
|
|
7141
7445
|
revision: number;
|
|
7142
7446
|
active_revision_id: (string | null);
|
|
7143
7447
|
latest_revision_id: (string | null);
|
|
@@ -7312,6 +7616,7 @@ export interface EventSubscriptionV1 {
|
|
|
7312
7616
|
export interface FunctionV1 {
|
|
7313
7617
|
code_owner: ("zo" | "workspace");
|
|
7314
7618
|
}
|
|
7619
|
+
export type MachineV1GpuType = ("T4" | "L4" | "A10" | "L40S" | "A100" | "A100-40GB" | "A100-80GB" | "RTX-PRO-6000" | "H100" | "H100!" | "H200" | "B200" | "B200+" | "B300");
|
|
7315
7620
|
/**
|
|
7316
7621
|
* Public properties of a `machine` resource.
|
|
7317
7622
|
*
|
|
@@ -7329,11 +7634,20 @@ export interface MachineV1 {
|
|
|
7329
7634
|
machine_image_id: (string | null);
|
|
7330
7635
|
vcpus: (number | null);
|
|
7331
7636
|
memory_mib: (number | null);
|
|
7637
|
+
gpu?: (MachineV1MachineGpu | null);
|
|
7332
7638
|
region: (string | null);
|
|
7333
7639
|
idle_timeout_seconds: (number | null);
|
|
7334
7640
|
max_run_seconds: (number | null);
|
|
7335
7641
|
init?: (("none" | "image") | null);
|
|
7336
7642
|
command?: ([string, ...(string)[]] | null);
|
|
7643
|
+
environment?: ({
|
|
7644
|
+
[k: string]: string;
|
|
7645
|
+
} | null);
|
|
7646
|
+
credentials?: (string[] | null);
|
|
7647
|
+
}
|
|
7648
|
+
export interface MachineV1MachineGpu {
|
|
7649
|
+
type: MachineV1GpuType;
|
|
7650
|
+
count: number;
|
|
7337
7651
|
}
|
|
7338
7652
|
export type MachineImageV1ImageOrigin = ("registry" | "build" | "machine_snapshot");
|
|
7339
7653
|
/**
|
|
@@ -7510,6 +7824,18 @@ export type Operations = {
|
|
|
7510
7824
|
output: ZoConnectionRegisterResourceOutputV1;
|
|
7511
7825
|
};
|
|
7512
7826
|
};
|
|
7827
|
+
"zo.connection.slack.complete_authorization": {
|
|
7828
|
+
1: {
|
|
7829
|
+
input: ZoConnectionSlackCompleteAuthorizationInputV1;
|
|
7830
|
+
output: ZoConnectionSlackCompleteAuthorizationOutputV1;
|
|
7831
|
+
};
|
|
7832
|
+
};
|
|
7833
|
+
"zo.connection.slack.start_authorization": {
|
|
7834
|
+
1: {
|
|
7835
|
+
input: ZoConnectionSlackStartAuthorizationInputV1;
|
|
7836
|
+
output: ZoConnectionSlackStartAuthorizationOutputV1;
|
|
7837
|
+
};
|
|
7838
|
+
};
|
|
7513
7839
|
"zo.connection.update": {
|
|
7514
7840
|
1: {
|
|
7515
7841
|
input: ZoConnectionUpdateInputV1;
|
|
@@ -8286,6 +8612,8 @@ export type DefaultVersions = {
|
|
|
8286
8612
|
"zo.connection.get": 1;
|
|
8287
8613
|
"zo.connection.list": 1;
|
|
8288
8614
|
"zo.connection.register_resource": 1;
|
|
8615
|
+
"zo.connection.slack.complete_authorization": 1;
|
|
8616
|
+
"zo.connection.slack.start_authorization": 1;
|
|
8289
8617
|
"zo.connection.update": 1;
|
|
8290
8618
|
"zo.connection_definition.list": 1;
|
|
8291
8619
|
"zo.connection_definition.publish": 1;
|