cloud_agent_checkpoints

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

Overview

Name	cloud_agent_checkpoints
Type	Resource
Id	railway.agents.cloud_agent_checkpoints

Fields

The following fields are returned by SELECT queries:

get

One CloudAgentCheckpoint row. A checkpoint of a cloud agent's disk.

Name	Datatype	Description
id	string
name	string
environment_id	string
created_at	string (date-time)
failure_reason	string	Why the capture failed.
region	string	Region the checkpoint was captured in.
status	string	(FAILED, IN_PROGRESS, SUCCEEDED)

list

One row per CloudAgentCheckpoint. A checkpoint of a cloud agent's disk.

Name	Datatype	Description
id	string
name	string
environment_id	string
created_at	string (date-time)
failure_reason	string	Why the capture failed.
region	string	Region the checkpoint was captured in.
status	string	(FAILED, IN_PROGRESS, SUCCEEDED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id		A cloud agent checkpoint by ID. Backed by the Railway GraphQL query cloudAgentCheckpoint.
list	select	environment_id		Cloud agent checkpoints in an environment, newest first. Backed by the Railway GraphQL query cloudAgentCheckpoints.
create	insert	id		Checkpoint the agent's disk. Poll cloudAgentCheckpoint until SUCCEEDED. Backed by the Railway GraphQL mutation cloudAgentCheckpointCreate.
delete	delete	id		Delete a checkpoint. Backed by the Railway GraphQL mutation cloudAgentCheckpointDelete.

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

SELECT examples

get

A cloud agent checkpoint by ID. Backed by the Railway GraphQL query cloudAgentCheckpoint.

SELECT
id,
name,
environment_id,
created_at,
failure_reason,
region,
status
FROM railway.agents.cloud_agent_checkpoints
WHERE id = '{{ id }}' -- required
;

list

Cloud agent checkpoints in an environment, newest first. Backed by the Railway GraphQL query cloudAgentCheckpoints.

SELECT
id,
name,
environment_id,
created_at,
failure_reason,
region,
status
FROM railway.agents.cloud_agent_checkpoints
WHERE environment_id = '{{ environment_id }}' -- required
;

INSERT examples

create

Checkpoint the agent's disk. Poll cloudAgentCheckpoint until SUCCEEDED. Backed by the Railway GraphQL mutation cloudAgentCheckpointCreate.

INSERT INTO railway.agents.cloud_agent_checkpoints (
id,
name
)
SELECT 
'{{ id }}' /* required */,
'{{ name }}'
RETURNING
id,
name,
environment_id,
created_at,
failure_reason,
region,
status
;

Manifest

# Description fields are for documentation purposes
- name: cloud_agent_checkpoints
props:
  - name: id
    value: "{{ id }}"
  - name: name
    value: "{{ name }}"

DELETE examples

delete

Delete a checkpoint. Backed by the Railway GraphQL mutation cloudAgentCheckpointDelete.

DELETE FROM railway.agents.cloud_agent_checkpoints
WHERE 
id = '{{ id }}' --required
;