Delete a managed sandbox¶
Advance credential, remote resource, and Ownership cleanup within the request. Success returns 200 and an empty object.
DELETE https://api.moi.matrixorigin.cn/v5/admin/agent-sandboxes/{id}
Before you call this API¶
Prepare a valid identity for this environment, configured administrator privileges, and an accessible authentication Workspace. Workspace Owner status or Genesis taas:admin does not automatically grant these administrator privileges. The example uses a personal access token and one X-Workspace-ID. See AI Studio.
Before deletion, confirm the target Workspace, resource ID, and data that may be deleted. This operation cannot recover original runtime contents; verify only on resources you are authorized to discard. An error may occur after partial cleanup or after deletion intent is persisted. Check the original resource and recovery records. A 404 or disappearance from a list does not establish completed cleanup. Do not create a replacement resource over the original ID.
Request parameters¶
curl -X DELETE "https://api.moi.matrixorigin.cn/v5/admin/agent-sandboxes/sandbox-example" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $AUTH_WORKSPACE_ID"
Parameter |
Type |
Required |
Description |
|---|---|---|---|
|
string |
Yes in this example |
A valid personal access token for this environment, belonging to a configured administrator principal. Confirm other standard authentication methods, such as Bearer, for the environment. |
|
string |
Yes |
One nonempty authentication Workspace header; not a target filter or target quota Workspace. |
|
string |
Yes |
Sandbox ID in the path. |
Successful response¶
{
"code": "OK",
"msg": "OK",
"data": {}
}
Field |
Type |
Description |
|---|---|---|
|
string |
OK on success. |
|
string |
OK on success. |
|
object |
Success data. |
|
object |
Always an empty object {}, not a 202 acceptance receipt. |
See Shared objects for all public nested object fields and separate explanations of omission and null.
Error responses¶
{"code":"ErrParamInvalid","msg":"Bad Request"}
Field |
Type |
Description |
|---|---|---|
|
string |
Error code for the current stage. |
|
string |
Error text; service-classified errors are usually localized. |
HTTP / code |
Conditions and handling |
|---|---|
400 / ErrParamInvalid |
Missing authentication Workspace, request decoding/integer parsing failure, or invalid quota fields. |
400 / SANDBOX_INVALID_SPEC |
A service validation failure, such as an invalid list window or network tool. A name containing SPEC does not limit it to specification creation. |
403 / COMPUTE_RESOURCE_SPEC_FORBIDDEN |
The current principal is not a configured administrator, or its identity does not match the authorization boundary. |
503 / COMPUTE_RESOURCE_SPEC_ADMIN_UNAVAILABLE |
Classified administrator directory/authorization facts are unavailable. |
404 / SANDBOX_NOT_FOUND |
The resource is unmanaged, ephemeral, pooled, missing, or in a hidden creation/deletion stage. |
503 / SANDBOX_IAM_UNAVAILABLE or SANDBOX_NETWORK_STORAGE_UNAVAILABLE |
Lifecycle identity or network persistence dependencies are unavailable. |
500 / SANDBOX_ERROR or ErrServer |
An unclassified Provider or other failure, or localization failure; these do not always return 503. |
See Errors and recovery for recovery stages.