# get_sandbox_template

Source: <https://everruns.com/docs/api/operations/get_sandbox_template/>

GET

/v1/sandbox-templates/{sandbox\_template\_id}

Select code samplecURL (shell:curl)

```js
const url = 'https://app.everruns.com/api/v1/sandbox-templates/example';
const options = {method: 'GET'};


try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```sh
curl --request GET \
  --url https://app.everruns.com/api/v1/sandbox-templates/example
```

* Production APIapp.everruns.com/api/v1/sandbox-templates/{sandbox\_template\_id}

Get one reusable Sandbox Template and its current immutable revision.

## Parameters

### Path Parameters

**sandbox\_template\_id**

required

string

## Responses

### 200

Media typeapplication/json

Organization-scoped reusable Sandbox Template.

object

**created\_at**

required

Creation timestamp.

string format: date-time

**current\_revision**

required

Latest immutable revision used for new references.

object

**created\_at**

required

Revision creation timestamp.

string format: date-time

**id**

required

Stable public revision identifier pinned into Agent and Session snapshots.

string

**revision**

required

Monotonically increasing revision number within the Sandbox Template.

integer format: int32

**sandbox\_template\_id**

required

Parent reusable Sandbox Template identifier.

string

**spec**

required

Complete immutable authored specification.

object

**bootstrap**

Reproducible commands run when physical compute is initialized.

object

**commands**

Ordered commands replayed when creating or recovering physical compute.

Array\<string>

**containment**

One of:

* object

  Requested isolation policy; resolution supplies an honest target default.

  object

  **escalation**

  Whether the runtime may widen containment after Session creation.

  string

  Allowed values: never approval auto

  **filesystem**

  Filesystem mutation boundary for command execution.

  object

  **writable\_roots**

  Absolute roots the runtime may mutate; empty means provider default.

  Array\<string>

  **level**

  required

  Isolation mechanism the provider must supply.

  string

  Allowed values: none native isolated

  **network**

  One of:

  * object

    object

    **mode**

    required

    string

    Allowed values: deny

  * object

    object

    **allowed\_hosts**

    required

    Array\<string>

    **mode**

    required

    string

    Allowed values: allowlist

  * object

    object

    **mode**

    required

    string

    Allowed values: allow

* null

  object

  **mode**

  required

  string

  Allowed values: deny

* object

  object

  **allowed\_hosts**

  required

  Array\<string>

  **mode**

  required

  string

  Allowed values: allowlist

* object

  object

  **mode**

  required

  string

  Allowed values: allow

* object

  null

**durability**

One of:

* string

  Requested recovery guarantee; resolution supplies a target default.

  string

  Allowed values: checkpointed provider\_snapshot none

* null

  null

**lifecycle**

Idle lifecycle policy controlled by Everruns.

object

**idle\_action**

Action Everruns requests after the idle interval.

string

Allowed values: checkpoint\_and\_stop stop keep\_running

**idle\_after\_seconds**

Inactivity interval before applying `idle_action`.

integer format: int64

**target**

required

Provider-neutral target plus its concrete adapter binding.

object

**connection\_id**

Credential/transport binding for a registered machine target.

string | null

**credential**

Provider credential source. User and Agent bindings are resolved to an exact virtual user when the Session starts; organization bindings also pin the exact connection.

object

**connection\_id**

Exact connection for organization grants, which may have several accounts for one provider.

string | null format: uuid

**source**

required

Identity scope from which the provider credential is resolved.

string

Allowed values: none session\_user agent organization

**virtual\_user\_id**

Exact virtual-user owner for user, Agent, and organization grants.

string | null format: uuid

**kind**

required

Provider-neutral target class.

string

Allowed values: host machine vfs container managed

**options**

Provider-owned, non-secret configuration. Credentials are references, never values in this object.

object

**provider**

Concrete adapter for target kinds with more than one implementation.

string | null

**template\_revision\_id**

Immutable Sandbox Template revision this specification was copied from. The specification remains complete so Agent snapshots are portable and later template revisions cannot change an existing snapshot.

string | null

**description**

Optional explanation of the Sandbox Template’s intended workload.

string | null

**display\_name**

required

Human-readable name shown in management surfaces.

string

**id**

required

Stable public Sandbox Template identifier.

string

**is\_managed**

required

Whether the definition is owned and sealed by the platform.

boolean

**name**

required

Addressable name used in configuration.

string

**status**

required

Lifecycle state such as `active` or `archived`.

string

**updated\_at**

required

Timestamp of the most recent definition or revision change.

string format: date-time

##### Example

```json
{
  "current_revision": {
    "revision": 3,
    "spec": {
      "containment": {
        "escalation": "never",
        "level": "none",
        "network": {
          "mode": "deny"
        }
      },
      "durability": "checkpointed",
      "lifecycle": {
        "idle_action": "checkpoint_and_stop",
        "idle_after_seconds": 300
      },
      "target": {
        "connection_id": "conn_01933b5a000070008000000000000001",
        "credential": {
          "connection_id": "00000000-0000-0000-0000-000000000002",
          "source": "none",
          "virtual_user_id": "00000000-0000-0000-0000-000000000001"
        },
        "kind": "host",
        "provider": "daytona"
      }
    }
  },
  "description": "Recoverable coding workspace managed by Daytona",
  "display_name": "Coding - Daytona",
  "name": "coding-daytona",
  "status": "active"
}
```