Checkpoints
Cedana API for checkpoints
Use query params to filter checkpoints. Supports filtering by ids (comma-separated UUIDs for single or multiple checkpoints)
Comma-separated list of checkpoint UUIDs to filter by
Returns checkpoints
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
Whether this checkpoint is a (GPU delta) increment. Authoritative even when parent_checkpoint_id is null (malformed id at ingest, parent deleted)
Checkpoint this one is an increment of; null for full checkpoints and for deltas whose parent is unknown or deleted
Invalid query parameters
Failed to connect/fetch from database
Client error
Server error
GET /v1/checkpoints HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"checksum": null,
"delta": true,
"gpu": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"info": null,
"name": null,
"parent_checkpoint_id": null,
"platform": "text",
"status": "initializing"
}
]Builds a new checkpoint without the metadata and information about the checkpoint with status initializing
Returns the checkpoint ID for the new checkpoint
Failed to create checkpoint in database
Client error
Server error
POST /v1/checkpoints HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
550e8400-e29b-41d4-a716-446655440000Marks checkpoint as deprecated, so that they can be removed on next internal state cleanup
Successfully deprecated checkpoint and returns id
Invalid UUID provided
Failed to execute request against database
Client error
Server error
PATCH /v1/checkpoints/deprecate/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
550e8400-e29b-41d4-a716-446655440000Add information about the checkpoint
Successfully updated checkpoint info and returns ID
Failed to execute request against database
Client error
Server error
PUT /v1/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-446655440000Marks checkpoint as successfully uploaded and ready for restore
Marks the checkpoint as successfully uploaded
Invalid request parameters
Failed to update checkpoint in database
Client error
Server error
POST /v1/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-446655440000Last updated
Was this helpful?