API reference

Cluster Management APIs

List checkpointable containers on all nodes

get

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

Path parameters

namespaceanyrequired

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

post

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

Body

checkpoint_dataobjectoptional

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/checkpoint' \
  --header 'Content-Type: application/json' \
  --data '{
    "checkpoint_data": {
      "checkpoint_path": "text",
      "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

post

rootfs checkpoint endpoint for containerd

Body

addressstringrequired

container_namestringrequired

image_refstringrequired

namespacestringrequired

rootstringoptional

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",
    "root": "text",
    "sandbox_name": "text"
  }'

200

400

404

500

200

No body

OK

start a checkpoint of a crio container's rootfs

post

rootfs checkpoint endpoint for crio

Body

container_namestringrequired

image_refstringrequired

namespacestringrequired

new_image_refstringrequired

registry_auth_dataobjectoptional

rootstringoptional

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": {
      "pull_auth_token": "text",
      "push_auth_token": "text"
    },
    "root": "text",
    "sandbox_name": "text"
  }'

200

400

404

500

200

No body

OK

Full containerd checkpoint request

post

Start a synchronous containerd checkpoint, which includes the rootfs.

Body

checkpoint_dataobjectoptional

leave_runningbooleanoptional

rootstringoptional

Root is the path to the runc storage for the host

rootfs_checkpoint_dataobjectoptional

Responses

cURL

JavaScript

Python

HTTP

cURL

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

200

400

404

500

200

No body

OK

Restore APIs

start a restore of a containerd container's rootfs

post

rootfs restore endpoint for containerd

Body

addressstringrequired

container_namestringrequired

image_refstringrequired

namespacestringrequired

rootstringoptional

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",
    "root": "text",
    "sandbox_name": "text"
  }'

200

400

404

500

200

No body

OK

start restore of a runc container

post

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.

Body

checkpoint_dataobjectoptional

checkpoint_idstringoptional

Responses

cURL

JavaScript

Python

HTTP

cURL

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

200

400

404

500

200

No body

OK