Skip to main content
GET
/
v1
/
jobs
List Jobs
curl --request GET \
  --url https://api.dispersed.com/v1/jobs
{
  "data": [
    {
      "object": "job",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "status": "PENDING",
      "task": "BATCH",
      "title": "<string>",
      "cpu_count": 123,
      "gpu_count": 123,
      "min_ram_gb": 123,
      "min_vram_gb": 123,
      "min_storage_gb": 123,
      "parameters": {
        "parameters": {
          "allowed_ips": [
            "<string>"
          ],
          "env": {},
          "host": "<string>",
          "image": "<string>",
          "imagesrc": "<string>",
          "ports": [
            123
          ],
          "default_protocol": "http",
          "secret": "<string>",
          "sshkey": "<string>",
          "tag": "<string>",
          "user": "<string>",
          "volumes": [
            {
              "image": "<string>",
              "mount": "<string>",
              "registry": "<string>",
              "secret": "<string>",
              "tag": "<string>",
              "user": "<string>"
            }
          ]
        },
        "type": "docker"
      },
      "timeout_assign_at_ms": 123,
      "uuid": "<string>",
      "started_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "gpu_name": "<string>",
      "gpu_registry_uuid": "<string>",
      "max_timeout_assign_ms": 123,
      "max_timeout_run_ms": 123,
      "max_timeout_start_ms": 123,
      "max_retry_count": 123,
      "max_node_count": 123,
      "image_size_bytes": 123,
      "container_access_tokens": [],
      "status_reason": "<string>",
      "source_recipe_uuid": "<string>"
    }
  ],
  "limit": 123,
  "page": 123,
  "total": 123
}

Query Parameters

​
limit
integer
Required range: 1 <= x <= 50
Example:

1

​
page
integer
Required range: 1 <= x <= 9007199254740991
Example:

1

​
sort
string
Example:

"created_at OR -created_at"

​
filter[cpu_count]
string
Example:

"1"

​
filter[created_at]
string
Example:

"2023-01-01,2024-01-01"

​
filter[min_ram_gb]
string
Example:

"8,16"

​
filter[min_storage_gb]
string
Example:

"16"

​
filter[min_vram_gb]
string
Example:

"4,8"

​
filter[status]
string
Example:

"PENDING,RUNNING"

​
filter[task]
string
Example:

"BATCH"

​
filter[uuid]
string

Response

List of Jobs

​
data
object[]
required
​
limit
integer
required
​
page
integer
required
​
total
integer
required