API
API for our managed service.
Returns the URL to download the file from
Failed to fulfill request
GET /v2/files/{path} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
<presigned-bucket-url-for-downloading-file>Returns the list of files in the directory
Failed to fulfill request
GET /v2/files/dir/{path} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
"file1.txt",
"file2.txt"
]Returns the actions with status
Failed list
Failed to connect/fetch from jobs table from database
GET /v2/actions HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"action_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"checkpoint_id": "b2c3d4e5-f6a7-8901-2345-67890abcdef1",
"status": "completed",
"type": "checkpoint",
"action_timestamp": "2023-10-27T10:00:00Z",
"checkpoint_completed_timestamp": "2023-10-27T10:05:00Z"
}
]The action_id of the given pod_id has been fetched Successfully
Failed to get action_id for the given pod_id
Failed to connect/fetch from pods_to_actions table from database
GET /v2/actions/from_pod/{id} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
<uuid-v4-here>Success
Failed to get action_id within the db
Failed to connect/fetch from pods_to_actions table from database
POST /v2/actions/upload HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66
{
"action_id": "text",
"pod_id": null,
"pod_spec": null,
"status": "text"
}SuccessReturns the id for the task
Failed to find checkpointable resource
Failed to connect/fetch from jobs table from database
POST /v2/checkpoint/pod HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 77
{
"cluster_id": "text",
"namespace": "text",
"pod_name": "text",
"runc_root": "text"
}<uuid-v4-here>Returns the current status of a pod checkpoint based on action ID
Returns the current status of the checkpoint operation
Action ID not found
Failed to retrieve status from database
GET /v2/checkpoint/status/{action_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"details": null,
"status": "initialized"
}Use query params to filter checkpoints
Returns checkpoints
Failed to connect/fetch from database
GET /v2/checkpoints HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"checksum": null,
"gpu": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"image_name_with_tag": null,
"platform": "text",
"process_info": null,
"status": "initialized"
}
]Builds a new checkpoint without the metadata and information about the checkpoint with status initializing
Returns the checkpoint id for the new checkpoint
Failed create checkpoint
Failed to connect/fetch from jobs table from database
POST /v2/checkpoints HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
<uuid-v4-here>Marks checkpoint as deprecated, so that they can be removed on next internal state cleanup. Checkpoints marked deprecated are removed within a fixed number of days depending on our customer service agreement.
Note: Checkpoints can't directly be deleted as use them as versioning points and might be required for restores that might be in-flight setting them deprecated marks them to be cleaned up as soon as possible(likely within a day).
Successfully deprecated checkpoint and returns id
Failed to find checkpoint from id
Failed to connect/execute request against db
PATCH /v2/checkpoints/deprecate/{id} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
<uuid-for-checkpoint>Add information about the checkpointed pod and runtime
Successfully deprecated checkpoint and returns id
Failed to find checkpoint from id
Failed to connect/execute request against db
PUT /v2/checkpoints/info/{id} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 32
{
"gpu": "text",
"platform": "text"
}<uuid-for-checkpoint>Marks the checkpoint as successfully uploaded
Failed mark checkpoint
Failed to connect/fetch from jobs table from database
POST /v2/checkpoints/uploaded/{id} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"restore_path": null
}<uuid-v4-here>Returns the URL to upload the file to
Failed to fulfill request
PUT /v2/files/{path} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
<presigned-bucket-url-for-uploading-file>Returns list of jobs from db
Failed to connect/fetch from jobs table from database
GET /v2/jobs HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"jid": "xenodochial_jones4",
"type": "containerd"
},
{
"jid": "dreamy_nobel1",
"type": "containerd"
}
]Resource id registered internally
Bad request
Failed to connect to db
POST /v2/k8s/sync HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 76
{
"cluster_id": null,
"metadata": null,
"org_id": null,
"resource": {
"type": "None"
}
}textReturns the checkpoint id for the new checkpoint
Failed create checkpoint
Failed create restore
Failed to connect/fetch from jobs table from database
POST /v2/restore/pod HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40
{
"action_id": "text",
"cluster_id": "text"
}<uuid-v4-here>Used to validate authentication token
Returns your user-id (a uuid)
Invalid Key/Token
User not attached to valid api key
GET /v2/user HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
textLast updated
Was this helpful?