Get Node Image Pull Progress

curl --request GET \
  --url https://api.dispersed.com/v1/nodes/{node_uuid}/events

const options = {method: 'GET'};

fetch('https://api.dispersed.com/v1/nodes/{node_uuid}/events', 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/nodes/{node_uuid}/events",
  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/nodes/{node_uuid}/events"

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.dispersed.com/v1/nodes/{node_uuid}/events")

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

{
  "download_percentage": 123,
  "latest": {
    "created_at": "2023-11-07T05:31:56Z",
    "object": "node_event",
    "client_observed_at_ms": 123,
    "payload": {},
    "schema_version": 123,
    "server_received_at_ms": 123,
    "type": "<string>",
    "job_run_uuid": "<string>",
    "node_uuid": "<string>",
    "uuid": "<string>"
  },
  "speed_bytes_per_sec": 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": []
  }
}

Nodes

Get Node Image Pull Progress

Check Docker image pull progress on a node you operate. Get the node’s UUID from GET /v1/nodes.

Read progress

Call GET /v1/nodes/{node_uuid}/events. Poll for updated progress while an image is downloading. Each request returns the latest snapshot as JSON, not a list of events or a live stream.

By default, this returns the node’s latest image pull progress. Set job_run_uuid to limit results to a particular run. The optional type parameter currently accepts only DOCKER_IMAGE_PULL_PROGRESS.

Response

download_percentage: the estimated download percentage, from 0 to 100, or null when the total size is not known.
speed_bytes_per_sec: the estimated recent download speed in bytes per second, or null when there are not enough samples to calculate it.
latest: the latest reported image pull event, including node_uuid, or null when no event is available.

All three fields are null before any matching progress is available. A null value means information is unavailable, not that the pull failed.

Access

Sign requests with your API key and HMAC headers. You need nodes.read.own for a node you operate, or nodes.read.all to read any node.

If you submitted a job rather than operating the node, use GET /v1/job-runs/{uuid}/events. That endpoint requires only Job Run read access and does not include node identity.

GET

nodes

{node_uuid}

events

Get Node Image Pull Progress

curl --request GET \
  --url https://api.dispersed.com/v1/nodes/{node_uuid}/events

const options = {method: 'GET'};

fetch('https://api.dispersed.com/v1/nodes/{node_uuid}/events', 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/nodes/{node_uuid}/events",
  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/nodes/{node_uuid}/events"

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.dispersed.com/v1/nodes/{node_uuid}/events")

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

{
  "download_percentage": 123,
  "latest": {
    "created_at": "2023-11-07T05:31:56Z",
    "object": "node_event",
    "client_observed_at_ms": 123,
    "payload": {},
    "schema_version": 123,
    "server_received_at_ms": 123,
    "type": "<string>",
    "job_run_uuid": "<string>",
    "node_uuid": "<string>",
    "uuid": "<string>"
  },
  "speed_bytes_per_sec": 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": []
  }
}

Path Parameters

node_uuid

string<uuid>

required

Query Parameters

job_run_uuid

string<uuid>

type

enum<string>

Available options:

DOCKER_IMAGE_PULL_PROGRESS

Response

The latest image pull progress, or null fields if no progress is available.

download_percentage

number | null

required

Estimated image download percentage, from 0 to 100. Null when the total download size is not known.

latest

object | null

required

The latest image pull event, including node_uuid, or null if none is available. type is DOCKER_IMAGE_PULL_PROGRESS. Inside payload, downloaded_bytes is the number of bytes downloaded so far. Optional fields include total_bytes (expected download size), image, tag, docker_status, and error_message. Other payload fields may be added.

Show child attributes

speed_bytes_per_sec

number | null

required

Estimated recent download speed in bytes per second. Null when there are not enough valid progress samples to calculate a speed.

Account Agreements

Accounts

Agreements

API Keys

Compute

Compute Rewards

Compute Ledger

Consumer Profiles

GPU Registry

Job Recipes

Job Runs

Jobs

Nodes

Node Sessions

Operator Profiles

SSH Public Keys

Users

Get Node Image Pull Progress

Read progress

Response

Access

Path Parameters

Query Parameters

Response