sandbox_checkpoints

Creates, updates, deletes, gets or lists a sandbox_checkpoints resource.

Overview

Name	sandbox_checkpoints
Type	Resource
Id	railway.agents.sandbox_checkpoints

Fields

The following fields are returned by SELECT queries:

list

One row per SandboxCheckpoint. A bootable snapshot of a sandbox's disk, scoped to an environment. Built from a template recipe or captured from a running sandbox.

Name	Datatype	Description
id	string
environment_id	string
created_at	string (date-time)
key	string	The checkpoint's identity within the environment (same as id): a recipe content hash for a built template, or the user-given name for one captured from a sandbox.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	environment_id		List named sandbox checkpoints in an environment. Backed by the Railway GraphQL query sandboxCheckpoints.
create	insert	environment_id, name, sandbox_id		Capture a running sandbox's current disk into a reusable, named checkpoint. Synchronous: the checkpoint is ready when this returns. Backed by the Railway GraphQL mutation sandboxCheckpointCreate.
rename	update	environment_id, id, name		Rename a sandbox checkpoint. Backed by the Railway GraphQL mutation sandboxCheckpointRename.
delete	delete	environment_id, id		Delete a sandbox checkpoint. Backed by the Railway GraphQL mutation sandboxCheckpointDelete.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
environment_id	string
id	string
name	string
sandbox_id	string

SELECT examples

list

List named sandbox checkpoints in an environment. Backed by the Railway GraphQL query sandboxCheckpoints.

SELECT
id,
environment_id,
created_at,
key
FROM railway.agents.sandbox_checkpoints
WHERE environment_id = '{{ environment_id }}' -- required
;

INSERT examples

create

Capture a running sandbox's current disk into a reusable, named checkpoint. Synchronous: the checkpoint is ready when this returns. Backed by the Railway GraphQL mutation sandboxCheckpointCreate.

INSERT INTO railway.agents.sandbox_checkpoints (
environment_id,
name,
sandbox_id
)
SELECT 
'{{ environment_id }}' /* required */,
'{{ name }}' /* required */,
'{{ sandbox_id }}' /* required */
RETURNING
id,
environment_id,
created_at,
key
;

Manifest

# Description fields are for documentation purposes
- name: sandbox_checkpoints
props:
  - name: environment_id
    value: "{{ environment_id }}"
  - name: name
    value: "{{ name }}"
  - name: sandbox_id
    value: "{{ sandbox_id }}"

UPDATE examples

rename

Rename a sandbox checkpoint. Backed by the Railway GraphQL mutation sandboxCheckpointRename.

UPDATE railway.agents.sandbox_checkpoints
SET 

WHERE 
environment_id = '{{ environment_id }}' --required
AND id = '{{ id }}' --required
AND name = '{{ name }}' --required
RETURNING
id,
environment_id,
created_at,
key;

DELETE examples

delete

Delete a sandbox checkpoint. Backed by the Railway GraphQL mutation sandboxCheckpointDelete.

DELETE FROM railway.agents.sandbox_checkpoints
WHERE 
environment_id = '{{ environment_id }}' --required
AND id = '{{ id }}' --required
;