Actions

Cedana API for actions

List actions

get

Authorizations

Auth Token

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

text/plain

500

Failed to connect/fetch from jobs table from database

text/plain

get

/v2/actions

HTTPcURLJavaScriptPython

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

<uuid-v4-here>

Get latest action belonging to a pod

get

Authorizations

Auth Token

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

text/plain

500

Failed to connect/fetch from pods_to_actions table from database

text/plain

get

/v2/actions/from_pod/{id}

HTTPcURLJavaScriptPython

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

<uuid-v4-here>

Upload pod spec

post

Authorizations

Auth Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

action_idstringRequired

persistent_volume_claimanyOptional

pod_idstring | nullOptional

pod_metadata_specanyOptional

pod_specanyOptional

statusstringRequired

Responses

200

Success

text/plain

Responsestring

404

Failed to get action_id within the db

text/plain

500

Failed to connect/fetch from pods_to_actions table from database

text/plain

post

/v2/actions/upload

HTTPcURLJavaScriptPython

POST /v2/actions/upload HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "action_id": "text",
  "persistent_volume_claim": null,
  "pod_id": null,
  "pod_metadata_spec": null,
  "pod_spec": null,
  "status": "text"
}

Success

Get path of latest checkpoint

get

Returns the path of the latest successful checkpoint for a given checkpoint name

Authorizations

Auth Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Returns the restore path

text/plain

Responsestring

400

Failed to get action for request

text/plain

500

Failed to connect/fetch from jobs table from database

text/plain

get

/v2/checkpoint/path

HTTPcURLJavaScriptPython

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

<restore-path>

Checkpoint pod

post

Authorizations

Auth Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

action_idstring | nullRead-onlyOptional

cluster_idstring | nullOptional

kindstring · enumOptionalPossible values:

namespacestring | nullOptional

overridesone ofOptional

nullOptional

or

pod_idstring | nullOptional

pod_namestring | nullOptional

reasonstring · enumOptionalPossible values:

Responses

200

Returns the ID for the task

text/plain

Responsestring

400

Invalid request parameters

text/plain

404

Failed to find checkpointable resource

text/plain

500

Failed to create checkpoint or connect to eventstream

text/plain

post

/v2/checkpoint/pod

HTTPcURLJavaScriptPython

POST /v2/checkpoint/pod HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 120

{
  "cluster_id": null,
  "kind": "simple",
  "namespace": null,
  "overrides": null,
  "pod_id": null,
  "pod_name": null,
  "reason": "heartbeat"
}

550e8400-e29b-41d4-a716-446655440000

Get status of checkpoint action

get

Returns the current status of a checkpoint action

Authorizations

Auth Token

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

text/plain

500

Failed to retrieve status from database

text/plain

get

/v2/checkpoint/status/{action_id}

HTTPcURLJavaScriptPython

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

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

Restore pod

post

Authorizations

Auth Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

action_idstringRequired

cluster_idstringOptional

overridesone ofOptional

nullOptional

or

reasonstring · enumRequiredPossible values:

Responses

200

Returns the checkpoint ID for the new checkpoint

text/plain

Responsestring

400

Invalid action_id or request parameters

text/plain

500

Failed to create restore or connect to eventstream

text/plain

post

/v2/restore/pod

HTTPcURLJavaScriptPython

POST /v2/restore/pod HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "action_id": "text",
  "cluster_id": "text",
  "overrides": null,
  "reason": "nodeTermination"
}

550e8400-e29b-41d4-a716-446655440000