Update sandbox egress allowlists¶
Replace a limited sandbox’s tool and extra egress endpoint allowlists. This changes subsequent network access. Include every list entry you want to retain.
PATCH https://api.moi.matrixorigin.cn/v5/agent-sandboxes/{sandbox_id}/network
Before you call this API¶
Prepare a personal access token and operation permissions for the target workspace. Keep environment, token, workspace, and sandbox ID consistent. Common objects and result confirmation describes resource identity, fields, and states. Replace example resource values with actual values.
Request¶
curl -X PATCH "https://api.moi.matrixorigin.cn/v5/agent-sandboxes/$SANDBOX_ID/network" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
-H 'Content-Type: application/json' \
--data-binary '{"network_tools":["git"],"egress_endpoints":[{"host":"example.com","ports":[443]}]}'
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string |
Required in path |
Target limited sandbox ID. |
|
string (array of strings) |
No |
Complete desired tool list. Omission/null/[] all clear this list. |
|
object (array of objects) |
No |
Complete desired extra endpoint list. Omission/null/[] all clear it. |
This PATCH replaces both MOI-managed lists rather than updating only supplied fields. Unlike creation, where empty tools use defaults, omitting a list here clears it. These fields do not remove default control channels or independently managed rules. No updatable network_mode field exists, and unrestricted cannot become limited through this request. Allowlist updates for unrestricted sandboxes are rejected. See common network information for scope and format.
Successful response¶
{
"code": "OK",
"msg": "OK",
"data": {
"id": "sbx-example",
"workspace_id": "workspace-example",
"user_id": "user-example",
"name": "audit-runner",
"phase": "ready",
"edge_agent_id": "sbx-example",
"network_mode": "limited",
"network_tools": [
"git"
],
"egress_endpoints": [
{
"host": "example.com",
"ports": [
443
]
}
],
"spec": "medium",
"disk_gi": 10,
"created_at": "2026-11-11T08:00:00Z",
"updated_at": "2026-11-11T08:00:00Z",
"update_available": null
}
}
HTTP 200 data has the following meaning; example values are not defaults.
Field |
Type |
Description |
|---|---|---|
|
string |
OK on success. |
|
string |
Response description. |
|
object |
Updated sandbox and lists. |
Confirm the result¶
Check policy against the returned values and details, and verify actual target access if needed. The service attempts to restore the original policy on failure, but an error does not guarantee restoration. Save original settings for verification.
Error handling¶
Use HTTP status and response code. Common errors and recovery distinguishes parameters, permissions, quotas, providers, and unknown outcomes. An error does not prove no resource was created or that retries/cleanup have completed.