Checkpoints

Cedana API for checkpoints

List checkpoints

get

Use query params to filter checkpoints. Supports filtering by ids (comma-separated UUIDs for single or multiple checkpoints)

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

idsstring · nullableOptional

Comma-separated list of checkpoint UUIDs to filter by

Responses

200

Returns checkpoints

application/json

Checkpoint is basic unit for cedana service operation it stores all the information regarding the snapshot we can use to save and then restore state

checksumstring · nullableOptional

gpustringRequired

idstring · uuidRequired

infoanyOptional

namestring · nullableOptional

platformstringRequired

statusstring · enumRequiredPossible values:

400

Invalid query parameters

application/json

500

Failed to connect/fetch from database

application/json

get

/v2/checkpoints

HTTPcURLJavaScriptPython

GET /v2/checkpoints HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "checksum": null,
    "gpu": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "info": null,
    "name": null,
    "platform": "text",
    "status": "initializing"
  }
]

Create checkpoint

post

Builds a new checkpoint without the metadata and information about the checkpoint with status initializing

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Returns the checkpoint ID for the new checkpoint

text/plain

stringOptional

500

Failed to create checkpoint in database

application/json

post

/v2/checkpoints

HTTPcURLJavaScriptPython

POST /v2/checkpoints HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

550e8400-e29b-41d4-a716-446655440000

Deprecate checkpoint

patch

Marks checkpoint as deprecated, so that they can be removed on next internal state cleanup

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200

Successfully deprecated checkpoint and returns id

text/plain

stringOptional

400

Invalid UUID provided

application/json

500

Failed to execute request against database

application/json

patch

/v2/checkpoints/deprecate/{id}

HTTPcURLJavaScriptPython

PATCH /v2/checkpoints/deprecate/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

550e8400-e29b-41d4-a716-446655440000

Put checkpoint info

put

Add information about the checkpoint

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

Body

application/json

gpustringRequired

infoanyOptional

platformstringRequired

Responses

200

Successfully updated checkpoint info and returns ID

text/plain

stringOptional

500

Failed to execute request against database

application/json

put

/v2/checkpoints/info/{id}

HTTPcURLJavaScriptPython

PUT /v2/checkpoints/info/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "gpu": "text",
  "info": null,
  "platform": "text"
}

550e8400-e29b-41d4-a716-446655440000

Uploaded checkpoint

post

Marks checkpoint as successfully uploaded and ready for restore

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

application/json

restore_pathstring · nullableOptional

Responses

200

Marks the checkpoint as successfully uploaded

text/plain

stringOptional

400

Invalid request parameters

application/json

500

Failed to update checkpoint in database

application/json

post

/v2/checkpoints/uploaded/{id}

HTTPcURLJavaScriptPython

POST /v2/checkpoints/uploaded/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "restore_path": null
}

550e8400-e29b-41d4-a716-446655440000