List Jobs

GET /v1/jobs

List Jobs

cURL

curl --request GET \
  --url https://api.dispersed.com/v1/jobs

import requests

url = "https://api.dispersed.com/v1/jobs"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.dispersed.com/v1/jobs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dispersed.com/v1/jobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dispersed.com/v1/jobs"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.dispersed.com/v1/jobs")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dispersed.com/v1/jobs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

200

{
  "data": [
    {
      "object": "job",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "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
          ],
          "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,
      "allowed_region_codes": [],
      "container_access_tokens": [],
      "status_reason": "<string>",
      "source_recipe_uuid": "<string>"
    }
  ],
  "limit": 123,
  "page": 123,
  "total": 123
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "timestamp": "<string>",
    "details": []
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "timestamp": "<string>",
    "details": []
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "timestamp": "<string>",
    "details": []
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "timestamp": "<string>",
    "details": []
  }
}

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

200

application/json

List of Jobs

data · object[] · required

Show child attributes

limit · integer · required

page · integer · required

total · integer · required