For the complete documentation index, see llms.txt. This page is also available as Markdown.

Actions

Cedana API for actions

List actions

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
typestring · nullableOptional
cluster_idstring · nullableOptional

Only return actions that ran on this cluster

Responses
200

Returns the actions with status

application/json
action_idstring · uuidRequired
action_timestampstring · nullableOptional
checkpoint_completed_timestampstring · nullableOptional
checkpoint_idstring · uuidRequired
checkpoint_namestring · nullableOptional

The checkpoint's CEDANA_CHECKPOINT name (the env value it restores from), used to group automatic/named checkpoints. Null for unnamed checkpoints.

checkpoint_statusstringRequired
deltaboolean · nullableOptional

Whether the checkpoint is a (GPU delta) increment. Authoritative even when parent_checkpoint_id is null (malformed id at ingest, parent deleted)

detailsanyRequired
gpustringRequired
node_namestring · nullableOptional
parent_checkpoint_idstring · nullableOptional

Checkpoint this one is an increment of; null for full checkpoints and for deltas whose parent is unknown or deleted

platformstringRequired
reasonstring · nullableOptional
statusstringRequired
total_durationinteger · nullableOptional
total_iointeger · nullableOptional
typestringRequired
workload_kindstring · nullableOptional

Owning workload kind of the checkpointed pod: "DynamoGraphDeployment" when the pod belongs to a Dynamo deployment, else the pod's immediate ownerReferences kind (ReplicaSet/Job/StatefulSet…). Null if unknown.

get/v1/actions
GET /v1/actions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
<uuid-v4-here>

Get latest action belonging to a pod

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Responses
200

The action_id of the given pod_id has been fetched successfully

text/plain
stringOptional
get/v1/actions/from_pod/{id}
GET /v1/actions/from_pod/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
<uuid-v4-here>

Upload pod spec

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
action_idstringRequired
persistent_volume_claimanyOptional
pod_idstring · nullableOptional
pod_metadata_specanyOptional
pod_specanyOptional
statusstringRequired
Responses
200

Success

text/plain
stringOptional
post/v1/actions/upload
POST /v1/actions/upload HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "action_id": "text",
  "persistent_volume_claim": null,
  "pod_id": null,
  "pod_metadata_spec": null,
  "pod_spec": null,
  "status": "text"
}
Success

Get action details by ID

get

Returns detailed information about a specific action including associated checkpoint data

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Action UUID

Responses
200

Action details retrieved successfully

application/json

Action details response for a single action

action_idstring · uuidRequired

The action ID

action_timestampstring · nullableOptional

When the action was created

checkpoint_completed_timestampstring · nullableOptional

When checkpoint completed (if any)

checkpoint_idstring · nullableOptional

Associated checkpoint ID (if any)

checkpoint_infoanyOptional

Full checkpoint profiling info (JSON)

checkpoint_namestring · nullableOptional

Checkpoint name/image

checkpoint_sizeinteger · nullableOptional

Checkpoint size in bytes

detailsanyRequired

Original request details (JSONB)

gpustring · nullableOptional

GPU type used

node_namestring · nullableOptional

Node where the pod was running

platformstring · nullableOptional

Platform (e.g., containerd)

reasonstring · nullableOptional

Reason for the action (heartbeat, manual, nodeTermination, etc.)

restore_pathstring · nullableOptional

Restore path for the checkpoint

statusstringRequired

Current status of the action

total_durationinteger · nullableOptional

Checkpoint duration in nanoseconds (from profiling)

total_iointeger · nullableOptional

Total I/O in bytes (from profiling)

typestringRequired

Action type (checkpoint_pod, restore_pod, heartbeat)

get/v1/actions/{id}
GET /v1/actions/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "action_id": "123e4567-e89b-12d3-a456-426614174000",
  "action_timestamp": null,
  "checkpoint_completed_timestamp": null,
  "checkpoint_id": null,
  "checkpoint_info": null,
  "checkpoint_name": null,
  "checkpoint_size": null,
  "details": null,
  "gpu": null,
  "node_name": null,
  "platform": null,
  "reason": null,
  "restore_path": null,
  "status": "text",
  "total_duration": null,
  "total_io": null,
  "type": "text"
}

Get path of latest checkpoint

get

Returns the path of the latest successful checkpoint for a given checkpoint name

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
namestring · nullableOptional
Responses
200

Returns the restore path

text/plain
stringOptional
get/v1/checkpoint/path
GET /v1/checkpoint/path HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
<restore-path>

Checkpoint pod

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
action_idstring · nullableRead-onlyOptional
cluster_idstring · nullableOptional
kindstring · enumOptionalPossible values:
namespacestring · nullableOptional
pod_idstring · nullableOptional
pod_namestring · nullableOptional
reasonstring · enumOptionalPossible values:
Responses
200

Returns the ID for the task

text/plain
stringOptional
post/v1/checkpoint/pod
POST /v1/checkpoint/pod HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 120

{
  "cluster_id": null,
  "kind": "simple",
  "namespace": null,
  "overrides": null,
  "pod_id": null,
  "pod_name": null,
  "reason": "heartbeat"
}
550e8400-e29b-41d4-a716-446655440000

Get status of checkpoint action

get

Returns the current status of a checkpoint action

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
action_idstringRequired
Responses
200

Returns the current status of the checkpoint operation

application/json
detailsstring · nullableOptional
statusstring · enumRequiredPossible values:
get/v1/checkpoint/status/{action_id}
GET /v1/checkpoint/status/{action_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "details": null,
  "status": "initialized"
}

Restore pod

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
action_idstringRequired
cluster_idstringOptional
reasonstring · enumRequiredPossible values:
Responses
200

Returns the action ID for the new restore

text/plain
stringOptional
post/v1/restore/pod
POST /v1/restore/pod HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "action_id": "text",
  "cluster_id": "text",
  "overrides": null,
  "reason": "nodeTermination"
}
550e8400-e29b-41d4-a716-446655440000

Last updated

Was this helpful?