> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List sandboxes

> List sandboxes.

`veryfront__list_sandboxes`

## Access

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

**Call type:** Read-only.

## Arguments

| Field | Type | Required | Description and constraints |
| - | - | - | - |
| `project_reference` | `string` | No | Project UUID or slug whose billed sandboxes are listed. Omit it to list your private sandboxes. |
| `access_scope` | `string` | No | Provide the access scope. Values: `"project"`, `"private"`. |
| `cursor` | `string` | No | Cursor for pagination. Uses the sandbox ID. |
| `limit` | `integer` | No | Maximum sandboxes to return. Defaults to 20 and is capped at 100. Default: `20`. Minimum: `1`. Maximum: `100`. |
| `sort_by` | `string` | No | Sort field. Defaults to `created_at`. Default: `"created_at"`. Values: `"created_at"`, `"status"`. |
| `sort_order` | `string` | No | Sort order. Defaults to desc. Default: `"desc"`. Values: `"asc"`, `"desc"`. |

## 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](https://veryfront.com/docs/cloud/getting-started/connect-mcp.md).

```json title="request.json" theme={null}
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__list_sandboxes",
    "arguments": {}
  }
}
```

## Result

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

| Field | Type | Required | Description and constraints |
| - | - | - | - |
| `data` | `object[]` | Yes | Primary result records returned by the tool. |
| `page_info` | `object` | Yes | Pagination cursor values for traversing the result set. |

## Full schemas

```json title="input-schema.json" theme={null}
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project UUID or slug whose billed sandboxes are listed. Omit it to list your private sandboxes."
    },
    "access_scope": {
      "type": "string",
      "enum": [
        "project",
        "private"
      ],
      "description": "Provide the access scope."
    },
    "cursor": {
      "type": "string",
      "description": "Cursor for pagination. Uses the sandbox ID."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Maximum sandboxes to return. Defaults to 20 and is capped at 100.",
      "default": 20
    },
    "sort_by": {
      "type": "string",
      "enum": [
        "created_at",
        "status"
      ],
      "description": "Sort field. Defaults to created_at.",
      "default": "created_at"
    },
    "sort_order": {
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ],
      "description": "Sort order. Defaults to desc.",
      "default": "desc"
    }
  },
  "additionalProperties": false,
  "description": "Arguments for the list_sandboxes tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
```

```json title="output-schema.json" theme={null}
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "Unique identifier for the returned record."
          },
          "short_id": {
            "type": "string"
          },
          "endpoint": {
            "type": "string",
            "description": "Sandbox endpoint URL."
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "provisioning",
              "running",
              "error",
              "deleting"
            ],
            "description": "Sandbox lifecycle status."
          },
          "project_id": {
            "anyOf": [
              {
                "type": "string",
                "format": "uuid",
                "description": "Project identifier associated with this result."
              },
              {
                "type": "null",
                "description": "Project identifier associated with this result."
              }
            ],
            "description": "Project identifier associated with this result."
          },
          "run_id": {
            "anyOf": [
              {
                "type": "string",
                "format": "uuid",
                "description": "Run identifier associated with this result."
              },
              {
                "type": "null",
                "description": "Run identifier associated with this result."
              }
            ],
            "description": "Agent run that created this sandbox."
          },
          "stopped_at": {
            "type": [
              "string",
              "null"
            ],
            "description": "Compute cleanup completed; only session history remains."
          },
          "access_scope": {
            "type": "string",
            "enum": [
              "project",
              "private"
            ]
          },
          "workspace_storage": {
            "type": "string",
            "enum": [
              "ephemeral",
              "persistent"
            ],
            "description": "Persistent workspaces survive runtime pod replacement. Deleting the sandbox also deletes its workspace."
          },
          "ttl_mode": {
            "type": "string",
            "enum": [
              "default",
              "duration",
              "always_on"
            ]
          },
          "ttl_hours": {
            "anyOf": [
              {
                "type": "integer",
                "exclusiveMinimum": 0
              },
              {
                "type": "null",
                "description": "The ttl hours returned by the tool."
              }
            ]
          },
          "expires_at": {
            "type": [
              "string",
              "null"
            ]
          },
          "created_at": {
            "type": "string",
            "description": "Creation timestamp in ISO 8601 format."
          },
          "last_activity_at": {
            "type": [
              "string",
              "null"
            ]
          },
          "variable_snapshot": {
            "type": "object",
            "properties": {
              "source_environment_id": {
                "anyOf": [
                  {
                    "type": "string",
                    "format": "uuid"
                  },
                  {
                    "type": "null",
                    "description": "The source environment id returned by the tool."
                  }
                ]
              },
              "variable_count": {
                "type": "integer",
                "minimum": 0
              },
              "copied_at": {
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "source_environment_id",
              "variable_count",
              "copied_at"
            ],
            "additionalProperties": false,
            "description": "Snapshot provenance on sandbox details. Variables are copied once, without live synchronization. No variable keys or values are included."
          }
        },
        "required": [
          "id",
          "short_id",
          "endpoint",
          "status",
          "project_id",
          "access_scope",
          "workspace_storage",
          "ttl_mode",
          "ttl_hours",
          "expires_at",
          "created_at",
          "last_activity_at"
        ],
        "additionalProperties": false
      },
      "description": "Primary result records returned by the tool."
    },
    "page_info": {
      "type": "object",
      "properties": {
        "self": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor that refers to the current page."
        },
        "first": {
          "type": "null"
        },
        "next": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor for the next page when pagination is available."
        },
        "prev": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor for the previous page when pagination is available."
        }
      },
      "required": [
        "self",
        "first",
        "next",
        "prev"
      ],
      "additionalProperties": false,
      "description": "Pagination cursor values for traversing the result set."
    }
  },
  "required": [
    "data",
    "page_info"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the list_sandboxes tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
```

<details>
  <summary>Try this tool</summary>

  Replace sample arguments with values for your project or connected account. Calls run only when you select Run tool.

  MCP tool call

  Call `veryfront__list_sandboxes` against the Veryfront MCP endpoint.

  Bearer token or API key

  Arguments (JSON)

  Run tool

  Output JSON

  <pre />
</details>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.