API reference

Cluster Management APIs

List checkpointable containers on all nodes

Returns a list of containers across cedana-managed nodes that can be checkpointed given a specific namespace.

get

/list/{namespace}

Path parameters

namespacestringrequired

Namespace to list containers from

Body

rootstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/list/{namespace}' \
  --header 'Content-Type: application/json' \
  --data '{"root":"text"}'

200

400

404

500

200

No body

OK

Checkpoint APIs

Start checkpoint of a runc container

Start a synchronous checkpoint of a runc container. Use /list/:namespace to get the required CheckpointData.

post

/checkpoint

Body

checkpoint_dataobject

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/checkpoint' \
  --header 'Content-Type: application/json' \
  --data '{"checkpoint_data":{"container_name":"text","namespace":"text","root":"text","sandbox_name":"text"}}'

200

400

404

500

200

No body

OK

start a checkpoint of a containerd container's rootfs

rootfs checkpoint endpoint for containerd

post

/checkpoint/rootfs

Body

addressstringrequired

container_namestringrequired

image_refstringrequired

namespacestringrequired

rootstring

sandbox_namestringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/checkpoint/rootfs' \
  --header 'Content-Type: application/json' \
  --data '{"address":"text","container_name":"text","image_ref":"text","namespace":"text","sandbox_name":"text"}'

200

400

404

500

200

No body

OK

start a checkpoint of a crio container's rootfs

rootfs checkpoint endpoint for crio

post

/checkpoint/rootfs/crio

Body

container_namestringrequired

image_refstringrequired

namespacestringrequired

new_image_refstringrequired

registry_auth_dataobject

rootstring

sandbox_namestringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/checkpoint/rootfs/crio' \
  --header 'Content-Type: application/json' \
  --data '{"container_name":"text","image_ref":"text","namespace":"text","new_image_ref":"text","registry_auth_data":{},"sandbox_name":"text"}'

200

400

404

500

200

No body

OK

Full containerd checkpoint request

Start a synchronous containerd checkpoint, which includes the rootfs.

post

/containerd/checkpoint

Body

checkpoint_dataobject

leave_runningboolean

rootstring

Root is the path to the runc storage for the host

rootfs_checkpoint_dataobject

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/containerd/checkpoint' \
  --header 'Content-Type: application/json' \
  --data '{"checkpoint_data":{"container_name":"text","namespace":"text","root":"text","sandbox_name":"text"},"rootfs_checkpoint_data":{"address":"text","container_name":"text","image_ref":"text","namespace":"text","sandbox_name":"text"}}'

200

400

404

500

200

No body

OK

Restore APIs

start a restore of a containerd container's rootfs

rootfs restore endpoint for containerd

post

/restore/rootfs

Body

addressstringrequired

container_namestringrequired

image_refstringrequired

namespacestringrequired

rootstring

sandbox_namestringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/restore/rootfs' \
  --header 'Content-Type: application/json' \
  --data '{"address":"text","container_name":"text","image_ref":"text","namespace":"text","sandbox_name":"text"}'

200

400

404

500

200

No body

OK

start restore of a runc container

Start a restore of a previously checkpointed runc container. Use /list/:namespace to get the required CheckpointData. Requires a target sleeping container to restore into. See documentation for more info.

post

/restore

Body

checkpoint_dataobject

checkpoint_idstring

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/restore' \
  --header 'Content-Type: application/json' \
  --data '{"checkpoint_data":{"container_name":"text","namespace":"text","root":"text","sandbox_name":"text"}}'

200

400

404

500

200

No body

OK