Jobs

Cedana API for legacy jobs

List checkpoints for Cedana jobs

get

Supports filtering by ids and/or jids (comma-separated lists)

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

idsstring · nullableOptional

Comma-separated list of checkpoint UUIDs to filter by

jidsstring · nullableOptional

Comma-separated list of job IDs to filter by

Responses

200

Returns checkpoints

application/json

IDstringOptional

JIDstringRequired

PathstringRequired

Sizeinteger · int64Required

Timeinteger · int64Required

400

Invalid query parameters

application/json

500

Failed to connect/fetch from database

application/json

4XX

Client error

application/json

5XX

Server error

application/json

get/v1/cedana/job/checkpoints

GET /v1/cedana/job/checkpoints HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "ID": "text",
    "JID": "text",
    "Path": "text",
    "Size": 1,
    "Time": 1
  }
]

Create or update a checkpoint for a Cedana job

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

IDstringOptional

JIDstringRequired

PathstringRequired

Sizeinteger · int64Required

Timeinteger · int64Required

Responses

200

Checkpoint created or updated successfully, returns the generated checkpoint ID

text/plain

stringOptional

400

Invalid request payload

application/json

500

Failed to execute request against database

application/json

4XX

Client error

application/json

5XX

Server error

application/json

put/v1/cedana/job/checkpoints/{id}

PUT /v1/cedana/job/checkpoints/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "ID": "text",
  "JID": "text",
  "Path": "text",
  "Size": 1,
  "Time": 1
}

text

Delete a checkpoint for a Cedana job

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200

Checkpoint deleted successfully

No content

400

Invalid UUID

application/json

500

Failed to delete checkpoint

application/json

4XX

Client error

application/json

5XX

Server error

application/json

delete/v1/cedana/job/checkpoints/{id}

DELETE /v1/cedana/job/checkpoints/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List jobs

get

Use query params to filter jobs. Supports filtering by jids or host_ids (comma-separated lists)

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

jidsstring · nullableOptional

Comma-separated list of job IDs to filter by

host_idsstring · nullableOptional

Comma-separated list of host IDs to filter by

Responses

200

Returns jobs

application/json

DetailsanyOptional

JIDstringOptional

LogstringOptional

TypestringRequired

400

Invalid query parameters

application/json

500

Failed to connect/fetch from database

application/json

4XX

Client error

application/json

5XX

Server error

application/json

get/v1/cedana/jobs

GET /v1/cedana/jobs HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "Details": null,
    "JID": "text",
    "Log": "text",
    "State": {
      "Cmdline": "text",
      "GIDs": [
        1
      ],
      "GPUEnabled": true,
      "Groups": [
        1
      ],
      "Host": {
        "CPU": {
          "Count": 1,
          "Family": "text",
          "PhysicalID": "text",
          "VendorID": "text"
        },
        "Hostname": "text",
        "ID": "text",
        "KernelArch": "text",
        "KernelVersion": "text",
        "MAC": "text",
        "Memory": {
          "Total": 1
        },
        "OS": "text",
        "Platform": "text"
      },
      "IsRunning": true,
      "PID": 1,
      "StartTime": 1,
      "Status": "text",
      "UIDs": [
        1
      ],
      "WorkingDir": "text"
    },
    "Type": "text"
  }
]

Create or update a job

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

jidstringRequired

Body

DetailsanyOptional

JIDstringOptional

LogstringOptional

TypestringRequired

Responses

200

Job created or updated successfully

No content

400

Invalid request payload

application/json

500

Failed to execute request against database

application/json

4XX

Client error

application/json

5XX

Server error

application/json

put/v1/cedana/jobs/{jid}

PUT /v1/cedana/jobs/{jid} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 429

{
  "Details": null,
  "JID": "text",
  "Log": "text",
  "State": {
    "Cmdline": "text",
    "GIDs": [
      1
    ],
    "GPUEnabled": true,
    "Groups": [
      1
    ],
    "Host": {
      "CPU": {
        "Count": 1,
        "Family": "text",
        "PhysicalID": "text",
        "VendorID": "text"
      },
      "Hostname": "text",
      "ID": "text",
      "KernelArch": "text",
      "KernelVersion": "text",
      "MAC": "text",
      "Memory": {
        "Total": 1
      },
      "OS": "text",
      "Platform": "text"
    },
    "IsRunning": true,
    "PID": 1,
    "StartTime": 1,
    "Status": "text",
    "UIDs": [
      1
    ],
    "WorkingDir": "text"
  },
  "Type": "text"
}

No content

Delete a job

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

jidstringRequired

Responses

200

Job deleted successfully

No content

500

Failed to execute request against database

application/json

4XX

Client error

application/json

5XX

Server error

application/json

delete/v1/cedana/jobs/{jid}

DELETE /v1/cedana/jobs/{jid} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content