@archildata/api-types 0.0.28 → 0.0.30

package/index.d.ts

@@ -514,6 +514,31 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/sandboxes/{sid}/timeout": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Set a sandbox's timeout
+         * @description Replaces the sandbox's lifetime budget and, while it is running, resets
+         *     its expiration deadline to the requested number of seconds from now.
+         *     The new budget is retained across later stops and starts. For an
+         *     inactive sandbox, it applies to the next powered-on session. Sandboxes
+         *     that are starting or shutting down, or whose timeout changes
+         *     concurrently, return 409.
+         */
+        post: operations["setSandboxTimeout"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/sandboxes/{sid}/start": {
         parameters: {
             query?: never;
@@ -619,7 +644,7 @@ export interface components {
         SandboxState: "pending" | "running" | "pausing" | "paused" | "stopping" | "stopped" | "exited" | "failed" | "deleting" | "deleted";
         /** @enum {string} */
         SandboxNetworkAction: "allow" | "deny";
-        /** @description Deny targets take precedence when an address or domain matches both lists. When domain rules are present, TCP ports 80 and 443 are restricted to HTTP/1.1 or HTTP/2. Plaintext HTTP authority is enforced on port 80, but requests matching a transformation rule are rejected. Port 443 is TLS-terminated; both TLS SNI and HTTP authority are evaluated, and the HTTP authority selects the upstream and any request transformations. DNS to the sandbox's configured resolvers is allowed and UDP port 443 is denied. */
+        /** @description Deny targets take precedence when an address or domain matches both lists. When domain rules are present, TCP ports 80 and 443 are restricted to HTTP/1.1 or HTTP/2. Plaintext HTTP authority is enforced on port 80, but requests matching a transformation rule are rejected unless the rule also forwards. Port 443 is TLS-terminated; both TLS SNI and HTTP authority are evaluated, and the HTTP authority selects the upstream, any request transformations, and any request forwarding. DNS to the sandbox's configured resolvers is allowed and UDP port 443 is denied. */
         SandboxEgressPolicy: {
             default: components["schemas"]["SandboxNetworkAction"];
             /** @description Allowed IPv4 addresses, CIDR ranges, exact domains, wildcard domains beginning with `*.`, or target objects with optional outbound HTTPS request transformations. A wildcard matches subdomains but not the apex domain, including when applying transformations. */
@@ -628,9 +653,14 @@ export interface components {
             deny?: string[];
         };
         SandboxEgressRule: {
-            /** @description Target allowed by this rule. Effective transformations require an exact or wildcard lowercase domain. */
+            /** @description Target allowed by this rule. Effective transformations and forwarding require an exact or wildcard lowercase domain. */
             target: string;
             transform?: components["schemas"]["SandboxEgressTransform"];
+            /**
+             * Format: uri
+             * @description Absolute public HTTPS URL that receives this rule's permitted HTTP and HTTPS requests instead of their original upstream. The original path is appended to this URL, and Archil overwrites the archil-forwarded-host, archil-forwarded-scheme, archil-forwarded-port, archil-forwarded-path, and archil-sandbox-id headers with request metadata. A transform on the same rule is applied before forwarding, so the forwarded request carries the transformed headers. URLs containing credentials, a query, or a fragment are rejected.
+             */
+            forward_url?: string;
         };
         /** @description Optional outbound HTTPS request transformations. An omitted or empty transform leaves the rule as an ordinary allow without request mutations. */
         SandboxEgressTransform: {
@@ -643,6 +673,10 @@ export interface components {
         SandboxNetwork: {
             egress?: components["schemas"]["SandboxEgressPolicy"];
         };
+        SandboxTimeoutRequest: {
+            /** @description Seconds from now until a running sandbox expires, and the lifetime budget for its next powered-on session. */
+            timeout: number;
+        };
         Sandbox: {
             /** Format: uuid */
             sandbox_id: string;
@@ -651,7 +685,7 @@ export interface components {
             status: components["schemas"]["SandboxState"];
             vcpu_count: number;
             mem_size_mib: number;
-            /** @description Full lifetime budget applied independently to each powered-on session. */
+            /** @description Full lifetime budget applied independently to each powered-on session. Defaults to 24 hours and can be reset with the timeout endpoint. */
             max_ttl_seconds: number;
             /** @description Maximum number of concurrently attached process sessions. Detached processes and one-shot process controls do not count. */
             max_concurrent_execs: number;
@@ -726,8 +760,11 @@ export interface components {
                 [key: string]: string;
             };
             network?: components["schemas"]["SandboxNetwork"];
-            /** @description Lifetime budget applied independently to each powered-on session */
-            max_ttl_seconds?: number;
+            /**
+             * @description Lifetime budget applied independently to each powered-on session
+             * @default 86400
+             */
+            max_ttl_seconds: number;
             /** @description Maximum number of concurrently attached process sessions. Detached processes and one-shot process controls do not count. */
             max_concurrent_execs?: number;
         };
@@ -2588,6 +2625,47 @@ export interface operations {
             503: components["responses"]["RetryableUnavailable"];
         };
     };
+    setSandboxTimeout: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Sandbox UUID */
+                sid: components["parameters"]["SandboxId"];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["SandboxTimeoutRequest"];
+            };
+        };
+        responses: {
+            /** @description The sandbox timeout was set */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ApiResponse_Sandbox"];
+                };
+            };
+            400: components["responses"]["ValidationError"];
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+            /** @description The sandbox is transitioning or its timeout changed concurrently */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            500: components["responses"]["InternalError"];
+            503: components["responses"]["RetryableUnavailable"];
+        };
+    };
     startSandbox: {
         parameters: {
             query?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@archildata/api-types",
-  "version": "0.0.28",
+  "version": "0.0.30",
   "description": "API types for the Archil control plane",
   "type": "module",
   "types": "index.d.ts",