Skip to content

Commit 93b612d

Browse files
committed
Improve public reference completeness
1 parent 8edb9b2 commit 93b612d

21 files changed

Lines changed: 562 additions & 34 deletions

‎reference/manifest.json‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,43 +3,43 @@
33
"connect/filesystem.md": "1cc1e81386810d3c5c999458e02340e3becb3da8138d943558584094750e5aae",
44
"connect/process.md": "037574455e9e8c5159c391d8c007e7272560f62c4e5ee681f8aec29f9cd24539",
55
"openapi/control-plane.yml": "99e42c340a18ac1f3bda9321d347b01f6bd8326c39373e92797bfb179ee0a0bf",
6-
"openapi/envd.yml": "c8cb85cbdcfb0ae4ed55a3a0cd6f58b17a23b14bfe74be904a160e770c6e91c3",
6+
"openapi/envd.yml": "334700432025fcdfd9f95f9e58d90e6290b835015a24f269548eba5500c0df4f",
77
"openapi/markdown/assignTemplateTags.md": "3ec3dc705cbda5780d0a9e78234c7777f014784b2ec193821b6f5bb2ea26ec57",
8-
"openapi/markdown/composeFiles.md": "3e5c37b40268689b6e5287a906c75b80f71fefafe94205c6327c976ca0594d5c",
8+
"openapi/markdown/composeFiles.md": "172894794d346ac42d1357e28aafa5c6daea32f361977d0e8d7ac43b04c61577",
99
"openapi/markdown/connectSandbox.md": "9106d09a6f525aa0bcbd1eed06de62a4d015d1f6fa63496ccb6aebbebb3ad332",
10-
"openapi/markdown/createSandbox.md": "42b8b28e9aac9bcbbacec9dec346d043340f8c94ac497147a80910341572226f",
10+
"openapi/markdown/createSandbox.md": "3bf499af52b01f87e48dfa56c0af227d4d22f755444118e8a8422b216c851f8d",
1111
"openapi/markdown/createSnapshot.md": "433724d1260fd60e68268a2984f7ca7ae54a1cad120fb25a026b6a6518af004f",
1212
"openapi/markdown/createTemplate.md": "b31935eef9b0c29bcd9402f7401a4159c349bed8b3e5458c4490870574bc2974",
1313
"openapi/markdown/deleteTemplate.md": "3f9a6ab1e0ab144f0a68e41938ef23fd07ac2509b16f6b4b9df5478e54a5865c",
1414
"openapi/markdown/deleteTemplateTags.md": "1b907ed1b5d9cd55a3b21f46c207217af8a4efe0fe6ccb56a8f988567fc27395",
15-
"openapi/markdown/downloadFile.md": "d687f0fadf42a0c8d40324fbf6a732677dae38ed1cf02a755cf86eb9a5155abc",
16-
"openapi/markdown/forkSandbox.md": "bc7846648216b1104ed1d1661eb08b9881b3fef7616bfae49542eca1d228e76e",
17-
"openapi/markdown/getEnvironmentHealth.md": "640c9435ce216a6fd0e5da7ee646d8527e5de428c946fad219946f5c1de5622a",
18-
"openapi/markdown/getEnvironmentMetrics.md": "fb7ce3264e1500da24b21a07b5b180110fa573fc3fb476c146f4529c16e7c089",
19-
"openapi/markdown/getEnvironmentVariables.md": "12803bbc7e3f2638e16f013ce05b2a688d8085739e38049c1022452fd7881e50",
20-
"openapi/markdown/getSandbox.md": "9e9f1200583b9abb206e7c69e9d4157403297042d2dd1e57e5bd804962073a91",
21-
"openapi/markdown/getSandboxLogs.md": "6641f57b0ef9f7e029b66deb472616ea4abe54f3884b3021bfcf97b37920a598",
15+
"openapi/markdown/downloadFile.md": "828154a446933bd19b1f20ca9170f6e93f2f80872fc08e92e46d339872e8f45c",
16+
"openapi/markdown/forkSandbox.md": "84962addf6f2d49e40aaaca2e27f79e8e98991f703c7374e8852d4e47944dbc4",
17+
"openapi/markdown/getEnvironmentHealth.md": "7595329f0fceb5ba613d73f8c522287f7836651d9a2dc44002a149c3ca8c57bf",
18+
"openapi/markdown/getEnvironmentMetrics.md": "d6ebfaa682e3e2b6489703daf643b887362f5fdca055f9f3b2367143b03a5112",
19+
"openapi/markdown/getEnvironmentVariables.md": "58fe720040afa68bc542c0416378bab9642dbfe73d397b923b220e44bb4c2f54",
20+
"openapi/markdown/getSandbox.md": "fb4a7184f903a8bdd8c3b7ea1d00b10d17d26c6dc56b1e7f1a07f91f99aee09d",
21+
"openapi/markdown/getSandboxLogs.md": "a3055767e82145d9c0cb1953ee1081489c0098200018802292634e4cb3c830c2",
2222
"openapi/markdown/getSandboxMetrics.md": "1572d44d0ff539495dadcbb909bb1e640b73375fcb4b0840243e692066162ace",
2323
"openapi/markdown/getTeamMetrics.md": "063860650df86f09f1119f441b1410b1e329dd20000cf1b1f8a1f84fdcbdac53",
2424
"openapi/markdown/getTeamMetricsMax.md": "5e5e6578470d1710c993ae69a91b34badaaa86e62e141eb91e57c6e0f7594fe6",
25-
"openapi/markdown/getTemplate.md": "fa972635535ecb1b19324216185f75c90fe81520ed79dc7e20a0894306e054b3",
26-
"openapi/markdown/getTemplateBuildLogs.md": "c1dc222e7ab5268897e8fdda893d1264ac9162db146fb89bbe6c9833f350ab7f",
27-
"openapi/markdown/getTemplateBuildStatus.md": "26741b144d7ce26f353173bd0665b30925e6161d914317fb994bae5c2b4d0d3d",
25+
"openapi/markdown/getTemplate.md": "a4747e42b28bb014ae4eb3b5477fe6d58cfda25c00ae829c339cfb7ef5ec6715",
26+
"openapi/markdown/getTemplateBuildLogs.md": "5f696d204a13be42ce9df32b51ac4680b853231595d84e14aca9db7e05b385ff",
27+
"openapi/markdown/getTemplateBuildStatus.md": "7ef1697ca9b6c3d44624df8ca528fdc5e4f81ebd226c748ae2183b2e99e27757",
2828
"openapi/markdown/getTemplateByAlias.md": "2a42010266038d50581e3526becf1f35ad3ada6eecd757522b083817fe435301",
2929
"openapi/markdown/getTemplateUploadUrl.md": "b06cb4aaed389e75daa8e509e3437a23915aad2b03ef6e69597df67984a48b19",
3030
"openapi/markdown/killSandbox.md": "c864528a36849a512be77bf144ef7d41356f01cb0dbbe1d2f5143712a95268f2",
31-
"openapi/markdown/listSandboxMetrics.md": "b945d76f80dc2fef506d2f21183bca49ddb045773b8895b6412e435e5c9d6d7f",
32-
"openapi/markdown/listSandboxes.md": "7744505b60b94d1c8db8c1b7a1a66bcf9bdb8f51a46b13b5a90349e562924f59",
31+
"openapi/markdown/listSandboxMetrics.md": "38cc35b6d1087635efc6fa351da48402a021f12b185e3bbfbafacc64a34b8d87",
32+
"openapi/markdown/listSandboxes.md": "ebb79c21ab83ad61ea2e7c738fa2f77d37c001e2d09142508209e7beab687aeb",
3333
"openapi/markdown/listSnapshots.md": "d7f7ae67491c5da2930181b0fe423ef8ad661f5f4e7e88f47ecfb58cb08ac83f",
3434
"openapi/markdown/listTemplateTags.md": "df27ed0dc04e6b49a3dc92704842e30365f50e88c8e28e6a5323a16aa10b7c45",
3535
"openapi/markdown/listTemplates.md": "e89b7d18efcfa6e16385e6b4e2f227ad2e5c9fa7608426ece673077a35468e12",
3636
"openapi/markdown/pauseSandbox.md": "0d1e7dd52ca966d37742e7d34898559dfd03c4ba3ca7f83f1859ddaefa9b0464",
3737
"openapi/markdown/refreshSandbox.md": "dea1862241aad45c17b194994722a23941263bb697b885e795ba97cf154469bd",
3838
"openapi/markdown/setSandboxTimeout.md": "ee0aaf78e2c0ffcdf4df1bde703fd4442d5436efad290bc235d1acc120adb997",
39-
"openapi/markdown/startTemplateBuild.md": "befd11983028352bd7bf727113deb9bbb7d86d7b02385441111f4de46087173c",
40-
"openapi/markdown/updateSandboxNetwork.md": "3449bd43a4e46c35d3f8ec314a47876ec06f85a8a75e4255212a85cb7a4c3e53",
39+
"openapi/markdown/startTemplateBuild.md": "f987c7627a0170ff2908fd344d76acea3b2d8f7875686ff746ad8a8b2b3922c4",
40+
"openapi/markdown/updateSandboxNetwork.md": "0254acd4dca8299bd7198024660bb1300752c6842f225c604389dd1951333675",
4141
"openapi/markdown/updateTemplate.md": "ace7930be4091213fc2e29a7109f489eaaf3a0e1d210aa65d9663a5adbf92250",
42-
"openapi/markdown/uploadFile.md": "fe1dcc1b1eaad25ecd73f8c00a49c94ca7c2686fbdb6f3e2fbbebbfec6928806",
42+
"openapi/markdown/uploadFile.md": "2c3b042f305f2e7234799f0af14979965e76a10ced1a74a464bb6afd96c5c68c",
4343
"openapi/operations.json": "f5097d93fb7eb5f6482e632624d5a212e29441ef8c558601ccbe2dae26db050d",
4444
"sdk/cli/auth.md": "0b2c75262b0c0670c7bc0f0f3cbed65fbe4a16d6fe4437789a5685b8bf2174a1",
4545
"sdk/cli/sandbox.md": "16b64c5a4e932eca2452e400e0faf154eba1d3c7373513aa7cd9744e02908313",

‎reference/openapi/envd.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ paths:
1616
operationId: getEnvironmentHealth
1717
tags:
1818
- environment
19+
parameters:
20+
- $ref: '#/components/parameters/AgentboxSandboxId'
21+
- $ref: '#/components/parameters/AgentboxSandboxPort'
1922
security: []
2023
/metrics:
2124
get:
@@ -30,6 +33,9 @@ paths:
3033
operationId: getEnvironmentMetrics
3134
tags:
3235
- environment
36+
parameters:
37+
- $ref: '#/components/parameters/AgentboxSandboxId'
38+
- $ref: '#/components/parameters/AgentboxSandboxPort'
3339
security:
3440
- {}
3541
- AccessTokenAuth: []
@@ -46,6 +52,9 @@ paths:
4652
operationId: getEnvironmentVariables
4753
tags:
4854
- environment
55+
parameters:
56+
- $ref: '#/components/parameters/AgentboxSandboxId'
57+
- $ref: '#/components/parameters/AgentboxSandboxPort'
4958
security:
5059
- {}
5160
- AccessTokenAuth: []
@@ -55,6 +64,8 @@ paths:
5564
tags:
5665
- files
5766
parameters:
67+
- $ref: '#/components/parameters/AgentboxSandboxId'
68+
- $ref: '#/components/parameters/AgentboxSandboxPort'
5869
- $ref: '#/components/parameters/FilePath'
5970
- $ref: '#/components/parameters/User'
6071
- $ref: '#/components/parameters/Signature'
@@ -122,6 +133,8 @@ paths:
122133
tags:
123134
- files
124135
parameters:
136+
- $ref: '#/components/parameters/AgentboxSandboxId'
137+
- $ref: '#/components/parameters/AgentboxSandboxPort'
125138
- $ref: '#/components/parameters/FilePath'
126139
- $ref: '#/components/parameters/User'
127140
- $ref: '#/components/parameters/Signature'
@@ -173,6 +186,9 @@ paths:
173186
'507':
174187
$ref: '#/components/responses/NotEnoughDiskSpace'
175188
operationId: composeFiles
189+
parameters:
190+
- $ref: '#/components/parameters/AgentboxSandboxId'
191+
- $ref: '#/components/parameters/AgentboxSandboxPort'
176192
security:
177193
- {}
178194
- AccessTokenAuth: []
@@ -209,6 +225,21 @@ components:
209225
used with the signature parameter.
210226
schema:
211227
type: integer
228+
AgentboxSandboxId:
229+
name: Agentbox-Sandbox-Id
230+
in: header
231+
required: true
232+
description: Identifier of the sandbox that receives the request.
233+
schema:
234+
type: string
235+
AgentboxSandboxPort:
236+
name: Agentbox-Sandbox-Port
237+
in: header
238+
required: true
239+
description: Internal envd HTTP port exposed through the sandbox proxy.
240+
schema:
241+
type: integer
242+
default: 49983
212243
requestBodies:
213244
File:
214245
required: true
@@ -399,3 +430,6 @@ components:
399430
type: apiKey
400431
in: header
401432
name: X-Access-Token
433+
servers:
434+
- url: https://sandbox.agentbox-runtime.ru
435+
description: AgentBox sandbox proxy. Routing headers are required.

‎reference/openapi/markdown/composeFiles.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

33
Compose multiple files into a single file using zero-copy concatenation. Source files are deleted after successful composition.
44

5+
## Parameters
6+
7+
- **`Agentbox-Sandbox-Id`** · `string` · header · required
8+
9+
Identifier of the sandbox that receives the request.
10+
11+
- **`Agentbox-Sandbox-Port`** · `integer` · header · required
12+
13+
Internal envd HTTP port exposed through the sandbox proxy.
14+
515
## Request body
616

717
Required: yes
@@ -48,6 +58,8 @@ Schema: `EntryInfo`
4858

4959
User-defined metadata stored as extended attributes on the file.
5060

61+
- **`metadata.*`** · `string` · additional property
62+
5163
### 400
5264

5365
Invalid path

‎reference/openapi/markdown/createSandbox.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ Schema: `NewSandbox`
3232

3333
Auto-resume configuration for paused sandboxes.
3434

35+
- **`autoResume.enabled`** · `SandboxAutoResumeEnabled` · required
36+
37+
Auto-resume enabled flag for paused sandboxes. Default false.
38+
3539
- **`secure`** · `boolean` · optional
3640

3741
Secure all system communication with sandbox
@@ -42,18 +46,74 @@ Schema: `NewSandbox`
4246

4347
- **`network`** · `SandboxNetworkConfig` · optional
4448

49+
- **`network.allowPublicTraffic`** · `boolean` · optional
50+
51+
Specify if the sandbox URLs should be accessible only with authentication.
52+
53+
- **`network.allowOut`** · `array<string>` · optional
54+
55+
List of allowed destinations for egress traffic. Each entry can be a CIDR block (e.g. "8.8.8.8/32"), a bare IP address (e.g. "8.8.8.8"), or a domain name (e.g. "example.com", "*.example.com"). Allowed entries always take precedence over denied entries.
56+
57+
- **`network.denyOut`** · `array<string>` · optional
58+
59+
List of denied CIDR blocks or IP addresses for egress traffic. Domain names are not supported for deny rules.
60+
61+
- **`network.maskRequestHost`** · `string` · optional
62+
63+
Specify host mask which will be used for all sandbox requests
64+
65+
- **`network.rules`** · `object` · optional
66+
67+
Per-domain transform rules applied to matching egress HTTP/HTTPS requests. Keys are domains (e.g. "api.example.com", "example.com"). A domain listed here is not automatically allowed - use allowOut to permit the traffic.
68+
69+
- **`network.rules.*`** · `array<SandboxNetworkRule>` · additional property
70+
71+
- **`network.rules.*.transform`** · `SandboxNetworkTransform` · optional
72+
73+
Transformations applied to matching egress requests before forwarding.
74+
75+
- **`network.rules.*.transform.headers`** · `object` · optional
76+
77+
HTTP headers to inject or override in matching requests. An existing header with the same name is replaced. Values are plain strings; secret resolution happens client-side before sending to the API.
78+
79+
- **`network.rules.*.transform.headers.*`** · `string` · additional property
80+
4581
- **`metadata`** · `SandboxMetadata` · optional
4682

83+
- **`metadata.*`** · `string` · additional property
84+
85+
Metadata of the sandbox
86+
4787
- **`envVars`** · `EnvVars` · optional
4888

89+
- **`envVars.*`** · `string` · additional property
90+
91+
Environment variables for the sandbox
92+
4993
- **`mcp`** · `Mcp` · optional
5094

5195
MCP configuration for the sandbox
5296

97+
- **`mcp.*`** · `object` · additional property
98+
5399
- **`iam`** · `SandboxIam` · optional
54100

55101
Sandbox workload identity configuration. A non-empty, valid tokens map enables workload identity for the sandbox.
56102

103+
- **`iam.tokens`** · `SandboxIamTokens` · optional
104+
105+
Named workload-token definitions, keyed by a caller-chosen token name.
106+
107+
- **`iam.tokens.*`** · `SandboxIamToken` · additional property
108+
109+
- **`iam.tokens.*.audience`** · `string` · required
110+
111+
Audience of the workload token, stored exactly as provided.
112+
113+
- **`iam.tokens.*.tokenType`** · `string` · required
114+
115+
Workload token type.
116+
57117
## Responses
58118

59119
### 201

‎reference/openapi/markdown/downloadFile.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ Download a file
44

55
## Parameters
66

7+
- **`Agentbox-Sandbox-Id`** · `string` · header · required
8+
9+
Identifier of the sandbox that receives the request.
10+
11+
- **`Agentbox-Sandbox-Port`** · `integer` · header · required
12+
13+
Internal envd HTTP port exposed through the sandbox proxy.
14+
715
- **`path`** · `string` · query · optional
816

917
Path to the file, URL encoded. Can be relative to the user's home directory (e.g. "file.txt" resolves to ~/file.txt).

‎reference/openapi/markdown/forkSandbox.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,36 @@ Schema: `array<SandboxForkResult>`
3636

3737
- **`sandbox`** · `Sandbox` · optional
3838

39+
- **`sandbox.templateID`** · `string` · required
40+
41+
Identifier of the template from which is the sandbox created
42+
43+
- **`sandbox.sandboxID`** · `string` · required
44+
45+
Identifier of the sandbox
46+
47+
- **`sandbox.alias`** · `string` · optional
48+
49+
Alias of the template
50+
51+
- **`sandbox.envdVersion`** · `EnvdVersion` · required
52+
53+
Version of the envd running in the sandbox
54+
55+
- **`sandbox.domain`** · `string` · optional
56+
57+
Base domain where the sandbox traffic is accessible
58+
3959
- **`error`** · `Error` · optional
4060

61+
- **`error.code`** · `integer` · required
62+
63+
Error code
64+
65+
- **`error.message`** · `string` · required
66+
67+
Error
68+
4169
### 409
4270

4371
Conflict

‎reference/openapi/markdown/getEnvironmentHealth.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

33
Check the health of the service
44

5+
## Parameters
6+
7+
- **`Agentbox-Sandbox-Id`** · `string` · header · required
8+
9+
Identifier of the sandbox that receives the request.
10+
11+
- **`Agentbox-Sandbox-Port`** · `integer` · header · required
12+
13+
Internal envd HTTP port exposed through the sandbox proxy.
14+
515
## Responses
616

717
### 204

‎reference/openapi/markdown/getEnvironmentMetrics.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

33
Service stats
44

5+
## Parameters
6+
7+
- **`Agentbox-Sandbox-Id`** · `string` · header · required
8+
9+
Identifier of the sandbox that receives the request.
10+
11+
- **`Agentbox-Sandbox-Port`** · `integer` · header · required
12+
13+
Internal envd HTTP port exposed through the sandbox proxy.
14+
515
## Responses
616

717
### 200

‎reference/openapi/markdown/getEnvironmentVariables.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

33
Environment variables
44

5+
## Parameters
6+
7+
- **`Agentbox-Sandbox-Id`** · `string` · header · required
8+
9+
Identifier of the sandbox that receives the request.
10+
11+
- **`Agentbox-Sandbox-Port`** · `integer` · header · required
12+
13+
Internal envd HTTP port exposed through the sandbox proxy.
14+
515
## Responses
616

717
### 200
@@ -11,3 +21,5 @@ Environment variables
1121
Content-Type: `application/json`
1222

1323
Schema: `EnvVars`
24+
25+
- **`*`** · `string` · additional property

0 commit comments

Comments
 (0)