> ## 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.

# Runtime

> Manage environments and infrastructure.

Manage environments and infrastructure.

Configure domains, environment variables, and servers. Manage release asset manifests and inspect deployment records.

Run commands synchronously, stream their output, or start background commands. Use the sandbox ID to access files, command results, and the terminal.

Use the [file endpoints](/docs/cloud/rest/api-reference/projects-files-sandbox-files/list-sandbox-files) and [terminal endpoint](/docs/cloud/rest/api-reference/runtime-sandboxes-sandbox-terminal/open-sandbox-terminal) to work in the same sandbox. Health, readiness, and heartbeat endpoints support sandbox monitoring. See [WebSocket connections](https://veryfront.com/docs/cloud/rest/protocols#websocket-connections) for terminal WebSocket access.

Cache entries are read, written and deleted under /cache/entries. The older /cache/get, /cache/set and related project routes are deprecated aliases of the same operations.

[Environments](#environments) · [Servers](#servers) · [Sandboxes](#sandboxes) · [Cache](#cache)

## Environments

Create and manage deployment environments. Use the environment ID when configuring [deployments](/docs/cloud/rest/apis/deployments#deployments), [domains](/docs/cloud/rest/apis/runtime#environments), [variables](/docs/cloud/rest/apis/runtime#environments), or [servers](/docs/cloud/rest/apis/runtime#servers).

List domains across a project.

Create, read, update, or delete domains for an environment.

List environment variable keys without values.

List, create, read, update, or delete environment variables.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/environments` | [GET](/docs/cloud/rest/api-reference/runtime-environments-environments/list-environments), [POST](/docs/cloud/rest/api-reference/runtime-environments-environments/create-environment) | List environments; Create environment |
| `/projects/{project_reference}/environments/{environment_id}` | [GET](/docs/cloud/rest/api-reference/runtime-environments-environments/get-environment), [PATCH](/docs/cloud/rest/api-reference/runtime-environments-environments/update-environment), [DELETE](/docs/cloud/rest/api-reference/runtime-environments-environments/delete-environment) | Get environment; Update environment; Delete environment |
| `/projects/{project_reference}/environments/{environment_id}/domains` | [GET](/docs/cloud/rest/api-reference/runtime-environments-environment-domains/list-environment-domains), [POST](/docs/cloud/rest/api-reference/runtime-environments-environment-domains/create-environment-domain) | List environment domains; Create environment domain |
| `/projects/{project_reference}/environments/{environment_id}/domains/{domain_reference}` | [GET](/docs/cloud/rest/api-reference/runtime-environments-environment-domains/get-environment-domain), [PATCH](/docs/cloud/rest/api-reference/runtime-environments-environment-domains/update-environment-domain), [DELETE](/docs/cloud/rest/api-reference/runtime-environments-environment-domains/delete-environment-domain) | Get environment domain; Update environment domain; Delete environment domain |
| `/projects/{project_reference}/environment-variables` | [GET](/docs/cloud/rest/api-reference/runtime-environments-environment-variables/list-environment-variables), [POST](/docs/cloud/rest/api-reference/runtime-environments-environment-variables/create-environment-variable) | List environment variables; Create environment variable |
| `/projects/{project_reference}/environment-variables/{key}` | [GET](/docs/cloud/rest/api-reference/runtime-environments-environment-variables/get-environment-variable), [PATCH](/docs/cloud/rest/api-reference/runtime-environments-environment-variables/update-environment-variable), [DELETE](/docs/cloud/rest/api-reference/runtime-environments-environment-variables/delete-environment-variable) | Get environment variable; Update environment variable; Delete environment variable |
| `/projects/{project_reference}/domains` | [GET](/docs/cloud/rest/api-reference/runtime-environments-project-domains/list-domains) | List domains |
| `/projects/{project_reference}/environment-variable-keys` | [GET](/docs/cloud/rest/api-reference/runtime-environments-environment-variable-keys/list-environment-variable-keys) | List environment variable keys |

## Servers

List, read, or delete project server records.

Create a server for an environment.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/environments/{environment_id}/servers` | [POST](/docs/cloud/rest/api-reference/runtime-servers-environment-servers/create-server) | Create server |
| `/projects/{project_reference}/servers` | [GET](/docs/cloud/rest/api-reference/runtime-servers-project-servers/list-servers) | List servers |
| `/projects/{project_reference}/servers/{server_id}` | [GET](/docs/cloud/rest/api-reference/runtime-servers-project-servers/get-server), [DELETE](/docs/cloud/rest/api-reference/runtime-servers-project-servers/delete-server) | Get server; Delete server |

## Sandboxes

Create, list, get, update, or delete sandboxes.

Get redacted environment snapshots.

Run commands and inspect command output.

Open a sandbox terminal.

Check sandbox health, readiness, and heartbeat state.

| Endpoint | Methods | Description |
| - | - | - |
| `/sandboxes` | [GET](/docs/cloud/rest/api-reference/runtime-sandboxes-sandbox-lifecycle/list-sandboxes), [POST](/docs/cloud/rest/api-reference/runtime-sandboxes-sandbox-lifecycle/create-sandbox) | List sandboxes; Create sandbox |
| `/sandboxes/{sandbox_id}` | [GET](/docs/cloud/rest/api-reference/runtime-sandboxes-sandbox-lifecycle/get-sandbox), [PATCH](/docs/cloud/rest/api-reference/runtime-sandboxes-sandbox-lifecycle/update-sandbox-lifetime), [DELETE](/docs/cloud/rest/api-reference/runtime-sandboxes-sandbox-lifecycle/delete-sandbox) | Get sandbox; Update sandbox lifetime; Delete sandbox |
| `/sandboxes/capabilities` | [GET](/docs/cloud/rest/api-reference/runtime-sandboxes-sandbox-lifecycle/get-sandbox-capabilities) | Get sandbox capabilities |
| `/sandboxes/{sandbox_id}/commands` | [GET](/docs/cloud/rest/api-reference/runtime-sandboxes-sandbox-commands/list-sandbox-background-commands), [POST](/docs/cloud/rest/api-reference/runtime-sandboxes-sandbox-commands/start-sandbox-background-command) | List sandbox background commands; Start sandbox background command |
| `/sandboxes/{sandbox_id}/commands/{command_id}` | [GET](/docs/cloud/rest/api-reference/runtime-sandboxes-sandbox-commands/get-sandbox-background-command) | Get sandbox background command |
| `/sandboxes/{sandbox_id}/commands/{command_id}/output` | [GET](/docs/cloud/rest/api-reference/runtime-sandboxes-sandbox-commands/get-sandbox-background-command-output) | Get sandbox background command output |
| `/sandboxes/{sandbox_id}/commands/{command_id}/cancel` | [POST](/docs/cloud/rest/api-reference/runtime-sandboxes-sandbox-commands/cancel-sandbox-background-command) | Cancel sandbox background command |
| `/sandboxes/{sandbox_id}/commands/run` | [POST](/docs/cloud/rest/api-reference/runtime-sandboxes-sandbox-commands/run-sandbox-command) | Run sandbox command |
| `/sandboxes/{sandbox_id}/commands/stream` | [POST](/docs/cloud/rest/api-reference/runtime-sandboxes-sandbox-commands/stream-sandbox-command) | Stream sandbox command |
| `/sandboxes/{sandbox_id}/environment` | [GET](/docs/cloud/rest/api-reference/runtime-sandboxes-sandbox-environment/get-sandbox-environment-snapshot) | Get sandbox environment snapshot |
| `/sandboxes/{sandbox_id}/heartbeat` | [POST](/docs/cloud/rest/api-reference/runtime-sandboxes-sandbox-health/update-sandbox-activity) | Update sandbox activity |
| `/sandboxes/{sandbox_id}/healthz` | [GET](/docs/cloud/rest/api-reference/runtime-sandboxes-sandbox-health/check-sandbox-health) | Check sandbox health |
| `/sandboxes/{sandbox_id}/readyz` | [GET](/docs/cloud/rest/api-reference/runtime-sandboxes-sandbox-health/check-sandbox-readiness) | Check sandbox readiness |
| `/sandboxes/{sandbox_id}/terminal` | [GET](/docs/cloud/rest/api-reference/runtime-sandboxes-sandbox-terminal/open-sandbox-terminal) | Open sandbox terminal |

## Cache

List, read and write cache entries one at a time or in batches of up to 100, and delete one entry or every entry matching a pattern.

Deprecated: read, write, or delete values in the authenticated user’s cache.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/cache/entries` | [GET](/docs/cloud/rest/api-reference/runtime-cache-project-cache/list-cache-entries), [DELETE](/docs/cloud/rest/api-reference/runtime-cache-project-cache/delete-cache-entries) | List cache entries; Delete cache entries |
| `/projects/{project_reference}/cache/keys` | [GET](/docs/cloud/rest/api-reference/runtime-cache-project-cache/list-cache-keys-deprecated-alias) (deprecated) | List cache keys (deprecated alias) |
| `/projects/{project_reference}/cache/entries/{key}` | [GET](/docs/cloud/rest/api-reference/runtime-cache-project-cache/get-cache-entry), [PUT](/docs/cloud/rest/api-reference/runtime-cache-project-cache/write-cache-entry), [DELETE](/docs/cloud/rest/api-reference/runtime-cache-project-cache/delete-cache-entry) | Get cache entry; Write cache entry; Delete cache entry |
| `/projects/{project_reference}/cache/get` | [GET](/docs/cloud/rest/api-reference/runtime-cache-project-cache/get-cache-entry-deprecated-alias) (deprecated) | Get cache entry (deprecated alias) |
| `/projects/{project_reference}/cache/stats` | [GET](/docs/cloud/rest/api-reference/runtime-cache-project-cache/get-cache-stats-deprecated) (deprecated) | Get cache stats (deprecated) |
| `/projects/{project_reference}/cache/get-batch` | [POST](/docs/cloud/rest/api-reference/runtime-cache-project-cache/get-multiple-cache-entries-deprecated-alias) (deprecated) | Get multiple cache entries (deprecated alias) |
| `/projects/{project_reference}/cache/del-pattern` | [POST](/docs/cloud/rest/api-reference/runtime-cache-project-cache/delete-cache-by-pattern-deprecated-alias) (deprecated) | Delete cache by pattern (deprecated alias) |
| `/projects/{project_reference}/cache/del` | [POST](/docs/cloud/rest/api-reference/runtime-cache-project-cache/delete-cache-entry-deprecated-alias) (deprecated) | Delete cache entry (deprecated alias) |
| `/projects/{project_reference}/cache/clear` | [POST](/docs/cloud/rest/api-reference/runtime-cache-project-cache/clear-cache-deprecated-alias) (deprecated) | Clear cache (deprecated alias) |
| `/projects/{project_reference}/cache/entries/read` | [POST](/docs/cloud/rest/api-reference/runtime-cache-project-cache/read-cache-entries) | Read cache entries |
| `/projects/{project_reference}/cache/set` | [POST](/docs/cloud/rest/api-reference/runtime-cache-project-cache/set-cache-entry-deprecated-alias) (deprecated) | Set cache entry (deprecated alias) |
| `/projects/{project_reference}/cache/set-batch` | [POST](/docs/cloud/rest/api-reference/runtime-cache-project-cache/set-multiple-cache-entries-deprecated-alias) (deprecated) | Set multiple cache entries (deprecated alias) |
| `/projects/{project_reference}/cache/entries/write` | [POST](/docs/cloud/rest/api-reference/runtime-cache-project-cache/write-cache-entries) | Write cache entries |
| `/cache/get` | [GET](/docs/cloud/rest/api-reference/runtime-cache-user-cache/get-user-cache-entry-deprecated) (deprecated) | Get user cache entry (deprecated) |
| `/cache/del` | [POST](/docs/cloud/rest/api-reference/runtime-cache-user-cache/delete-user-cache-entry-deprecated) (deprecated) | Delete user cache entry (deprecated) |
| `/cache/set` | [POST](/docs/cloud/rest/api-reference/runtime-cache-user-cache/set-user-cache-entry-deprecated) (deprecated) | Set user cache entry (deprecated) |

[Back to REST API reference](/docs/cloud/rest)


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