@distilled.cloud/vercel 0.0.0 → 1.0.0-rc.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/lib/credentials.d.ts +21 -0
- package/lib/credentials.d.ts.map +1 -0
- package/lib/credentials.js +40 -0
- package/lib/credentials.js.map +1 -0
- package/lib/errors.d.ts +80 -0
- package/lib/errors.d.ts.map +1 -0
- package/lib/errors.js +50 -0
- package/lib/errors.js.map +1 -0
- package/lib/index.d.ts +15 -0
- package/lib/index.d.ts.map +1 -0
- package/lib/index.js +15 -0
- package/lib/index.js.map +1 -0
- package/lib/protocol.d.ts +18 -0
- package/lib/protocol.d.ts.map +1 -0
- package/lib/protocol.js +69 -0
- package/lib/protocol.js.map +1 -0
- package/lib/retry.d.ts +54 -0
- package/lib/retry.d.ts.map +1 -0
- package/lib/retry.js +47 -0
- package/lib/retry.js.map +1 -0
- package/lib/services/access_groups.d.ts +459 -0
- package/lib/services/access_groups.d.ts.map +1 -0
- package/lib/services/access_groups.js +449 -0
- package/lib/services/access_groups.js.map +1 -0
- package/lib/services/ai_gateway.d.ts +122 -0
- package/lib/services/ai_gateway.d.ts.map +1 -0
- package/lib/services/ai_gateway.js +125 -0
- package/lib/services/ai_gateway.js.map +1 -0
- package/lib/services/aliases.d.ts +591 -0
- package/lib/services/aliases.d.ts.map +1 -0
- package/lib/services/aliases.js +482 -0
- package/lib/services/aliases.js.map +1 -0
- package/lib/services/api_ai_gateway.d.ts +275 -0
- package/lib/services/api_ai_gateway.d.ts.map +1 -0
- package/lib/services/api_ai_gateway.js +227 -0
- package/lib/services/api_ai_gateway.js.map +1 -0
- package/lib/services/artifacts.d.ts +228 -0
- package/lib/services/artifacts.d.ts.map +1 -0
- package/lib/services/artifacts.js +214 -0
- package/lib/services/artifacts.js.map +1 -0
- package/lib/services/authentication.d.ts +373 -0
- package/lib/services/authentication.d.ts.map +1 -0
- package/lib/services/authentication.js +304 -0
- package/lib/services/authentication.js.map +1 -0
- package/lib/services/billing.d.ts +930 -0
- package/lib/services/billing.d.ts.map +1 -0
- package/lib/services/billing.js +695 -0
- package/lib/services/billing.js.map +1 -0
- package/lib/services/bulk_redirects.d.ts +308 -0
- package/lib/services/bulk_redirects.d.ts.map +1 -0
- package/lib/services/bulk_redirects.js +302 -0
- package/lib/services/bulk_redirects.js.map +1 -0
- package/lib/services/certs.d.ts +171 -0
- package/lib/services/certs.d.ts.map +1 -0
- package/lib/services/certs.js +163 -0
- package/lib/services/certs.js.map +1 -0
- package/lib/services/checks_v2.d.ts +1167 -0
- package/lib/services/checks_v2.d.ts.map +1 -0
- package/lib/services/checks_v2.js +1141 -0
- package/lib/services/checks_v2.js.map +1 -0
- package/lib/services/connect.d.ts +2228 -0
- package/lib/services/connect.d.ts.map +1 -0
- package/lib/services/connect.js +1575 -0
- package/lib/services/connect.js.map +1 -0
- package/lib/services/deployments.d.ts +9419 -0
- package/lib/services/deployments.d.ts.map +1 -0
- package/lib/services/deployments.js +8248 -0
- package/lib/services/deployments.js.map +1 -0
- package/lib/services/dns.d.ts +279 -0
- package/lib/services/dns.d.ts.map +1 -0
- package/lib/services/dns.js +277 -0
- package/lib/services/dns.js.map +1 -0
- package/lib/services/domains.d.ts +564 -0
- package/lib/services/domains.d.ts.map +1 -0
- package/lib/services/domains.js +469 -0
- package/lib/services/domains.js.map +1 -0
- package/lib/services/domains_registrar.d.ts +798 -0
- package/lib/services/domains_registrar.d.ts.map +1 -0
- package/lib/services/domains_registrar.js +916 -0
- package/lib/services/domains_registrar.js.map +1 -0
- package/lib/services/drains.d.ts +2263 -0
- package/lib/services/drains.d.ts.map +1 -0
- package/lib/services/drains.js +2121 -0
- package/lib/services/drains.js.map +1 -0
- package/lib/services/edge_cache.d.ts +125 -0
- package/lib/services/edge_cache.d.ts.map +1 -0
- package/lib/services/edge_cache.js +138 -0
- package/lib/services/edge_cache.js.map +1 -0
- package/lib/services/environment.d.ts +1020 -0
- package/lib/services/environment.d.ts.map +1 -0
- package/lib/services/environment.js +805 -0
- package/lib/services/environment.js.map +1 -0
- package/lib/services/feature_flags.d.ts +2893 -0
- package/lib/services/feature_flags.d.ts.map +1 -0
- package/lib/services/feature_flags.js +2707 -0
- package/lib/services/feature_flags.js.map +1 -0
- package/lib/services/global_config.d.ts +618 -0
- package/lib/services/global_config.d.ts.map +1 -0
- package/lib/services/global_config.js +709 -0
- package/lib/services/global_config.js.map +1 -0
- package/lib/services/index.d.ts +42 -0
- package/lib/services/index.d.ts.map +1 -0
- package/lib/services/index.js +43 -0
- package/lib/services/index.js.map +1 -0
- package/lib/services/integrations.d.ts +3014 -0
- package/lib/services/integrations.d.ts.map +1 -0
- package/lib/services/integrations.js +2544 -0
- package/lib/services/integrations.js.map +1 -0
- package/lib/services/kms.d.ts +1095 -0
- package/lib/services/kms.d.ts.map +1 -0
- package/lib/services/kms.js +956 -0
- package/lib/services/kms.js.map +1 -0
- package/lib/services/log_drains.d.ts +848 -0
- package/lib/services/log_drains.d.ts.map +1 -0
- package/lib/services/log_drains.js +782 -0
- package/lib/services/log_drains.js.map +1 -0
- package/lib/services/logs.d.ts +40 -0
- package/lib/services/logs.d.ts.map +1 -0
- package/lib/services/logs.js +43 -0
- package/lib/services/logs.js.map +1 -0
- package/lib/services/marketplace.d.ts +1053 -0
- package/lib/services/marketplace.d.ts.map +1 -0
- package/lib/services/marketplace.js +1116 -0
- package/lib/services/marketplace.js.map +1 -0
- package/lib/services/microfrontends.d.ts +3250 -0
- package/lib/services/microfrontends.d.ts.map +1 -0
- package/lib/services/microfrontends.js +3154 -0
- package/lib/services/microfrontends.js.map +1 -0
- package/lib/services/misc.d.ts +192 -0
- package/lib/services/misc.d.ts.map +1 -0
- package/lib/services/misc.js +124 -0
- package/lib/services/misc.js.map +1 -0
- package/lib/services/networking.d.ts +360 -0
- package/lib/services/networking.d.ts.map +1 -0
- package/lib/services/networking.js +353 -0
- package/lib/services/networking.js.map +1 -0
- package/lib/services/observability.d.ts +168 -0
- package/lib/services/observability.d.ts.map +1 -0
- package/lib/services/observability.js +190 -0
- package/lib/services/observability.js.map +1 -0
- package/lib/services/project_members.d.ts +142 -0
- package/lib/services/project_members.d.ts.map +1 -0
- package/lib/services/project_members.js +135 -0
- package/lib/services/project_members.js.map +1 -0
- package/lib/services/project_routes.d.ts +1990 -0
- package/lib/services/project_routes.d.ts.map +1 -0
- package/lib/services/project_routes.js +1883 -0
- package/lib/services/project_routes.js.map +1 -0
- package/lib/services/projects.d.ts +23677 -0
- package/lib/services/projects.d.ts.map +1 -0
- package/lib/services/projects.js +22223 -0
- package/lib/services/projects.js.map +1 -0
- package/lib/services/rolling_release.d.ts +764 -0
- package/lib/services/rolling_release.d.ts.map +1 -0
- package/lib/services/rolling_release.js +583 -0
- package/lib/services/rolling_release.js.map +1 -0
- package/lib/services/sandboxes.d.ts +2777 -0
- package/lib/services/sandboxes.d.ts.map +1 -0
- package/lib/services/sandboxes.js +2142 -0
- package/lib/services/sandboxes.js.map +1 -0
- package/lib/services/security.d.ts +4247 -0
- package/lib/services/security.d.ts.map +1 -0
- package/lib/services/security.js +4377 -0
- package/lib/services/security.js.map +1 -0
- package/lib/services/storage.d.ts +251 -0
- package/lib/services/storage.d.ts.map +1 -0
- package/lib/services/storage.js +257 -0
- package/lib/services/storage.js.map +1 -0
- package/lib/services/teams.d.ts +1600 -0
- package/lib/services/teams.d.ts.map +1 -0
- package/lib/services/teams.js +1314 -0
- package/lib/services/teams.js.map +1 -0
- package/lib/services/user.d.ts +8559 -0
- package/lib/services/user.d.ts.map +1 -0
- package/lib/services/user.js +7407 -0
- package/lib/services/user.js.map +1 -0
- package/lib/services/vcr.d.ts +751 -0
- package/lib/services/vcr.d.ts.map +1 -0
- package/lib/services/vcr.js +826 -0
- package/lib/services/vcr.js.map +1 -0
- package/lib/services/web_analytics.d.ts +726 -0
- package/lib/services/web_analytics.d.ts.map +1 -0
- package/lib/services/web_analytics.js +707 -0
- package/lib/services/web_analytics.js.map +1 -0
- package/lib/services/webhooks.d.ts +219 -0
- package/lib/services/webhooks.d.ts.map +1 -0
- package/lib/services/webhooks.js +177 -0
- package/lib/services/webhooks.js.map +1 -0
- package/lib/traits.d.ts +10 -0
- package/lib/traits.d.ts.map +1 -0
- package/lib/traits.js +11 -0
- package/lib/traits.js.map +1 -0
- package/package.json +78 -7
- package/src/credentials.ts +70 -0
- package/src/errors.ts +93 -0
- package/src/index.ts +18 -0
- package/src/protocol.ts +98 -0
- package/src/retry.ts +78 -0
- package/src/services/access_groups.ts +1165 -0
- package/src/services/ai_gateway.ts +267 -0
- package/src/services/aliases.ts +1315 -0
- package/src/services/api_ai_gateway.ts +607 -0
- package/src/services/artifacts.ts +542 -0
- package/src/services/authentication.ts +827 -0
- package/src/services/billing.ts +2104 -0
- package/src/services/bulk_redirects.ts +748 -0
- package/src/services/certs.ts +371 -0
- package/src/services/checks_v2.ts +3084 -0
- package/src/services/connect.ts +4805 -0
- package/src/services/deployments.ts +24576 -0
- package/src/services/dns.ts +715 -0
- package/src/services/domains.ts +1257 -0
- package/src/services/domains_registrar.ts +2257 -0
- package/src/services/drains.ts +5828 -0
- package/src/services/edge_cache.ts +303 -0
- package/src/services/environment.ts +2379 -0
- package/src/services/feature_flags.ts +7722 -0
- package/src/services/global_config.ts +1668 -0
- package/src/services/index.ts +42 -0
- package/src/services/integrations.ts +9022 -0
- package/src/services/kms.ts +2614 -0
- package/src/services/log_drains.ts +2434 -0
- package/src/services/logs.ts +78 -0
- package/src/services/marketplace.ts +2849 -0
- package/src/services/microfrontends.ts +9921 -0
- package/src/services/misc.ts +364 -0
- package/src/services/networking.ts +865 -0
- package/src/services/observability.ts +435 -0
- package/src/services/project_members.ts +326 -0
- package/src/services/project_routes.ts +5229 -0
- package/src/services/projects.ts +68139 -0
- package/src/services/rolling_release.ts +1860 -0
- package/src/services/sandboxes.ts +6988 -0
- package/src/services/security.ts +13931 -0
- package/src/services/storage.ts +850 -0
- package/src/services/teams.ts +4055 -0
- package/src/services/user.ts +23195 -0
- package/src/services/vcr.ts +2070 -0
- package/src/services/web_analytics.ts +1638 -0
- package/src/services/webhooks.ts +1102 -0
- package/src/traits.ts +46 -0
- package/README.md +0 -15
- package/bun.lock +0 -26
- package/index.ts +0 -1
- package/tsconfig.json +0 -29
|
@@ -0,0 +1,2777 @@
|
|
|
1
|
+
import * as S from "@distilled.cloud/core/schema";
|
|
2
|
+
import * as Redacted from "effect/Redacted";
|
|
3
|
+
import * as API from "@distilled.cloud/core/api";
|
|
4
|
+
import { type VercelOpError, type VercelOpContext } from "../protocol.ts";
|
|
5
|
+
export type { VercelOpError, VercelOpContext };
|
|
6
|
+
declare const BadRequest_base: S.Class<BadRequest, S.TaggedStruct<"BadRequest", {
|
|
7
|
+
readonly code: any;
|
|
8
|
+
readonly message: any;
|
|
9
|
+
}>, import("effect/Cause").YieldableError> & (new (...args: any[]) => {
|
|
10
|
+
"@distilled.cloud/error/categories": {
|
|
11
|
+
BadRequestError: true;
|
|
12
|
+
};
|
|
13
|
+
});
|
|
14
|
+
export declare class BadRequest extends /*@__PURE__*/ BadRequest_base {
|
|
15
|
+
}
|
|
16
|
+
declare const Conflict_base: S.Class<Conflict, S.TaggedStruct<"Conflict", {
|
|
17
|
+
readonly code: any;
|
|
18
|
+
readonly message: any;
|
|
19
|
+
}>, import("effect/Cause").YieldableError> & (new (...args: any[]) => {
|
|
20
|
+
"@distilled.cloud/error/categories": {
|
|
21
|
+
ConflictError: true;
|
|
22
|
+
};
|
|
23
|
+
});
|
|
24
|
+
export declare class Conflict extends /*@__PURE__*/ Conflict_base {
|
|
25
|
+
}
|
|
26
|
+
declare const Forbidden_base: S.Class<Forbidden, S.TaggedStruct<"Forbidden", {
|
|
27
|
+
readonly code: any;
|
|
28
|
+
readonly message: any;
|
|
29
|
+
}>, import("effect/Cause").YieldableError> & (new (...args: any[]) => {
|
|
30
|
+
"@distilled.cloud/error/categories": {
|
|
31
|
+
AuthError: true;
|
|
32
|
+
};
|
|
33
|
+
});
|
|
34
|
+
export declare class Forbidden extends /*@__PURE__*/ Forbidden_base {
|
|
35
|
+
}
|
|
36
|
+
declare const NotFound_base: S.Class<NotFound, S.TaggedStruct<"NotFound", {
|
|
37
|
+
readonly code: any;
|
|
38
|
+
readonly message: any;
|
|
39
|
+
}>, import("effect/Cause").YieldableError> & (new (...args: any[]) => {
|
|
40
|
+
"@distilled.cloud/error/categories": {
|
|
41
|
+
BadRequestError: true;
|
|
42
|
+
};
|
|
43
|
+
});
|
|
44
|
+
export declare class NotFound extends /*@__PURE__*/ NotFound_base {
|
|
45
|
+
}
|
|
46
|
+
declare const PaymentRequired_base: S.Class<PaymentRequired, S.TaggedStruct<"PaymentRequired", {
|
|
47
|
+
readonly code: any;
|
|
48
|
+
readonly message: any;
|
|
49
|
+
}>, import("effect/Cause").YieldableError> & (new (...args: any[]) => {
|
|
50
|
+
"@distilled.cloud/error/categories": {
|
|
51
|
+
QuotaError: true;
|
|
52
|
+
};
|
|
53
|
+
});
|
|
54
|
+
export declare class PaymentRequired extends /*@__PURE__*/ PaymentRequired_base {
|
|
55
|
+
}
|
|
56
|
+
declare const UnprocessableEntity_base: S.Class<UnprocessableEntity, S.TaggedStruct<"UnprocessableEntity", {
|
|
57
|
+
readonly code: any;
|
|
58
|
+
readonly message: any;
|
|
59
|
+
}>, import("effect/Cause").YieldableError> & (new (...args: any[]) => {
|
|
60
|
+
"@distilled.cloud/error/categories": {
|
|
61
|
+
BadRequestError: true;
|
|
62
|
+
};
|
|
63
|
+
});
|
|
64
|
+
export declare class UnprocessableEntity extends /*@__PURE__*/ UnprocessableEntity_base {
|
|
65
|
+
}
|
|
66
|
+
/** The network access policy mode. Use \"allow-all\" to permit all outbound traffic. Use \"deny-all\" to block all outbound traffic. Use \"custom\" to specify explicit allow/deny rules. */
|
|
67
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase0Mode = "allow-all" | "deny-all" | "custom" | "default-allow" | "default-deny";
|
|
68
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase0Mode: any;
|
|
69
|
+
/** List of domain names the sandbox is allowed to connect to. Only applies when mode is \"custom\". Supports wildcard patterns (e.g., \"*.example.com\" matches all subdomains). */
|
|
70
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase0AllowedDomainsList = Array<string>;
|
|
71
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase0AllowedDomainsList: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0AllowedDomainsList>;
|
|
72
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is allowed to connect to. Traffic to these addresses bypasses domain-based restrictions. */
|
|
73
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase0AllowedCIDRsList = Array<string>;
|
|
74
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase0AllowedCIDRsList: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0AllowedCIDRsList>;
|
|
75
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is blocked from connecting to. These rules take precedence over all allowed rules. */
|
|
76
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase0DeniedCIDRsList = Array<string>;
|
|
77
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase0DeniedCIDRsList: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0DeniedCIDRsList>;
|
|
78
|
+
/** HTTP headers to inject into requests for this domain. Existing headers with the same name will be overridden. */
|
|
79
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemHeadersMap = {
|
|
80
|
+
[key: string]: string | undefined;
|
|
81
|
+
};
|
|
82
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemHeadersMap: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemHeadersMap>;
|
|
83
|
+
/** Match on the request path. Comparison is case-sensitive. */
|
|
84
|
+
export interface CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath {
|
|
85
|
+
/** Match the value exactly. Case-sensitive for paths, header values, and methods; case-insensitive for domains and header keys. */
|
|
86
|
+
exact?: string;
|
|
87
|
+
/** Match values that start with the given prefix. */
|
|
88
|
+
startsWith?: string;
|
|
89
|
+
}
|
|
90
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
91
|
+
/** HTTP methods to match. Any single match succeeds (OR semantics). */
|
|
92
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchMethodList = Array<string>;
|
|
93
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchMethodList: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchMethodList>;
|
|
94
|
+
/** Matcher for the entry key (header name or query key). */
|
|
95
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItemKey = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
96
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItemKey: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
97
|
+
/** Matcher for the entry value. */
|
|
98
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItemValue = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
99
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItemValue: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
100
|
+
export interface CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem {
|
|
101
|
+
/** Matcher for the entry key (header name or query key). */
|
|
102
|
+
key?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
103
|
+
/** Matcher for the entry value. */
|
|
104
|
+
value?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
105
|
+
}
|
|
106
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
107
|
+
/** Query-string entry matchers. Multiple entries are ANDed. Query parameter names and values are both compared case-sensitively (RFC 3986). When a request has multiple values for the same key, any matching value satisfies the matcher. */
|
|
108
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
109
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringList: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringList>;
|
|
110
|
+
/** Matcher for the entry key (header name or query key). */
|
|
111
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItemKey = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
112
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItemKey: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
113
|
+
/** Matcher for the entry value. */
|
|
114
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItemValue = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
115
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItemValue: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
116
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItem = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem;
|
|
117
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
118
|
+
/** Header matchers. Multiple entries are ANDed. Header names are compared case-insensitively (RFC 9110); header values are compared case-sensitively. When a request has multiple values for the same header, any matching value satisfies the matcher. */
|
|
119
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
120
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersList: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersList>;
|
|
121
|
+
/** Optional L7 match. When provided, the injection rule only applies to requests that satisfy every specified dimension. When multiple injection rules target the same domain they are evaluated in order and the first match wins; a rule without `match` matches any request and shadows later rules for the same domain. */
|
|
122
|
+
export interface CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatch {
|
|
123
|
+
/** Match on the request path. Comparison is case-sensitive. */
|
|
124
|
+
path?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
125
|
+
/** HTTP methods to match. Any single match succeeds (OR semantics). */
|
|
126
|
+
method?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchMethodList;
|
|
127
|
+
/** Query-string entry matchers. Multiple entries are ANDed. Query parameter names and values are both compared case-sensitively (RFC 3986). When a request has multiple values for the same key, any matching value satisfies the matcher. */
|
|
128
|
+
queryString?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringList;
|
|
129
|
+
/** Header matchers. Multiple entries are ANDed. Header names are compared case-insensitively (RFC 9110); header values are compared case-sensitively. When a request has multiple values for the same header, any matching value satisfies the matcher. */
|
|
130
|
+
headers?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersList;
|
|
131
|
+
}
|
|
132
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatch: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatch>;
|
|
133
|
+
export interface CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItem {
|
|
134
|
+
/** The domain (or pattern) of requests to add headers for. Supports wildcards like *.example.com. */
|
|
135
|
+
domain: string;
|
|
136
|
+
/** HTTP headers to inject into requests for this domain. Existing headers with the same name will be overridden. */
|
|
137
|
+
headers: CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemHeadersMap;
|
|
138
|
+
/** Optional L7 match. When provided, the injection rule only applies to requests that satisfy every specified dimension. When multiple injection rules target the same domain they are evaluated in order and the first match wins; a rule without `match` matches any request and shadows later rules for the same domain. */
|
|
139
|
+
match?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatch;
|
|
140
|
+
}
|
|
141
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItem>;
|
|
142
|
+
/** HTTP header injection rules for outgoing requests matching specific domains. Traffic to matching domains will be intercepted instead of proxied through encrypted connections. */
|
|
143
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItem>;
|
|
144
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesList: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesList>;
|
|
145
|
+
/** Network access policy for the sandbox.\n Controls which external hosts the sandbox can communicate with.\n Use \"allow-all\" mode to allow all traffic, \"deny-all\" to block all traffic or \"custom\" to provide specific rules. */
|
|
146
|
+
export interface CreateSandboxesByNameForkV2RequestNetworkPolicyCase0 {
|
|
147
|
+
/** The network access policy mode. Use \"allow-all\" to permit all outbound traffic. Use \"deny-all\" to block all outbound traffic. Use \"custom\" to specify explicit allow/deny rules. */
|
|
148
|
+
mode: CreateSandboxesByNameForkV2RequestNetworkPolicyCase0Mode | (string & {});
|
|
149
|
+
/** List of domain names the sandbox is allowed to connect to. Only applies when mode is \"custom\". Supports wildcard patterns (e.g., \"*.example.com\" matches all subdomains). */
|
|
150
|
+
allowedDomains?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase0AllowedDomainsList;
|
|
151
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is allowed to connect to. Traffic to these addresses bypasses domain-based restrictions. */
|
|
152
|
+
allowedCIDRs?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase0AllowedCIDRsList;
|
|
153
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is blocked from connecting to. These rules take precedence over all allowed rules. */
|
|
154
|
+
deniedCIDRs?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase0DeniedCIDRsList;
|
|
155
|
+
/** HTTP header injection rules for outgoing requests matching specific domains. Traffic to matching domains will be intercepted instead of proxied through encrypted connections. */
|
|
156
|
+
injectionRules?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesList;
|
|
157
|
+
}
|
|
158
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase0: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0>;
|
|
159
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase0List = Array<string>;
|
|
160
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase0List: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase0List>;
|
|
161
|
+
/** Match on the request path. Comparison is case-sensitive. */
|
|
162
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchPath = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
163
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchPath: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
164
|
+
/** HTTP methods to match. Any single match succeeds (OR semantics). */
|
|
165
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchMethodList = Array<string>;
|
|
166
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchMethodList: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchMethodList>;
|
|
167
|
+
/** Matcher for the entry key (header name or query key). */
|
|
168
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItemKey = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
169
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItemKey: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
170
|
+
/** Matcher for the entry value. */
|
|
171
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItemValue = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
172
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItemValue: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
173
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItem = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem;
|
|
174
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
175
|
+
/** Query-string entry matchers. Multiple entries are ANDed. Query parameter names and values are both compared case-sensitively (RFC 3986). When a request has multiple values for the same key, any matching value satisfies the matcher. */
|
|
176
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
177
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringList: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringList>;
|
|
178
|
+
/** Matcher for the entry key (header name or query key). */
|
|
179
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItemKey = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
180
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItemKey: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
181
|
+
/** Matcher for the entry value. */
|
|
182
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItemValue = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
183
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItemValue: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
184
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItem = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem;
|
|
185
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
186
|
+
/** Header matchers. Multiple entries are ANDed. Header names are compared case-insensitively (RFC 9110); header values are compared case-sensitively. When a request has multiple values for the same header, any matching value satisfies the matcher. */
|
|
187
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
188
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersList: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersList>;
|
|
189
|
+
/** Optional L7 match. When provided, the injection rule only applies to requests that satisfy every specified dimension. When multiple injection rules target the same domain they are evaluated in order and the first match wins; a rule without `match` matches any request and shadows later rules for the same domain. */
|
|
190
|
+
export interface CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatch {
|
|
191
|
+
/** Match on the request path. Comparison is case-sensitive. */
|
|
192
|
+
path?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
193
|
+
/** HTTP methods to match. Any single match succeeds (OR semantics). */
|
|
194
|
+
method?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchMethodList;
|
|
195
|
+
/** Query-string entry matchers. Multiple entries are ANDed. Query parameter names and values are both compared case-sensitively (RFC 3986). When a request has multiple values for the same key, any matching value satisfies the matcher. */
|
|
196
|
+
queryString?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringList;
|
|
197
|
+
/** Header matchers. Multiple entries are ANDed. Header names are compared case-insensitively (RFC 9110); header values are compared case-sensitively. When a request has multiple values for the same header, any matching value satisfies the matcher. */
|
|
198
|
+
headers?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersList;
|
|
199
|
+
}
|
|
200
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatch: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatch>;
|
|
201
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemTransformItemHeadersMap = {
|
|
202
|
+
[key: string]: string | undefined;
|
|
203
|
+
};
|
|
204
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemTransformItemHeadersMap: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemTransformItemHeadersMap>;
|
|
205
|
+
export interface CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemTransformItem {
|
|
206
|
+
headers?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemTransformItemHeadersMap;
|
|
207
|
+
}
|
|
208
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemTransformItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemTransformItem>;
|
|
209
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemTransformList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemTransformItem>;
|
|
210
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemTransformList: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemTransformList>;
|
|
211
|
+
export interface CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItem {
|
|
212
|
+
/** Optional L7 match. When provided, the injection rule only applies to requests that satisfy every specified dimension. When multiple injection rules target the same domain they are evaluated in order and the first match wins; a rule without `match` matches any request and shadows later rules for the same domain. */
|
|
213
|
+
match?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemMatch;
|
|
214
|
+
transform?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItemTransformList;
|
|
215
|
+
/** HTTP/1.1 proxy URL to forward traffic to. Must not include username, password, query string, or fragment. */
|
|
216
|
+
forwardURL?: string;
|
|
217
|
+
}
|
|
218
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItem>;
|
|
219
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueItem>;
|
|
220
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueList: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueList>;
|
|
221
|
+
/** A rule applied to requests matching a domain in the network policy. Only one of `transform` or `forwardURL` can be specified per rule. */
|
|
222
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1Map = {
|
|
223
|
+
[key: string]: CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1ValueList | undefined;
|
|
224
|
+
};
|
|
225
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1Map: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1Map>;
|
|
226
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase1Allow = CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase0List | CreateSandboxesByNameForkV2RequestNetworkPolicyCase1AllowCase1Map;
|
|
227
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase1Allow: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase1Allow>;
|
|
228
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase1SubnetsAllowList = Array<string>;
|
|
229
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase1SubnetsAllowList: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase1SubnetsAllowList>;
|
|
230
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicyCase1SubnetsDenyList = Array<string>;
|
|
231
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase1SubnetsDenyList: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase1SubnetsDenyList>;
|
|
232
|
+
export interface CreateSandboxesByNameForkV2RequestNetworkPolicyCase1Subnets {
|
|
233
|
+
allow?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase1SubnetsAllowList;
|
|
234
|
+
deny?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase1SubnetsDenyList;
|
|
235
|
+
}
|
|
236
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase1Subnets: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase1Subnets>;
|
|
237
|
+
export interface CreateSandboxesByNameForkV2RequestNetworkPolicyCase1 {
|
|
238
|
+
allow?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase1Allow;
|
|
239
|
+
subnets?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase1Subnets;
|
|
240
|
+
}
|
|
241
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicyCase1: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase1>;
|
|
242
|
+
export type CreateSandboxesByNameForkV2RequestNetworkPolicy = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0 | CreateSandboxesByNameForkV2RequestNetworkPolicyCase1;
|
|
243
|
+
export declare const CreateSandboxesByNameForkV2RequestNetworkPolicy: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicy>;
|
|
244
|
+
/** Resources to define the VM */
|
|
245
|
+
export interface CreateSandboxesByNameForkV2RequestResources {
|
|
246
|
+
/** The number of virtual CPUs to allocate to the sandbox. Must be 1, or an even number. */
|
|
247
|
+
vcpus?: number;
|
|
248
|
+
/** The amount of memory in megabytes to allocate to the sandbox. Must equal vcpus * 2048. */
|
|
249
|
+
memory?: number;
|
|
250
|
+
}
|
|
251
|
+
export declare const CreateSandboxesByNameForkV2RequestResources: S.Schema<CreateSandboxesByNameForkV2RequestResources>;
|
|
252
|
+
/** List of ports to expose from the sandbox. Each port will be accessible via a unique URL. Maximum of 15 ports can be exposed. */
|
|
253
|
+
export type CreateSandboxesByNameForkV2RequestPortsList = Array<number>;
|
|
254
|
+
export declare const CreateSandboxesByNameForkV2RequestPortsList: S.Schema<CreateSandboxesByNameForkV2RequestPortsList>;
|
|
255
|
+
/** Default environment variables for the sandbox. These are inherited by all commands unless overridden. */
|
|
256
|
+
export type CreateSandboxesByNameForkV2RequestEnvMap = {
|
|
257
|
+
[key: string]: string | undefined;
|
|
258
|
+
};
|
|
259
|
+
export declare const CreateSandboxesByNameForkV2RequestEnvMap: S.Schema<CreateSandboxesByNameForkV2RequestEnvMap>;
|
|
260
|
+
/** Mount the drive read-only or read-write. */
|
|
261
|
+
export type CreateSandboxesByNameForkV2RequestMountsValueMode = "read-only" | "read-write";
|
|
262
|
+
export declare const CreateSandboxesByNameForkV2RequestMountsValueMode: any;
|
|
263
|
+
export interface CreateSandboxesByNameForkV2RequestMountsValue {
|
|
264
|
+
/** Name of the drive to mount. The drive must already exist. */
|
|
265
|
+
drive: string;
|
|
266
|
+
/** Mount the drive read-only or read-write. */
|
|
267
|
+
mode?: CreateSandboxesByNameForkV2RequestMountsValueMode | (string & {});
|
|
268
|
+
}
|
|
269
|
+
export declare const CreateSandboxesByNameForkV2RequestMountsValue: S.Schema<CreateSandboxesByNameForkV2RequestMountsValue>;
|
|
270
|
+
/** List of drives to mount to the sandbox at the provided path. */
|
|
271
|
+
export type CreateSandboxesByNameForkV2RequestMountsMap = {
|
|
272
|
+
[key: string]: CreateSandboxesByNameForkV2RequestMountsValue | undefined;
|
|
273
|
+
};
|
|
274
|
+
export declare const CreateSandboxesByNameForkV2RequestMountsMap: S.Schema<CreateSandboxesByNameForkV2RequestMountsMap>;
|
|
275
|
+
/** The Vercel region in which to create the sandbox. */
|
|
276
|
+
export type CreateSandboxesByNameForkV2RequestRegion = "iad1" | "sfo1" | "cle1" | "cdg1" | "fra1" | "arn1" | "sin1" | "pdx1" | "lhr1" | "icn1" | "bom1" | "cpt1" | "dub1" | "gru1" | "hkg1" | "syd1" | "yul1" | "hnd1" | "kix1";
|
|
277
|
+
export declare const CreateSandboxesByNameForkV2RequestRegion: any;
|
|
278
|
+
export type CreateSandboxesByNameForkV2RequestFailoverRegionsItem = "iad1" | "sfo1" | "cle1" | "cdg1" | "fra1" | "arn1" | "sin1" | "pdx1" | "lhr1" | "icn1" | "bom1" | "cpt1" | "dub1" | "gru1" | "hkg1" | "syd1" | "yul1" | "hnd1" | "kix1";
|
|
279
|
+
export declare const CreateSandboxesByNameForkV2RequestFailoverRegionsItem: any;
|
|
280
|
+
/** The regions the sandbox falls back to when it cannot be created in `region`. */
|
|
281
|
+
export type CreateSandboxesByNameForkV2RequestFailoverRegionsList = Array<CreateSandboxesByNameForkV2RequestFailoverRegionsItem | (string & {})>;
|
|
282
|
+
export declare const CreateSandboxesByNameForkV2RequestFailoverRegionsList: S.Schema<CreateSandboxesByNameForkV2RequestFailoverRegionsList>;
|
|
283
|
+
/** Default snapshot expiration time in milliseconds. Set to 0 to disable expiration. When set, this value is used as the default expiration for all snapshots created for this sandbox. */
|
|
284
|
+
export type CreateSandboxesByNameForkV2RequestSnapshotExpiration = unknown | number;
|
|
285
|
+
export declare const CreateSandboxesByNameForkV2RequestSnapshotExpiration: S.Schema<CreateSandboxesByNameForkV2RequestSnapshotExpiration>;
|
|
286
|
+
/** Expiration time in milliseconds for kept snapshots. Falls back to snapshotExpiration. */
|
|
287
|
+
export type CreateSandboxesByNameForkV2RequestKeepLastSnapshotsExpiration = unknown | number;
|
|
288
|
+
export declare const CreateSandboxesByNameForkV2RequestKeepLastSnapshotsExpiration: S.Schema<CreateSandboxesByNameForkV2RequestKeepLastSnapshotsExpiration>;
|
|
289
|
+
/** Protect the N most recent snapshots with different expiration/deletion behavior. */
|
|
290
|
+
export interface CreateSandboxesByNameForkV2RequestKeepLastSnapshots {
|
|
291
|
+
/** Number of most recent snapshots to keep. */
|
|
292
|
+
count: number;
|
|
293
|
+
/** Expiration time in milliseconds for kept snapshots. Falls back to snapshotExpiration. */
|
|
294
|
+
expiration?: CreateSandboxesByNameForkV2RequestKeepLastSnapshotsExpiration;
|
|
295
|
+
/** Whether to immediately delete evicted snapshots. Defaults to true. */
|
|
296
|
+
deleteEvicted?: boolean;
|
|
297
|
+
}
|
|
298
|
+
export declare const CreateSandboxesByNameForkV2RequestKeepLastSnapshots: S.Schema<CreateSandboxesByNameForkV2RequestKeepLastSnapshots>;
|
|
299
|
+
/** Key-value tags to associate with the sandbox. Maximum 5 tags. */
|
|
300
|
+
export type CreateSandboxesByNameForkV2RequestTagsMap = {
|
|
301
|
+
[key: string]: string | undefined;
|
|
302
|
+
};
|
|
303
|
+
export declare const CreateSandboxesByNameForkV2RequestTagsMap: S.Schema<CreateSandboxesByNameForkV2RequestTagsMap>;
|
|
304
|
+
export interface CreateSandboxesByNameForkV2Request {
|
|
305
|
+
/** Name of the source sandbox to fork. */
|
|
306
|
+
name: string;
|
|
307
|
+
/** The ID of the project the source sandbox belongs to. Required unless authenticating with an OIDC token. */
|
|
308
|
+
projectId?: string;
|
|
309
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
310
|
+
teamId?: string;
|
|
311
|
+
/** The Team slug to perform the request on behalf of. */
|
|
312
|
+
slug?: string;
|
|
313
|
+
networkPolicy?: CreateSandboxesByNameForkV2RequestNetworkPolicy;
|
|
314
|
+
/** Resources to define the VM */
|
|
315
|
+
resources?: CreateSandboxesByNameForkV2RequestResources;
|
|
316
|
+
/** List of ports to expose from the sandbox. Each port will be accessible via a unique URL. Maximum of 15 ports can be exposed. */
|
|
317
|
+
ports?: CreateSandboxesByNameForkV2RequestPortsList;
|
|
318
|
+
/** Image to use for the sandbox. */
|
|
319
|
+
image?: string;
|
|
320
|
+
/** Maximum duration in milliseconds that the sandbox can run before being automatically stopped. */
|
|
321
|
+
timeout?: number;
|
|
322
|
+
/** Default environment variables for the sandbox. These are inherited by all commands unless overridden. */
|
|
323
|
+
env?: CreateSandboxesByNameForkV2RequestEnvMap;
|
|
324
|
+
/** List of drives to mount to the sandbox at the provided path. */
|
|
325
|
+
mounts?: CreateSandboxesByNameForkV2RequestMountsMap;
|
|
326
|
+
/** The Vercel region in which to create the sandbox. */
|
|
327
|
+
region?: CreateSandboxesByNameForkV2RequestRegion | (string & {});
|
|
328
|
+
/** The regions the sandbox falls back to when it cannot be created in `region`. */
|
|
329
|
+
failoverRegions?: CreateSandboxesByNameForkV2RequestFailoverRegionsList;
|
|
330
|
+
/** Whether the sandbox persists its state across restarts via automatic snapshots. Defaults to the source sandbox setting. */
|
|
331
|
+
persistent?: boolean;
|
|
332
|
+
/** Default snapshot expiration time in milliseconds. Set to 0 to disable expiration. When set, this value is used as the default expiration for all snapshots created for this sandbox. */
|
|
333
|
+
snapshotExpiration?: CreateSandboxesByNameForkV2RequestSnapshotExpiration;
|
|
334
|
+
/** Protect the N most recent snapshots with different expiration/deletion behavior. */
|
|
335
|
+
keepLastSnapshots?: CreateSandboxesByNameForkV2RequestKeepLastSnapshots;
|
|
336
|
+
/** Key-value tags to associate with the sandbox. Maximum 5 tags. */
|
|
337
|
+
tags?: CreateSandboxesByNameForkV2RequestTagsMap;
|
|
338
|
+
}
|
|
339
|
+
export declare const CreateSandboxesByNameForkV2Request: S.Schema<CreateSandboxesByNameForkV2Request>;
|
|
340
|
+
/** The status of the current sandbox. */
|
|
341
|
+
export type NamedSandboxStatus = "running" | "stopped" | "stopping";
|
|
342
|
+
export declare const NamedSandboxStatus: any;
|
|
343
|
+
/** The regions the sandbox fails over to. Empty when it does not fail over. */
|
|
344
|
+
export type NamedSandboxFailoverRegionsItem = "arn1" | "bom1" | "cdg1" | "cle1" | "cpt1" | "dub1" | "fra1" | "gru1" | "hkg1" | "hnd1" | "iad1" | "icn1" | "kix1" | "lhr1" | "pdx1" | "sfo1" | "sin1" | "syd1" | "yul1";
|
|
345
|
+
export declare const NamedSandboxFailoverRegionsItem: any;
|
|
346
|
+
/** The regions the sandbox fails over to. Empty when it does not fail over. */
|
|
347
|
+
export type NamedSandboxFailoverRegionsList = Array<NamedSandboxFailoverRegionsItem>;
|
|
348
|
+
export declare const NamedSandboxFailoverRegionsList: S.Schema<NamedSandboxFailoverRegionsList>;
|
|
349
|
+
/** Keep-last snapshot configuration. */
|
|
350
|
+
export interface NamedSandboxKeepLastSnapshots {
|
|
351
|
+
/** Number of most recent snapshots to keep. */
|
|
352
|
+
count: number;
|
|
353
|
+
/** Expiration time in milliseconds for kept snapshots. */
|
|
354
|
+
expiration?: number;
|
|
355
|
+
/** Whether to immediately delete evicted snapshots. */
|
|
356
|
+
deleteEvicted: boolean;
|
|
357
|
+
}
|
|
358
|
+
export declare const NamedSandboxKeepLastSnapshots: S.Schema<NamedSandboxKeepLastSnapshots>;
|
|
359
|
+
export type NamedSandboxNetworkPolicyMode = "allow-all" | "custom" | "default-allow" | "default-deny" | "deny-all";
|
|
360
|
+
export declare const NamedSandboxNetworkPolicyMode: any;
|
|
361
|
+
export type NamedSandboxNetworkPolicyAllowedDomainsList = Array<string>;
|
|
362
|
+
export declare const NamedSandboxNetworkPolicyAllowedDomainsList: S.Schema<NamedSandboxNetworkPolicyAllowedDomainsList>;
|
|
363
|
+
export type NamedSandboxNetworkPolicyAllowedCIDRsList = Array<string>;
|
|
364
|
+
export declare const NamedSandboxNetworkPolicyAllowedCIDRsList: S.Schema<NamedSandboxNetworkPolicyAllowedCIDRsList>;
|
|
365
|
+
export type NamedSandboxNetworkPolicyDeniedCIDRsList = Array<string>;
|
|
366
|
+
export declare const NamedSandboxNetworkPolicyDeniedCIDRsList: S.Schema<NamedSandboxNetworkPolicyDeniedCIDRsList>;
|
|
367
|
+
/** Network policy configuration. */
|
|
368
|
+
export interface NamedSandboxNetworkPolicy {
|
|
369
|
+
mode: NamedSandboxNetworkPolicyMode;
|
|
370
|
+
allowedDomains?: NamedSandboxNetworkPolicyAllowedDomainsList;
|
|
371
|
+
allowedCIDRs?: NamedSandboxNetworkPolicyAllowedCIDRsList;
|
|
372
|
+
deniedCIDRs?: NamedSandboxNetworkPolicyDeniedCIDRsList;
|
|
373
|
+
s3Key?: string;
|
|
374
|
+
}
|
|
375
|
+
export declare const NamedSandboxNetworkPolicy: S.Schema<NamedSandboxNetworkPolicy>;
|
|
376
|
+
/** Key-value tags attached to the named sandbox. */
|
|
377
|
+
export type NamedSandboxTagsMap = {
|
|
378
|
+
[key: string]: string | undefined;
|
|
379
|
+
};
|
|
380
|
+
export declare const NamedSandboxTagsMap: S.Schema<NamedSandboxTagsMap>;
|
|
381
|
+
export type NamedSandboxMountsValueMode = "read-only" | "read-write";
|
|
382
|
+
export declare const NamedSandboxMountsValueMode: any;
|
|
383
|
+
/** Key-value pairs of mount path and drive. */
|
|
384
|
+
export interface NamedSandboxMountsValue {
|
|
385
|
+
drive: string;
|
|
386
|
+
mode?: NamedSandboxMountsValueMode;
|
|
387
|
+
}
|
|
388
|
+
export declare const NamedSandboxMountsValue: S.Schema<NamedSandboxMountsValue>;
|
|
389
|
+
/** Key-value pairs of mount path and drive. */
|
|
390
|
+
export type NamedSandboxMountsMap = {
|
|
391
|
+
[key: string]: NamedSandboxMountsValue | undefined;
|
|
392
|
+
};
|
|
393
|
+
export declare const NamedSandboxMountsMap: S.Schema<NamedSandboxMountsMap>;
|
|
394
|
+
/** This object contains information related to a Vercel NamedSandbox. */
|
|
395
|
+
export interface NamedSandbox {
|
|
396
|
+
/** The unique identifier of the sandbox. */
|
|
397
|
+
name: string;
|
|
398
|
+
/** Current snapshot ID that the named sandbox is pointing to. */
|
|
399
|
+
currentSnapshotId?: string;
|
|
400
|
+
/** Current session ID the sandbox is pointing to. */
|
|
401
|
+
currentSessionId: string;
|
|
402
|
+
/** The status of the current sandbox. */
|
|
403
|
+
status: NamedSandboxStatus;
|
|
404
|
+
/** The time when the sandbox status was last updated, in milliseconds since the epoch. */
|
|
405
|
+
statusUpdatedAt: number;
|
|
406
|
+
/** Whether the sandbox persists its state across restarts via automatic snapshots. */
|
|
407
|
+
persistent: boolean;
|
|
408
|
+
/** The region the sandbox is pinned to: the region stored on the sandbox, otherwise the platform default. Where a running session actually landed is reported by `session.region`. */
|
|
409
|
+
region?: string;
|
|
410
|
+
/** The regions the sandbox fails over to. Empty when it does not fail over. */
|
|
411
|
+
failoverRegions?: NamedSandboxFailoverRegionsList;
|
|
412
|
+
/** Number of virtual CPUs allocated. */
|
|
413
|
+
vcpus?: number;
|
|
414
|
+
/** Memory allocated in MB. */
|
|
415
|
+
memory?: number;
|
|
416
|
+
/** Runtime identifier. */
|
|
417
|
+
runtime?: string;
|
|
418
|
+
/** Digest-pinned reference of the container image the sandbox was created from, when it was created from an image ("{repository}@{manifestDigest}"). */
|
|
419
|
+
image?: string;
|
|
420
|
+
/** Timeout in milliseconds. */
|
|
421
|
+
timeout?: number;
|
|
422
|
+
/** Default snapshot expiration time in milliseconds. 0 means no expiration. */
|
|
423
|
+
snapshotExpiration?: number;
|
|
424
|
+
/** Keep-last snapshot configuration. */
|
|
425
|
+
keepLastSnapshots?: NamedSandboxKeepLastSnapshots;
|
|
426
|
+
/** Network policy configuration. */
|
|
427
|
+
networkPolicy?: NamedSandboxNetworkPolicy;
|
|
428
|
+
/** Cumulative egress bytes across all sandbox runs. */
|
|
429
|
+
totalEgressBytes?: number;
|
|
430
|
+
/** Cumulative ingress bytes across all sandbox runs. */
|
|
431
|
+
totalIngressBytes?: number;
|
|
432
|
+
/** Cumulative active CPU duration in milliseconds across all sandbox runs. */
|
|
433
|
+
totalActiveCpuDurationMs?: number;
|
|
434
|
+
/** Cumulative wall-clock duration in milliseconds across all sandbox runs. */
|
|
435
|
+
totalDurationMs?: number;
|
|
436
|
+
/** The working directory of the sandbox. */
|
|
437
|
+
cwd?: string;
|
|
438
|
+
/** Key-value tags attached to the named sandbox. */
|
|
439
|
+
tags?: NamedSandboxTagsMap;
|
|
440
|
+
/** Key-value pairs of mount path and drive. */
|
|
441
|
+
mounts?: NamedSandboxMountsMap;
|
|
442
|
+
/** The time when the named sandbox was created, in milliseconds since the epoch. */
|
|
443
|
+
createdAt: number;
|
|
444
|
+
/** The time when the named sandbox was last updated, in milliseconds since the epoch. */
|
|
445
|
+
updatedAt: number;
|
|
446
|
+
/** The time at which the currently running sandbox will time out, in milliseconds since the epoch. Only present while a session is running. */
|
|
447
|
+
expiresAt?: number;
|
|
448
|
+
}
|
|
449
|
+
export declare const NamedSandbox: S.Schema<NamedSandbox>;
|
|
450
|
+
/** The status of the sandbox. */
|
|
451
|
+
export type SessionStatus = "aborted" | "failed" | "pending" | "running" | "snapshotting" | "stopped" | "stopping";
|
|
452
|
+
export declare const SessionStatus: any;
|
|
453
|
+
/** The network policy mode. - 'allow-all': All traffic is allowed. - 'deny-all': All traffic is blocked. - 'custom': Traffic is controlled by explicit allow/deny rules. */
|
|
454
|
+
export type SandboxNetworkPolicyMode = "allow-all" | "custom" | "deny-all";
|
|
455
|
+
export declare const SandboxNetworkPolicyMode: any;
|
|
456
|
+
/** List of domain names the sandbox is allowed to connect to. Supports wildcard patterns (e.g., "*.vercel.com" matches all subdomains). */
|
|
457
|
+
export type SandboxNetworkPolicyAllowedDomainsList = Array<string>;
|
|
458
|
+
export declare const SandboxNetworkPolicyAllowedDomainsList: S.Schema<SandboxNetworkPolicyAllowedDomainsList>;
|
|
459
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is allowed to connect to. */
|
|
460
|
+
export type SandboxNetworkPolicyAllowedCIDRsList = Array<string>;
|
|
461
|
+
export declare const SandboxNetworkPolicyAllowedCIDRsList: S.Schema<SandboxNetworkPolicyAllowedCIDRsList>;
|
|
462
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is blocked from connecting to. These rules take precedence over all allowed rules. */
|
|
463
|
+
export type SandboxNetworkPolicyDeniedCIDRsList = Array<string>;
|
|
464
|
+
export declare const SandboxNetworkPolicyDeniedCIDRsList: S.Schema<SandboxNetworkPolicyDeniedCIDRsList>;
|
|
465
|
+
/** The names of HTTP headers that have value that will be injected for requests to this domain. */
|
|
466
|
+
export type SandboxInjectionRuleHeaderNamesList = Array<string>;
|
|
467
|
+
export declare const SandboxInjectionRuleHeaderNamesList: S.Schema<SandboxInjectionRuleHeaderNamesList>;
|
|
468
|
+
/** HTTP header injection rules for outgoing requests matching specific domains. */
|
|
469
|
+
export interface SandboxInjectionRule {
|
|
470
|
+
/** The domain (or pattern) that this injection rule applies to. Supports wildcards like *.vercel.com. */
|
|
471
|
+
domain: string;
|
|
472
|
+
/** The names of HTTP headers that have value that will be injected for requests to this domain. */
|
|
473
|
+
headerNames?: SandboxInjectionRuleHeaderNamesList;
|
|
474
|
+
}
|
|
475
|
+
export declare const SandboxInjectionRule: S.Schema<SandboxInjectionRule>;
|
|
476
|
+
/** HTTP header injection rules for outgoing requests matching specific domains. */
|
|
477
|
+
export type SandboxNetworkPolicyInjectionRulesList = Array<SandboxInjectionRule>;
|
|
478
|
+
export declare const SandboxNetworkPolicyInjectionRulesList: S.Schema<SandboxNetworkPolicyInjectionRulesList>;
|
|
479
|
+
/** The network policy applied to this sandbox, if any. */
|
|
480
|
+
export interface SandboxNetworkPolicy {
|
|
481
|
+
/** The network policy mode. - 'allow-all': All traffic is allowed. - 'deny-all': All traffic is blocked. - 'custom': Traffic is controlled by explicit allow/deny rules. */
|
|
482
|
+
mode: SandboxNetworkPolicyMode;
|
|
483
|
+
/** List of domain names the sandbox is allowed to connect to. Supports wildcard patterns (e.g., "*.vercel.com" matches all subdomains). */
|
|
484
|
+
allowedDomains?: SandboxNetworkPolicyAllowedDomainsList;
|
|
485
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is allowed to connect to. */
|
|
486
|
+
allowedCIDRs?: SandboxNetworkPolicyAllowedCIDRsList;
|
|
487
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is blocked from connecting to. These rules take precedence over all allowed rules. */
|
|
488
|
+
deniedCIDRs?: SandboxNetworkPolicyDeniedCIDRsList;
|
|
489
|
+
/** HTTP header injection rules for outgoing requests matching specific domains. */
|
|
490
|
+
injectionRules?: SandboxNetworkPolicyInjectionRulesList;
|
|
491
|
+
}
|
|
492
|
+
export declare const SandboxNetworkPolicy: S.Schema<SandboxNetworkPolicy>;
|
|
493
|
+
/** The quantity of data transfered to and from the sandbox, in bytes. This value is only available once the sandbox is stopped, and only if it stopped successfully. */
|
|
494
|
+
export interface SessionNetworkTransfer {
|
|
495
|
+
ingress: number;
|
|
496
|
+
egress: number;
|
|
497
|
+
}
|
|
498
|
+
export declare const SessionNetworkTransfer: S.Schema<SessionNetworkTransfer>;
|
|
499
|
+
/** This object contains information related to a Vercel Sandbox Session. v2 endpoints return "session" instead of "sandbox" as the response wrapper key. */
|
|
500
|
+
export interface Session {
|
|
501
|
+
/** The name of the source sandbox. */
|
|
502
|
+
sourceSandboxName: string;
|
|
503
|
+
/** The unique identifier of the project associated with this session. */
|
|
504
|
+
projectId: string;
|
|
505
|
+
/** The unique identifier of the sandbox. */
|
|
506
|
+
id: string;
|
|
507
|
+
/** Memory allocated to this sandbox in MB. */
|
|
508
|
+
memory: number;
|
|
509
|
+
/** Number of vCPUs allocated to this sandbox. */
|
|
510
|
+
vcpus: number;
|
|
511
|
+
/** The region where the sandbox is hosted. */
|
|
512
|
+
region: string;
|
|
513
|
+
/** The runtime of the sandbox. */
|
|
514
|
+
runtime: string;
|
|
515
|
+
/** The maximum amount of time the sandbox will run for in milliseconds. */
|
|
516
|
+
timeout: number;
|
|
517
|
+
/** The status of the sandbox. */
|
|
518
|
+
status: SessionStatus;
|
|
519
|
+
/** The time when the sandbox was requested, in milliseconds since the epoch. */
|
|
520
|
+
requestedAt: number;
|
|
521
|
+
/** The time when the sandbox was started, in milliseconds since the epoch. */
|
|
522
|
+
startedAt?: number;
|
|
523
|
+
/** The working directory of the sandbox. */
|
|
524
|
+
cwd: string;
|
|
525
|
+
/** The time when the sandbox was requested to stop, in milliseconds since the epoch. */
|
|
526
|
+
requestedStopAt?: number;
|
|
527
|
+
/** The time when the sandbox was stopped, in milliseconds since the epoch. */
|
|
528
|
+
stoppedAt?: number;
|
|
529
|
+
/** The time when the sandbox was aborted, in milliseconds since the epoch. */
|
|
530
|
+
abortedAt?: number;
|
|
531
|
+
/** The duration of the sandbox in milliseconds. */
|
|
532
|
+
duration?: number;
|
|
533
|
+
/** The unique identifier of the snapshot associated with this sandbox, if any. */
|
|
534
|
+
sourceSnapshotId?: string;
|
|
535
|
+
/** The time when a snapshot was requested, in milliseconds since the epoch. */
|
|
536
|
+
snapshottedAt?: number;
|
|
537
|
+
/** The time when the sandbox was created, in milliseconds since the epoch. */
|
|
538
|
+
createdAt: number;
|
|
539
|
+
/** The last time the sandbox was updated, in milliseconds since the epoch. */
|
|
540
|
+
updatedAt: number;
|
|
541
|
+
networkPolicy?: SandboxNetworkPolicy;
|
|
542
|
+
/** The amount of CPU time the sandbox consumed, if available, in milliseconds. This value is only available once the sandbox is stopped, and only if it stopped successfully. */
|
|
543
|
+
activeCpuDurationMs?: number;
|
|
544
|
+
/** The quantity of data transfered to and from the sandbox, in bytes. This value is only available once the sandbox is stopped, and only if it stopped successfully. */
|
|
545
|
+
networkTransfer?: SessionNetworkTransfer;
|
|
546
|
+
}
|
|
547
|
+
export declare const Session: S.Schema<Session>;
|
|
548
|
+
/** This object represents a public route in a Vercel Sandbox. */
|
|
549
|
+
export interface SandboxPublicRoute {
|
|
550
|
+
/** A public URL to access the corresponding port in the Sandbox. */
|
|
551
|
+
url: string;
|
|
552
|
+
/** The user port number that the route is mapped to. */
|
|
553
|
+
port: number;
|
|
554
|
+
/** The subdomain assigned to this route. */
|
|
555
|
+
subdomain: string;
|
|
556
|
+
/** Whether the route is reserved by the system (e.g. for internal use). */
|
|
557
|
+
system?: boolean;
|
|
558
|
+
}
|
|
559
|
+
export declare const SandboxPublicRoute: S.Schema<SandboxPublicRoute>;
|
|
560
|
+
export type CreateSandboxesByNameForkV2ResponseRoutesList = Array<SandboxPublicRoute>;
|
|
561
|
+
export declare const CreateSandboxesByNameForkV2ResponseRoutesList: S.Schema<CreateSandboxesByNameForkV2ResponseRoutesList>;
|
|
562
|
+
export interface CreateSandboxesByNameForkV2Response {
|
|
563
|
+
sandbox: NamedSandbox;
|
|
564
|
+
session: Session;
|
|
565
|
+
routes: CreateSandboxesByNameForkV2ResponseRoutesList;
|
|
566
|
+
}
|
|
567
|
+
export declare const CreateSandboxesByNameForkV2Response: S.Schema<CreateSandboxesByNameForkV2Response>;
|
|
568
|
+
/** The network access policy mode. Use \"allow-all\" to permit all outbound traffic. Use \"deny-all\" to block all outbound traffic. Use \"custom\" to specify explicit allow/deny rules. */
|
|
569
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase0Mode = "allow-all" | "deny-all" | "custom" | "default-allow" | "default-deny";
|
|
570
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase0Mode: any;
|
|
571
|
+
/** List of domain names the sandbox is allowed to connect to. Only applies when mode is \"custom\". Supports wildcard patterns (e.g., \"*.example.com\" matches all subdomains). */
|
|
572
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase0AllowedDomainsList = Array<string>;
|
|
573
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase0AllowedDomainsList: S.Schema<CreateSandboxesByNameForkV3RequestNetworkPolicyCase0AllowedDomainsList>;
|
|
574
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is allowed to connect to. Traffic to these addresses bypasses domain-based restrictions. */
|
|
575
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase0AllowedCIDRsList = Array<string>;
|
|
576
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase0AllowedCIDRsList: S.Schema<CreateSandboxesByNameForkV3RequestNetworkPolicyCase0AllowedCIDRsList>;
|
|
577
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is blocked from connecting to. These rules take precedence over all allowed rules. */
|
|
578
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase0DeniedCIDRsList = Array<string>;
|
|
579
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase0DeniedCIDRsList: S.Schema<CreateSandboxesByNameForkV3RequestNetworkPolicyCase0DeniedCIDRsList>;
|
|
580
|
+
/** HTTP headers to inject into requests for this domain. Existing headers with the same name will be overridden. */
|
|
581
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemHeadersMap = {
|
|
582
|
+
[key: string]: string | undefined;
|
|
583
|
+
};
|
|
584
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemHeadersMap: S.Schema<CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemHeadersMap>;
|
|
585
|
+
/** Match on the request path. Comparison is case-sensitive. */
|
|
586
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatchPath = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
587
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatchPath: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
588
|
+
/** HTTP methods to match. Any single match succeeds (OR semantics). */
|
|
589
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatchMethodList = Array<string>;
|
|
590
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatchMethodList: S.Schema<CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatchMethodList>;
|
|
591
|
+
/** Matcher for the entry key (header name or query key). */
|
|
592
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItemKey = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
593
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItemKey: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
594
|
+
/** Matcher for the entry value. */
|
|
595
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItemValue = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
596
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItemValue: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
597
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem;
|
|
598
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
599
|
+
/** Query-string entry matchers. Multiple entries are ANDed. Query parameter names and values are both compared case-sensitively (RFC 3986). When a request has multiple values for the same key, any matching value satisfies the matcher. */
|
|
600
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
601
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringList: S.Schema<CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringList>;
|
|
602
|
+
/** Matcher for the entry key (header name or query key). */
|
|
603
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItemKey = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
604
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItemKey: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
605
|
+
/** Matcher for the entry value. */
|
|
606
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItemValue = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
607
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItemValue: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
608
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItem = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem;
|
|
609
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
610
|
+
/** Header matchers. Multiple entries are ANDed. Header names are compared case-insensitively (RFC 9110); header values are compared case-sensitively. When a request has multiple values for the same header, any matching value satisfies the matcher. */
|
|
611
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
612
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersList: S.Schema<CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersList>;
|
|
613
|
+
/** Optional L7 match. When provided, the injection rule only applies to requests that satisfy every specified dimension. When multiple injection rules target the same domain they are evaluated in order and the first match wins; a rule without `match` matches any request and shadows later rules for the same domain. */
|
|
614
|
+
export interface CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatch {
|
|
615
|
+
/** Match on the request path. Comparison is case-sensitive. */
|
|
616
|
+
path?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
617
|
+
/** HTTP methods to match. Any single match succeeds (OR semantics). */
|
|
618
|
+
method?: CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatchMethodList;
|
|
619
|
+
/** Query-string entry matchers. Multiple entries are ANDed. Query parameter names and values are both compared case-sensitively (RFC 3986). When a request has multiple values for the same key, any matching value satisfies the matcher. */
|
|
620
|
+
queryString?: CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringList;
|
|
621
|
+
/** Header matchers. Multiple entries are ANDed. Header names are compared case-insensitively (RFC 9110); header values are compared case-sensitively. When a request has multiple values for the same header, any matching value satisfies the matcher. */
|
|
622
|
+
headers?: CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersList;
|
|
623
|
+
}
|
|
624
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatch: S.Schema<CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatch>;
|
|
625
|
+
export interface CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItem {
|
|
626
|
+
/** The domain (or pattern) of requests to add headers for. Supports wildcards like *.example.com. */
|
|
627
|
+
domain: string;
|
|
628
|
+
/** HTTP headers to inject into requests for this domain. Existing headers with the same name will be overridden. */
|
|
629
|
+
headers: CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemHeadersMap;
|
|
630
|
+
/** Optional L7 match. When provided, the injection rule only applies to requests that satisfy every specified dimension. When multiple injection rules target the same domain they are evaluated in order and the first match wins; a rule without `match` matches any request and shadows later rules for the same domain. */
|
|
631
|
+
match?: CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItemMatch;
|
|
632
|
+
}
|
|
633
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItem: S.Schema<CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItem>;
|
|
634
|
+
/** HTTP header injection rules for outgoing requests matching specific domains. Traffic to matching domains will be intercepted instead of proxied through encrypted connections. */
|
|
635
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesList = Array<CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesItem>;
|
|
636
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesList: S.Schema<CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesList>;
|
|
637
|
+
/** Network access policy for the sandbox.\n Controls which external hosts the sandbox can communicate with.\n Use \"allow-all\" mode to allow all traffic, \"deny-all\" to block all traffic or \"custom\" to provide specific rules. */
|
|
638
|
+
export interface CreateSandboxesByNameForkV3RequestNetworkPolicyCase0 {
|
|
639
|
+
/** The network access policy mode. Use \"allow-all\" to permit all outbound traffic. Use \"deny-all\" to block all outbound traffic. Use \"custom\" to specify explicit allow/deny rules. */
|
|
640
|
+
mode: CreateSandboxesByNameForkV3RequestNetworkPolicyCase0Mode | (string & {});
|
|
641
|
+
/** List of domain names the sandbox is allowed to connect to. Only applies when mode is \"custom\". Supports wildcard patterns (e.g., \"*.example.com\" matches all subdomains). */
|
|
642
|
+
allowedDomains?: CreateSandboxesByNameForkV3RequestNetworkPolicyCase0AllowedDomainsList;
|
|
643
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is allowed to connect to. Traffic to these addresses bypasses domain-based restrictions. */
|
|
644
|
+
allowedCIDRs?: CreateSandboxesByNameForkV3RequestNetworkPolicyCase0AllowedCIDRsList;
|
|
645
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is blocked from connecting to. These rules take precedence over all allowed rules. */
|
|
646
|
+
deniedCIDRs?: CreateSandboxesByNameForkV3RequestNetworkPolicyCase0DeniedCIDRsList;
|
|
647
|
+
/** HTTP header injection rules for outgoing requests matching specific domains. Traffic to matching domains will be intercepted instead of proxied through encrypted connections. */
|
|
648
|
+
injectionRules?: CreateSandboxesByNameForkV3RequestNetworkPolicyCase0InjectionRulesList;
|
|
649
|
+
}
|
|
650
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase0: S.Schema<CreateSandboxesByNameForkV3RequestNetworkPolicyCase0>;
|
|
651
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase0List = Array<string>;
|
|
652
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase0List: S.Schema<CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase0List>;
|
|
653
|
+
/** Match on the request path. Comparison is case-sensitive. */
|
|
654
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchPath = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
655
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchPath: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
656
|
+
/** HTTP methods to match. Any single match succeeds (OR semantics). */
|
|
657
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchMethodList = Array<string>;
|
|
658
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchMethodList: S.Schema<CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchMethodList>;
|
|
659
|
+
/** Matcher for the entry key (header name or query key). */
|
|
660
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItemKey = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
661
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItemKey: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
662
|
+
/** Matcher for the entry value. */
|
|
663
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItemValue = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
664
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItemValue: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
665
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItem = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem;
|
|
666
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
667
|
+
/** Query-string entry matchers. Multiple entries are ANDed. Query parameter names and values are both compared case-sensitively (RFC 3986). When a request has multiple values for the same key, any matching value satisfies the matcher. */
|
|
668
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
669
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringList: S.Schema<CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringList>;
|
|
670
|
+
/** Matcher for the entry key (header name or query key). */
|
|
671
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItemKey = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
672
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItemKey: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
673
|
+
/** Matcher for the entry value. */
|
|
674
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItemValue = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
675
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItemValue: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
676
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItem = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem;
|
|
677
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
678
|
+
/** Header matchers. Multiple entries are ANDed. Header names are compared case-insensitively (RFC 9110); header values are compared case-sensitively. When a request has multiple values for the same header, any matching value satisfies the matcher. */
|
|
679
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
680
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersList: S.Schema<CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersList>;
|
|
681
|
+
/** Optional L7 match. When provided, the injection rule only applies to requests that satisfy every specified dimension. When multiple injection rules target the same domain they are evaluated in order and the first match wins; a rule without `match` matches any request and shadows later rules for the same domain. */
|
|
682
|
+
export interface CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatch {
|
|
683
|
+
/** Match on the request path. Comparison is case-sensitive. */
|
|
684
|
+
path?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
685
|
+
/** HTTP methods to match. Any single match succeeds (OR semantics). */
|
|
686
|
+
method?: CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchMethodList;
|
|
687
|
+
/** Query-string entry matchers. Multiple entries are ANDed. Query parameter names and values are both compared case-sensitively (RFC 3986). When a request has multiple values for the same key, any matching value satisfies the matcher. */
|
|
688
|
+
queryString?: CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringList;
|
|
689
|
+
/** Header matchers. Multiple entries are ANDed. Header names are compared case-insensitively (RFC 9110); header values are compared case-sensitively. When a request has multiple values for the same header, any matching value satisfies the matcher. */
|
|
690
|
+
headers?: CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersList;
|
|
691
|
+
}
|
|
692
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatch: S.Schema<CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatch>;
|
|
693
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemTransformItemHeadersMap = {
|
|
694
|
+
[key: string]: string | undefined;
|
|
695
|
+
};
|
|
696
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemTransformItemHeadersMap: S.Schema<CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemTransformItemHeadersMap>;
|
|
697
|
+
export interface CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemTransformItem {
|
|
698
|
+
headers?: CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemTransformItemHeadersMap;
|
|
699
|
+
}
|
|
700
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemTransformItem: S.Schema<CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemTransformItem>;
|
|
701
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemTransformList = Array<CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemTransformItem>;
|
|
702
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemTransformList: S.Schema<CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemTransformList>;
|
|
703
|
+
export interface CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItem {
|
|
704
|
+
/** Optional L7 match. When provided, the injection rule only applies to requests that satisfy every specified dimension. When multiple injection rules target the same domain they are evaluated in order and the first match wins; a rule without `match` matches any request and shadows later rules for the same domain. */
|
|
705
|
+
match?: CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemMatch;
|
|
706
|
+
transform?: CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItemTransformList;
|
|
707
|
+
/** HTTP/1.1 proxy URL to forward traffic to. Must not include username, password, query string, or fragment. */
|
|
708
|
+
forwardURL?: string;
|
|
709
|
+
}
|
|
710
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItem: S.Schema<CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItem>;
|
|
711
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueList = Array<CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueItem>;
|
|
712
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueList: S.Schema<CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueList>;
|
|
713
|
+
/** A rule applied to requests matching a domain in the network policy. Only one of `transform` or `forwardURL` can be specified per rule. */
|
|
714
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1Map = {
|
|
715
|
+
[key: string]: CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1ValueList | undefined;
|
|
716
|
+
};
|
|
717
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1Map: S.Schema<CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1Map>;
|
|
718
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase1Allow = CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase0List | CreateSandboxesByNameForkV3RequestNetworkPolicyCase1AllowCase1Map;
|
|
719
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase1Allow: S.Schema<CreateSandboxesByNameForkV3RequestNetworkPolicyCase1Allow>;
|
|
720
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase1SubnetsAllowList = Array<string>;
|
|
721
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase1SubnetsAllowList: S.Schema<CreateSandboxesByNameForkV3RequestNetworkPolicyCase1SubnetsAllowList>;
|
|
722
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicyCase1SubnetsDenyList = Array<string>;
|
|
723
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase1SubnetsDenyList: S.Schema<CreateSandboxesByNameForkV3RequestNetworkPolicyCase1SubnetsDenyList>;
|
|
724
|
+
export interface CreateSandboxesByNameForkV3RequestNetworkPolicyCase1Subnets {
|
|
725
|
+
allow?: CreateSandboxesByNameForkV3RequestNetworkPolicyCase1SubnetsAllowList;
|
|
726
|
+
deny?: CreateSandboxesByNameForkV3RequestNetworkPolicyCase1SubnetsDenyList;
|
|
727
|
+
}
|
|
728
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase1Subnets: S.Schema<CreateSandboxesByNameForkV3RequestNetworkPolicyCase1Subnets>;
|
|
729
|
+
export interface CreateSandboxesByNameForkV3RequestNetworkPolicyCase1 {
|
|
730
|
+
allow?: CreateSandboxesByNameForkV3RequestNetworkPolicyCase1Allow;
|
|
731
|
+
subnets?: CreateSandboxesByNameForkV3RequestNetworkPolicyCase1Subnets;
|
|
732
|
+
}
|
|
733
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicyCase1: S.Schema<CreateSandboxesByNameForkV3RequestNetworkPolicyCase1>;
|
|
734
|
+
export type CreateSandboxesByNameForkV3RequestNetworkPolicy = CreateSandboxesByNameForkV3RequestNetworkPolicyCase0 | CreateSandboxesByNameForkV3RequestNetworkPolicyCase1;
|
|
735
|
+
export declare const CreateSandboxesByNameForkV3RequestNetworkPolicy: S.Schema<CreateSandboxesByNameForkV3RequestNetworkPolicy>;
|
|
736
|
+
/** Resources to define the VM */
|
|
737
|
+
export type CreateSandboxesByNameForkV3RequestResources = CreateSandboxesByNameForkV2RequestResources;
|
|
738
|
+
export declare const CreateSandboxesByNameForkV3RequestResources: S.Schema<CreateSandboxesByNameForkV2RequestResources>;
|
|
739
|
+
/** List of ports to expose from the sandbox. Each port will be accessible via a unique URL. Maximum of 15 ports can be exposed. */
|
|
740
|
+
export type CreateSandboxesByNameForkV3RequestPortsList = Array<number>;
|
|
741
|
+
export declare const CreateSandboxesByNameForkV3RequestPortsList: S.Schema<CreateSandboxesByNameForkV3RequestPortsList>;
|
|
742
|
+
/** Default environment variables for the sandbox. These are inherited by all commands unless overridden. */
|
|
743
|
+
export type CreateSandboxesByNameForkV3RequestEnvMap = {
|
|
744
|
+
[key: string]: string | undefined;
|
|
745
|
+
};
|
|
746
|
+
export declare const CreateSandboxesByNameForkV3RequestEnvMap: S.Schema<CreateSandboxesByNameForkV3RequestEnvMap>;
|
|
747
|
+
/** Mount the drive read-only or read-write. */
|
|
748
|
+
export type CreateSandboxesByNameForkV3RequestMountsValueMode = "read-only" | "read-write";
|
|
749
|
+
export declare const CreateSandboxesByNameForkV3RequestMountsValueMode: any;
|
|
750
|
+
export interface CreateSandboxesByNameForkV3RequestMountsValue {
|
|
751
|
+
/** Name of the drive to mount. The drive must already exist. */
|
|
752
|
+
drive: string;
|
|
753
|
+
/** Mount the drive read-only or read-write. */
|
|
754
|
+
mode?: CreateSandboxesByNameForkV3RequestMountsValueMode | (string & {});
|
|
755
|
+
}
|
|
756
|
+
export declare const CreateSandboxesByNameForkV3RequestMountsValue: S.Schema<CreateSandboxesByNameForkV3RequestMountsValue>;
|
|
757
|
+
/** List of drives to mount to the sandbox at the provided path. */
|
|
758
|
+
export type CreateSandboxesByNameForkV3RequestMountsMap = {
|
|
759
|
+
[key: string]: CreateSandboxesByNameForkV3RequestMountsValue | undefined;
|
|
760
|
+
};
|
|
761
|
+
export declare const CreateSandboxesByNameForkV3RequestMountsMap: S.Schema<CreateSandboxesByNameForkV3RequestMountsMap>;
|
|
762
|
+
/** The Vercel region in which to create the sandbox. */
|
|
763
|
+
export type CreateSandboxesByNameForkV3RequestRegion = "iad1" | "sfo1" | "cle1" | "cdg1" | "fra1" | "arn1" | "sin1" | "pdx1" | "lhr1" | "icn1" | "bom1" | "cpt1" | "dub1" | "gru1" | "hkg1" | "syd1" | "yul1" | "hnd1" | "kix1";
|
|
764
|
+
export declare const CreateSandboxesByNameForkV3RequestRegion: any;
|
|
765
|
+
export type CreateSandboxesByNameForkV3RequestFailoverRegionsItem = "iad1" | "sfo1" | "cle1" | "cdg1" | "fra1" | "arn1" | "sin1" | "pdx1" | "lhr1" | "icn1" | "bom1" | "cpt1" | "dub1" | "gru1" | "hkg1" | "syd1" | "yul1" | "hnd1" | "kix1";
|
|
766
|
+
export declare const CreateSandboxesByNameForkV3RequestFailoverRegionsItem: any;
|
|
767
|
+
/** The regions the sandbox falls back to when it cannot be created in `region`. */
|
|
768
|
+
export type CreateSandboxesByNameForkV3RequestFailoverRegionsList = Array<CreateSandboxesByNameForkV3RequestFailoverRegionsItem | (string & {})>;
|
|
769
|
+
export declare const CreateSandboxesByNameForkV3RequestFailoverRegionsList: S.Schema<CreateSandboxesByNameForkV3RequestFailoverRegionsList>;
|
|
770
|
+
/** Default snapshot expiration time in milliseconds. Defaults to 7 days. Set to 0 to disable expiration. When set, this value is used as the default expiration for all snapshots created for this sandbox. */
|
|
771
|
+
export type CreateSandboxesByNameForkV3RequestSnapshotExpiration = unknown | number;
|
|
772
|
+
export declare const CreateSandboxesByNameForkV3RequestSnapshotExpiration: S.Schema<CreateSandboxesByNameForkV3RequestSnapshotExpiration>;
|
|
773
|
+
/** Expiration time in milliseconds for kept snapshots. Falls back to snapshotExpiration. */
|
|
774
|
+
export type CreateSandboxesByNameForkV3RequestKeepLastSnapshotsCase1Expiration = unknown | number;
|
|
775
|
+
export declare const CreateSandboxesByNameForkV3RequestKeepLastSnapshotsCase1Expiration: S.Schema<CreateSandboxesByNameForkV3RequestKeepLastSnapshotsCase1Expiration>;
|
|
776
|
+
export interface CreateSandboxesByNameForkV3RequestKeepLastSnapshotsCase1 {
|
|
777
|
+
/** Number of most recent snapshots to keep. */
|
|
778
|
+
count: number;
|
|
779
|
+
/** Expiration time in milliseconds for kept snapshots. Falls back to snapshotExpiration. */
|
|
780
|
+
expiration?: CreateSandboxesByNameForkV3RequestKeepLastSnapshotsCase1Expiration;
|
|
781
|
+
/** Whether to immediately delete evicted snapshots. Defaults to true. */
|
|
782
|
+
deleteEvicted?: boolean;
|
|
783
|
+
}
|
|
784
|
+
export declare const CreateSandboxesByNameForkV3RequestKeepLastSnapshotsCase1: S.Schema<CreateSandboxesByNameForkV3RequestKeepLastSnapshotsCase1>;
|
|
785
|
+
/** Protect the N most recent snapshots with different expiration/deletion behavior. Persistent sandboxes default to keeping only the last snapshot (evicted snapshots are deleted). Set to null to disable the limit. */
|
|
786
|
+
export type CreateSandboxesByNameForkV3RequestKeepLastSnapshots = string | CreateSandboxesByNameForkV3RequestKeepLastSnapshotsCase1;
|
|
787
|
+
export declare const CreateSandboxesByNameForkV3RequestKeepLastSnapshots: S.Schema<CreateSandboxesByNameForkV3RequestKeepLastSnapshots>;
|
|
788
|
+
/** Key-value tags to associate with the sandbox. Maximum 5 tags. */
|
|
789
|
+
export type CreateSandboxesByNameForkV3RequestTagsMap = {
|
|
790
|
+
[key: string]: string | undefined;
|
|
791
|
+
};
|
|
792
|
+
export declare const CreateSandboxesByNameForkV3RequestTagsMap: S.Schema<CreateSandboxesByNameForkV3RequestTagsMap>;
|
|
793
|
+
export interface CreateSandboxesByNameForkV3Request {
|
|
794
|
+
/** Name of the source sandbox to fork. */
|
|
795
|
+
name: string;
|
|
796
|
+
/** The ID of the project the source sandbox belongs to. Required unless authenticating with an OIDC token. */
|
|
797
|
+
projectId?: string;
|
|
798
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
799
|
+
teamId?: string;
|
|
800
|
+
/** The Team slug to perform the request on behalf of. */
|
|
801
|
+
slug?: string;
|
|
802
|
+
networkPolicy?: CreateSandboxesByNameForkV3RequestNetworkPolicy;
|
|
803
|
+
/** Resources to define the VM */
|
|
804
|
+
resources?: CreateSandboxesByNameForkV2RequestResources;
|
|
805
|
+
/** List of ports to expose from the sandbox. Each port will be accessible via a unique URL. Maximum of 15 ports can be exposed. */
|
|
806
|
+
ports?: CreateSandboxesByNameForkV3RequestPortsList;
|
|
807
|
+
/** Image to use for the sandbox. */
|
|
808
|
+
image?: string;
|
|
809
|
+
/** Maximum duration in milliseconds that the sandbox can run before being automatically stopped. */
|
|
810
|
+
timeout?: number;
|
|
811
|
+
/** Default environment variables for the sandbox. These are inherited by all commands unless overridden. */
|
|
812
|
+
env?: CreateSandboxesByNameForkV3RequestEnvMap;
|
|
813
|
+
/** List of drives to mount to the sandbox at the provided path. */
|
|
814
|
+
mounts?: CreateSandboxesByNameForkV3RequestMountsMap;
|
|
815
|
+
/** The Vercel region in which to create the sandbox. */
|
|
816
|
+
region?: CreateSandboxesByNameForkV3RequestRegion | (string & {});
|
|
817
|
+
/** The regions the sandbox falls back to when it cannot be created in `region`. */
|
|
818
|
+
failoverRegions?: CreateSandboxesByNameForkV3RequestFailoverRegionsList;
|
|
819
|
+
/** Whether the sandbox persists its state across restarts via automatic snapshots. Defaults to the source sandbox setting. */
|
|
820
|
+
persistent?: boolean;
|
|
821
|
+
/** Default snapshot expiration time in milliseconds. Defaults to 7 days. Set to 0 to disable expiration. When set, this value is used as the default expiration for all snapshots created for this sandbox. */
|
|
822
|
+
snapshotExpiration?: CreateSandboxesByNameForkV3RequestSnapshotExpiration;
|
|
823
|
+
/** Protect the N most recent snapshots with different expiration/deletion behavior. Persistent sandboxes default to keeping only the last snapshot (evicted snapshots are deleted). Set to null to disable the limit. */
|
|
824
|
+
keepLastSnapshots?: CreateSandboxesByNameForkV3RequestKeepLastSnapshots;
|
|
825
|
+
/** Key-value tags to associate with the sandbox. Maximum 5 tags. */
|
|
826
|
+
tags?: CreateSandboxesByNameForkV3RequestTagsMap;
|
|
827
|
+
}
|
|
828
|
+
export declare const CreateSandboxesByNameForkV3Request: S.Schema<CreateSandboxesByNameForkV3Request>;
|
|
829
|
+
export type CreateSandboxesByNameForkV3ResponseRoutesList = Array<SandboxPublicRoute>;
|
|
830
|
+
export declare const CreateSandboxesByNameForkV3ResponseRoutesList: S.Schema<CreateSandboxesByNameForkV3ResponseRoutesList>;
|
|
831
|
+
export interface CreateSandboxesByNameForkV3Response {
|
|
832
|
+
sandbox: NamedSandbox;
|
|
833
|
+
session: Session;
|
|
834
|
+
routes: CreateSandboxesByNameForkV3ResponseRoutesList;
|
|
835
|
+
}
|
|
836
|
+
export declare const CreateSandboxesByNameForkV3Response: S.Schema<CreateSandboxesByNameForkV3Response>;
|
|
837
|
+
/** The number of milliseconds after which the snapshot will expire and be deleted. Use 0 for no expiration. */
|
|
838
|
+
export type CreateSandboxesSessionsBySessionIdSnapshotV2RequestExpiration = unknown | number;
|
|
839
|
+
export declare const CreateSandboxesSessionsBySessionIdSnapshotV2RequestExpiration: S.Schema<CreateSandboxesSessionsBySessionIdSnapshotV2RequestExpiration>;
|
|
840
|
+
export interface CreateSandboxesSessionsBySessionIdSnapshotV2Request {
|
|
841
|
+
/** The unique identifier of the session to snapshot. */
|
|
842
|
+
sessionId: string;
|
|
843
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
844
|
+
teamId?: string;
|
|
845
|
+
/** The Team slug to perform the request on behalf of. */
|
|
846
|
+
slug?: string;
|
|
847
|
+
/** The number of milliseconds after which the snapshot will expire and be deleted. Use 0 for no expiration. */
|
|
848
|
+
expiration?: CreateSandboxesSessionsBySessionIdSnapshotV2RequestExpiration;
|
|
849
|
+
}
|
|
850
|
+
export declare const CreateSandboxesSessionsBySessionIdSnapshotV2Request: S.Schema<CreateSandboxesSessionsBySessionIdSnapshotV2Request>;
|
|
851
|
+
/** The regions where the snapshot is available. */
|
|
852
|
+
export type SnapshotRegionsList = Array<string>;
|
|
853
|
+
export declare const SnapshotRegionsList: S.Schema<SnapshotRegionsList>;
|
|
854
|
+
/** The status of the snapshot. */
|
|
855
|
+
export type SnapshotStatus = "created" | "deleted" | "failed";
|
|
856
|
+
export declare const SnapshotStatus: any;
|
|
857
|
+
/** The method used to create the snapshot. */
|
|
858
|
+
export type SnapshotCreationMethod = "automatic" | "manual";
|
|
859
|
+
export declare const SnapshotCreationMethod: any;
|
|
860
|
+
/** This object contains information related to a Snapshot of a Vercel Sandbox session (v2 API). */
|
|
861
|
+
export interface Snapshot {
|
|
862
|
+
/** The unique identifier of the snapshot. */
|
|
863
|
+
id: string;
|
|
864
|
+
/** The unique identifier of the session from which the snapshot was created. */
|
|
865
|
+
sourceSessionId: string;
|
|
866
|
+
/** The region where the snapshot is stored. */
|
|
867
|
+
region?: string;
|
|
868
|
+
/** The regions where the snapshot is available. */
|
|
869
|
+
regions?: SnapshotRegionsList;
|
|
870
|
+
/** The status of the snapshot. */
|
|
871
|
+
status: SnapshotStatus;
|
|
872
|
+
/** The size of the snapshot in bytes. */
|
|
873
|
+
sizeBytes: number;
|
|
874
|
+
/** The time when the snapshot will expire, in milliseconds since the epoch. If not set, the snapshot does not have any expiration. */
|
|
875
|
+
expiresAt?: number;
|
|
876
|
+
/** The time when the snapshot was created, in milliseconds since the epoch. */
|
|
877
|
+
createdAt: number;
|
|
878
|
+
/** The last time the snapshot was updated, in milliseconds since the epoch. */
|
|
879
|
+
updatedAt: number;
|
|
880
|
+
/** The last time the snapshot was used (e.g. to resume or create a sandbox), in milliseconds since the epoch. Falls back to `createdAt` for older snapshots that predate this field. */
|
|
881
|
+
lastUsedAt: number;
|
|
882
|
+
/** The method used to create the snapshot. */
|
|
883
|
+
creationMethod?: SnapshotCreationMethod;
|
|
884
|
+
/** The unique identifier of the parent snapshot, if this snapshot was created from another snapshot. */
|
|
885
|
+
parentId?: string;
|
|
886
|
+
}
|
|
887
|
+
export declare const Snapshot: S.Schema<Snapshot>;
|
|
888
|
+
export interface CreateSandboxesSessionsBySessionIdSnapshotV2Response {
|
|
889
|
+
snapshot: Snapshot;
|
|
890
|
+
session: Session;
|
|
891
|
+
}
|
|
892
|
+
export declare const CreateSandboxesSessionsBySessionIdSnapshotV2Response: S.Schema<CreateSandboxesSessionsBySessionIdSnapshotV2Response>;
|
|
893
|
+
/** The number of milliseconds after which the snapshot will expire and be deleted. Defaults to 7 days when neither this field nor the sandbox configuration specifies an expiration. Use 0 for no expiration. */
|
|
894
|
+
export type CreateSandboxesSessionsBySessionIdSnapshotV3RequestExpiration = unknown | number;
|
|
895
|
+
export declare const CreateSandboxesSessionsBySessionIdSnapshotV3RequestExpiration: S.Schema<CreateSandboxesSessionsBySessionIdSnapshotV3RequestExpiration>;
|
|
896
|
+
export interface CreateSandboxesSessionsBySessionIdSnapshotV3Request {
|
|
897
|
+
/** The unique identifier of the session to snapshot. */
|
|
898
|
+
sessionId: string;
|
|
899
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
900
|
+
teamId?: string;
|
|
901
|
+
/** The Team slug to perform the request on behalf of. */
|
|
902
|
+
slug?: string;
|
|
903
|
+
/** The number of milliseconds after which the snapshot will expire and be deleted. Defaults to 7 days when neither this field nor the sandbox configuration specifies an expiration. Use 0 for no expiration. */
|
|
904
|
+
expiration?: CreateSandboxesSessionsBySessionIdSnapshotV3RequestExpiration;
|
|
905
|
+
}
|
|
906
|
+
export declare const CreateSandboxesSessionsBySessionIdSnapshotV3Request: S.Schema<CreateSandboxesSessionsBySessionIdSnapshotV3Request>;
|
|
907
|
+
export interface CreateSandboxesSessionsBySessionIdSnapshotV3Response {
|
|
908
|
+
snapshot: Snapshot;
|
|
909
|
+
session: Session;
|
|
910
|
+
}
|
|
911
|
+
export declare const CreateSandboxesSessionsBySessionIdSnapshotV3Response: S.Schema<CreateSandboxesSessionsBySessionIdSnapshotV3Response>;
|
|
912
|
+
/** The network access policy mode. Use \"allow-all\" to permit all outbound traffic. Use \"deny-all\" to block all outbound traffic. Use \"custom\" to specify explicit allow/deny rules. */
|
|
913
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase0Mode = "allow-all" | "deny-all" | "custom" | "default-allow" | "default-deny";
|
|
914
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase0Mode: any;
|
|
915
|
+
/** List of domain names the sandbox is allowed to connect to. Only applies when mode is \"custom\". Supports wildcard patterns (e.g., \"*.example.com\" matches all subdomains). */
|
|
916
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase0AllowedDomainsList = Array<string>;
|
|
917
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase0AllowedDomainsList: S.Schema<CreateSandboxesV2RequestNetworkPolicyCase0AllowedDomainsList>;
|
|
918
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is allowed to connect to. Traffic to these addresses bypasses domain-based restrictions. */
|
|
919
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase0AllowedCIDRsList = Array<string>;
|
|
920
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase0AllowedCIDRsList: S.Schema<CreateSandboxesV2RequestNetworkPolicyCase0AllowedCIDRsList>;
|
|
921
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is blocked from connecting to. These rules take precedence over all allowed rules. */
|
|
922
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase0DeniedCIDRsList = Array<string>;
|
|
923
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase0DeniedCIDRsList: S.Schema<CreateSandboxesV2RequestNetworkPolicyCase0DeniedCIDRsList>;
|
|
924
|
+
/** HTTP headers to inject into requests for this domain. Existing headers with the same name will be overridden. */
|
|
925
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemHeadersMap = {
|
|
926
|
+
[key: string]: string | undefined;
|
|
927
|
+
};
|
|
928
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemHeadersMap: S.Schema<CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemHeadersMap>;
|
|
929
|
+
/** Match on the request path. Comparison is case-sensitive. */
|
|
930
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
931
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
932
|
+
/** HTTP methods to match. Any single match succeeds (OR semantics). */
|
|
933
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatchMethodList = Array<string>;
|
|
934
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatchMethodList: S.Schema<CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatchMethodList>;
|
|
935
|
+
/** Matcher for the entry key (header name or query key). */
|
|
936
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItemKey = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
937
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItemKey: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
938
|
+
/** Matcher for the entry value. */
|
|
939
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItemValue = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
940
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItemValue: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
941
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem;
|
|
942
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
943
|
+
/** Query-string entry matchers. Multiple entries are ANDed. Query parameter names and values are both compared case-sensitively (RFC 3986). When a request has multiple values for the same key, any matching value satisfies the matcher. */
|
|
944
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
945
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringList: S.Schema<CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringList>;
|
|
946
|
+
/** Matcher for the entry key (header name or query key). */
|
|
947
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItemKey = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
948
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItemKey: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
949
|
+
/** Matcher for the entry value. */
|
|
950
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItemValue = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
951
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItemValue: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
952
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItem = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem;
|
|
953
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
954
|
+
/** Header matchers. Multiple entries are ANDed. Header names are compared case-insensitively (RFC 9110); header values are compared case-sensitively. When a request has multiple values for the same header, any matching value satisfies the matcher. */
|
|
955
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
956
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersList: S.Schema<CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersList>;
|
|
957
|
+
/** Optional L7 match. When provided, the injection rule only applies to requests that satisfy every specified dimension. When multiple injection rules target the same domain they are evaluated in order and the first match wins; a rule without `match` matches any request and shadows later rules for the same domain. */
|
|
958
|
+
export interface CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatch {
|
|
959
|
+
/** Match on the request path. Comparison is case-sensitive. */
|
|
960
|
+
path?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
961
|
+
/** HTTP methods to match. Any single match succeeds (OR semantics). */
|
|
962
|
+
method?: CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatchMethodList;
|
|
963
|
+
/** Query-string entry matchers. Multiple entries are ANDed. Query parameter names and values are both compared case-sensitively (RFC 3986). When a request has multiple values for the same key, any matching value satisfies the matcher. */
|
|
964
|
+
queryString?: CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringList;
|
|
965
|
+
/** Header matchers. Multiple entries are ANDed. Header names are compared case-insensitively (RFC 9110); header values are compared case-sensitively. When a request has multiple values for the same header, any matching value satisfies the matcher. */
|
|
966
|
+
headers?: CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersList;
|
|
967
|
+
}
|
|
968
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatch: S.Schema<CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatch>;
|
|
969
|
+
export interface CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItem {
|
|
970
|
+
/** The domain (or pattern) of requests to add headers for. Supports wildcards like *.example.com. */
|
|
971
|
+
domain: string;
|
|
972
|
+
/** HTTP headers to inject into requests for this domain. Existing headers with the same name will be overridden. */
|
|
973
|
+
headers: CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemHeadersMap;
|
|
974
|
+
/** Optional L7 match. When provided, the injection rule only applies to requests that satisfy every specified dimension. When multiple injection rules target the same domain they are evaluated in order and the first match wins; a rule without `match` matches any request and shadows later rules for the same domain. */
|
|
975
|
+
match?: CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItemMatch;
|
|
976
|
+
}
|
|
977
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItem: S.Schema<CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItem>;
|
|
978
|
+
/** HTTP header injection rules for outgoing requests matching specific domains. Traffic to matching domains will be intercepted instead of proxied through encrypted connections. */
|
|
979
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesList = Array<CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesItem>;
|
|
980
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesList: S.Schema<CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesList>;
|
|
981
|
+
/** Network access policy for the sandbox.\n Controls which external hosts the sandbox can communicate with.\n Use \"allow-all\" mode to allow all traffic, \"deny-all\" to block all traffic or \"custom\" to provide specific rules. */
|
|
982
|
+
export interface CreateSandboxesV2RequestNetworkPolicyCase0 {
|
|
983
|
+
/** The network access policy mode. Use \"allow-all\" to permit all outbound traffic. Use \"deny-all\" to block all outbound traffic. Use \"custom\" to specify explicit allow/deny rules. */
|
|
984
|
+
mode: CreateSandboxesV2RequestNetworkPolicyCase0Mode | (string & {});
|
|
985
|
+
/** List of domain names the sandbox is allowed to connect to. Only applies when mode is \"custom\". Supports wildcard patterns (e.g., \"*.example.com\" matches all subdomains). */
|
|
986
|
+
allowedDomains?: CreateSandboxesV2RequestNetworkPolicyCase0AllowedDomainsList;
|
|
987
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is allowed to connect to. Traffic to these addresses bypasses domain-based restrictions. */
|
|
988
|
+
allowedCIDRs?: CreateSandboxesV2RequestNetworkPolicyCase0AllowedCIDRsList;
|
|
989
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is blocked from connecting to. These rules take precedence over all allowed rules. */
|
|
990
|
+
deniedCIDRs?: CreateSandboxesV2RequestNetworkPolicyCase0DeniedCIDRsList;
|
|
991
|
+
/** HTTP header injection rules for outgoing requests matching specific domains. Traffic to matching domains will be intercepted instead of proxied through encrypted connections. */
|
|
992
|
+
injectionRules?: CreateSandboxesV2RequestNetworkPolicyCase0InjectionRulesList;
|
|
993
|
+
}
|
|
994
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase0: S.Schema<CreateSandboxesV2RequestNetworkPolicyCase0>;
|
|
995
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase1AllowCase0List = Array<string>;
|
|
996
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase1AllowCase0List: S.Schema<CreateSandboxesV2RequestNetworkPolicyCase1AllowCase0List>;
|
|
997
|
+
/** Match on the request path. Comparison is case-sensitive. */
|
|
998
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchPath = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
999
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchPath: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
1000
|
+
/** HTTP methods to match. Any single match succeeds (OR semantics). */
|
|
1001
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchMethodList = Array<string>;
|
|
1002
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchMethodList: S.Schema<CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchMethodList>;
|
|
1003
|
+
/** Matcher for the entry key (header name or query key). */
|
|
1004
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItemKey = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1005
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItemKey: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
1006
|
+
/** Matcher for the entry value. */
|
|
1007
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItemValue = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1008
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItemValue: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
1009
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItem = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem;
|
|
1010
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
1011
|
+
/** Query-string entry matchers. Multiple entries are ANDed. Query parameter names and values are both compared case-sensitively (RFC 3986). When a request has multiple values for the same key, any matching value satisfies the matcher. */
|
|
1012
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
1013
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringList: S.Schema<CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringList>;
|
|
1014
|
+
/** Matcher for the entry key (header name or query key). */
|
|
1015
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItemKey = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1016
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItemKey: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
1017
|
+
/** Matcher for the entry value. */
|
|
1018
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItemValue = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1019
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItemValue: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
1020
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItem = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem;
|
|
1021
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
1022
|
+
/** Header matchers. Multiple entries are ANDed. Header names are compared case-insensitively (RFC 9110); header values are compared case-sensitively. When a request has multiple values for the same header, any matching value satisfies the matcher. */
|
|
1023
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
1024
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersList: S.Schema<CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersList>;
|
|
1025
|
+
/** Optional L7 match. When provided, the injection rule only applies to requests that satisfy every specified dimension. When multiple injection rules target the same domain they are evaluated in order and the first match wins; a rule without `match` matches any request and shadows later rules for the same domain. */
|
|
1026
|
+
export interface CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatch {
|
|
1027
|
+
/** Match on the request path. Comparison is case-sensitive. */
|
|
1028
|
+
path?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1029
|
+
/** HTTP methods to match. Any single match succeeds (OR semantics). */
|
|
1030
|
+
method?: CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchMethodList;
|
|
1031
|
+
/** Query-string entry matchers. Multiple entries are ANDed. Query parameter names and values are both compared case-sensitively (RFC 3986). When a request has multiple values for the same key, any matching value satisfies the matcher. */
|
|
1032
|
+
queryString?: CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringList;
|
|
1033
|
+
/** Header matchers. Multiple entries are ANDed. Header names are compared case-insensitively (RFC 9110); header values are compared case-sensitively. When a request has multiple values for the same header, any matching value satisfies the matcher. */
|
|
1034
|
+
headers?: CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersList;
|
|
1035
|
+
}
|
|
1036
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatch: S.Schema<CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatch>;
|
|
1037
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemTransformItemHeadersMap = {
|
|
1038
|
+
[key: string]: string | undefined;
|
|
1039
|
+
};
|
|
1040
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemTransformItemHeadersMap: S.Schema<CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemTransformItemHeadersMap>;
|
|
1041
|
+
export interface CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemTransformItem {
|
|
1042
|
+
headers?: CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemTransformItemHeadersMap;
|
|
1043
|
+
}
|
|
1044
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemTransformItem: S.Schema<CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemTransformItem>;
|
|
1045
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemTransformList = Array<CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemTransformItem>;
|
|
1046
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemTransformList: S.Schema<CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemTransformList>;
|
|
1047
|
+
export interface CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItem {
|
|
1048
|
+
/** Optional L7 match. When provided, the injection rule only applies to requests that satisfy every specified dimension. When multiple injection rules target the same domain they are evaluated in order and the first match wins; a rule without `match` matches any request and shadows later rules for the same domain. */
|
|
1049
|
+
match?: CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemMatch;
|
|
1050
|
+
transform?: CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItemTransformList;
|
|
1051
|
+
/** HTTP/1.1 proxy URL to forward traffic to. Must not include username, password, query string, or fragment. */
|
|
1052
|
+
forwardURL?: string;
|
|
1053
|
+
}
|
|
1054
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItem: S.Schema<CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItem>;
|
|
1055
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueList = Array<CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueItem>;
|
|
1056
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueList: S.Schema<CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueList>;
|
|
1057
|
+
/** A rule applied to requests matching a domain in the network policy. Only one of `transform` or `forwardURL` can be specified per rule. */
|
|
1058
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1Map = {
|
|
1059
|
+
[key: string]: CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1ValueList | undefined;
|
|
1060
|
+
};
|
|
1061
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1Map: S.Schema<CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1Map>;
|
|
1062
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase1Allow = CreateSandboxesV2RequestNetworkPolicyCase1AllowCase0List | CreateSandboxesV2RequestNetworkPolicyCase1AllowCase1Map;
|
|
1063
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase1Allow: S.Schema<CreateSandboxesV2RequestNetworkPolicyCase1Allow>;
|
|
1064
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase1SubnetsAllowList = Array<string>;
|
|
1065
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase1SubnetsAllowList: S.Schema<CreateSandboxesV2RequestNetworkPolicyCase1SubnetsAllowList>;
|
|
1066
|
+
export type CreateSandboxesV2RequestNetworkPolicyCase1SubnetsDenyList = Array<string>;
|
|
1067
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase1SubnetsDenyList: S.Schema<CreateSandboxesV2RequestNetworkPolicyCase1SubnetsDenyList>;
|
|
1068
|
+
export interface CreateSandboxesV2RequestNetworkPolicyCase1Subnets {
|
|
1069
|
+
allow?: CreateSandboxesV2RequestNetworkPolicyCase1SubnetsAllowList;
|
|
1070
|
+
deny?: CreateSandboxesV2RequestNetworkPolicyCase1SubnetsDenyList;
|
|
1071
|
+
}
|
|
1072
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase1Subnets: S.Schema<CreateSandboxesV2RequestNetworkPolicyCase1Subnets>;
|
|
1073
|
+
export interface CreateSandboxesV2RequestNetworkPolicyCase1 {
|
|
1074
|
+
allow?: CreateSandboxesV2RequestNetworkPolicyCase1Allow;
|
|
1075
|
+
subnets?: CreateSandboxesV2RequestNetworkPolicyCase1Subnets;
|
|
1076
|
+
}
|
|
1077
|
+
export declare const CreateSandboxesV2RequestNetworkPolicyCase1: S.Schema<CreateSandboxesV2RequestNetworkPolicyCase1>;
|
|
1078
|
+
export type CreateSandboxesV2RequestNetworkPolicy = CreateSandboxesV2RequestNetworkPolicyCase0 | CreateSandboxesV2RequestNetworkPolicyCase1;
|
|
1079
|
+
export declare const CreateSandboxesV2RequestNetworkPolicy: S.Schema<CreateSandboxesV2RequestNetworkPolicy>;
|
|
1080
|
+
/** The runtime environment for the sandbox. Determines the pre-installed language runtimes and tools available. */
|
|
1081
|
+
export type CreateSandboxesV2RequestRuntime = "node22" | "node24" | "node26" | "python3.13";
|
|
1082
|
+
export declare const CreateSandboxesV2RequestRuntime: any;
|
|
1083
|
+
/** Resources to define the VM */
|
|
1084
|
+
export type CreateSandboxesV2RequestResources = CreateSandboxesByNameForkV2RequestResources;
|
|
1085
|
+
export declare const CreateSandboxesV2RequestResources: S.Schema<CreateSandboxesByNameForkV2RequestResources>;
|
|
1086
|
+
/** Clone a Git repository into the sandbox. */
|
|
1087
|
+
export interface CreateSandboxesV2RequestSourceCase0 {
|
|
1088
|
+
/** Indicates the source is a Git repository. */
|
|
1089
|
+
type: unknown;
|
|
1090
|
+
/** The URL of the Git repository to clone. */
|
|
1091
|
+
url: string;
|
|
1092
|
+
/** Username for Git authentication. Required together with password for private repositories. */
|
|
1093
|
+
username?: string;
|
|
1094
|
+
/** Password or personal access token for Git authentication. Required together with username for private repositories. */
|
|
1095
|
+
password?: string | Redacted.Redacted<string>;
|
|
1096
|
+
/** Create a shallow clone with history truncated to the specified number of commits. Useful for faster cloning of large repositories. */
|
|
1097
|
+
depth?: number;
|
|
1098
|
+
/** The specific commit SHA, branch name, or tag to checkout after cloning. */
|
|
1099
|
+
revision?: string;
|
|
1100
|
+
}
|
|
1101
|
+
export declare const CreateSandboxesV2RequestSourceCase0: S.Schema<CreateSandboxesV2RequestSourceCase0>;
|
|
1102
|
+
/** Download and extract a gzipped tarball into the sandbox. */
|
|
1103
|
+
export interface CreateSandboxesV2RequestSourceCase1 {
|
|
1104
|
+
/** Indicates the source is a tarball. */
|
|
1105
|
+
type: unknown;
|
|
1106
|
+
/** URL of a gzipped tarball (.tar.gz) to download and extract. */
|
|
1107
|
+
url: string;
|
|
1108
|
+
}
|
|
1109
|
+
export declare const CreateSandboxesV2RequestSourceCase1: S.Schema<CreateSandboxesV2RequestSourceCase1>;
|
|
1110
|
+
/** Restore the sandbox filesystem from an existing snapshot. */
|
|
1111
|
+
export interface CreateSandboxesV2RequestSourceCase2 {
|
|
1112
|
+
/** Indicates the source is a snapshot. */
|
|
1113
|
+
type: unknown;
|
|
1114
|
+
/** The unique identifier of the snapshot to restore. */
|
|
1115
|
+
snapshotId: string;
|
|
1116
|
+
}
|
|
1117
|
+
export declare const CreateSandboxesV2RequestSourceCase2: S.Schema<CreateSandboxesV2RequestSourceCase2>;
|
|
1118
|
+
/** The source from which to initialize the sandbox filesystem. Can be a Git repository, a tarball URL, or an existing snapshot. */
|
|
1119
|
+
export type CreateSandboxesV2RequestSource = CreateSandboxesV2RequestSourceCase0 | CreateSandboxesV2RequestSourceCase1 | CreateSandboxesV2RequestSourceCase2;
|
|
1120
|
+
export declare const CreateSandboxesV2RequestSource: S.Schema<CreateSandboxesV2RequestSource>;
|
|
1121
|
+
/** List of ports to expose from the sandbox. Each port will be accessible via a unique URL. Maximum of 15 ports can be exposed. */
|
|
1122
|
+
export type CreateSandboxesV2RequestPortsList = Array<number>;
|
|
1123
|
+
export declare const CreateSandboxesV2RequestPortsList: S.Schema<CreateSandboxesV2RequestPortsList>;
|
|
1124
|
+
/** Default environment variables for the sandbox. These are inherited by all commands unless overridden. */
|
|
1125
|
+
export type CreateSandboxesV2RequestEnvMap = {
|
|
1126
|
+
[key: string]: string | undefined;
|
|
1127
|
+
};
|
|
1128
|
+
export declare const CreateSandboxesV2RequestEnvMap: S.Schema<CreateSandboxesV2RequestEnvMap>;
|
|
1129
|
+
/** Mount the drive read-only or read-write. */
|
|
1130
|
+
export type CreateSandboxesV2RequestMountsValueMode = "read-only" | "read-write";
|
|
1131
|
+
export declare const CreateSandboxesV2RequestMountsValueMode: any;
|
|
1132
|
+
export interface CreateSandboxesV2RequestMountsValue {
|
|
1133
|
+
/** Name of the drive to mount. The drive must already exist. */
|
|
1134
|
+
drive: string;
|
|
1135
|
+
/** Mount the drive read-only or read-write. */
|
|
1136
|
+
mode?: CreateSandboxesV2RequestMountsValueMode | (string & {});
|
|
1137
|
+
}
|
|
1138
|
+
export declare const CreateSandboxesV2RequestMountsValue: S.Schema<CreateSandboxesV2RequestMountsValue>;
|
|
1139
|
+
/** List of drives to mount to the sandbox at the provided path. */
|
|
1140
|
+
export type CreateSandboxesV2RequestMountsMap = {
|
|
1141
|
+
[key: string]: CreateSandboxesV2RequestMountsValue | undefined;
|
|
1142
|
+
};
|
|
1143
|
+
export declare const CreateSandboxesV2RequestMountsMap: S.Schema<CreateSandboxesV2RequestMountsMap>;
|
|
1144
|
+
/** The Vercel region in which to create the sandbox. */
|
|
1145
|
+
export type CreateSandboxesV2RequestRegion = "iad1" | "sfo1" | "cle1" | "cdg1" | "fra1" | "arn1" | "sin1" | "pdx1" | "lhr1" | "icn1" | "bom1" | "cpt1" | "dub1" | "gru1" | "hkg1" | "syd1" | "yul1" | "hnd1" | "kix1";
|
|
1146
|
+
export declare const CreateSandboxesV2RequestRegion: any;
|
|
1147
|
+
export type CreateSandboxesV2RequestFailoverRegionsItem = "iad1" | "sfo1" | "cle1" | "cdg1" | "fra1" | "arn1" | "sin1" | "pdx1" | "lhr1" | "icn1" | "bom1" | "cpt1" | "dub1" | "gru1" | "hkg1" | "syd1" | "yul1" | "hnd1" | "kix1";
|
|
1148
|
+
export declare const CreateSandboxesV2RequestFailoverRegionsItem: any;
|
|
1149
|
+
/** The regions the sandbox falls back to when it cannot be created in `region`. */
|
|
1150
|
+
export type CreateSandboxesV2RequestFailoverRegionsList = Array<CreateSandboxesV2RequestFailoverRegionsItem | (string & {})>;
|
|
1151
|
+
export declare const CreateSandboxesV2RequestFailoverRegionsList: S.Schema<CreateSandboxesV2RequestFailoverRegionsList>;
|
|
1152
|
+
/** Default snapshot expiration time in milliseconds. Set to 0 to disable expiration. When set, this value is used as the default expiration for all snapshots created for this sandbox. */
|
|
1153
|
+
export type CreateSandboxesV2RequestSnapshotExpiration = unknown | number;
|
|
1154
|
+
export declare const CreateSandboxesV2RequestSnapshotExpiration: S.Schema<CreateSandboxesV2RequestSnapshotExpiration>;
|
|
1155
|
+
/** Expiration time in milliseconds for kept snapshots. Falls back to snapshotExpiration. */
|
|
1156
|
+
export type CreateSandboxesV2RequestKeepLastSnapshotsExpiration = unknown | number;
|
|
1157
|
+
export declare const CreateSandboxesV2RequestKeepLastSnapshotsExpiration: S.Schema<CreateSandboxesV2RequestKeepLastSnapshotsExpiration>;
|
|
1158
|
+
/** Protect the N most recent snapshots with different expiration/deletion behavior. */
|
|
1159
|
+
export interface CreateSandboxesV2RequestKeepLastSnapshots {
|
|
1160
|
+
/** Number of most recent snapshots to keep. */
|
|
1161
|
+
count: number;
|
|
1162
|
+
/** Expiration time in milliseconds for kept snapshots. Falls back to snapshotExpiration. */
|
|
1163
|
+
expiration?: CreateSandboxesV2RequestKeepLastSnapshotsExpiration;
|
|
1164
|
+
/** Whether to immediately delete evicted snapshots. Defaults to true. */
|
|
1165
|
+
deleteEvicted?: boolean;
|
|
1166
|
+
}
|
|
1167
|
+
export declare const CreateSandboxesV2RequestKeepLastSnapshots: S.Schema<CreateSandboxesV2RequestKeepLastSnapshots>;
|
|
1168
|
+
/** Key-value tags to associate with the sandbox. Maximum 5 tags. */
|
|
1169
|
+
export type CreateSandboxesV2RequestTagsMap = {
|
|
1170
|
+
[key: string]: string | undefined;
|
|
1171
|
+
};
|
|
1172
|
+
export declare const CreateSandboxesV2RequestTagsMap: S.Schema<CreateSandboxesV2RequestTagsMap>;
|
|
1173
|
+
export interface CreateSandboxesV2Request {
|
|
1174
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
1175
|
+
teamId?: string;
|
|
1176
|
+
/** The Team slug to perform the request on behalf of. */
|
|
1177
|
+
slug?: string;
|
|
1178
|
+
networkPolicy?: CreateSandboxesV2RequestNetworkPolicy;
|
|
1179
|
+
/** The runtime environment for the sandbox. Determines the pre-installed language runtimes and tools available. */
|
|
1180
|
+
runtime?: CreateSandboxesV2RequestRuntime | (string & {});
|
|
1181
|
+
/** Resources to define the VM */
|
|
1182
|
+
resources?: CreateSandboxesByNameForkV2RequestResources;
|
|
1183
|
+
/** The source from which to initialize the sandbox filesystem. Can be a Git repository, a tarball URL, or an existing snapshot. */
|
|
1184
|
+
source?: CreateSandboxesV2RequestSource;
|
|
1185
|
+
/** The target project slug or ID in which the sandbox will be assigned to. */
|
|
1186
|
+
projectId?: string;
|
|
1187
|
+
/** List of ports to expose from the sandbox. Each port will be accessible via a unique URL. Maximum of 15 ports can be exposed. */
|
|
1188
|
+
ports?: CreateSandboxesV2RequestPortsList;
|
|
1189
|
+
/** Image to use for the sandbox. */
|
|
1190
|
+
image?: string;
|
|
1191
|
+
/** Maximum duration in milliseconds that the sandbox can run before being automatically stopped. */
|
|
1192
|
+
timeout?: number;
|
|
1193
|
+
/** Default environment variables for the sandbox. These are inherited by all commands unless overridden. */
|
|
1194
|
+
env?: CreateSandboxesV2RequestEnvMap;
|
|
1195
|
+
/** List of drives to mount to the sandbox at the provided path. */
|
|
1196
|
+
mounts?: CreateSandboxesV2RequestMountsMap;
|
|
1197
|
+
/** The Vercel region in which to create the sandbox. */
|
|
1198
|
+
region?: CreateSandboxesV2RequestRegion | (string & {});
|
|
1199
|
+
/** The regions the sandbox falls back to when it cannot be created in `region`. */
|
|
1200
|
+
failoverRegions?: CreateSandboxesV2RequestFailoverRegionsList;
|
|
1201
|
+
/** Name for the sandbox. Must be unique per project and URL-safe (alphanumeric, hyphens, underscores). */
|
|
1202
|
+
name?: string;
|
|
1203
|
+
/** Whether the sandbox persists its state across restarts via automatic snapshots. Defaults to true. */
|
|
1204
|
+
persistent?: boolean;
|
|
1205
|
+
/** Default snapshot expiration time in milliseconds. Set to 0 to disable expiration. When set, this value is used as the default expiration for all snapshots created for this sandbox. */
|
|
1206
|
+
snapshotExpiration?: CreateSandboxesV2RequestSnapshotExpiration;
|
|
1207
|
+
/** Protect the N most recent snapshots with different expiration/deletion behavior. */
|
|
1208
|
+
keepLastSnapshots?: CreateSandboxesV2RequestKeepLastSnapshots;
|
|
1209
|
+
/** Key-value tags to associate with the sandbox. Maximum 5 tags. */
|
|
1210
|
+
tags?: CreateSandboxesV2RequestTagsMap;
|
|
1211
|
+
}
|
|
1212
|
+
export declare const CreateSandboxesV2Request: S.Schema<CreateSandboxesV2Request>;
|
|
1213
|
+
export type CreateSandboxesV2ResponseRoutesList = Array<SandboxPublicRoute>;
|
|
1214
|
+
export declare const CreateSandboxesV2ResponseRoutesList: S.Schema<CreateSandboxesV2ResponseRoutesList>;
|
|
1215
|
+
export interface CreateSandboxesV2Response {
|
|
1216
|
+
sandbox: NamedSandbox;
|
|
1217
|
+
session: Session;
|
|
1218
|
+
routes: CreateSandboxesV2ResponseRoutesList;
|
|
1219
|
+
}
|
|
1220
|
+
export declare const CreateSandboxesV2Response: S.Schema<CreateSandboxesV2Response>;
|
|
1221
|
+
/** The network access policy mode. Use \"allow-all\" to permit all outbound traffic. Use \"deny-all\" to block all outbound traffic. Use \"custom\" to specify explicit allow/deny rules. */
|
|
1222
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase0Mode = "allow-all" | "deny-all" | "custom" | "default-allow" | "default-deny";
|
|
1223
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase0Mode: any;
|
|
1224
|
+
/** List of domain names the sandbox is allowed to connect to. Only applies when mode is \"custom\". Supports wildcard patterns (e.g., \"*.example.com\" matches all subdomains). */
|
|
1225
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase0AllowedDomainsList = Array<string>;
|
|
1226
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase0AllowedDomainsList: S.Schema<CreateSandboxesV3RequestNetworkPolicyCase0AllowedDomainsList>;
|
|
1227
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is allowed to connect to. Traffic to these addresses bypasses domain-based restrictions. */
|
|
1228
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase0AllowedCIDRsList = Array<string>;
|
|
1229
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase0AllowedCIDRsList: S.Schema<CreateSandboxesV3RequestNetworkPolicyCase0AllowedCIDRsList>;
|
|
1230
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is blocked from connecting to. These rules take precedence over all allowed rules. */
|
|
1231
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase0DeniedCIDRsList = Array<string>;
|
|
1232
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase0DeniedCIDRsList: S.Schema<CreateSandboxesV3RequestNetworkPolicyCase0DeniedCIDRsList>;
|
|
1233
|
+
/** HTTP headers to inject into requests for this domain. Existing headers with the same name will be overridden. */
|
|
1234
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemHeadersMap = {
|
|
1235
|
+
[key: string]: string | undefined;
|
|
1236
|
+
};
|
|
1237
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemHeadersMap: S.Schema<CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemHeadersMap>;
|
|
1238
|
+
/** Match on the request path. Comparison is case-sensitive. */
|
|
1239
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatchPath = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1240
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatchPath: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
1241
|
+
/** HTTP methods to match. Any single match succeeds (OR semantics). */
|
|
1242
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatchMethodList = Array<string>;
|
|
1243
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatchMethodList: S.Schema<CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatchMethodList>;
|
|
1244
|
+
/** Matcher for the entry key (header name or query key). */
|
|
1245
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItemKey = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1246
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItemKey: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
1247
|
+
/** Matcher for the entry value. */
|
|
1248
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItemValue = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1249
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItemValue: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
1250
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem;
|
|
1251
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
1252
|
+
/** Query-string entry matchers. Multiple entries are ANDed. Query parameter names and values are both compared case-sensitively (RFC 3986). When a request has multiple values for the same key, any matching value satisfies the matcher. */
|
|
1253
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
1254
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringList: S.Schema<CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringList>;
|
|
1255
|
+
/** Matcher for the entry key (header name or query key). */
|
|
1256
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItemKey = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1257
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItemKey: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
1258
|
+
/** Matcher for the entry value. */
|
|
1259
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItemValue = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1260
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItemValue: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
1261
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItem = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem;
|
|
1262
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
1263
|
+
/** Header matchers. Multiple entries are ANDed. Header names are compared case-insensitively (RFC 9110); header values are compared case-sensitively. When a request has multiple values for the same header, any matching value satisfies the matcher. */
|
|
1264
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
1265
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersList: S.Schema<CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersList>;
|
|
1266
|
+
/** Optional L7 match. When provided, the injection rule only applies to requests that satisfy every specified dimension. When multiple injection rules target the same domain they are evaluated in order and the first match wins; a rule without `match` matches any request and shadows later rules for the same domain. */
|
|
1267
|
+
export interface CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatch {
|
|
1268
|
+
/** Match on the request path. Comparison is case-sensitive. */
|
|
1269
|
+
path?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1270
|
+
/** HTTP methods to match. Any single match succeeds (OR semantics). */
|
|
1271
|
+
method?: CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatchMethodList;
|
|
1272
|
+
/** Query-string entry matchers. Multiple entries are ANDed. Query parameter names and values are both compared case-sensitively (RFC 3986). When a request has multiple values for the same key, any matching value satisfies the matcher. */
|
|
1273
|
+
queryString?: CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringList;
|
|
1274
|
+
/** Header matchers. Multiple entries are ANDed. Header names are compared case-insensitively (RFC 9110); header values are compared case-sensitively. When a request has multiple values for the same header, any matching value satisfies the matcher. */
|
|
1275
|
+
headers?: CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersList;
|
|
1276
|
+
}
|
|
1277
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatch: S.Schema<CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatch>;
|
|
1278
|
+
export interface CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItem {
|
|
1279
|
+
/** The domain (or pattern) of requests to add headers for. Supports wildcards like *.example.com. */
|
|
1280
|
+
domain: string;
|
|
1281
|
+
/** HTTP headers to inject into requests for this domain. Existing headers with the same name will be overridden. */
|
|
1282
|
+
headers: CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemHeadersMap;
|
|
1283
|
+
/** Optional L7 match. When provided, the injection rule only applies to requests that satisfy every specified dimension. When multiple injection rules target the same domain they are evaluated in order and the first match wins; a rule without `match` matches any request and shadows later rules for the same domain. */
|
|
1284
|
+
match?: CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItemMatch;
|
|
1285
|
+
}
|
|
1286
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItem: S.Schema<CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItem>;
|
|
1287
|
+
/** HTTP header injection rules for outgoing requests matching specific domains. Traffic to matching domains will be intercepted instead of proxied through encrypted connections. */
|
|
1288
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesList = Array<CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesItem>;
|
|
1289
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesList: S.Schema<CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesList>;
|
|
1290
|
+
/** Network access policy for the sandbox.\n Controls which external hosts the sandbox can communicate with.\n Use \"allow-all\" mode to allow all traffic, \"deny-all\" to block all traffic or \"custom\" to provide specific rules. */
|
|
1291
|
+
export interface CreateSandboxesV3RequestNetworkPolicyCase0 {
|
|
1292
|
+
/** The network access policy mode. Use \"allow-all\" to permit all outbound traffic. Use \"deny-all\" to block all outbound traffic. Use \"custom\" to specify explicit allow/deny rules. */
|
|
1293
|
+
mode: CreateSandboxesV3RequestNetworkPolicyCase0Mode | (string & {});
|
|
1294
|
+
/** List of domain names the sandbox is allowed to connect to. Only applies when mode is \"custom\". Supports wildcard patterns (e.g., \"*.example.com\" matches all subdomains). */
|
|
1295
|
+
allowedDomains?: CreateSandboxesV3RequestNetworkPolicyCase0AllowedDomainsList;
|
|
1296
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is allowed to connect to. Traffic to these addresses bypasses domain-based restrictions. */
|
|
1297
|
+
allowedCIDRs?: CreateSandboxesV3RequestNetworkPolicyCase0AllowedCIDRsList;
|
|
1298
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is blocked from connecting to. These rules take precedence over all allowed rules. */
|
|
1299
|
+
deniedCIDRs?: CreateSandboxesV3RequestNetworkPolicyCase0DeniedCIDRsList;
|
|
1300
|
+
/** HTTP header injection rules for outgoing requests matching specific domains. Traffic to matching domains will be intercepted instead of proxied through encrypted connections. */
|
|
1301
|
+
injectionRules?: CreateSandboxesV3RequestNetworkPolicyCase0InjectionRulesList;
|
|
1302
|
+
}
|
|
1303
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase0: S.Schema<CreateSandboxesV3RequestNetworkPolicyCase0>;
|
|
1304
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase1AllowCase0List = Array<string>;
|
|
1305
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase1AllowCase0List: S.Schema<CreateSandboxesV3RequestNetworkPolicyCase1AllowCase0List>;
|
|
1306
|
+
/** Match on the request path. Comparison is case-sensitive. */
|
|
1307
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchPath = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1308
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchPath: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
1309
|
+
/** HTTP methods to match. Any single match succeeds (OR semantics). */
|
|
1310
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchMethodList = Array<string>;
|
|
1311
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchMethodList: S.Schema<CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchMethodList>;
|
|
1312
|
+
/** Matcher for the entry key (header name or query key). */
|
|
1313
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItemKey = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1314
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItemKey: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
1315
|
+
/** Matcher for the entry value. */
|
|
1316
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItemValue = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1317
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItemValue: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
1318
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItem = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem;
|
|
1319
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
1320
|
+
/** Query-string entry matchers. Multiple entries are ANDed. Query parameter names and values are both compared case-sensitively (RFC 3986). When a request has multiple values for the same key, any matching value satisfies the matcher. */
|
|
1321
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
1322
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringList: S.Schema<CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringList>;
|
|
1323
|
+
/** Matcher for the entry key (header name or query key). */
|
|
1324
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItemKey = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1325
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItemKey: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
1326
|
+
/** Matcher for the entry value. */
|
|
1327
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItemValue = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1328
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItemValue: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
1329
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItem = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem;
|
|
1330
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
1331
|
+
/** Header matchers. Multiple entries are ANDed. Header names are compared case-insensitively (RFC 9110); header values are compared case-sensitively. When a request has multiple values for the same header, any matching value satisfies the matcher. */
|
|
1332
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
1333
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersList: S.Schema<CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersList>;
|
|
1334
|
+
/** Optional L7 match. When provided, the injection rule only applies to requests that satisfy every specified dimension. When multiple injection rules target the same domain they are evaluated in order and the first match wins; a rule without `match` matches any request and shadows later rules for the same domain. */
|
|
1335
|
+
export interface CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatch {
|
|
1336
|
+
/** Match on the request path. Comparison is case-sensitive. */
|
|
1337
|
+
path?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1338
|
+
/** HTTP methods to match. Any single match succeeds (OR semantics). */
|
|
1339
|
+
method?: CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchMethodList;
|
|
1340
|
+
/** Query-string entry matchers. Multiple entries are ANDed. Query parameter names and values are both compared case-sensitively (RFC 3986). When a request has multiple values for the same key, any matching value satisfies the matcher. */
|
|
1341
|
+
queryString?: CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringList;
|
|
1342
|
+
/** Header matchers. Multiple entries are ANDed. Header names are compared case-insensitively (RFC 9110); header values are compared case-sensitively. When a request has multiple values for the same header, any matching value satisfies the matcher. */
|
|
1343
|
+
headers?: CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersList;
|
|
1344
|
+
}
|
|
1345
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatch: S.Schema<CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatch>;
|
|
1346
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemTransformItemHeadersMap = {
|
|
1347
|
+
[key: string]: string | undefined;
|
|
1348
|
+
};
|
|
1349
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemTransformItemHeadersMap: S.Schema<CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemTransformItemHeadersMap>;
|
|
1350
|
+
export interface CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemTransformItem {
|
|
1351
|
+
headers?: CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemTransformItemHeadersMap;
|
|
1352
|
+
}
|
|
1353
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemTransformItem: S.Schema<CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemTransformItem>;
|
|
1354
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemTransformList = Array<CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemTransformItem>;
|
|
1355
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemTransformList: S.Schema<CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemTransformList>;
|
|
1356
|
+
export interface CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItem {
|
|
1357
|
+
/** Optional L7 match. When provided, the injection rule only applies to requests that satisfy every specified dimension. When multiple injection rules target the same domain they are evaluated in order and the first match wins; a rule without `match` matches any request and shadows later rules for the same domain. */
|
|
1358
|
+
match?: CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemMatch;
|
|
1359
|
+
transform?: CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItemTransformList;
|
|
1360
|
+
/** HTTP/1.1 proxy URL to forward traffic to. Must not include username, password, query string, or fragment. */
|
|
1361
|
+
forwardURL?: string;
|
|
1362
|
+
}
|
|
1363
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItem: S.Schema<CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItem>;
|
|
1364
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueList = Array<CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueItem>;
|
|
1365
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueList: S.Schema<CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueList>;
|
|
1366
|
+
/** A rule applied to requests matching a domain in the network policy. Only one of `transform` or `forwardURL` can be specified per rule. */
|
|
1367
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1Map = {
|
|
1368
|
+
[key: string]: CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1ValueList | undefined;
|
|
1369
|
+
};
|
|
1370
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1Map: S.Schema<CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1Map>;
|
|
1371
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase1Allow = CreateSandboxesV3RequestNetworkPolicyCase1AllowCase0List | CreateSandboxesV3RequestNetworkPolicyCase1AllowCase1Map;
|
|
1372
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase1Allow: S.Schema<CreateSandboxesV3RequestNetworkPolicyCase1Allow>;
|
|
1373
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase1SubnetsAllowList = Array<string>;
|
|
1374
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase1SubnetsAllowList: S.Schema<CreateSandboxesV3RequestNetworkPolicyCase1SubnetsAllowList>;
|
|
1375
|
+
export type CreateSandboxesV3RequestNetworkPolicyCase1SubnetsDenyList = Array<string>;
|
|
1376
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase1SubnetsDenyList: S.Schema<CreateSandboxesV3RequestNetworkPolicyCase1SubnetsDenyList>;
|
|
1377
|
+
export interface CreateSandboxesV3RequestNetworkPolicyCase1Subnets {
|
|
1378
|
+
allow?: CreateSandboxesV3RequestNetworkPolicyCase1SubnetsAllowList;
|
|
1379
|
+
deny?: CreateSandboxesV3RequestNetworkPolicyCase1SubnetsDenyList;
|
|
1380
|
+
}
|
|
1381
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase1Subnets: S.Schema<CreateSandboxesV3RequestNetworkPolicyCase1Subnets>;
|
|
1382
|
+
export interface CreateSandboxesV3RequestNetworkPolicyCase1 {
|
|
1383
|
+
allow?: CreateSandboxesV3RequestNetworkPolicyCase1Allow;
|
|
1384
|
+
subnets?: CreateSandboxesV3RequestNetworkPolicyCase1Subnets;
|
|
1385
|
+
}
|
|
1386
|
+
export declare const CreateSandboxesV3RequestNetworkPolicyCase1: S.Schema<CreateSandboxesV3RequestNetworkPolicyCase1>;
|
|
1387
|
+
export type CreateSandboxesV3RequestNetworkPolicy = CreateSandboxesV3RequestNetworkPolicyCase0 | CreateSandboxesV3RequestNetworkPolicyCase1;
|
|
1388
|
+
export declare const CreateSandboxesV3RequestNetworkPolicy: S.Schema<CreateSandboxesV3RequestNetworkPolicy>;
|
|
1389
|
+
/** Resources to define the VM */
|
|
1390
|
+
export type CreateSandboxesV3RequestResources = CreateSandboxesByNameForkV2RequestResources;
|
|
1391
|
+
export declare const CreateSandboxesV3RequestResources: S.Schema<CreateSandboxesByNameForkV2RequestResources>;
|
|
1392
|
+
/** Clone a Git repository into the sandbox. */
|
|
1393
|
+
export type CreateSandboxesV3RequestSourceCase0 = CreateSandboxesV2RequestSourceCase0;
|
|
1394
|
+
export declare const CreateSandboxesV3RequestSourceCase0: S.Schema<CreateSandboxesV2RequestSourceCase0>;
|
|
1395
|
+
/** Download and extract a gzipped tarball into the sandbox. */
|
|
1396
|
+
export type CreateSandboxesV3RequestSourceCase1 = CreateSandboxesV2RequestSourceCase1;
|
|
1397
|
+
export declare const CreateSandboxesV3RequestSourceCase1: S.Schema<CreateSandboxesV2RequestSourceCase1>;
|
|
1398
|
+
/** Restore the sandbox filesystem from an existing snapshot. */
|
|
1399
|
+
export type CreateSandboxesV3RequestSourceCase2 = CreateSandboxesV2RequestSourceCase2;
|
|
1400
|
+
export declare const CreateSandboxesV3RequestSourceCase2: S.Schema<CreateSandboxesV2RequestSourceCase2>;
|
|
1401
|
+
/** The source from which to initialize the sandbox filesystem. Can be a Git repository, a tarball URL, or an existing snapshot. */
|
|
1402
|
+
export type CreateSandboxesV3RequestSource = CreateSandboxesV2RequestSourceCase0 | CreateSandboxesV2RequestSourceCase1 | CreateSandboxesV2RequestSourceCase2;
|
|
1403
|
+
export declare const CreateSandboxesV3RequestSource: S.Schema<CreateSandboxesV3RequestSource>;
|
|
1404
|
+
/** List of ports to expose from the sandbox. Each port will be accessible via a unique URL. Maximum of 15 ports can be exposed. */
|
|
1405
|
+
export type CreateSandboxesV3RequestPortsList = Array<number>;
|
|
1406
|
+
export declare const CreateSandboxesV3RequestPortsList: S.Schema<CreateSandboxesV3RequestPortsList>;
|
|
1407
|
+
/** Default environment variables for the sandbox. These are inherited by all commands unless overridden. */
|
|
1408
|
+
export type CreateSandboxesV3RequestEnvMap = {
|
|
1409
|
+
[key: string]: string | undefined;
|
|
1410
|
+
};
|
|
1411
|
+
export declare const CreateSandboxesV3RequestEnvMap: S.Schema<CreateSandboxesV3RequestEnvMap>;
|
|
1412
|
+
/** Mount the drive read-only or read-write. */
|
|
1413
|
+
export type CreateSandboxesV3RequestMountsValueMode = "read-only" | "read-write";
|
|
1414
|
+
export declare const CreateSandboxesV3RequestMountsValueMode: any;
|
|
1415
|
+
export interface CreateSandboxesV3RequestMountsValue {
|
|
1416
|
+
/** Name of the drive to mount. The drive must already exist. */
|
|
1417
|
+
drive: string;
|
|
1418
|
+
/** Mount the drive read-only or read-write. */
|
|
1419
|
+
mode?: CreateSandboxesV3RequestMountsValueMode | (string & {});
|
|
1420
|
+
}
|
|
1421
|
+
export declare const CreateSandboxesV3RequestMountsValue: S.Schema<CreateSandboxesV3RequestMountsValue>;
|
|
1422
|
+
/** List of drives to mount to the sandbox at the provided path. */
|
|
1423
|
+
export type CreateSandboxesV3RequestMountsMap = {
|
|
1424
|
+
[key: string]: CreateSandboxesV3RequestMountsValue | undefined;
|
|
1425
|
+
};
|
|
1426
|
+
export declare const CreateSandboxesV3RequestMountsMap: S.Schema<CreateSandboxesV3RequestMountsMap>;
|
|
1427
|
+
/** The Vercel region in which to create the sandbox. */
|
|
1428
|
+
export type CreateSandboxesV3RequestRegion = "iad1" | "sfo1" | "cle1" | "cdg1" | "fra1" | "arn1" | "sin1" | "pdx1" | "lhr1" | "icn1" | "bom1" | "cpt1" | "dub1" | "gru1" | "hkg1" | "syd1" | "yul1" | "hnd1" | "kix1";
|
|
1429
|
+
export declare const CreateSandboxesV3RequestRegion: any;
|
|
1430
|
+
export type CreateSandboxesV3RequestFailoverRegionsItem = "iad1" | "sfo1" | "cle1" | "cdg1" | "fra1" | "arn1" | "sin1" | "pdx1" | "lhr1" | "icn1" | "bom1" | "cpt1" | "dub1" | "gru1" | "hkg1" | "syd1" | "yul1" | "hnd1" | "kix1";
|
|
1431
|
+
export declare const CreateSandboxesV3RequestFailoverRegionsItem: any;
|
|
1432
|
+
/** The regions the sandbox falls back to when it cannot be created in `region`. */
|
|
1433
|
+
export type CreateSandboxesV3RequestFailoverRegionsList = Array<CreateSandboxesV3RequestFailoverRegionsItem | (string & {})>;
|
|
1434
|
+
export declare const CreateSandboxesV3RequestFailoverRegionsList: S.Schema<CreateSandboxesV3RequestFailoverRegionsList>;
|
|
1435
|
+
/** Default snapshot expiration time in milliseconds. Set to 0 to disable expiration. When set, this value is used as the default expiration for all snapshots created for this sandbox. */
|
|
1436
|
+
export type CreateSandboxesV3RequestSnapshotExpiration = unknown | number;
|
|
1437
|
+
export declare const CreateSandboxesV3RequestSnapshotExpiration: S.Schema<CreateSandboxesV3RequestSnapshotExpiration>;
|
|
1438
|
+
/** Expiration time in milliseconds for kept snapshots. Falls back to snapshotExpiration. */
|
|
1439
|
+
export type CreateSandboxesV3RequestKeepLastSnapshotsExpiration = unknown | number;
|
|
1440
|
+
export declare const CreateSandboxesV3RequestKeepLastSnapshotsExpiration: S.Schema<CreateSandboxesV3RequestKeepLastSnapshotsExpiration>;
|
|
1441
|
+
/** Protect the N most recent snapshots with different expiration/deletion behavior. */
|
|
1442
|
+
export interface CreateSandboxesV3RequestKeepLastSnapshots {
|
|
1443
|
+
/** Number of most recent snapshots to keep. */
|
|
1444
|
+
count: number;
|
|
1445
|
+
/** Expiration time in milliseconds for kept snapshots. Falls back to snapshotExpiration. */
|
|
1446
|
+
expiration?: CreateSandboxesV3RequestKeepLastSnapshotsExpiration;
|
|
1447
|
+
/** Whether to immediately delete evicted snapshots. Defaults to true. */
|
|
1448
|
+
deleteEvicted?: boolean;
|
|
1449
|
+
}
|
|
1450
|
+
export declare const CreateSandboxesV3RequestKeepLastSnapshots: S.Schema<CreateSandboxesV3RequestKeepLastSnapshots>;
|
|
1451
|
+
/** Key-value tags to associate with the sandbox. Maximum 5 tags. */
|
|
1452
|
+
export type CreateSandboxesV3RequestTagsMap = {
|
|
1453
|
+
[key: string]: string | undefined;
|
|
1454
|
+
};
|
|
1455
|
+
export declare const CreateSandboxesV3RequestTagsMap: S.Schema<CreateSandboxesV3RequestTagsMap>;
|
|
1456
|
+
export interface CreateSandboxesV3Request {
|
|
1457
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
1458
|
+
teamId?: string;
|
|
1459
|
+
/** The Team slug to perform the request on behalf of. */
|
|
1460
|
+
slug?: string;
|
|
1461
|
+
networkPolicy?: CreateSandboxesV3RequestNetworkPolicy;
|
|
1462
|
+
/** Resources to define the VM */
|
|
1463
|
+
resources?: CreateSandboxesByNameForkV2RequestResources;
|
|
1464
|
+
/** The source from which to initialize the sandbox filesystem. Can be a Git repository, a tarball URL, or an existing snapshot. */
|
|
1465
|
+
source?: CreateSandboxesV3RequestSource;
|
|
1466
|
+
/** The target project slug or ID in which the sandbox will be assigned to. */
|
|
1467
|
+
projectId?: string;
|
|
1468
|
+
/** List of ports to expose from the sandbox. Each port will be accessible via a unique URL. Maximum of 15 ports can be exposed. */
|
|
1469
|
+
ports?: CreateSandboxesV3RequestPortsList;
|
|
1470
|
+
/** Image to use for the sandbox. */
|
|
1471
|
+
image?: string;
|
|
1472
|
+
/** Maximum duration in milliseconds that the sandbox can run before being automatically stopped. */
|
|
1473
|
+
timeout?: number;
|
|
1474
|
+
/** Default environment variables for the sandbox. These are inherited by all commands unless overridden. */
|
|
1475
|
+
env?: CreateSandboxesV3RequestEnvMap;
|
|
1476
|
+
/** List of drives to mount to the sandbox at the provided path. */
|
|
1477
|
+
mounts?: CreateSandboxesV3RequestMountsMap;
|
|
1478
|
+
/** The Vercel region in which to create the sandbox. */
|
|
1479
|
+
region?: CreateSandboxesV3RequestRegion | (string & {});
|
|
1480
|
+
/** The regions the sandbox falls back to when it cannot be created in `region`. */
|
|
1481
|
+
failoverRegions?: CreateSandboxesV3RequestFailoverRegionsList;
|
|
1482
|
+
/** Name for the sandbox. Must be unique per project and URL-safe (alphanumeric, hyphens, underscores). */
|
|
1483
|
+
name?: string;
|
|
1484
|
+
/** Whether the sandbox persists its state across restarts via automatic snapshots. Defaults to true. */
|
|
1485
|
+
persistent?: boolean;
|
|
1486
|
+
/** Default snapshot expiration time in milliseconds. Set to 0 to disable expiration. When set, this value is used as the default expiration for all snapshots created for this sandbox. */
|
|
1487
|
+
snapshotExpiration?: CreateSandboxesV3RequestSnapshotExpiration;
|
|
1488
|
+
/** Protect the N most recent snapshots with different expiration/deletion behavior. */
|
|
1489
|
+
keepLastSnapshots?: CreateSandboxesV3RequestKeepLastSnapshots;
|
|
1490
|
+
/** Key-value tags to associate with the sandbox. Maximum 5 tags. */
|
|
1491
|
+
tags?: CreateSandboxesV3RequestTagsMap;
|
|
1492
|
+
}
|
|
1493
|
+
export declare const CreateSandboxesV3Request: S.Schema<CreateSandboxesV3Request>;
|
|
1494
|
+
export type CreateSandboxesV3ResponseRoutesList = Array<SandboxPublicRoute>;
|
|
1495
|
+
export declare const CreateSandboxesV3ResponseRoutesList: S.Schema<CreateSandboxesV3ResponseRoutesList>;
|
|
1496
|
+
export interface CreateSandboxesV3Response {
|
|
1497
|
+
sandbox: NamedSandbox;
|
|
1498
|
+
session: Session;
|
|
1499
|
+
routes: CreateSandboxesV3ResponseRoutesList;
|
|
1500
|
+
}
|
|
1501
|
+
export declare const CreateSandboxesV3Response: S.Schema<CreateSandboxesV3Response>;
|
|
1502
|
+
/** The network access policy mode. Use \"allow-all\" to permit all outbound traffic. Use \"deny-all\" to block all outbound traffic. Use \"custom\" to specify explicit allow/deny rules. */
|
|
1503
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase0Mode = "allow-all" | "deny-all" | "custom" | "default-allow" | "default-deny";
|
|
1504
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase0Mode: any;
|
|
1505
|
+
/** List of domain names the sandbox is allowed to connect to. Only applies when mode is \"custom\". Supports wildcard patterns (e.g., \"*.example.com\" matches all subdomains). */
|
|
1506
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase0AllowedDomainsList = Array<string>;
|
|
1507
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase0AllowedDomainsList: S.Schema<CreateSandboxesV4RequestNetworkPolicyCase0AllowedDomainsList>;
|
|
1508
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is allowed to connect to. Traffic to these addresses bypasses domain-based restrictions. */
|
|
1509
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase0AllowedCIDRsList = Array<string>;
|
|
1510
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase0AllowedCIDRsList: S.Schema<CreateSandboxesV4RequestNetworkPolicyCase0AllowedCIDRsList>;
|
|
1511
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is blocked from connecting to. These rules take precedence over all allowed rules. */
|
|
1512
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase0DeniedCIDRsList = Array<string>;
|
|
1513
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase0DeniedCIDRsList: S.Schema<CreateSandboxesV4RequestNetworkPolicyCase0DeniedCIDRsList>;
|
|
1514
|
+
/** HTTP headers to inject into requests for this domain. Existing headers with the same name will be overridden. */
|
|
1515
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemHeadersMap = {
|
|
1516
|
+
[key: string]: string | undefined;
|
|
1517
|
+
};
|
|
1518
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemHeadersMap: S.Schema<CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemHeadersMap>;
|
|
1519
|
+
/** Match on the request path. Comparison is case-sensitive. */
|
|
1520
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatchPath = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1521
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatchPath: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
1522
|
+
/** HTTP methods to match. Any single match succeeds (OR semantics). */
|
|
1523
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatchMethodList = Array<string>;
|
|
1524
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatchMethodList: S.Schema<CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatchMethodList>;
|
|
1525
|
+
/** Matcher for the entry key (header name or query key). */
|
|
1526
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItemKey = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1527
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItemKey: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
1528
|
+
/** Matcher for the entry value. */
|
|
1529
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItemValue = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1530
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItemValue: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
1531
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem;
|
|
1532
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
1533
|
+
/** Query-string entry matchers. Multiple entries are ANDed. Query parameter names and values are both compared case-sensitively (RFC 3986). When a request has multiple values for the same key, any matching value satisfies the matcher. */
|
|
1534
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
1535
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringList: S.Schema<CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringList>;
|
|
1536
|
+
/** Matcher for the entry key (header name or query key). */
|
|
1537
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItemKey = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1538
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItemKey: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
1539
|
+
/** Matcher for the entry value. */
|
|
1540
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItemValue = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1541
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItemValue: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
1542
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItem = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem;
|
|
1543
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
1544
|
+
/** Header matchers. Multiple entries are ANDed. Header names are compared case-insensitively (RFC 9110); header values are compared case-sensitively. When a request has multiple values for the same header, any matching value satisfies the matcher. */
|
|
1545
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
1546
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersList: S.Schema<CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersList>;
|
|
1547
|
+
/** Optional L7 match. When provided, the injection rule only applies to requests that satisfy every specified dimension. When multiple injection rules target the same domain they are evaluated in order and the first match wins; a rule without `match` matches any request and shadows later rules for the same domain. */
|
|
1548
|
+
export interface CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatch {
|
|
1549
|
+
/** Match on the request path. Comparison is case-sensitive. */
|
|
1550
|
+
path?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1551
|
+
/** HTTP methods to match. Any single match succeeds (OR semantics). */
|
|
1552
|
+
method?: CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatchMethodList;
|
|
1553
|
+
/** Query-string entry matchers. Multiple entries are ANDed. Query parameter names and values are both compared case-sensitively (RFC 3986). When a request has multiple values for the same key, any matching value satisfies the matcher. */
|
|
1554
|
+
queryString?: CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringList;
|
|
1555
|
+
/** Header matchers. Multiple entries are ANDed. Header names are compared case-insensitively (RFC 9110); header values are compared case-sensitively. When a request has multiple values for the same header, any matching value satisfies the matcher. */
|
|
1556
|
+
headers?: CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatchHeadersList;
|
|
1557
|
+
}
|
|
1558
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatch: S.Schema<CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatch>;
|
|
1559
|
+
export interface CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItem {
|
|
1560
|
+
/** The domain (or pattern) of requests to add headers for. Supports wildcards like *.example.com. */
|
|
1561
|
+
domain: string;
|
|
1562
|
+
/** HTTP headers to inject into requests for this domain. Existing headers with the same name will be overridden. */
|
|
1563
|
+
headers: CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemHeadersMap;
|
|
1564
|
+
/** Optional L7 match. When provided, the injection rule only applies to requests that satisfy every specified dimension. When multiple injection rules target the same domain they are evaluated in order and the first match wins; a rule without `match` matches any request and shadows later rules for the same domain. */
|
|
1565
|
+
match?: CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItemMatch;
|
|
1566
|
+
}
|
|
1567
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItem: S.Schema<CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItem>;
|
|
1568
|
+
/** HTTP header injection rules for outgoing requests matching specific domains. Traffic to matching domains will be intercepted instead of proxied through encrypted connections. */
|
|
1569
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesList = Array<CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesItem>;
|
|
1570
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesList: S.Schema<CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesList>;
|
|
1571
|
+
/** Network access policy for the sandbox.\n Controls which external hosts the sandbox can communicate with.\n Use \"allow-all\" mode to allow all traffic, \"deny-all\" to block all traffic or \"custom\" to provide specific rules. */
|
|
1572
|
+
export interface CreateSandboxesV4RequestNetworkPolicyCase0 {
|
|
1573
|
+
/** The network access policy mode. Use \"allow-all\" to permit all outbound traffic. Use \"deny-all\" to block all outbound traffic. Use \"custom\" to specify explicit allow/deny rules. */
|
|
1574
|
+
mode: CreateSandboxesV4RequestNetworkPolicyCase0Mode | (string & {});
|
|
1575
|
+
/** List of domain names the sandbox is allowed to connect to. Only applies when mode is \"custom\". Supports wildcard patterns (e.g., \"*.example.com\" matches all subdomains). */
|
|
1576
|
+
allowedDomains?: CreateSandboxesV4RequestNetworkPolicyCase0AllowedDomainsList;
|
|
1577
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is allowed to connect to. Traffic to these addresses bypasses domain-based restrictions. */
|
|
1578
|
+
allowedCIDRs?: CreateSandboxesV4RequestNetworkPolicyCase0AllowedCIDRsList;
|
|
1579
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is blocked from connecting to. These rules take precedence over all allowed rules. */
|
|
1580
|
+
deniedCIDRs?: CreateSandboxesV4RequestNetworkPolicyCase0DeniedCIDRsList;
|
|
1581
|
+
/** HTTP header injection rules for outgoing requests matching specific domains. Traffic to matching domains will be intercepted instead of proxied through encrypted connections. */
|
|
1582
|
+
injectionRules?: CreateSandboxesV4RequestNetworkPolicyCase0InjectionRulesList;
|
|
1583
|
+
}
|
|
1584
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase0: S.Schema<CreateSandboxesV4RequestNetworkPolicyCase0>;
|
|
1585
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase1AllowCase0List = Array<string>;
|
|
1586
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase1AllowCase0List: S.Schema<CreateSandboxesV4RequestNetworkPolicyCase1AllowCase0List>;
|
|
1587
|
+
/** Match on the request path. Comparison is case-sensitive. */
|
|
1588
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatchPath = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1589
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatchPath: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
1590
|
+
/** HTTP methods to match. Any single match succeeds (OR semantics). */
|
|
1591
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatchMethodList = Array<string>;
|
|
1592
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatchMethodList: S.Schema<CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatchMethodList>;
|
|
1593
|
+
/** Matcher for the entry key (header name or query key). */
|
|
1594
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItemKey = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1595
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItemKey: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
1596
|
+
/** Matcher for the entry value. */
|
|
1597
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItemValue = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1598
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItemValue: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
1599
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItem = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem;
|
|
1600
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
1601
|
+
/** Query-string entry matchers. Multiple entries are ANDed. Query parameter names and values are both compared case-sensitively (RFC 3986). When a request has multiple values for the same key, any matching value satisfies the matcher. */
|
|
1602
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
1603
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringList: S.Schema<CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringList>;
|
|
1604
|
+
/** Matcher for the entry key (header name or query key). */
|
|
1605
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItemKey = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1606
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItemKey: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
1607
|
+
/** Matcher for the entry value. */
|
|
1608
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItemValue = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1609
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItemValue: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
1610
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItem = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem;
|
|
1611
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
1612
|
+
/** Header matchers. Multiple entries are ANDed. Header names are compared case-insensitively (RFC 9110); header values are compared case-sensitively. When a request has multiple values for the same header, any matching value satisfies the matcher. */
|
|
1613
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
1614
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersList: S.Schema<CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersList>;
|
|
1615
|
+
/** Optional L7 match. When provided, the injection rule only applies to requests that satisfy every specified dimension. When multiple injection rules target the same domain they are evaluated in order and the first match wins; a rule without `match` matches any request and shadows later rules for the same domain. */
|
|
1616
|
+
export interface CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatch {
|
|
1617
|
+
/** Match on the request path. Comparison is case-sensitive. */
|
|
1618
|
+
path?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
1619
|
+
/** HTTP methods to match. Any single match succeeds (OR semantics). */
|
|
1620
|
+
method?: CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatchMethodList;
|
|
1621
|
+
/** Query-string entry matchers. Multiple entries are ANDed. Query parameter names and values are both compared case-sensitively (RFC 3986). When a request has multiple values for the same key, any matching value satisfies the matcher. */
|
|
1622
|
+
queryString?: CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringList;
|
|
1623
|
+
/** Header matchers. Multiple entries are ANDed. Header names are compared case-insensitively (RFC 9110); header values are compared case-sensitively. When a request has multiple values for the same header, any matching value satisfies the matcher. */
|
|
1624
|
+
headers?: CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersList;
|
|
1625
|
+
}
|
|
1626
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatch: S.Schema<CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatch>;
|
|
1627
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemTransformItemHeadersMap = {
|
|
1628
|
+
[key: string]: string | undefined;
|
|
1629
|
+
};
|
|
1630
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemTransformItemHeadersMap: S.Schema<CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemTransformItemHeadersMap>;
|
|
1631
|
+
export interface CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemTransformItem {
|
|
1632
|
+
headers?: CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemTransformItemHeadersMap;
|
|
1633
|
+
}
|
|
1634
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemTransformItem: S.Schema<CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemTransformItem>;
|
|
1635
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemTransformList = Array<CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemTransformItem>;
|
|
1636
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemTransformList: S.Schema<CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemTransformList>;
|
|
1637
|
+
export interface CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItem {
|
|
1638
|
+
/** Optional L7 match. When provided, the injection rule only applies to requests that satisfy every specified dimension. When multiple injection rules target the same domain they are evaluated in order and the first match wins; a rule without `match` matches any request and shadows later rules for the same domain. */
|
|
1639
|
+
match?: CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemMatch;
|
|
1640
|
+
transform?: CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItemTransformList;
|
|
1641
|
+
/** HTTP/1.1 proxy URL to forward traffic to. Must not include username, password, query string, or fragment. */
|
|
1642
|
+
forwardURL?: string;
|
|
1643
|
+
}
|
|
1644
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItem: S.Schema<CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItem>;
|
|
1645
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueList = Array<CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueItem>;
|
|
1646
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueList: S.Schema<CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueList>;
|
|
1647
|
+
/** A rule applied to requests matching a domain in the network policy. Only one of `transform` or `forwardURL` can be specified per rule. */
|
|
1648
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1Map = {
|
|
1649
|
+
[key: string]: CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1ValueList | undefined;
|
|
1650
|
+
};
|
|
1651
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1Map: S.Schema<CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1Map>;
|
|
1652
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase1Allow = CreateSandboxesV4RequestNetworkPolicyCase1AllowCase0List | CreateSandboxesV4RequestNetworkPolicyCase1AllowCase1Map;
|
|
1653
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase1Allow: S.Schema<CreateSandboxesV4RequestNetworkPolicyCase1Allow>;
|
|
1654
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase1SubnetsAllowList = Array<string>;
|
|
1655
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase1SubnetsAllowList: S.Schema<CreateSandboxesV4RequestNetworkPolicyCase1SubnetsAllowList>;
|
|
1656
|
+
export type CreateSandboxesV4RequestNetworkPolicyCase1SubnetsDenyList = Array<string>;
|
|
1657
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase1SubnetsDenyList: S.Schema<CreateSandboxesV4RequestNetworkPolicyCase1SubnetsDenyList>;
|
|
1658
|
+
export interface CreateSandboxesV4RequestNetworkPolicyCase1Subnets {
|
|
1659
|
+
allow?: CreateSandboxesV4RequestNetworkPolicyCase1SubnetsAllowList;
|
|
1660
|
+
deny?: CreateSandboxesV4RequestNetworkPolicyCase1SubnetsDenyList;
|
|
1661
|
+
}
|
|
1662
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase1Subnets: S.Schema<CreateSandboxesV4RequestNetworkPolicyCase1Subnets>;
|
|
1663
|
+
export interface CreateSandboxesV4RequestNetworkPolicyCase1 {
|
|
1664
|
+
allow?: CreateSandboxesV4RequestNetworkPolicyCase1Allow;
|
|
1665
|
+
subnets?: CreateSandboxesV4RequestNetworkPolicyCase1Subnets;
|
|
1666
|
+
}
|
|
1667
|
+
export declare const CreateSandboxesV4RequestNetworkPolicyCase1: S.Schema<CreateSandboxesV4RequestNetworkPolicyCase1>;
|
|
1668
|
+
export type CreateSandboxesV4RequestNetworkPolicy = CreateSandboxesV4RequestNetworkPolicyCase0 | CreateSandboxesV4RequestNetworkPolicyCase1;
|
|
1669
|
+
export declare const CreateSandboxesV4RequestNetworkPolicy: S.Schema<CreateSandboxesV4RequestNetworkPolicy>;
|
|
1670
|
+
/** Resources to define the VM */
|
|
1671
|
+
export type CreateSandboxesV4RequestResources = CreateSandboxesByNameForkV2RequestResources;
|
|
1672
|
+
export declare const CreateSandboxesV4RequestResources: S.Schema<CreateSandboxesByNameForkV2RequestResources>;
|
|
1673
|
+
/** Clone a Git repository into the sandbox. */
|
|
1674
|
+
export type CreateSandboxesV4RequestSourceCase0 = CreateSandboxesV2RequestSourceCase0;
|
|
1675
|
+
export declare const CreateSandboxesV4RequestSourceCase0: S.Schema<CreateSandboxesV2RequestSourceCase0>;
|
|
1676
|
+
/** Download and extract a gzipped tarball into the sandbox. */
|
|
1677
|
+
export type CreateSandboxesV4RequestSourceCase1 = CreateSandboxesV2RequestSourceCase1;
|
|
1678
|
+
export declare const CreateSandboxesV4RequestSourceCase1: S.Schema<CreateSandboxesV2RequestSourceCase1>;
|
|
1679
|
+
/** Restore the sandbox filesystem from an existing snapshot. */
|
|
1680
|
+
export type CreateSandboxesV4RequestSourceCase2 = CreateSandboxesV2RequestSourceCase2;
|
|
1681
|
+
export declare const CreateSandboxesV4RequestSourceCase2: S.Schema<CreateSandboxesV2RequestSourceCase2>;
|
|
1682
|
+
/** The source from which to initialize the sandbox filesystem. Can be a Git repository, a tarball URL, or an existing snapshot. */
|
|
1683
|
+
export type CreateSandboxesV4RequestSource = CreateSandboxesV2RequestSourceCase0 | CreateSandboxesV2RequestSourceCase1 | CreateSandboxesV2RequestSourceCase2;
|
|
1684
|
+
export declare const CreateSandboxesV4RequestSource: S.Schema<CreateSandboxesV4RequestSource>;
|
|
1685
|
+
/** List of ports to expose from the sandbox. Each port will be accessible via a unique URL. Maximum of 15 ports can be exposed. */
|
|
1686
|
+
export type CreateSandboxesV4RequestPortsList = Array<number>;
|
|
1687
|
+
export declare const CreateSandboxesV4RequestPortsList: S.Schema<CreateSandboxesV4RequestPortsList>;
|
|
1688
|
+
/** Default environment variables for the sandbox. These are inherited by all commands unless overridden. */
|
|
1689
|
+
export type CreateSandboxesV4RequestEnvMap = {
|
|
1690
|
+
[key: string]: string | undefined;
|
|
1691
|
+
};
|
|
1692
|
+
export declare const CreateSandboxesV4RequestEnvMap: S.Schema<CreateSandboxesV4RequestEnvMap>;
|
|
1693
|
+
/** Mount the drive read-only or read-write. */
|
|
1694
|
+
export type CreateSandboxesV4RequestMountsValueMode = "read-only" | "read-write";
|
|
1695
|
+
export declare const CreateSandboxesV4RequestMountsValueMode: any;
|
|
1696
|
+
export interface CreateSandboxesV4RequestMountsValue {
|
|
1697
|
+
/** Name of the drive to mount. The drive must already exist. */
|
|
1698
|
+
drive: string;
|
|
1699
|
+
/** Mount the drive read-only or read-write. */
|
|
1700
|
+
mode?: CreateSandboxesV4RequestMountsValueMode | (string & {});
|
|
1701
|
+
}
|
|
1702
|
+
export declare const CreateSandboxesV4RequestMountsValue: S.Schema<CreateSandboxesV4RequestMountsValue>;
|
|
1703
|
+
/** List of drives to mount to the sandbox at the provided path. */
|
|
1704
|
+
export type CreateSandboxesV4RequestMountsMap = {
|
|
1705
|
+
[key: string]: CreateSandboxesV4RequestMountsValue | undefined;
|
|
1706
|
+
};
|
|
1707
|
+
export declare const CreateSandboxesV4RequestMountsMap: S.Schema<CreateSandboxesV4RequestMountsMap>;
|
|
1708
|
+
/** The Vercel region in which to create the sandbox. */
|
|
1709
|
+
export type CreateSandboxesV4RequestRegion = "iad1" | "sfo1" | "cle1" | "cdg1" | "fra1" | "arn1" | "sin1" | "pdx1" | "lhr1" | "icn1" | "bom1" | "cpt1" | "dub1" | "gru1" | "hkg1" | "syd1" | "yul1" | "hnd1" | "kix1";
|
|
1710
|
+
export declare const CreateSandboxesV4RequestRegion: any;
|
|
1711
|
+
export type CreateSandboxesV4RequestFailoverRegionsItem = "iad1" | "sfo1" | "cle1" | "cdg1" | "fra1" | "arn1" | "sin1" | "pdx1" | "lhr1" | "icn1" | "bom1" | "cpt1" | "dub1" | "gru1" | "hkg1" | "syd1" | "yul1" | "hnd1" | "kix1";
|
|
1712
|
+
export declare const CreateSandboxesV4RequestFailoverRegionsItem: any;
|
|
1713
|
+
/** The regions the sandbox falls back to when it cannot be created in `region`. */
|
|
1714
|
+
export type CreateSandboxesV4RequestFailoverRegionsList = Array<CreateSandboxesV4RequestFailoverRegionsItem | (string & {})>;
|
|
1715
|
+
export declare const CreateSandboxesV4RequestFailoverRegionsList: S.Schema<CreateSandboxesV4RequestFailoverRegionsList>;
|
|
1716
|
+
/** Default snapshot expiration time in milliseconds. Defaults to 7 days. Set to 0 to disable expiration. When set, this value is used as the default expiration for all snapshots created for this sandbox. */
|
|
1717
|
+
export type CreateSandboxesV4RequestSnapshotExpiration = unknown | number;
|
|
1718
|
+
export declare const CreateSandboxesV4RequestSnapshotExpiration: S.Schema<CreateSandboxesV4RequestSnapshotExpiration>;
|
|
1719
|
+
/** Expiration time in milliseconds for kept snapshots. Falls back to snapshotExpiration. */
|
|
1720
|
+
export type CreateSandboxesV4RequestKeepLastSnapshotsCase1Expiration = unknown | number;
|
|
1721
|
+
export declare const CreateSandboxesV4RequestKeepLastSnapshotsCase1Expiration: S.Schema<CreateSandboxesV4RequestKeepLastSnapshotsCase1Expiration>;
|
|
1722
|
+
export interface CreateSandboxesV4RequestKeepLastSnapshotsCase1 {
|
|
1723
|
+
/** Number of most recent snapshots to keep. */
|
|
1724
|
+
count: number;
|
|
1725
|
+
/** Expiration time in milliseconds for kept snapshots. Falls back to snapshotExpiration. */
|
|
1726
|
+
expiration?: CreateSandboxesV4RequestKeepLastSnapshotsCase1Expiration;
|
|
1727
|
+
/** Whether to immediately delete evicted snapshots. Defaults to true. */
|
|
1728
|
+
deleteEvicted?: boolean;
|
|
1729
|
+
}
|
|
1730
|
+
export declare const CreateSandboxesV4RequestKeepLastSnapshotsCase1: S.Schema<CreateSandboxesV4RequestKeepLastSnapshotsCase1>;
|
|
1731
|
+
/** Protect the N most recent snapshots with different expiration/deletion behavior. Persistent sandboxes default to keeping only the last snapshot (evicted snapshots are deleted). Set to null to disable the limit. */
|
|
1732
|
+
export type CreateSandboxesV4RequestKeepLastSnapshots = string | CreateSandboxesV4RequestKeepLastSnapshotsCase1;
|
|
1733
|
+
export declare const CreateSandboxesV4RequestKeepLastSnapshots: S.Schema<CreateSandboxesV4RequestKeepLastSnapshots>;
|
|
1734
|
+
/** Key-value tags to associate with the sandbox. Maximum 5 tags. */
|
|
1735
|
+
export type CreateSandboxesV4RequestTagsMap = {
|
|
1736
|
+
[key: string]: string | undefined;
|
|
1737
|
+
};
|
|
1738
|
+
export declare const CreateSandboxesV4RequestTagsMap: S.Schema<CreateSandboxesV4RequestTagsMap>;
|
|
1739
|
+
export interface CreateSandboxesV4Request {
|
|
1740
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
1741
|
+
teamId?: string;
|
|
1742
|
+
/** The Team slug to perform the request on behalf of. */
|
|
1743
|
+
slug?: string;
|
|
1744
|
+
networkPolicy?: CreateSandboxesV4RequestNetworkPolicy;
|
|
1745
|
+
/** Resources to define the VM */
|
|
1746
|
+
resources?: CreateSandboxesByNameForkV2RequestResources;
|
|
1747
|
+
/** The source from which to initialize the sandbox filesystem. Can be a Git repository, a tarball URL, or an existing snapshot. */
|
|
1748
|
+
source?: CreateSandboxesV4RequestSource;
|
|
1749
|
+
/** The target project slug or ID in which the sandbox will be assigned to. */
|
|
1750
|
+
projectId?: string;
|
|
1751
|
+
/** List of ports to expose from the sandbox. Each port will be accessible via a unique URL. Maximum of 15 ports can be exposed. */
|
|
1752
|
+
ports?: CreateSandboxesV4RequestPortsList;
|
|
1753
|
+
/** Image to use for the sandbox. */
|
|
1754
|
+
image?: string;
|
|
1755
|
+
/** Maximum duration in milliseconds that the sandbox can run before being automatically stopped. */
|
|
1756
|
+
timeout?: number;
|
|
1757
|
+
/** Default environment variables for the sandbox. These are inherited by all commands unless overridden. */
|
|
1758
|
+
env?: CreateSandboxesV4RequestEnvMap;
|
|
1759
|
+
/** List of drives to mount to the sandbox at the provided path. */
|
|
1760
|
+
mounts?: CreateSandboxesV4RequestMountsMap;
|
|
1761
|
+
/** The Vercel region in which to create the sandbox. */
|
|
1762
|
+
region?: CreateSandboxesV4RequestRegion | (string & {});
|
|
1763
|
+
/** The regions the sandbox falls back to when it cannot be created in `region`. */
|
|
1764
|
+
failoverRegions?: CreateSandboxesV4RequestFailoverRegionsList;
|
|
1765
|
+
/** Name for the sandbox. Must be unique per project and URL-safe (alphanumeric, hyphens, underscores). */
|
|
1766
|
+
name?: string;
|
|
1767
|
+
/** Whether the sandbox persists its state across restarts via automatic snapshots. Defaults to true. */
|
|
1768
|
+
persistent?: boolean;
|
|
1769
|
+
/** Default snapshot expiration time in milliseconds. Defaults to 7 days. Set to 0 to disable expiration. When set, this value is used as the default expiration for all snapshots created for this sandbox. */
|
|
1770
|
+
snapshotExpiration?: CreateSandboxesV4RequestSnapshotExpiration;
|
|
1771
|
+
/** Protect the N most recent snapshots with different expiration/deletion behavior. Persistent sandboxes default to keeping only the last snapshot (evicted snapshots are deleted). Set to null to disable the limit. */
|
|
1772
|
+
keepLastSnapshots?: CreateSandboxesV4RequestKeepLastSnapshots;
|
|
1773
|
+
/** Key-value tags to associate with the sandbox. Maximum 5 tags. */
|
|
1774
|
+
tags?: CreateSandboxesV4RequestTagsMap;
|
|
1775
|
+
}
|
|
1776
|
+
export declare const CreateSandboxesV4Request: S.Schema<CreateSandboxesV4Request>;
|
|
1777
|
+
export type CreateSandboxesV4ResponseRoutesList = Array<SandboxPublicRoute>;
|
|
1778
|
+
export declare const CreateSandboxesV4ResponseRoutesList: S.Schema<CreateSandboxesV4ResponseRoutesList>;
|
|
1779
|
+
export interface CreateSandboxesV4Response {
|
|
1780
|
+
sandbox: NamedSandbox;
|
|
1781
|
+
session: Session;
|
|
1782
|
+
routes: CreateSandboxesV4ResponseRoutesList;
|
|
1783
|
+
}
|
|
1784
|
+
export declare const CreateSandboxesV4Response: S.Schema<CreateSandboxesV4Response>;
|
|
1785
|
+
export interface CreateSessionDirectoryRequest {
|
|
1786
|
+
/** The unique identifier of the session to create the directory in. */
|
|
1787
|
+
sessionId: string;
|
|
1788
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
1789
|
+
teamId?: string;
|
|
1790
|
+
/** The Team slug to perform the request on behalf of. */
|
|
1791
|
+
slug?: string;
|
|
1792
|
+
/** The base directory for resolving relative paths. If not specified, paths are resolved from the sandbox home directory. */
|
|
1793
|
+
cwd?: string;
|
|
1794
|
+
/** The path of the directory to create. Can be absolute or relative to the working directory. */
|
|
1795
|
+
path: string;
|
|
1796
|
+
/** If true, creates parent directories as needed (like `mkdir -p`). If false, fails if parent directories do not exist. */
|
|
1797
|
+
recursive?: boolean;
|
|
1798
|
+
}
|
|
1799
|
+
export declare const CreateSessionDirectoryRequest: S.Schema<CreateSessionDirectoryRequest>;
|
|
1800
|
+
export type CreateSessionDirectoryResponse = unknown;
|
|
1801
|
+
export declare const CreateSessionDirectoryResponse: S.Schema<CreateSessionDirectoryResponse>;
|
|
1802
|
+
export interface DeleteDriveRequest {
|
|
1803
|
+
/** Name for the drive. Must be unique per project and URL-safe (alphanumeric, hyphens, underscores). */
|
|
1804
|
+
name: string;
|
|
1805
|
+
/** The project ID or name associated with the drive. Required unless using a Vercel OIDC token scoped to a project. */
|
|
1806
|
+
projectId?: string;
|
|
1807
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
1808
|
+
teamId?: string;
|
|
1809
|
+
/** The Team slug to perform the request on behalf of. */
|
|
1810
|
+
slug?: string;
|
|
1811
|
+
}
|
|
1812
|
+
export declare const DeleteDriveRequest: S.Schema<DeleteDriveRequest>;
|
|
1813
|
+
/** This object contains information related to a Vercel Sandbox Drive. */
|
|
1814
|
+
export interface Drive {
|
|
1815
|
+
/** The unique drive ID. */
|
|
1816
|
+
id: string;
|
|
1817
|
+
/** The unique drive name within the project. */
|
|
1818
|
+
name: string;
|
|
1819
|
+
/** The project that owns the drive. */
|
|
1820
|
+
projectId: string;
|
|
1821
|
+
/** The maximum drive size in bytes. */
|
|
1822
|
+
maxSizeBytes: number;
|
|
1823
|
+
/** The region where the drive is stored. */
|
|
1824
|
+
region: string;
|
|
1825
|
+
/** Current session ID the drive is attached to, if any. */
|
|
1826
|
+
currentSessionId?: string;
|
|
1827
|
+
/** Current sandbox name the drive is attached to, if any. */
|
|
1828
|
+
currentSandboxName?: string;
|
|
1829
|
+
/** The time when the drive was created, in milliseconds since the epoch. */
|
|
1830
|
+
createdAt: number;
|
|
1831
|
+
/** The last time the drive was updated, in milliseconds since the epoch. */
|
|
1832
|
+
updatedAt: number;
|
|
1833
|
+
}
|
|
1834
|
+
export declare const Drive: S.Schema<Drive>;
|
|
1835
|
+
export interface DeleteDriveResponse {
|
|
1836
|
+
drive: Drive;
|
|
1837
|
+
}
|
|
1838
|
+
export declare const DeleteDriveResponse: S.Schema<DeleteDriveResponse>;
|
|
1839
|
+
export interface DeleteSandboxRequest {
|
|
1840
|
+
/** The sandbox name to delete. */
|
|
1841
|
+
name: string;
|
|
1842
|
+
/** The project ID that owns the named sandbox. When provided, takes precedence over OIDC project context. */
|
|
1843
|
+
projectId?: string;
|
|
1844
|
+
/** When true, snapshots of the deleted sandbox that are not referenced by any other sandbox are also deleted asynchronously. Defaults to false. */
|
|
1845
|
+
deleteOrphanSnapshots?: boolean;
|
|
1846
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
1847
|
+
teamId?: string;
|
|
1848
|
+
/** The Team slug to perform the request on behalf of. */
|
|
1849
|
+
slug?: string;
|
|
1850
|
+
}
|
|
1851
|
+
export declare const DeleteSandboxRequest: S.Schema<DeleteSandboxRequest>;
|
|
1852
|
+
export interface DeleteSandboxResponse {
|
|
1853
|
+
sandbox: NamedSandbox;
|
|
1854
|
+
}
|
|
1855
|
+
export declare const DeleteSandboxResponse: S.Schema<DeleteSandboxResponse>;
|
|
1856
|
+
export interface DeleteSessionSnapshotRequest {
|
|
1857
|
+
/** The unique identifier of the snapshot to delete. */
|
|
1858
|
+
snapshotId: string;
|
|
1859
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
1860
|
+
teamId?: string;
|
|
1861
|
+
/** The Team slug to perform the request on behalf of. */
|
|
1862
|
+
slug?: string;
|
|
1863
|
+
}
|
|
1864
|
+
export declare const DeleteSessionSnapshotRequest: S.Schema<DeleteSessionSnapshotRequest>;
|
|
1865
|
+
export interface DeleteSessionSnapshotResponse {
|
|
1866
|
+
snapshot: Snapshot;
|
|
1867
|
+
}
|
|
1868
|
+
export declare const DeleteSessionSnapshotResponse: S.Schema<DeleteSessionSnapshotResponse>;
|
|
1869
|
+
export interface ExtendSessionTimeoutRequest {
|
|
1870
|
+
/** The unique identifier of the session to extend the timeout for. */
|
|
1871
|
+
sessionId: string;
|
|
1872
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
1873
|
+
teamId?: string;
|
|
1874
|
+
/** The Team slug to perform the request on behalf of. */
|
|
1875
|
+
slug?: string;
|
|
1876
|
+
/** The amount of time in milliseconds to add to the current timeout. Must be at least 1000ms (1 second). */
|
|
1877
|
+
duration: number;
|
|
1878
|
+
}
|
|
1879
|
+
export declare const ExtendSessionTimeoutRequest: S.Schema<ExtendSessionTimeoutRequest>;
|
|
1880
|
+
export interface ExtendSessionTimeoutResponse {
|
|
1881
|
+
session: Session;
|
|
1882
|
+
}
|
|
1883
|
+
export declare const ExtendSessionTimeoutResponse: S.Schema<ExtendSessionTimeoutResponse>;
|
|
1884
|
+
export interface GetNamedSandboxRequest {
|
|
1885
|
+
/** Name for the sandbox. Must be unique per project and URL-safe (alphanumeric, hyphens, underscores). */
|
|
1886
|
+
name: string;
|
|
1887
|
+
/** The project ID or name (required when not using OIDC token). */
|
|
1888
|
+
projectId?: string;
|
|
1889
|
+
/** Whether to automatically resume a stopped named sandbox by creating a new instance from its snapshot. Defaults to false. */
|
|
1890
|
+
resume?: boolean;
|
|
1891
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
1892
|
+
teamId?: string;
|
|
1893
|
+
/** The Team slug to perform the request on behalf of. */
|
|
1894
|
+
slug?: string;
|
|
1895
|
+
}
|
|
1896
|
+
export declare const GetNamedSandboxRequest: S.Schema<GetNamedSandboxRequest>;
|
|
1897
|
+
export type GetNamedSandboxResponseRoutesList = Array<SandboxPublicRoute>;
|
|
1898
|
+
export declare const GetNamedSandboxResponseRoutesList: S.Schema<GetNamedSandboxResponseRoutesList>;
|
|
1899
|
+
export interface GetNamedSandboxResponse {
|
|
1900
|
+
sandbox: NamedSandbox;
|
|
1901
|
+
session: Session;
|
|
1902
|
+
routes: GetNamedSandboxResponseRoutesList;
|
|
1903
|
+
resumed: boolean;
|
|
1904
|
+
}
|
|
1905
|
+
export declare const GetNamedSandboxResponse: S.Schema<GetNamedSandboxResponse>;
|
|
1906
|
+
/** Region where the drive is stored. Defaults to iad1. */
|
|
1907
|
+
export type GetOrCreateDriveRequestRegion = "iad1" | "sfo1" | "cle1" | "cdg1" | "fra1" | "arn1" | "sin1" | "pdx1" | "lhr1" | "icn1" | "bom1" | "cpt1" | "dub1" | "gru1" | "hkg1" | "syd1" | "yul1" | "hnd1" | "kix1";
|
|
1908
|
+
export declare const GetOrCreateDriveRequestRegion: any;
|
|
1909
|
+
export interface GetOrCreateDriveRequest {
|
|
1910
|
+
/** Name for the drive. Must be unique per project and URL-safe (alphanumeric, hyphens, underscores). */
|
|
1911
|
+
name: string;
|
|
1912
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
1913
|
+
teamId?: string;
|
|
1914
|
+
/** The Team slug to perform the request on behalf of. */
|
|
1915
|
+
slug?: string;
|
|
1916
|
+
/** The project ID or name to associate the drive with. Required unless using a Vercel OIDC token scoped to a project. */
|
|
1917
|
+
projectId?: string;
|
|
1918
|
+
/** Maximum drive size in bytes. Defaults to 100 GiB when omitted. */
|
|
1919
|
+
maxSizeBytes?: number;
|
|
1920
|
+
/** Region where the drive is stored. Defaults to iad1. */
|
|
1921
|
+
region?: GetOrCreateDriveRequestRegion | (string & {});
|
|
1922
|
+
}
|
|
1923
|
+
export declare const GetOrCreateDriveRequest: S.Schema<GetOrCreateDriveRequest>;
|
|
1924
|
+
export interface GetOrCreateDriveResponse {
|
|
1925
|
+
drive: Drive;
|
|
1926
|
+
}
|
|
1927
|
+
export declare const GetOrCreateDriveResponse: S.Schema<GetOrCreateDriveResponse>;
|
|
1928
|
+
export interface GetSessionRequest {
|
|
1929
|
+
/** The unique identifier of the session to retrieve. */
|
|
1930
|
+
sessionId: string;
|
|
1931
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
1932
|
+
teamId?: string;
|
|
1933
|
+
/** The Team slug to perform the request on behalf of. */
|
|
1934
|
+
slug?: string;
|
|
1935
|
+
}
|
|
1936
|
+
export declare const GetSessionRequest: S.Schema<GetSessionRequest>;
|
|
1937
|
+
export type GetSessionResponseRoutesList = Array<SandboxPublicRoute>;
|
|
1938
|
+
export declare const GetSessionResponseRoutesList: S.Schema<GetSessionResponseRoutesList>;
|
|
1939
|
+
export interface GetSessionResponse {
|
|
1940
|
+
session: Session;
|
|
1941
|
+
routes: GetSessionResponseRoutesList;
|
|
1942
|
+
}
|
|
1943
|
+
export declare const GetSessionResponse: S.Schema<GetSessionResponse>;
|
|
1944
|
+
export interface GetSessionCommandRequest {
|
|
1945
|
+
/** The unique identifier of the session containing the command. */
|
|
1946
|
+
sessionId: string;
|
|
1947
|
+
/** The unique identifier of the command to retrieve. */
|
|
1948
|
+
cmdId: string;
|
|
1949
|
+
/** If set to "true", the request will block until the command finishes execution. Useful for synchronously waiting for command completion. */
|
|
1950
|
+
wait?: boolean;
|
|
1951
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
1952
|
+
teamId?: string;
|
|
1953
|
+
/** The Team slug to perform the request on behalf of. */
|
|
1954
|
+
slug?: string;
|
|
1955
|
+
}
|
|
1956
|
+
export declare const GetSessionCommandRequest: S.Schema<GetSessionCommandRequest>;
|
|
1957
|
+
/** The arguments of the command. */
|
|
1958
|
+
export type SessionCommandArgsList = Array<string>;
|
|
1959
|
+
export declare const SessionCommandArgsList: S.Schema<SessionCommandArgsList>;
|
|
1960
|
+
/** This object represents a command run in a Vercel Sandbox session (v2 API). */
|
|
1961
|
+
export interface SessionCommand {
|
|
1962
|
+
/** The ID of the command. */
|
|
1963
|
+
id: string;
|
|
1964
|
+
/** The name of the command. */
|
|
1965
|
+
name: string;
|
|
1966
|
+
/** The arguments of the command. */
|
|
1967
|
+
args: SessionCommandArgsList;
|
|
1968
|
+
/** The current working directory of the command. */
|
|
1969
|
+
cwd: string;
|
|
1970
|
+
/** The ID of the session associated with the command. */
|
|
1971
|
+
sessionId: string;
|
|
1972
|
+
/** If the command did finish, the exit code. */
|
|
1973
|
+
exitCode: number | null;
|
|
1974
|
+
/** When the command was started, in milliseconds since the epoch. */
|
|
1975
|
+
startedAt: number;
|
|
1976
|
+
/** Duration of the command execution in milliseconds. */
|
|
1977
|
+
durationMs?: number;
|
|
1978
|
+
}
|
|
1979
|
+
export declare const SessionCommand: S.Schema<SessionCommand>;
|
|
1980
|
+
export interface GetSessionCommandResponse {
|
|
1981
|
+
command: SessionCommand;
|
|
1982
|
+
}
|
|
1983
|
+
export declare const GetSessionCommandResponse: S.Schema<GetSessionCommandResponse>;
|
|
1984
|
+
export interface GetSessionCommandLogsRequest {
|
|
1985
|
+
/** The unique identifier of the session containing the command. */
|
|
1986
|
+
sessionId: string;
|
|
1987
|
+
/** The unique identifier of the command to stream logs for. */
|
|
1988
|
+
cmdId: string;
|
|
1989
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
1990
|
+
teamId?: string;
|
|
1991
|
+
/** The Team slug to perform the request on behalf of. */
|
|
1992
|
+
slug?: string;
|
|
1993
|
+
}
|
|
1994
|
+
export declare const GetSessionCommandLogsRequest: S.Schema<GetSessionCommandLogsRequest>;
|
|
1995
|
+
export interface GetSessionCommandLogsResponse {
|
|
1996
|
+
}
|
|
1997
|
+
export declare const GetSessionCommandLogsResponse: S.Schema<GetSessionCommandLogsResponse>;
|
|
1998
|
+
export interface GetSessionSnapshotRequest {
|
|
1999
|
+
/** The unique identifier of the snapshot to retrieve. */
|
|
2000
|
+
snapshotId: string;
|
|
2001
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
2002
|
+
teamId?: string;
|
|
2003
|
+
/** The Team slug to perform the request on behalf of. */
|
|
2004
|
+
slug?: string;
|
|
2005
|
+
}
|
|
2006
|
+
export declare const GetSessionSnapshotRequest: S.Schema<GetSessionSnapshotRequest>;
|
|
2007
|
+
export interface GetSessionSnapshotResponse {
|
|
2008
|
+
snapshot: Snapshot;
|
|
2009
|
+
}
|
|
2010
|
+
export declare const GetSessionSnapshotResponse: S.Schema<GetSessionSnapshotResponse>;
|
|
2011
|
+
export interface KillSessionCommandRequest {
|
|
2012
|
+
/** The unique identifier of the session containing the command. */
|
|
2013
|
+
sessionId: string;
|
|
2014
|
+
/** The unique identifier of the command to terminate. */
|
|
2015
|
+
cmdId: string;
|
|
2016
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
2017
|
+
teamId?: string;
|
|
2018
|
+
/** The Team slug to perform the request on behalf of. */
|
|
2019
|
+
slug?: string;
|
|
2020
|
+
/** The POSIX signal number to send to the process. Common values: 15 (SIGTERM) for graceful termination, 9 (SIGKILL) for forced termination. */
|
|
2021
|
+
signal: number;
|
|
2022
|
+
}
|
|
2023
|
+
export declare const KillSessionCommandRequest: S.Schema<KillSessionCommandRequest>;
|
|
2024
|
+
export interface KillSessionCommandResponse {
|
|
2025
|
+
command: SessionCommand;
|
|
2026
|
+
}
|
|
2027
|
+
export declare const KillSessionCommandResponse: S.Schema<KillSessionCommandResponse>;
|
|
2028
|
+
/** Field to sort drives by. */
|
|
2029
|
+
export type ListDrivesRequestSortBy = "createdAt" | "updatedAt" | "name";
|
|
2030
|
+
export declare const ListDrivesRequestSortBy: any;
|
|
2031
|
+
/** Sort direction for results. */
|
|
2032
|
+
export type ListDrivesRequestSortOrder = "asc" | "desc";
|
|
2033
|
+
export declare const ListDrivesRequestSortOrder: any;
|
|
2034
|
+
export interface ListDrivesRequest {
|
|
2035
|
+
/** The project ID or name associated with the drives. Required unless using a Vercel OIDC token scoped to a project. */
|
|
2036
|
+
projectId?: string;
|
|
2037
|
+
/** Maximum number of drives to return in the response. Used for pagination. */
|
|
2038
|
+
limit?: number;
|
|
2039
|
+
/** Opaque pagination cursor from a previous response. */
|
|
2040
|
+
cursor?: string;
|
|
2041
|
+
/** Field to sort drives by. */
|
|
2042
|
+
sortBy?: ListDrivesRequestSortBy | (string & {});
|
|
2043
|
+
/** Filter drives whose name starts with this prefix. Only valid when sortBy=name. */
|
|
2044
|
+
namePrefix?: string;
|
|
2045
|
+
/** Sort direction for results. */
|
|
2046
|
+
sortOrder?: ListDrivesRequestSortOrder | (string & {});
|
|
2047
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
2048
|
+
teamId?: string;
|
|
2049
|
+
/** The Team slug to perform the request on behalf of. */
|
|
2050
|
+
slug?: string;
|
|
2051
|
+
}
|
|
2052
|
+
export declare const ListDrivesRequest: S.Schema<ListDrivesRequest>;
|
|
2053
|
+
export type ListDrivesResponseDrivesList = Array<Drive>;
|
|
2054
|
+
export declare const ListDrivesResponseDrivesList: S.Schema<ListDrivesResponseDrivesList>;
|
|
2055
|
+
export interface ListDrivesResponsePagination {
|
|
2056
|
+
count: number;
|
|
2057
|
+
next: string | null;
|
|
2058
|
+
}
|
|
2059
|
+
export declare const ListDrivesResponsePagination: S.Schema<ListDrivesResponsePagination>;
|
|
2060
|
+
export interface ListDrivesResponse {
|
|
2061
|
+
drives: ListDrivesResponseDrivesList;
|
|
2062
|
+
pagination: ListDrivesResponsePagination;
|
|
2063
|
+
}
|
|
2064
|
+
export declare const ListDrivesResponse: S.Schema<ListDrivesResponse>;
|
|
2065
|
+
export interface ListSessionCommandsRequest {
|
|
2066
|
+
/** The unique identifier of the session to list commands for. */
|
|
2067
|
+
sessionId: string;
|
|
2068
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
2069
|
+
teamId?: string;
|
|
2070
|
+
/** The Team slug to perform the request on behalf of. */
|
|
2071
|
+
slug?: string;
|
|
2072
|
+
}
|
|
2073
|
+
export declare const ListSessionCommandsRequest: S.Schema<ListSessionCommandsRequest>;
|
|
2074
|
+
export type ListSessionCommandsResponseCommandsList = Array<SessionCommand>;
|
|
2075
|
+
export declare const ListSessionCommandsResponseCommandsList: S.Schema<ListSessionCommandsResponseCommandsList>;
|
|
2076
|
+
export interface ListSessionCommandsResponse {
|
|
2077
|
+
commands: ListSessionCommandsResponseCommandsList;
|
|
2078
|
+
}
|
|
2079
|
+
export declare const ListSessionCommandsResponse: S.Schema<ListSessionCommandsResponse>;
|
|
2080
|
+
/** Sort direction for results by creation time. */
|
|
2081
|
+
export type ListSessionsRequestSortOrder = "asc" | "desc";
|
|
2082
|
+
export declare const ListSessionsRequestSortOrder: any;
|
|
2083
|
+
export interface ListSessionsRequest {
|
|
2084
|
+
/** The unique identifier or name of the project to list sessions for. */
|
|
2085
|
+
project?: string;
|
|
2086
|
+
/** Filter sessions by sandbox name. Only sessions belonging to the specified sandbox are returned. */
|
|
2087
|
+
name?: string;
|
|
2088
|
+
/** Maximum number of sessions to return in the response. Used for pagination. */
|
|
2089
|
+
limit?: number;
|
|
2090
|
+
/** Opaque pagination cursor from a previous response. */
|
|
2091
|
+
cursor?: string;
|
|
2092
|
+
/** Sort direction for results by creation time. */
|
|
2093
|
+
sortOrder?: ListSessionsRequestSortOrder | (string & {});
|
|
2094
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
2095
|
+
teamId?: string;
|
|
2096
|
+
/** The Team slug to perform the request on behalf of. */
|
|
2097
|
+
slug?: string;
|
|
2098
|
+
}
|
|
2099
|
+
export declare const ListSessionsRequest: S.Schema<ListSessionsRequest>;
|
|
2100
|
+
export type ListSessionsResponseBodyCase1SessionsList = Array<Session>;
|
|
2101
|
+
export declare const ListSessionsResponseBodyCase1SessionsList: S.Schema<ListSessionsResponseBodyCase1SessionsList>;
|
|
2102
|
+
export type ListSessionsResponseBodyCase1Pagination = ListDrivesResponsePagination;
|
|
2103
|
+
export declare const ListSessionsResponseBodyCase1Pagination: S.Schema<ListDrivesResponsePagination>;
|
|
2104
|
+
export interface ListSessionsResponseBodyCase1 {
|
|
2105
|
+
sessions: ListSessionsResponseBodyCase1SessionsList;
|
|
2106
|
+
pagination: ListDrivesResponsePagination;
|
|
2107
|
+
}
|
|
2108
|
+
export declare const ListSessionsResponseBodyCase1: S.Schema<ListSessionsResponseBodyCase1>;
|
|
2109
|
+
export type ListSessionsResponseBody = unknown | ListSessionsResponseBodyCase1;
|
|
2110
|
+
export declare const ListSessionsResponseBody: S.Schema<ListSessionsResponseBody>;
|
|
2111
|
+
export type ListSessionsResponse = ListSessionsResponseBody;
|
|
2112
|
+
export declare const ListSessionsResponse: S.Schema<ListSessionsResponse>;
|
|
2113
|
+
/** Sort direction for results by creation time. */
|
|
2114
|
+
export type ListSessionSnapshotsRequestSortOrder = "asc" | "desc";
|
|
2115
|
+
export declare const ListSessionSnapshotsRequestSortOrder: any;
|
|
2116
|
+
export interface ListSessionSnapshotsRequest {
|
|
2117
|
+
/** The unique identifier or name of the project to list snapshots for. */
|
|
2118
|
+
project?: string;
|
|
2119
|
+
/** Name for the sandbox. Must be unique per project and URL-safe (alphanumeric, hyphens, underscores). */
|
|
2120
|
+
name?: string;
|
|
2121
|
+
/** Maximum number of snapshots to return in the response. Used for pagination. */
|
|
2122
|
+
limit?: number;
|
|
2123
|
+
/** Opaque pagination cursor from a previous response. */
|
|
2124
|
+
cursor?: string;
|
|
2125
|
+
/** Sort direction for results by creation time. */
|
|
2126
|
+
sortOrder?: ListSessionSnapshotsRequestSortOrder | (string & {});
|
|
2127
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
2128
|
+
teamId?: string;
|
|
2129
|
+
/** The Team slug to perform the request on behalf of. */
|
|
2130
|
+
slug?: string;
|
|
2131
|
+
}
|
|
2132
|
+
export declare const ListSessionSnapshotsRequest: S.Schema<ListSessionSnapshotsRequest>;
|
|
2133
|
+
export type ListSessionSnapshotsResponseBodyCase1SnapshotsList = Array<Snapshot>;
|
|
2134
|
+
export declare const ListSessionSnapshotsResponseBodyCase1SnapshotsList: S.Schema<ListSessionSnapshotsResponseBodyCase1SnapshotsList>;
|
|
2135
|
+
export type ListSessionSnapshotsResponseBodyCase1Pagination = ListDrivesResponsePagination;
|
|
2136
|
+
export declare const ListSessionSnapshotsResponseBodyCase1Pagination: S.Schema<ListDrivesResponsePagination>;
|
|
2137
|
+
export interface ListSessionSnapshotsResponseBodyCase1 {
|
|
2138
|
+
snapshots: ListSessionSnapshotsResponseBodyCase1SnapshotsList;
|
|
2139
|
+
pagination: ListDrivesResponsePagination;
|
|
2140
|
+
}
|
|
2141
|
+
export declare const ListSessionSnapshotsResponseBodyCase1: S.Schema<ListSessionSnapshotsResponseBodyCase1>;
|
|
2142
|
+
export type ListSessionSnapshotsResponseBody = unknown | ListSessionSnapshotsResponseBodyCase1;
|
|
2143
|
+
export declare const ListSessionSnapshotsResponseBody: S.Schema<ListSessionSnapshotsResponseBody>;
|
|
2144
|
+
export type ListSessionSnapshotsResponse = ListSessionSnapshotsResponseBody;
|
|
2145
|
+
export declare const ListSessionSnapshotsResponse: S.Schema<ListSessionSnapshotsResponse>;
|
|
2146
|
+
export interface ReadSessionFileRequest {
|
|
2147
|
+
/** The unique identifier of the session to read the file from. */
|
|
2148
|
+
sessionId: string;
|
|
2149
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
2150
|
+
teamId?: string;
|
|
2151
|
+
/** The Team slug to perform the request on behalf of. */
|
|
2152
|
+
slug?: string;
|
|
2153
|
+
/** The base directory for resolving relative paths. If not specified, paths are resolved from the sandbox home directory. */
|
|
2154
|
+
cwd?: string;
|
|
2155
|
+
/** The path of the file to read. Can be absolute or relative to the working directory. */
|
|
2156
|
+
path: string;
|
|
2157
|
+
}
|
|
2158
|
+
export declare const ReadSessionFileRequest: S.Schema<ReadSessionFileRequest>;
|
|
2159
|
+
export interface ReadSessionFileResponse {
|
|
2160
|
+
}
|
|
2161
|
+
export declare const ReadSessionFileResponse: S.Schema<ReadSessionFileResponse>;
|
|
2162
|
+
/** Arguments to pass to the command. Each argument should be a separate array element. */
|
|
2163
|
+
export type RunSessionCommandRequestArgsList = Array<string>;
|
|
2164
|
+
export declare const RunSessionCommandRequestArgsList: S.Schema<RunSessionCommandRequestArgsList>;
|
|
2165
|
+
/** Additional environment variables to set for this command. These are merged with the sandbox environment. */
|
|
2166
|
+
export type RunSessionCommandRequestEnvMap = {
|
|
2167
|
+
[key: string]: string | undefined;
|
|
2168
|
+
};
|
|
2169
|
+
export declare const RunSessionCommandRequestEnvMap: S.Schema<RunSessionCommandRequestEnvMap>;
|
|
2170
|
+
export interface RunSessionCommandRequest {
|
|
2171
|
+
/** The unique identifier of the session in which to execute the command. */
|
|
2172
|
+
sessionId: string;
|
|
2173
|
+
/** The unique identifier of the command to stream logs for. */
|
|
2174
|
+
cmdId: string;
|
|
2175
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
2176
|
+
teamId?: string;
|
|
2177
|
+
/** The Team slug to perform the request on behalf of. */
|
|
2178
|
+
slug?: string;
|
|
2179
|
+
/** The executable or shell command to run. This is the program name without arguments. */
|
|
2180
|
+
command: string;
|
|
2181
|
+
/** Arguments to pass to the command. Each argument should be a separate array element. */
|
|
2182
|
+
args?: RunSessionCommandRequestArgsList;
|
|
2183
|
+
/** The working directory in which to execute the command. Defaults to the sandbox home directory if not specified. */
|
|
2184
|
+
cwd?: string;
|
|
2185
|
+
/** Additional environment variables to set for this command. These are merged with the sandbox environment. */
|
|
2186
|
+
env?: RunSessionCommandRequestEnvMap;
|
|
2187
|
+
/** Execute the command with root (superuser) privileges. */
|
|
2188
|
+
sudo?: boolean;
|
|
2189
|
+
/** If true, returns an ND-JSON stream that emits the command status when started and again when finished. Useful for synchronously waiting for command completion. */
|
|
2190
|
+
wait?: boolean;
|
|
2191
|
+
/** If true, stream the logs of the command execution in real-time via ND-JSON. This is only applicable if `wait` is also true. */
|
|
2192
|
+
logs?: boolean;
|
|
2193
|
+
/** Maximum duration in milliseconds the command may run before it is killed with SIGKILL, up to 5 hours. Enforced at exec time, independently of `wait`. */
|
|
2194
|
+
timeout?: number;
|
|
2195
|
+
}
|
|
2196
|
+
export declare const RunSessionCommandRequest: S.Schema<RunSessionCommandRequest>;
|
|
2197
|
+
export interface RunSessionCommandResponse {
|
|
2198
|
+
command: SessionCommand;
|
|
2199
|
+
}
|
|
2200
|
+
export declare const RunSessionCommandResponse: S.Schema<RunSessionCommandResponse>;
|
|
2201
|
+
export interface StopSessionRequest {
|
|
2202
|
+
/** The unique identifier of the session to stop. */
|
|
2203
|
+
sessionId: string;
|
|
2204
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
2205
|
+
teamId?: string;
|
|
2206
|
+
/** The Team slug to perform the request on behalf of. */
|
|
2207
|
+
slug?: string;
|
|
2208
|
+
}
|
|
2209
|
+
export declare const StopSessionRequest: S.Schema<StopSessionRequest>;
|
|
2210
|
+
export interface StopSessionResponseBodyCase0 {
|
|
2211
|
+
session: Session;
|
|
2212
|
+
}
|
|
2213
|
+
export declare const StopSessionResponseBodyCase0: S.Schema<StopSessionResponseBodyCase0>;
|
|
2214
|
+
export interface StopSessionResponseBodyCase1 {
|
|
2215
|
+
snapshot: Snapshot;
|
|
2216
|
+
sandbox: NamedSandbox;
|
|
2217
|
+
session: Session;
|
|
2218
|
+
}
|
|
2219
|
+
export declare const StopSessionResponseBodyCase1: S.Schema<StopSessionResponseBodyCase1>;
|
|
2220
|
+
export type StopSessionResponseBody = StopSessionResponseBodyCase0 | StopSessionResponseBodyCase1;
|
|
2221
|
+
export declare const StopSessionResponseBody: S.Schema<StopSessionResponseBody>;
|
|
2222
|
+
export type StopSessionResponse = StopSessionResponseBody;
|
|
2223
|
+
export declare const StopSessionResponse: S.Schema<StopSessionResponse>;
|
|
2224
|
+
/** Resources to define the VM */
|
|
2225
|
+
export type UpdateSandboxRequestResources = CreateSandboxesByNameForkV2RequestResources;
|
|
2226
|
+
export declare const UpdateSandboxRequestResources: S.Schema<CreateSandboxesByNameForkV2RequestResources>;
|
|
2227
|
+
/** The runtime environment for the sandbox. Determines the pre-installed language runtimes and tools available. */
|
|
2228
|
+
export type UpdateSandboxRequestRuntime = "node22" | "node24" | "node26" | "python3.13";
|
|
2229
|
+
export declare const UpdateSandboxRequestRuntime: any;
|
|
2230
|
+
/** Default snapshot expiration time in milliseconds. Set to 0 to disable expiration. When set, this value is used as the default expiration for all snapshots created for this sandbox. */
|
|
2231
|
+
export type UpdateSandboxRequestSnapshotExpiration = unknown | number;
|
|
2232
|
+
export declare const UpdateSandboxRequestSnapshotExpiration: S.Schema<UpdateSandboxRequestSnapshotExpiration>;
|
|
2233
|
+
/** Expiration time in milliseconds for kept snapshots. Falls back to snapshotExpiration. */
|
|
2234
|
+
export type UpdateSandboxRequestKeepLastSnapshotsCase1Expiration = unknown | number;
|
|
2235
|
+
export declare const UpdateSandboxRequestKeepLastSnapshotsCase1Expiration: S.Schema<UpdateSandboxRequestKeepLastSnapshotsCase1Expiration>;
|
|
2236
|
+
export interface UpdateSandboxRequestKeepLastSnapshotsCase1 {
|
|
2237
|
+
/** Number of most recent snapshots to keep. */
|
|
2238
|
+
count: number;
|
|
2239
|
+
/** Expiration time in milliseconds for kept snapshots. Falls back to snapshotExpiration. */
|
|
2240
|
+
expiration?: UpdateSandboxRequestKeepLastSnapshotsCase1Expiration;
|
|
2241
|
+
/** Whether to immediately delete evicted snapshots. Defaults to true. */
|
|
2242
|
+
deleteEvicted?: boolean;
|
|
2243
|
+
}
|
|
2244
|
+
export declare const UpdateSandboxRequestKeepLastSnapshotsCase1: S.Schema<UpdateSandboxRequestKeepLastSnapshotsCase1>;
|
|
2245
|
+
/** Protect the N most recent snapshots with different expiration/deletion behavior. Set to null to clear. */
|
|
2246
|
+
export type UpdateSandboxRequestKeepLastSnapshots = string | UpdateSandboxRequestKeepLastSnapshotsCase1;
|
|
2247
|
+
export declare const UpdateSandboxRequestKeepLastSnapshots: S.Schema<UpdateSandboxRequestKeepLastSnapshots>;
|
|
2248
|
+
/** The network access policy mode. Use \"allow-all\" to permit all outbound traffic. Use \"deny-all\" to block all outbound traffic. Use \"custom\" to specify explicit allow/deny rules. */
|
|
2249
|
+
export type UpdateSandboxRequestNetworkPolicyCase0Mode = "allow-all" | "deny-all" | "custom" | "default-allow" | "default-deny";
|
|
2250
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase0Mode: any;
|
|
2251
|
+
/** List of domain names the sandbox is allowed to connect to. Only applies when mode is \"custom\". Supports wildcard patterns (e.g., \"*.example.com\" matches all subdomains). */
|
|
2252
|
+
export type UpdateSandboxRequestNetworkPolicyCase0AllowedDomainsList = Array<string>;
|
|
2253
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase0AllowedDomainsList: S.Schema<UpdateSandboxRequestNetworkPolicyCase0AllowedDomainsList>;
|
|
2254
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is allowed to connect to. Traffic to these addresses bypasses domain-based restrictions. */
|
|
2255
|
+
export type UpdateSandboxRequestNetworkPolicyCase0AllowedCIDRsList = Array<string>;
|
|
2256
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase0AllowedCIDRsList: S.Schema<UpdateSandboxRequestNetworkPolicyCase0AllowedCIDRsList>;
|
|
2257
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is blocked from connecting to. These rules take precedence over all allowed rules. */
|
|
2258
|
+
export type UpdateSandboxRequestNetworkPolicyCase0DeniedCIDRsList = Array<string>;
|
|
2259
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase0DeniedCIDRsList: S.Schema<UpdateSandboxRequestNetworkPolicyCase0DeniedCIDRsList>;
|
|
2260
|
+
/** HTTP headers to inject into requests for this domain. Existing headers with the same name will be overridden. */
|
|
2261
|
+
export type UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemHeadersMap = {
|
|
2262
|
+
[key: string]: string | undefined;
|
|
2263
|
+
};
|
|
2264
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemHeadersMap: S.Schema<UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemHeadersMap>;
|
|
2265
|
+
/** Match on the request path. Comparison is case-sensitive. */
|
|
2266
|
+
export type UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatchPath = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
2267
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatchPath: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
2268
|
+
/** HTTP methods to match. Any single match succeeds (OR semantics). */
|
|
2269
|
+
export type UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatchMethodList = Array<string>;
|
|
2270
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatchMethodList: S.Schema<UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatchMethodList>;
|
|
2271
|
+
/** Matcher for the entry key (header name or query key). */
|
|
2272
|
+
export type UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItemKey = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
2273
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItemKey: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
2274
|
+
/** Matcher for the entry value. */
|
|
2275
|
+
export type UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItemValue = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
2276
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItemValue: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
2277
|
+
export type UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem;
|
|
2278
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
2279
|
+
/** Query-string entry matchers. Multiple entries are ANDed. Query parameter names and values are both compared case-sensitively (RFC 3986). When a request has multiple values for the same key, any matching value satisfies the matcher. */
|
|
2280
|
+
export type UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
2281
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringList: S.Schema<UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringList>;
|
|
2282
|
+
/** Matcher for the entry key (header name or query key). */
|
|
2283
|
+
export type UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItemKey = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
2284
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItemKey: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
2285
|
+
/** Matcher for the entry value. */
|
|
2286
|
+
export type UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItemValue = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
2287
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItemValue: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
2288
|
+
export type UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItem = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem;
|
|
2289
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatchHeadersItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
2290
|
+
/** Header matchers. Multiple entries are ANDed. Header names are compared case-insensitively (RFC 9110); header values are compared case-sensitively. When a request has multiple values for the same header, any matching value satisfies the matcher. */
|
|
2291
|
+
export type UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatchHeadersList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
2292
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatchHeadersList: S.Schema<UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatchHeadersList>;
|
|
2293
|
+
/** Optional L7 match. When provided, the injection rule only applies to requests that satisfy every specified dimension. When multiple injection rules target the same domain they are evaluated in order and the first match wins; a rule without `match` matches any request and shadows later rules for the same domain. */
|
|
2294
|
+
export interface UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatch {
|
|
2295
|
+
/** Match on the request path. Comparison is case-sensitive. */
|
|
2296
|
+
path?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
2297
|
+
/** HTTP methods to match. Any single match succeeds (OR semantics). */
|
|
2298
|
+
method?: UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatchMethodList;
|
|
2299
|
+
/** Query-string entry matchers. Multiple entries are ANDed. Query parameter names and values are both compared case-sensitively (RFC 3986). When a request has multiple values for the same key, any matching value satisfies the matcher. */
|
|
2300
|
+
queryString?: UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringList;
|
|
2301
|
+
/** Header matchers. Multiple entries are ANDed. Header names are compared case-insensitively (RFC 9110); header values are compared case-sensitively. When a request has multiple values for the same header, any matching value satisfies the matcher. */
|
|
2302
|
+
headers?: UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatchHeadersList;
|
|
2303
|
+
}
|
|
2304
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatch: S.Schema<UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatch>;
|
|
2305
|
+
export interface UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItem {
|
|
2306
|
+
/** The domain (or pattern) of requests to add headers for. Supports wildcards like *.example.com. */
|
|
2307
|
+
domain: string;
|
|
2308
|
+
/** HTTP headers to inject into requests for this domain. Existing headers with the same name will be overridden. */
|
|
2309
|
+
headers: UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemHeadersMap;
|
|
2310
|
+
/** Optional L7 match. When provided, the injection rule only applies to requests that satisfy every specified dimension. When multiple injection rules target the same domain they are evaluated in order and the first match wins; a rule without `match` matches any request and shadows later rules for the same domain. */
|
|
2311
|
+
match?: UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItemMatch;
|
|
2312
|
+
}
|
|
2313
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItem: S.Schema<UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItem>;
|
|
2314
|
+
/** HTTP header injection rules for outgoing requests matching specific domains. Traffic to matching domains will be intercepted instead of proxied through encrypted connections. */
|
|
2315
|
+
export type UpdateSandboxRequestNetworkPolicyCase0InjectionRulesList = Array<UpdateSandboxRequestNetworkPolicyCase0InjectionRulesItem>;
|
|
2316
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase0InjectionRulesList: S.Schema<UpdateSandboxRequestNetworkPolicyCase0InjectionRulesList>;
|
|
2317
|
+
/** Network access policy for the sandbox.\n Controls which external hosts the sandbox can communicate with.\n Use \"allow-all\" mode to allow all traffic, \"deny-all\" to block all traffic or \"custom\" to provide specific rules. */
|
|
2318
|
+
export interface UpdateSandboxRequestNetworkPolicyCase0 {
|
|
2319
|
+
/** The network access policy mode. Use \"allow-all\" to permit all outbound traffic. Use \"deny-all\" to block all outbound traffic. Use \"custom\" to specify explicit allow/deny rules. */
|
|
2320
|
+
mode: UpdateSandboxRequestNetworkPolicyCase0Mode | (string & {});
|
|
2321
|
+
/** List of domain names the sandbox is allowed to connect to. Only applies when mode is \"custom\". Supports wildcard patterns (e.g., \"*.example.com\" matches all subdomains). */
|
|
2322
|
+
allowedDomains?: UpdateSandboxRequestNetworkPolicyCase0AllowedDomainsList;
|
|
2323
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is allowed to connect to. Traffic to these addresses bypasses domain-based restrictions. */
|
|
2324
|
+
allowedCIDRs?: UpdateSandboxRequestNetworkPolicyCase0AllowedCIDRsList;
|
|
2325
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is blocked from connecting to. These rules take precedence over all allowed rules. */
|
|
2326
|
+
deniedCIDRs?: UpdateSandboxRequestNetworkPolicyCase0DeniedCIDRsList;
|
|
2327
|
+
/** HTTP header injection rules for outgoing requests matching specific domains. Traffic to matching domains will be intercepted instead of proxied through encrypted connections. */
|
|
2328
|
+
injectionRules?: UpdateSandboxRequestNetworkPolicyCase0InjectionRulesList;
|
|
2329
|
+
}
|
|
2330
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase0: S.Schema<UpdateSandboxRequestNetworkPolicyCase0>;
|
|
2331
|
+
export type UpdateSandboxRequestNetworkPolicyCase1AllowCase0List = Array<string>;
|
|
2332
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase1AllowCase0List: S.Schema<UpdateSandboxRequestNetworkPolicyCase1AllowCase0List>;
|
|
2333
|
+
/** Match on the request path. Comparison is case-sensitive. */
|
|
2334
|
+
export type UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatchPath = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
2335
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatchPath: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
2336
|
+
/** HTTP methods to match. Any single match succeeds (OR semantics). */
|
|
2337
|
+
export type UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatchMethodList = Array<string>;
|
|
2338
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatchMethodList: S.Schema<UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatchMethodList>;
|
|
2339
|
+
/** Matcher for the entry key (header name or query key). */
|
|
2340
|
+
export type UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItemKey = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
2341
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItemKey: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
2342
|
+
/** Matcher for the entry value. */
|
|
2343
|
+
export type UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItemValue = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
2344
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItemValue: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
2345
|
+
export type UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItem = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem;
|
|
2346
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
2347
|
+
/** Query-string entry matchers. Multiple entries are ANDed. Query parameter names and values are both compared case-sensitively (RFC 3986). When a request has multiple values for the same key, any matching value satisfies the matcher. */
|
|
2348
|
+
export type UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
2349
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringList: S.Schema<UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringList>;
|
|
2350
|
+
/** Matcher for the entry key (header name or query key). */
|
|
2351
|
+
export type UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItemKey = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
2352
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItemKey: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
2353
|
+
/** Matcher for the entry value. */
|
|
2354
|
+
export type UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItemValue = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
2355
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItemValue: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
2356
|
+
export type UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItem = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem;
|
|
2357
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
2358
|
+
/** Header matchers. Multiple entries are ANDed. Header names are compared case-insensitively (RFC 9110); header values are compared case-sensitively. When a request has multiple values for the same header, any matching value satisfies the matcher. */
|
|
2359
|
+
export type UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
2360
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersList: S.Schema<UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersList>;
|
|
2361
|
+
/** Optional L7 match. When provided, the injection rule only applies to requests that satisfy every specified dimension. When multiple injection rules target the same domain they are evaluated in order and the first match wins; a rule without `match` matches any request and shadows later rules for the same domain. */
|
|
2362
|
+
export interface UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatch {
|
|
2363
|
+
/** Match on the request path. Comparison is case-sensitive. */
|
|
2364
|
+
path?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
2365
|
+
/** HTTP methods to match. Any single match succeeds (OR semantics). */
|
|
2366
|
+
method?: UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatchMethodList;
|
|
2367
|
+
/** Query-string entry matchers. Multiple entries are ANDed. Query parameter names and values are both compared case-sensitively (RFC 3986). When a request has multiple values for the same key, any matching value satisfies the matcher. */
|
|
2368
|
+
queryString?: UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatchQueryStringList;
|
|
2369
|
+
/** Header matchers. Multiple entries are ANDed. Header names are compared case-insensitively (RFC 9110); header values are compared case-sensitively. When a request has multiple values for the same header, any matching value satisfies the matcher. */
|
|
2370
|
+
headers?: UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatchHeadersList;
|
|
2371
|
+
}
|
|
2372
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatch: S.Schema<UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatch>;
|
|
2373
|
+
export type UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemTransformItemHeadersMap = {
|
|
2374
|
+
[key: string]: string | undefined;
|
|
2375
|
+
};
|
|
2376
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemTransformItemHeadersMap: S.Schema<UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemTransformItemHeadersMap>;
|
|
2377
|
+
export interface UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemTransformItem {
|
|
2378
|
+
headers?: UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemTransformItemHeadersMap;
|
|
2379
|
+
}
|
|
2380
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemTransformItem: S.Schema<UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemTransformItem>;
|
|
2381
|
+
export type UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemTransformList = Array<UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemTransformItem>;
|
|
2382
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemTransformList: S.Schema<UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemTransformList>;
|
|
2383
|
+
export interface UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItem {
|
|
2384
|
+
/** Optional L7 match. When provided, the injection rule only applies to requests that satisfy every specified dimension. When multiple injection rules target the same domain they are evaluated in order and the first match wins; a rule without `match` matches any request and shadows later rules for the same domain. */
|
|
2385
|
+
match?: UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemMatch;
|
|
2386
|
+
transform?: UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItemTransformList;
|
|
2387
|
+
/** HTTP/1.1 proxy URL to forward traffic to. Must not include username, password, query string, or fragment. */
|
|
2388
|
+
forwardURL?: string;
|
|
2389
|
+
}
|
|
2390
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItem: S.Schema<UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItem>;
|
|
2391
|
+
export type UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueList = Array<UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueItem>;
|
|
2392
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueList: S.Schema<UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueList>;
|
|
2393
|
+
/** A rule applied to requests matching a domain in the network policy. Only one of `transform` or `forwardURL` can be specified per rule. */
|
|
2394
|
+
export type UpdateSandboxRequestNetworkPolicyCase1AllowCase1Map = {
|
|
2395
|
+
[key: string]: UpdateSandboxRequestNetworkPolicyCase1AllowCase1ValueList | undefined;
|
|
2396
|
+
};
|
|
2397
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase1AllowCase1Map: S.Schema<UpdateSandboxRequestNetworkPolicyCase1AllowCase1Map>;
|
|
2398
|
+
export type UpdateSandboxRequestNetworkPolicyCase1Allow = UpdateSandboxRequestNetworkPolicyCase1AllowCase0List | UpdateSandboxRequestNetworkPolicyCase1AllowCase1Map;
|
|
2399
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase1Allow: S.Schema<UpdateSandboxRequestNetworkPolicyCase1Allow>;
|
|
2400
|
+
export type UpdateSandboxRequestNetworkPolicyCase1SubnetsAllowList = Array<string>;
|
|
2401
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase1SubnetsAllowList: S.Schema<UpdateSandboxRequestNetworkPolicyCase1SubnetsAllowList>;
|
|
2402
|
+
export type UpdateSandboxRequestNetworkPolicyCase1SubnetsDenyList = Array<string>;
|
|
2403
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase1SubnetsDenyList: S.Schema<UpdateSandboxRequestNetworkPolicyCase1SubnetsDenyList>;
|
|
2404
|
+
export interface UpdateSandboxRequestNetworkPolicyCase1Subnets {
|
|
2405
|
+
allow?: UpdateSandboxRequestNetworkPolicyCase1SubnetsAllowList;
|
|
2406
|
+
deny?: UpdateSandboxRequestNetworkPolicyCase1SubnetsDenyList;
|
|
2407
|
+
}
|
|
2408
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase1Subnets: S.Schema<UpdateSandboxRequestNetworkPolicyCase1Subnets>;
|
|
2409
|
+
export interface UpdateSandboxRequestNetworkPolicyCase1 {
|
|
2410
|
+
allow?: UpdateSandboxRequestNetworkPolicyCase1Allow;
|
|
2411
|
+
subnets?: UpdateSandboxRequestNetworkPolicyCase1Subnets;
|
|
2412
|
+
}
|
|
2413
|
+
export declare const UpdateSandboxRequestNetworkPolicyCase1: S.Schema<UpdateSandboxRequestNetworkPolicyCase1>;
|
|
2414
|
+
export type UpdateSandboxRequestNetworkPolicy = UpdateSandboxRequestNetworkPolicyCase0 | UpdateSandboxRequestNetworkPolicyCase1;
|
|
2415
|
+
export declare const UpdateSandboxRequestNetworkPolicy: S.Schema<UpdateSandboxRequestNetworkPolicy>;
|
|
2416
|
+
/** The Vercel region in which to create the sandbox. */
|
|
2417
|
+
export type UpdateSandboxRequestRegion = "iad1" | "sfo1" | "cle1" | "cdg1" | "fra1" | "arn1" | "sin1" | "pdx1" | "lhr1" | "icn1" | "bom1" | "cpt1" | "dub1" | "gru1" | "hkg1" | "syd1" | "yul1" | "hnd1" | "kix1";
|
|
2418
|
+
export declare const UpdateSandboxRequestRegion: any;
|
|
2419
|
+
export type UpdateSandboxRequestFailoverRegionsItem = "iad1" | "sfo1" | "cle1" | "cdg1" | "fra1" | "arn1" | "sin1" | "pdx1" | "lhr1" | "icn1" | "bom1" | "cpt1" | "dub1" | "gru1" | "hkg1" | "syd1" | "yul1" | "hnd1" | "kix1";
|
|
2420
|
+
export declare const UpdateSandboxRequestFailoverRegionsItem: any;
|
|
2421
|
+
/** The regions the sandbox falls back to when it cannot be created in `region`. */
|
|
2422
|
+
export type UpdateSandboxRequestFailoverRegionsList = Array<UpdateSandboxRequestFailoverRegionsItem | (string & {})>;
|
|
2423
|
+
export declare const UpdateSandboxRequestFailoverRegionsList: S.Schema<UpdateSandboxRequestFailoverRegionsList>;
|
|
2424
|
+
/** Default environment variables for the sandbox. Set to empty object to clear. */
|
|
2425
|
+
export type UpdateSandboxRequestEnvMap = {
|
|
2426
|
+
[key: string]: string | undefined;
|
|
2427
|
+
};
|
|
2428
|
+
export declare const UpdateSandboxRequestEnvMap: S.Schema<UpdateSandboxRequestEnvMap>;
|
|
2429
|
+
/** List of ports to expose from the sandbox. Each port will be accessible via a unique URL. Maximum of 15 ports can be exposed. */
|
|
2430
|
+
export type UpdateSandboxRequestPortsList = Array<number>;
|
|
2431
|
+
export declare const UpdateSandboxRequestPortsList: S.Schema<UpdateSandboxRequestPortsList>;
|
|
2432
|
+
/** Key-value tags to associate with the sandbox. Replaces existing tags. Set to empty object to clear. Maximum 5 tags. */
|
|
2433
|
+
export type UpdateSandboxRequestTagsMap = {
|
|
2434
|
+
[key: string]: string | undefined;
|
|
2435
|
+
};
|
|
2436
|
+
export declare const UpdateSandboxRequestTagsMap: S.Schema<UpdateSandboxRequestTagsMap>;
|
|
2437
|
+
export interface UpdateSandboxRequest {
|
|
2438
|
+
/** The sandbox to update. */
|
|
2439
|
+
name: string;
|
|
2440
|
+
/** The project ID that owns the named sandbox. When provided, takes precedence over OIDC project context. */
|
|
2441
|
+
projectId?: string;
|
|
2442
|
+
/** Whether to automatically resume a stopped named sandbox by creating a new instance from its snapshot. Defaults to false. */
|
|
2443
|
+
resume?: boolean;
|
|
2444
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
2445
|
+
teamId?: string;
|
|
2446
|
+
/** The Team slug to perform the request on behalf of. */
|
|
2447
|
+
slug?: string;
|
|
2448
|
+
/** Resources to define the VM */
|
|
2449
|
+
resources?: CreateSandboxesByNameForkV2RequestResources;
|
|
2450
|
+
/** The runtime environment for the sandbox. Determines the pre-installed language runtimes and tools available. */
|
|
2451
|
+
runtime?: UpdateSandboxRequestRuntime | (string & {});
|
|
2452
|
+
/** Maximum duration in milliseconds that the sandbox can run before being automatically stopped. */
|
|
2453
|
+
timeout?: number;
|
|
2454
|
+
/** Whether the sandbox persists its state across restarts via automatic snapshots. */
|
|
2455
|
+
persistent?: boolean;
|
|
2456
|
+
/** Default snapshot expiration time in milliseconds. Set to 0 to disable expiration. When set, this value is used as the default expiration for all snapshots created for this sandbox. */
|
|
2457
|
+
snapshotExpiration?: UpdateSandboxRequestSnapshotExpiration;
|
|
2458
|
+
/** Protect the N most recent snapshots with different expiration/deletion behavior. Set to null to clear. */
|
|
2459
|
+
keepLastSnapshots?: UpdateSandboxRequestKeepLastSnapshots;
|
|
2460
|
+
networkPolicy?: UpdateSandboxRequestNetworkPolicy;
|
|
2461
|
+
/** The Vercel region in which to create the sandbox. */
|
|
2462
|
+
region?: UpdateSandboxRequestRegion | (string & {});
|
|
2463
|
+
/** The regions the sandbox falls back to when it cannot be created in `region`. */
|
|
2464
|
+
failoverRegions?: UpdateSandboxRequestFailoverRegionsList;
|
|
2465
|
+
/** Default environment variables for the sandbox. Set to empty object to clear. */
|
|
2466
|
+
env?: UpdateSandboxRequestEnvMap;
|
|
2467
|
+
/** List of ports to expose from the sandbox. Each port will be accessible via a unique URL. Maximum of 15 ports can be exposed. */
|
|
2468
|
+
ports?: UpdateSandboxRequestPortsList;
|
|
2469
|
+
/** The snapshot ID to set as the current snapshot. Must be active and belong to the same project. */
|
|
2470
|
+
currentSnapshotId?: string;
|
|
2471
|
+
/** Key-value tags to associate with the sandbox. Replaces existing tags. Set to empty object to clear. Maximum 5 tags. */
|
|
2472
|
+
tags?: UpdateSandboxRequestTagsMap;
|
|
2473
|
+
}
|
|
2474
|
+
export declare const UpdateSandboxRequest: S.Schema<UpdateSandboxRequest>;
|
|
2475
|
+
export type UpdateSandboxResponseBodyCase0RoutesList = Array<SandboxPublicRoute>;
|
|
2476
|
+
export declare const UpdateSandboxResponseBodyCase0RoutesList: S.Schema<UpdateSandboxResponseBodyCase0RoutesList>;
|
|
2477
|
+
export interface UpdateSandboxResponseBodyCase0 {
|
|
2478
|
+
routes: UpdateSandboxResponseBodyCase0RoutesList;
|
|
2479
|
+
sandbox: NamedSandbox;
|
|
2480
|
+
}
|
|
2481
|
+
export declare const UpdateSandboxResponseBodyCase0: S.Schema<UpdateSandboxResponseBodyCase0>;
|
|
2482
|
+
export type UpdateSandboxResponseBodyCase1RoutesList = Array<SandboxPublicRoute>;
|
|
2483
|
+
export declare const UpdateSandboxResponseBodyCase1RoutesList: S.Schema<UpdateSandboxResponseBodyCase1RoutesList>;
|
|
2484
|
+
export interface UpdateSandboxResponseBodyCase1 {
|
|
2485
|
+
sandbox: NamedSandbox;
|
|
2486
|
+
session: Session;
|
|
2487
|
+
routes: UpdateSandboxResponseBodyCase1RoutesList;
|
|
2488
|
+
resumed: boolean;
|
|
2489
|
+
}
|
|
2490
|
+
export declare const UpdateSandboxResponseBodyCase1: S.Schema<UpdateSandboxResponseBodyCase1>;
|
|
2491
|
+
export type UpdateSandboxResponseBody = UpdateSandboxResponseBodyCase0 | UpdateSandboxResponseBodyCase1;
|
|
2492
|
+
export declare const UpdateSandboxResponseBody: S.Schema<UpdateSandboxResponseBody>;
|
|
2493
|
+
export type UpdateSandboxResponse = UpdateSandboxResponseBody;
|
|
2494
|
+
export declare const UpdateSandboxResponse: S.Schema<UpdateSandboxResponse>;
|
|
2495
|
+
/** The network access policy mode. Use \"allow-all\" to permit all outbound traffic. Use \"deny-all\" to block all outbound traffic. Use \"custom\" to specify explicit allow/deny rules. */
|
|
2496
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase0Mode = "allow-all" | "deny-all" | "custom" | "default-allow" | "default-deny";
|
|
2497
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase0Mode: any;
|
|
2498
|
+
/** List of domain names the sandbox is allowed to connect to. Only applies when mode is \"custom\". Supports wildcard patterns (e.g., \"*.example.com\" matches all subdomains). */
|
|
2499
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase0AllowedDomainsList = Array<string>;
|
|
2500
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase0AllowedDomainsList: S.Schema<UpdateSessionNetworkPolicyRequestBodyCase0AllowedDomainsList>;
|
|
2501
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is allowed to connect to. Traffic to these addresses bypasses domain-based restrictions. */
|
|
2502
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase0AllowedCIDRsList = Array<string>;
|
|
2503
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase0AllowedCIDRsList: S.Schema<UpdateSessionNetworkPolicyRequestBodyCase0AllowedCIDRsList>;
|
|
2504
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is blocked from connecting to. These rules take precedence over all allowed rules. */
|
|
2505
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase0DeniedCIDRsList = Array<string>;
|
|
2506
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase0DeniedCIDRsList: S.Schema<UpdateSessionNetworkPolicyRequestBodyCase0DeniedCIDRsList>;
|
|
2507
|
+
/** HTTP headers to inject into requests for this domain. Existing headers with the same name will be overridden. */
|
|
2508
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemHeadersMap = {
|
|
2509
|
+
[key: string]: string | undefined;
|
|
2510
|
+
};
|
|
2511
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemHeadersMap: S.Schema<UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemHeadersMap>;
|
|
2512
|
+
/** Match on the request path. Comparison is case-sensitive. */
|
|
2513
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatchPath = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
2514
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatchPath: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
2515
|
+
/** HTTP methods to match. Any single match succeeds (OR semantics). */
|
|
2516
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatchMethodList = Array<string>;
|
|
2517
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatchMethodList: S.Schema<UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatchMethodList>;
|
|
2518
|
+
/** Matcher for the entry key (header name or query key). */
|
|
2519
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatchQueryStringItemKey = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
2520
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatchQueryStringItemKey: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
2521
|
+
/** Matcher for the entry value. */
|
|
2522
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatchQueryStringItemValue = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
2523
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatchQueryStringItemValue: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
2524
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatchQueryStringItem = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem;
|
|
2525
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatchQueryStringItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
2526
|
+
/** Query-string entry matchers. Multiple entries are ANDed. Query parameter names and values are both compared case-sensitively (RFC 3986). When a request has multiple values for the same key, any matching value satisfies the matcher. */
|
|
2527
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatchQueryStringList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
2528
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatchQueryStringList: S.Schema<UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatchQueryStringList>;
|
|
2529
|
+
/** Matcher for the entry key (header name or query key). */
|
|
2530
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatchHeadersItemKey = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
2531
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatchHeadersItemKey: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
2532
|
+
/** Matcher for the entry value. */
|
|
2533
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatchHeadersItemValue = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
2534
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatchHeadersItemValue: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
2535
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatchHeadersItem = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem;
|
|
2536
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatchHeadersItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
2537
|
+
/** Header matchers. Multiple entries are ANDed. Header names are compared case-insensitively (RFC 9110); header values are compared case-sensitively. When a request has multiple values for the same header, any matching value satisfies the matcher. */
|
|
2538
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatchHeadersList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
2539
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatchHeadersList: S.Schema<UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatchHeadersList>;
|
|
2540
|
+
/** Optional L7 match. When provided, the injection rule only applies to requests that satisfy every specified dimension. When multiple injection rules target the same domain they are evaluated in order and the first match wins; a rule without `match` matches any request and shadows later rules for the same domain. */
|
|
2541
|
+
export interface UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatch {
|
|
2542
|
+
/** Match on the request path. Comparison is case-sensitive. */
|
|
2543
|
+
path?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
2544
|
+
/** HTTP methods to match. Any single match succeeds (OR semantics). */
|
|
2545
|
+
method?: UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatchMethodList;
|
|
2546
|
+
/** Query-string entry matchers. Multiple entries are ANDed. Query parameter names and values are both compared case-sensitively (RFC 3986). When a request has multiple values for the same key, any matching value satisfies the matcher. */
|
|
2547
|
+
queryString?: UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatchQueryStringList;
|
|
2548
|
+
/** Header matchers. Multiple entries are ANDed. Header names are compared case-insensitively (RFC 9110); header values are compared case-sensitively. When a request has multiple values for the same header, any matching value satisfies the matcher. */
|
|
2549
|
+
headers?: UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatchHeadersList;
|
|
2550
|
+
}
|
|
2551
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatch: S.Schema<UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatch>;
|
|
2552
|
+
export interface UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItem {
|
|
2553
|
+
/** The domain (or pattern) of requests to add headers for. Supports wildcards like *.example.com. */
|
|
2554
|
+
domain: string;
|
|
2555
|
+
/** HTTP headers to inject into requests for this domain. Existing headers with the same name will be overridden. */
|
|
2556
|
+
headers: UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemHeadersMap;
|
|
2557
|
+
/** Optional L7 match. When provided, the injection rule only applies to requests that satisfy every specified dimension. When multiple injection rules target the same domain they are evaluated in order and the first match wins; a rule without `match` matches any request and shadows later rules for the same domain. */
|
|
2558
|
+
match?: UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItemMatch;
|
|
2559
|
+
}
|
|
2560
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItem: S.Schema<UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItem>;
|
|
2561
|
+
/** HTTP header injection rules for outgoing requests matching specific domains. Traffic to matching domains will be intercepted instead of proxied through encrypted connections. */
|
|
2562
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesList = Array<UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesItem>;
|
|
2563
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesList: S.Schema<UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesList>;
|
|
2564
|
+
/** Network access policy for the sandbox.\n Controls which external hosts the sandbox can communicate with.\n Use \"allow-all\" mode to allow all traffic, \"deny-all\" to block all traffic or \"custom\" to provide specific rules. */
|
|
2565
|
+
export interface UpdateSessionNetworkPolicyRequestBodyCase0 {
|
|
2566
|
+
/** The network access policy mode. Use \"allow-all\" to permit all outbound traffic. Use \"deny-all\" to block all outbound traffic. Use \"custom\" to specify explicit allow/deny rules. */
|
|
2567
|
+
mode: UpdateSessionNetworkPolicyRequestBodyCase0Mode | (string & {});
|
|
2568
|
+
/** List of domain names the sandbox is allowed to connect to. Only applies when mode is \"custom\". Supports wildcard patterns (e.g., \"*.example.com\" matches all subdomains). */
|
|
2569
|
+
allowedDomains?: UpdateSessionNetworkPolicyRequestBodyCase0AllowedDomainsList;
|
|
2570
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is allowed to connect to. Traffic to these addresses bypasses domain-based restrictions. */
|
|
2571
|
+
allowedCIDRs?: UpdateSessionNetworkPolicyRequestBodyCase0AllowedCIDRsList;
|
|
2572
|
+
/** List of IP address ranges (in CIDR notation) the sandbox is blocked from connecting to. These rules take precedence over all allowed rules. */
|
|
2573
|
+
deniedCIDRs?: UpdateSessionNetworkPolicyRequestBodyCase0DeniedCIDRsList;
|
|
2574
|
+
/** HTTP header injection rules for outgoing requests matching specific domains. Traffic to matching domains will be intercepted instead of proxied through encrypted connections. */
|
|
2575
|
+
injectionRules?: UpdateSessionNetworkPolicyRequestBodyCase0InjectionRulesList;
|
|
2576
|
+
}
|
|
2577
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase0: S.Schema<UpdateSessionNetworkPolicyRequestBodyCase0>;
|
|
2578
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase1AllowCase0List = Array<string>;
|
|
2579
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase1AllowCase0List: S.Schema<UpdateSessionNetworkPolicyRequestBodyCase1AllowCase0List>;
|
|
2580
|
+
/** Match on the request path. Comparison is case-sensitive. */
|
|
2581
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatchPath = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
2582
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatchPath: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
2583
|
+
/** HTTP methods to match. Any single match succeeds (OR semantics). */
|
|
2584
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatchMethodList = Array<string>;
|
|
2585
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatchMethodList: S.Schema<UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatchMethodList>;
|
|
2586
|
+
/** Matcher for the entry key (header name or query key). */
|
|
2587
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatchQueryStringItemKey = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
2588
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatchQueryStringItemKey: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
2589
|
+
/** Matcher for the entry value. */
|
|
2590
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatchQueryStringItemValue = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
2591
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatchQueryStringItemValue: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
2592
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatchQueryStringItem = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem;
|
|
2593
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatchQueryStringItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
2594
|
+
/** Query-string entry matchers. Multiple entries are ANDed. Query parameter names and values are both compared case-sensitively (RFC 3986). When a request has multiple values for the same key, any matching value satisfies the matcher. */
|
|
2595
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatchQueryStringList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
2596
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatchQueryStringList: S.Schema<UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatchQueryStringList>;
|
|
2597
|
+
/** Matcher for the entry key (header name or query key). */
|
|
2598
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatchHeadersItemKey = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
2599
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatchHeadersItemKey: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
2600
|
+
/** Matcher for the entry value. */
|
|
2601
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatchHeadersItemValue = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
2602
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatchHeadersItemValue: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath>;
|
|
2603
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatchHeadersItem = CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem;
|
|
2604
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatchHeadersItem: S.Schema<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
2605
|
+
/** Header matchers. Multiple entries are ANDed. Header names are compared case-insensitively (RFC 9110); header values are compared case-sensitively. When a request has multiple values for the same header, any matching value satisfies the matcher. */
|
|
2606
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatchHeadersList = Array<CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchQueryStringItem>;
|
|
2607
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatchHeadersList: S.Schema<UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatchHeadersList>;
|
|
2608
|
+
/** Optional L7 match. When provided, the injection rule only applies to requests that satisfy every specified dimension. When multiple injection rules target the same domain they are evaluated in order and the first match wins; a rule without `match` matches any request and shadows later rules for the same domain. */
|
|
2609
|
+
export interface UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatch {
|
|
2610
|
+
/** Match on the request path. Comparison is case-sensitive. */
|
|
2611
|
+
path?: CreateSandboxesByNameForkV2RequestNetworkPolicyCase0InjectionRulesItemMatchPath;
|
|
2612
|
+
/** HTTP methods to match. Any single match succeeds (OR semantics). */
|
|
2613
|
+
method?: UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatchMethodList;
|
|
2614
|
+
/** Query-string entry matchers. Multiple entries are ANDed. Query parameter names and values are both compared case-sensitively (RFC 3986). When a request has multiple values for the same key, any matching value satisfies the matcher. */
|
|
2615
|
+
queryString?: UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatchQueryStringList;
|
|
2616
|
+
/** Header matchers. Multiple entries are ANDed. Header names are compared case-insensitively (RFC 9110); header values are compared case-sensitively. When a request has multiple values for the same header, any matching value satisfies the matcher. */
|
|
2617
|
+
headers?: UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatchHeadersList;
|
|
2618
|
+
}
|
|
2619
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatch: S.Schema<UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatch>;
|
|
2620
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemTransformItemHeadersMap = {
|
|
2621
|
+
[key: string]: string | undefined;
|
|
2622
|
+
};
|
|
2623
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemTransformItemHeadersMap: S.Schema<UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemTransformItemHeadersMap>;
|
|
2624
|
+
export interface UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemTransformItem {
|
|
2625
|
+
headers?: UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemTransformItemHeadersMap;
|
|
2626
|
+
}
|
|
2627
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemTransformItem: S.Schema<UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemTransformItem>;
|
|
2628
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemTransformList = Array<UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemTransformItem>;
|
|
2629
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemTransformList: S.Schema<UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemTransformList>;
|
|
2630
|
+
export interface UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItem {
|
|
2631
|
+
/** Optional L7 match. When provided, the injection rule only applies to requests that satisfy every specified dimension. When multiple injection rules target the same domain they are evaluated in order and the first match wins; a rule without `match` matches any request and shadows later rules for the same domain. */
|
|
2632
|
+
match?: UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemMatch;
|
|
2633
|
+
transform?: UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItemTransformList;
|
|
2634
|
+
/** HTTP/1.1 proxy URL to forward traffic to. Must not include username, password, query string, or fragment. */
|
|
2635
|
+
forwardURL?: string;
|
|
2636
|
+
}
|
|
2637
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItem: S.Schema<UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItem>;
|
|
2638
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueList = Array<UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueItem>;
|
|
2639
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueList: S.Schema<UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueList>;
|
|
2640
|
+
/** A rule applied to requests matching a domain in the network policy. Only one of `transform` or `forwardURL` can be specified per rule. */
|
|
2641
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1Map = {
|
|
2642
|
+
[key: string]: UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1ValueList | undefined;
|
|
2643
|
+
};
|
|
2644
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1Map: S.Schema<UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1Map>;
|
|
2645
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase1Allow = UpdateSessionNetworkPolicyRequestBodyCase1AllowCase0List | UpdateSessionNetworkPolicyRequestBodyCase1AllowCase1Map;
|
|
2646
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase1Allow: S.Schema<UpdateSessionNetworkPolicyRequestBodyCase1Allow>;
|
|
2647
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase1SubnetsAllowList = Array<string>;
|
|
2648
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase1SubnetsAllowList: S.Schema<UpdateSessionNetworkPolicyRequestBodyCase1SubnetsAllowList>;
|
|
2649
|
+
export type UpdateSessionNetworkPolicyRequestBodyCase1SubnetsDenyList = Array<string>;
|
|
2650
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase1SubnetsDenyList: S.Schema<UpdateSessionNetworkPolicyRequestBodyCase1SubnetsDenyList>;
|
|
2651
|
+
export interface UpdateSessionNetworkPolicyRequestBodyCase1Subnets {
|
|
2652
|
+
allow?: UpdateSessionNetworkPolicyRequestBodyCase1SubnetsAllowList;
|
|
2653
|
+
deny?: UpdateSessionNetworkPolicyRequestBodyCase1SubnetsDenyList;
|
|
2654
|
+
}
|
|
2655
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase1Subnets: S.Schema<UpdateSessionNetworkPolicyRequestBodyCase1Subnets>;
|
|
2656
|
+
export interface UpdateSessionNetworkPolicyRequestBodyCase1 {
|
|
2657
|
+
allow?: UpdateSessionNetworkPolicyRequestBodyCase1Allow;
|
|
2658
|
+
subnets?: UpdateSessionNetworkPolicyRequestBodyCase1Subnets;
|
|
2659
|
+
}
|
|
2660
|
+
export declare const UpdateSessionNetworkPolicyRequestBodyCase1: S.Schema<UpdateSessionNetworkPolicyRequestBodyCase1>;
|
|
2661
|
+
export type UpdateSessionNetworkPolicyRequestBody = UpdateSessionNetworkPolicyRequestBodyCase0 | UpdateSessionNetworkPolicyRequestBodyCase1;
|
|
2662
|
+
export declare const UpdateSessionNetworkPolicyRequestBody: S.Schema<UpdateSessionNetworkPolicyRequestBody>;
|
|
2663
|
+
export interface UpdateSessionNetworkPolicyRequest {
|
|
2664
|
+
/** The unique identifier of the session to update the network policy for. */
|
|
2665
|
+
sessionId: string;
|
|
2666
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
2667
|
+
teamId?: string;
|
|
2668
|
+
/** The Team slug to perform the request on behalf of. */
|
|
2669
|
+
slug?: string;
|
|
2670
|
+
body?: UpdateSessionNetworkPolicyRequestBody;
|
|
2671
|
+
}
|
|
2672
|
+
export declare const UpdateSessionNetworkPolicyRequest: S.Schema<UpdateSessionNetworkPolicyRequest>;
|
|
2673
|
+
export interface UpdateSessionNetworkPolicyResponse {
|
|
2674
|
+
session: Session;
|
|
2675
|
+
}
|
|
2676
|
+
export declare const UpdateSessionNetworkPolicyResponse: S.Schema<UpdateSessionNetworkPolicyResponse>;
|
|
2677
|
+
export interface WriteSessionFilesRequest {
|
|
2678
|
+
/** The unique identifier of the session to write files to. */
|
|
2679
|
+
sessionId: string;
|
|
2680
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
2681
|
+
teamId?: string;
|
|
2682
|
+
/** The Team slug to perform the request on behalf of. */
|
|
2683
|
+
slug?: string;
|
|
2684
|
+
/** The target directory where the tarball contents will be extracted. If not specified, files are extracted to the sandbox home directory. */
|
|
2685
|
+
xCwd?: string;
|
|
2686
|
+
}
|
|
2687
|
+
export declare const WriteSessionFilesRequest: S.Schema<WriteSessionFilesRequest>;
|
|
2688
|
+
export type WriteSessionFilesResponse = unknown;
|
|
2689
|
+
export declare const WriteSessionFilesResponse: S.Schema<WriteSessionFilesResponse>;
|
|
2690
|
+
export type CreateSandboxesByNameForkV2Error = BadRequest | PaymentRequired | Forbidden | NotFound | Conflict | UnprocessableEntity | VercelOpError;
|
|
2691
|
+
/** Fork a named sandbox Forks a named sandbox, creating a new named sandbox from the source's configuration. Resources, timeout, ports, tags, network policy, mounts, Connect network, image, persistence, snapshot settings and — unlike the SDK-side fork — environment variables are copied from the source automatically (`interactive` is not). When the source has a snapshot the fork starts from it; otherwise it starts from the source's runtime/image. Any field provided in the request body overrides the value copied from the source. */
|
|
2692
|
+
export declare const createSandboxesByNameForkV2: API.OperationMethod<CreateSandboxesByNameForkV2Request, CreateSandboxesByNameForkV2Response, CreateSandboxesByNameForkV2Error, VercelOpContext>;
|
|
2693
|
+
export type CreateSandboxesByNameForkV3Error = BadRequest | PaymentRequired | Forbidden | NotFound | Conflict | UnprocessableEntity | VercelOpError;
|
|
2694
|
+
/** Fork a named sandbox Forks a named sandbox, creating a new named sandbox from the source's configuration. Resources, timeout, ports, tags, network policy, mounts, Connect network, image, persistence, snapshot settings and — unlike the SDK-side fork — environment variables are copied from the source automatically (`interactive` is not). When the source has a snapshot the fork starts from it; otherwise it starts from the source's runtime/image. Any field provided in the request body overrides the value copied from the source. Unlike v2, when neither the body nor the source provides a value, snapshots expire after 7 days by default and persistent sandboxes keep only their most recent snapshot (`keepLastSnapshots: null` disables the limit). */
|
|
2695
|
+
export declare const createSandboxesByNameForkV3: API.OperationMethod<CreateSandboxesByNameForkV3Request, CreateSandboxesByNameForkV3Response, CreateSandboxesByNameForkV3Error, VercelOpContext>;
|
|
2696
|
+
export type CreateSandboxesSessionsBySessionIdSnapshotV2Error = BadRequest | PaymentRequired | Forbidden | NotFound | UnprocessableEntity | VercelOpError;
|
|
2697
|
+
/** Create a snapshot Creates a point-in-time snapshot of a running session's filesystem. Snapshots can be used to quickly restore a session to a previous state or to create new sessions with pre-configured environments. The session must be running and able to accept commands for a snapshot to be created. The session will be terminated after the snapshot is created. */
|
|
2698
|
+
export declare const createSandboxesSessionsBySessionIdSnapshotV2: API.OperationMethod<CreateSandboxesSessionsBySessionIdSnapshotV2Request, CreateSandboxesSessionsBySessionIdSnapshotV2Response, CreateSandboxesSessionsBySessionIdSnapshotV2Error, VercelOpContext>;
|
|
2699
|
+
export type CreateSandboxesSessionsBySessionIdSnapshotV3Error = BadRequest | PaymentRequired | Forbidden | NotFound | UnprocessableEntity | VercelOpError;
|
|
2700
|
+
/** Create a snapshot Creates a point-in-time snapshot of a running session's filesystem. Snapshots can be used to quickly restore a session to a previous state or to create new sessions with pre-configured environments. The session must be running and able to accept commands for a snapshot to be created. The session will be terminated after the snapshot is created. Unlike v2, snapshots expire after 7 days when neither the request nor the sandbox configuration specifies an expiration. */
|
|
2701
|
+
export declare const createSandboxesSessionsBySessionIdSnapshotV3: API.OperationMethod<CreateSandboxesSessionsBySessionIdSnapshotV3Request, CreateSandboxesSessionsBySessionIdSnapshotV3Response, CreateSandboxesSessionsBySessionIdSnapshotV3Error, VercelOpContext>;
|
|
2702
|
+
export type CreateSandboxesV2Error = BadRequest | PaymentRequired | Forbidden | NotFound | Conflict | UnprocessableEntity | VercelOpError;
|
|
2703
|
+
/** Create a named sandbox Creates a named sandbox environment. Named sandboxes have a unique name within a project and support automatic snapshotting on shutdown. */
|
|
2704
|
+
export declare const createSandboxesV2: API.OperationMethod<CreateSandboxesV2Request, CreateSandboxesV2Response, CreateSandboxesV2Error, VercelOpContext>;
|
|
2705
|
+
export type CreateSandboxesV3Error = BadRequest | PaymentRequired | Forbidden | NotFound | Conflict | UnprocessableEntity | VercelOpError;
|
|
2706
|
+
/** Create a named sandbox Creates a named sandbox environment. Named sandboxes have a unique name within a project and support automatic snapshotting on shutdown. Unlike v2, this version has no `runtime` parameter: when no `image` is provided (and the sandbox is not restored from a snapshot), the sandbox is created from the default universal image. */
|
|
2707
|
+
export declare const createSandboxesV3: API.OperationMethod<CreateSandboxesV3Request, CreateSandboxesV3Response, CreateSandboxesV3Error, VercelOpContext>;
|
|
2708
|
+
export type CreateSandboxesV4Error = BadRequest | PaymentRequired | Forbidden | NotFound | Conflict | UnprocessableEntity | VercelOpError;
|
|
2709
|
+
/** Create a named sandbox Creates a named sandbox environment. Named sandboxes have a unique name within a project and support automatic snapshotting on shutdown. When no `image` is provided (and the sandbox is not restored from a snapshot), the sandbox is created from the default universal image. Unlike v3, snapshots expire after 7 days by default and persistent sandboxes keep only their most recent snapshot unless `keepLastSnapshots` is configured otherwise (or set to `null` to disable the limit). */
|
|
2710
|
+
export declare const createSandboxesV4: API.OperationMethod<CreateSandboxesV4Request, CreateSandboxesV4Response, CreateSandboxesV4Error, VercelOpContext>;
|
|
2711
|
+
export type CreateSessionDirectoryError = BadRequest | Forbidden | NotFound | UnprocessableEntity | VercelOpError;
|
|
2712
|
+
/** Create a directory Creates a new directory in a session's filesystem. By default, parent directories are created recursively if they don't exist (similar to `mkdir -p`). */
|
|
2713
|
+
export declare const createSessionDirectory: API.OperationMethod<CreateSessionDirectoryRequest, CreateSessionDirectoryResponse, CreateSessionDirectoryError, VercelOpContext>;
|
|
2714
|
+
export type DeleteDriveError = BadRequest | Forbidden | NotFound | Conflict | VercelOpError;
|
|
2715
|
+
/** Delete a drive Deletes a drive by project and name. Attached drives cannot be deleted. Stop or replace the session currently using the drive before retrying deletion. Drives are in private beta. Register your interest to get access: https://vercel.com/changelog/drives-for-vercel-sandbox-in-private-beta */
|
|
2716
|
+
export declare const deleteDrive: API.OperationMethod<DeleteDriveRequest, DeleteDriveResponse, DeleteDriveError, VercelOpContext>;
|
|
2717
|
+
export type DeleteSandboxError = BadRequest | Forbidden | NotFound | VercelOpError;
|
|
2718
|
+
/** Delete a sandbox Deletes a sandbox by name. If sandboxes are currently running, they will be stopped first. This operation deletes all sandbox entities with the given name and the named sandbox metadata. */
|
|
2719
|
+
export declare const deleteSandbox: API.OperationMethod<DeleteSandboxRequest, DeleteSandboxResponse, DeleteSandboxError, VercelOpContext>;
|
|
2720
|
+
export type DeleteSessionSnapshotError = BadRequest | Forbidden | NotFound | VercelOpError;
|
|
2721
|
+
/** Delete a snapshot Permanently deletes a snapshot and frees its associated storage. This action cannot be undone. After deletion, the snapshot can no longer be used to create new sessions. */
|
|
2722
|
+
export declare const deleteSessionSnapshot: API.OperationMethod<DeleteSessionSnapshotRequest, DeleteSessionSnapshotResponse, DeleteSessionSnapshotError, VercelOpContext>;
|
|
2723
|
+
export type ExtendSessionTimeoutError = BadRequest | Forbidden | NotFound | UnprocessableEntity | VercelOpError;
|
|
2724
|
+
/** Extend session timeout Extends the maximum execution time of a running session. The session must be active and able to accept commands. The total timeout cannot exceed the maximum allowed limit for your account. */
|
|
2725
|
+
export declare const extendSessionTimeout: API.OperationMethod<ExtendSessionTimeoutRequest, ExtendSessionTimeoutResponse, ExtendSessionTimeoutError, VercelOpContext>;
|
|
2726
|
+
export type GetNamedSandboxError = BadRequest | PaymentRequired | Forbidden | NotFound | Conflict | VercelOpError;
|
|
2727
|
+
/** Get a named sandbox Retrieves a named sandbox by name, including its current sandbox and routes. If the sandbox is stopped and resume is true, a new sandbox will be created from the most recent snapshot. */
|
|
2728
|
+
export declare const getNamedSandbox: API.OperationMethod<GetNamedSandboxRequest, GetNamedSandboxResponse, GetNamedSandboxError, VercelOpContext>;
|
|
2729
|
+
export type GetOrCreateDriveError = BadRequest | PaymentRequired | Forbidden | NotFound | Conflict | VercelOpError;
|
|
2730
|
+
/** Get or create a drive Gets an existing drive by project and name, or creates it when it does not exist. Drives are in private beta. Register your interest to get access: https://vercel.com/changelog/drives-for-vercel-sandbox-in-private-beta */
|
|
2731
|
+
export declare const getOrCreateDrive: API.OperationMethod<GetOrCreateDriveRequest, GetOrCreateDriveResponse, GetOrCreateDriveError, VercelOpContext>;
|
|
2732
|
+
export type GetSessionError = BadRequest | Forbidden | NotFound | VercelOpError;
|
|
2733
|
+
/** Get a session Retrieves detailed information about a specific session, including its current status, resource configuration, and exposed routes. */
|
|
2734
|
+
export declare const getSession: API.OperationMethod<GetSessionRequest, GetSessionResponse, GetSessionError, VercelOpContext>;
|
|
2735
|
+
export type GetSessionCommandError = BadRequest | Forbidden | NotFound | UnprocessableEntity | VercelOpError;
|
|
2736
|
+
/** Get a command Retrieves the current status and details of a command executed in a session. Use the `wait` parameter to block until the command finishes execution. */
|
|
2737
|
+
export declare const getSessionCommand: API.OperationMethod<GetSessionCommandRequest, GetSessionCommandResponse, GetSessionCommandError, VercelOpContext>;
|
|
2738
|
+
export type GetSessionCommandLogsError = BadRequest | Forbidden | NotFound | UnprocessableEntity | VercelOpError;
|
|
2739
|
+
/** Stream command logs Streams the output of a command in real-time using newline-delimited JSON (ND-JSON). Each entry includes the output data and stream type. Stream types include `stdout`, `stderr`, and `error` (for stream failures). */
|
|
2740
|
+
export declare const getSessionCommandLogs: API.OperationMethod<GetSessionCommandLogsRequest, GetSessionCommandLogsResponse, GetSessionCommandLogsError, VercelOpContext>;
|
|
2741
|
+
export type GetSessionSnapshotError = BadRequest | Forbidden | NotFound | VercelOpError;
|
|
2742
|
+
/** Get a snapshot Retrieves detailed information about a specific snapshot, including its creation time, size, expiration date, and the source session it was created from. */
|
|
2743
|
+
export declare const getSessionSnapshot: API.OperationMethod<GetSessionSnapshotRequest, GetSessionSnapshotResponse, GetSessionSnapshotError, VercelOpContext>;
|
|
2744
|
+
export type KillSessionCommandError = BadRequest | Forbidden | NotFound | UnprocessableEntity | VercelOpError;
|
|
2745
|
+
/** Kill a command Sends a signal to terminate a running command in a session. The signal can be used to gracefully stop (SIGTERM) or forcefully kill (SIGKILL) the process. The command must still be running for this operation to succeed. */
|
|
2746
|
+
export declare const killSessionCommand: API.OperationMethod<KillSessionCommandRequest, KillSessionCommandResponse, KillSessionCommandError, VercelOpContext>;
|
|
2747
|
+
export type ListDrivesError = BadRequest | Forbidden | NotFound | VercelOpError;
|
|
2748
|
+
/** List drives Retrieves a paginated list of drives belonging to a specific project. Drives are in private beta. Register your interest to get access: https://vercel.com/changelog/drives-for-vercel-sandbox-in-private-beta */
|
|
2749
|
+
export declare const listDrives: API.OperationMethod<ListDrivesRequest, ListDrivesResponse, ListDrivesError, VercelOpContext>;
|
|
2750
|
+
export type ListSessionCommandsError = BadRequest | Forbidden | NotFound | VercelOpError;
|
|
2751
|
+
/** List commands Retrieves a list of all commands that have been executed in a session, including their current status, exit codes, and execution times, ordered from the most recent to the oldest. */
|
|
2752
|
+
export declare const listSessionCommands: API.OperationMethod<ListSessionCommandsRequest, ListSessionCommandsResponse, ListSessionCommandsError, VercelOpContext>;
|
|
2753
|
+
export type ListSessionsError = BadRequest | Forbidden | NotFound | VercelOpError;
|
|
2754
|
+
/** List sessions Retrieves a paginated list of sessions belonging to a specific sandbox. Results are sorted by creation time and paginated using an opaque cursor. */
|
|
2755
|
+
export declare const listSessions: API.OperationMethod<ListSessionsRequest, ListSessionsResponse, ListSessionsError, VercelOpContext>;
|
|
2756
|
+
export type ListSessionSnapshotsError = BadRequest | Forbidden | NotFound | VercelOpError;
|
|
2757
|
+
/** List snapshots Retrieves a paginated list of snapshots for a specific project. */
|
|
2758
|
+
export declare const listSessionSnapshots: API.OperationMethod<ListSessionSnapshotsRequest, ListSessionSnapshotsResponse, ListSessionSnapshotsError, VercelOpContext>;
|
|
2759
|
+
export type ReadSessionFileError = BadRequest | Forbidden | NotFound | UnprocessableEntity | VercelOpError;
|
|
2760
|
+
/** Read a file Downloads the contents of a file from a session's filesystem. The file content is returned as a binary stream with appropriate Content-Disposition headers for file download. */
|
|
2761
|
+
export declare const readSessionFile: API.OperationMethod<ReadSessionFileRequest, ReadSessionFileResponse, ReadSessionFileError, VercelOpContext>;
|
|
2762
|
+
export type RunSessionCommandError = BadRequest | Forbidden | NotFound | UnprocessableEntity | VercelOpError;
|
|
2763
|
+
/** Execute a command Executes a shell command inside a running session. The command runs asynchronously and returns immediately with a command ID that can be used to track its progress and retrieve its output. Optionally, use the `wait` parameter to stream the command status until completion. */
|
|
2764
|
+
export declare const runSessionCommand: API.OperationMethod<RunSessionCommandRequest, RunSessionCommandResponse, RunSessionCommandError, VercelOpContext>;
|
|
2765
|
+
export type StopSessionError = BadRequest | Forbidden | NotFound | UnprocessableEntity | VercelOpError;
|
|
2766
|
+
/** Stop a session Stops a running session and releases its allocated resources. All running processes within the session will be terminated. This action cannot be undone. A stopped session cannot be restarted. */
|
|
2767
|
+
export declare const stopSession: API.OperationMethod<StopSessionRequest, StopSessionResponse, StopSessionError, VercelOpContext>;
|
|
2768
|
+
export type UpdateSandboxError = BadRequest | PaymentRequired | Forbidden | NotFound | Conflict | UnprocessableEntity | VercelOpError;
|
|
2769
|
+
/** Update a sandbox Updates the configuration of a sandbox. Only the provided fields will be modified; omitted fields remain unchanged. */
|
|
2770
|
+
export declare const updateSandbox: API.OperationMethod<UpdateSandboxRequest, UpdateSandboxResponse, UpdateSandboxError, VercelOpContext>;
|
|
2771
|
+
export type UpdateSessionNetworkPolicyError = BadRequest | Forbidden | NotFound | UnprocessableEntity | VercelOpError;
|
|
2772
|
+
/** Update network policy Replaces the network access policy of a running session. Use this to control which external hosts the session can communicate with. This is a full replacement. Any previously configured network rules will be overwritten. */
|
|
2773
|
+
export declare const updateSessionNetworkPolicy: API.OperationMethod<UpdateSessionNetworkPolicyRequest, UpdateSessionNetworkPolicyResponse, UpdateSessionNetworkPolicyError, VercelOpContext>;
|
|
2774
|
+
export type WriteSessionFilesError = BadRequest | Forbidden | NotFound | UnprocessableEntity | VercelOpError;
|
|
2775
|
+
/** Write files Uploads and extracts files to a session's filesystem. Files must be uploaded as a gzipped tarball (`.tar.gz`) with the `Content-Type` header set to `application/gzip`. The tarball contents are extracted to the session's working directory, or to a custom directory specified via the `x-cwd` header. */
|
|
2776
|
+
export declare const writeSessionFiles: API.OperationMethod<WriteSessionFilesRequest, WriteSessionFilesResponse, WriteSessionFilesError, VercelOpContext>;
|
|
2777
|
+
//# sourceMappingURL=sandboxes.d.ts.map
|