API

API for our managed service.

Download file

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pathstringRequired

Responses

200

Returns the URL to download the file from

text/plain

Responsestring

500

Failed to fulfill request

application/json

get

/v2/files/{path}

GET /v2/files/{path} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

<presigned-bucket-url-for-downloading-file>

Read directory contents

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pathstringRequired

Responses

200

Returns the list of files in the directory

application/json

Responsestring[]

500

Failed to fulfill request

application/json

get

/v2/files/dir/{path}

GET /v2/files/dir/{path} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  "file1.txt",
  "file2.txt"
]

Service discovery

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

namestringRequired

Responses

200

Returns url for the service named

text/plain

Responsestring

500

Failed to connect/fetch from database

application/json

get

/v2/discover/{name}

GET /v2/discover/{name} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text

List actions

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

typestring | nullOptional

Responses

200

Returns the actions with status

application/json

400

Failed list

application/json

500

Failed to connect/fetch from jobs table from database

application/json

get

/v2/actions

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"
  }
]

Get latest action_id belonging to a given pod_id

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200

The action_id of the given pod_id has been fetched Successfully

text/plain

Responsestring

404

Failed to get action_id for the given pod_id

application/json

500

Failed to connect/fetch from pods_to_actions table from database

application/json

get

/v2/actions/from_pod/{id}

GET /v2/actions/from_pod/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

<uuid-v4-here>

Upload podspec via rest api

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

action_idstringRequired

pod_idstring | nullOptional

pod_specanyOptional

statusstringRequired

Responses

200

Success

text/plain

Responsestring

404

Failed to get action_id within the db

application/json

500

Failed to connect/fetch from pods_to_actions table from database

application/json

post

/v2/actions/upload

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"
}

Success

Checkpoint a pod

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

action_idstring | nullRead-onlyOptional

cluster_idstringRequired

namespacestringRequired

pod_namestringRequired

runc_rootstringRequired

Responses

200

Returns the id for the task

text/plain

Responsestring

404

Failed to find checkpointable resource

application/json

500

Failed to connect/fetch from jobs table from database

application/json

post

/v2/checkpoint/pod

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>

Get status of a pod checkpoint operation

get

Returns the current status of a pod checkpoint based on action ID

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

action_idstringRequired

Responses

200

Returns the current status of the checkpoint operation

application/json

404

Action ID not found

application/json

500

Failed to retrieve status from database

application/json

get

/v2/checkpoint/status/{action_id}

GET /v2/checkpoint/status/{action_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "details": null,
  "status": "initialized"
}

List checkpoints

get

Use query params to filter checkpoints

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

idsstring · uuid[]Optional

Responses

200

Returns checkpoints

application/json

500

Failed to connect/fetch from database

application/json

get

/v2/checkpoints

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"
  }
]

Create checkpoint

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Returns the checkpoint id for the new checkpoint

text/plain

Responsestring

404

Failed create checkpoint

application/json

500

Failed to connect/fetch from jobs table from database

application/json

post

/v2/checkpoints

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

<uuid-v4-here>

Deprecate checkpoint

patch

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).

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200

Successfully deprecated checkpoint and returns id

text/plain

Responsestring

404

Failed to find checkpoint from id

500

Failed to connect/execute request against db

patch

/v2/checkpoints/deprecate/{id}

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

<uuid-for-checkpoint>

Put checkpoint info

put

Add information about the checkpointed pod and runtime

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

Body

gpustringRequired

platformstringRequired

Responses

200

Successfully deprecated checkpoint and returns id

text/plain

Responsestring

404

Failed to find checkpoint from id

application/json

500

Failed to connect/execute request against db

application/json

put

/v2/checkpoints/info/{id}

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>

Uploaded checkpoint

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

restore_pathstring | nullOptional

Responses

200

Marks the checkpoint as successfully uploaded

text/plain

Responsestring

404

Failed mark checkpoint

application/json

500

Failed to connect/fetch from jobs table from database

application/json

post

/v2/checkpoints/uploaded/{id}

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>

Upload file

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pathstringRequired

Responses

200

Returns the URL to upload the file to

text/plain

Responsestring

500

Failed to fulfill request

application/json

put

/v2/files/{path}

PUT /v2/files/{path} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

<presigned-bucket-url-for-uploading-file>

List jobs

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Returns list of jobs from db

application/json

500

Failed to connect/fetch from jobs table from database

get

/v2/jobs

GET /v2/jobs HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "jid": "xenodochial_jones4",
    "type": "containerd"
  },
  {
    "jid": "dreamy_nobel1",
    "type": "containerd"
  }
]

Update K8s Cluster Resource

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

cluster_idstring | nullOptional

metadataanyOptional

org_idstring | nullOptional

resourceone ofOptional

Responses

200

Resource id registered internally

text/plain

Responsestring

400

Bad request

application/json

500

Failed to connect to db

application/json

post

/v2/k8s/sync

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"
  }
}

text

List pods

get

Use query params to filter pods

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Returns pods

application/json

Responseobject · Pod[]

Entire json for the Kubernetes

500

Failed to connect/fetch from database

application/json

get

/v2/pods

GET /v2/pods HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {}
]

Restore a pod

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

action_idstringRequired

cluster_idstringOptional

Responses

200

Returns the checkpoint id for the new checkpoint

text/plain

Responsestring

400

Failed create checkpoint

application/json

404

Failed create restore

application/json

500

Failed to connect/fetch from jobs table from database

application/json

post

/v2/restore/pod

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>

Get User

get

Used to validate authentication token

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Returns your user-id (a uuid)

text/plain

Responsestring

401

Invalid Key/Token

application/json

404

User not attached to valid api key

application/json

get

/v2/user

GET /v2/user HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text

PreviousLLaMA Inference GPU Save, Migrate & Resume (SMR)

Last updated 5 months ago

Was this helpful?