Cancel sandbox background command

veryfront__cancel_sandbox_background_command

Requires project.sandboxes.manage.

Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources.

Call type: Can change resources.

Arguments

FieldTypeRequiredDescription and constraints
sandbox_idstringYesSandbox UUID, as returned by createSandbox. Format: uuid.
command_idstringYesBackground command ID, as returned by startSandboxBackgroundCommand. Minimum length: 1.

Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See MCP client setup.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__cancel_sandbox_background_command",
    "arguments": {
      "sandbox_id": "00000000-0000-4000-8000-000000000000",
      "command_id": "example"
    }
  }
}

Result

The published output shape is summarized below. Inspect both the MCP response content and isError when handling a call.

FieldTypeRequiredDescription and constraints
command_idstringYes
commandstringYes
signalstring or nullYes
heartbeat_statusstringYesValues: "disabled", "healthy", "degraded".
last_heartbeat_atstring or nullYes
last_heartbeat_errorstring or nullYes
heartbeat_failure_countintegerYesMinimum: 0.
statusstringYesLifecycle status for the returned record. Values: "pending", "running", "completed", "failed", "canceled".
exit_codeinteger or nullYes
started_atstring or nullYes
finished_atstring or nullYes

Full schemas

json
{
  "type": "object",
  "properties": {
    "sandbox_id": {
      "type": "string",
      "format": "uuid",
      "description": "Sandbox UUID, as returned by createSandbox."
    },
    "command_id": {
      "type": "string",
      "minLength": 1,
      "description": "Background command ID, as returned by startSandboxBackgroundCommand."
    }
  },
  "required": [
    "sandbox_id",
    "command_id"
  ],
  "additionalProperties": false,
  "description": "Arguments for the cancel_sandbox_background_command tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
json
{
  "type": "object",
  "properties": {
    "command_id": {
      "type": "string"
    },
    "command": {
      "type": "string"
    },
    "signal": {
      "type": [
        "string",
        "null"
      ]
    },
    "heartbeat_status": {
      "type": "string",
      "enum": [
        "disabled",
        "healthy",
        "degraded"
      ]
    },
    "last_heartbeat_at": {
      "type": [
        "string",
        "null"
      ]
    },
    "last_heartbeat_error": {
      "type": [
        "string",
        "null"
      ]
    },
    "heartbeat_failure_count": {
      "type": "integer",
      "minimum": 0
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "running",
        "completed",
        "failed",
        "canceled"
      ],
      "description": "Lifecycle status for the returned record."
    },
    "exit_code": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null",
          "description": "The exit code returned by the tool."
        }
      ]
    },
    "started_at": {
      "type": [
        "string",
        "null"
      ]
    },
    "finished_at": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "command_id",
    "command",
    "signal",
    "heartbeat_status",
    "last_heartbeat_at",
    "last_heartbeat_error",
    "heartbeat_failure_count",
    "status",
    "exit_code",
    "started_at",
    "finished_at"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the cancel_sandbox_background_command tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}