List Nodes

GET /v1/nodes

List Nodes

cURL

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

200

{
  "data": [
    {
      "name": "<string>",
      "status": "AVAILABLE",
      "object": "node",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "_id": "<string>",
      "uuid": "<string>",
      "last_seen_at": "2023-11-07T05:31:56Z",
      "latest_hardware_event": {
        "timestamp_ms": 123,
        "object": "node_hardware_event",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "uuid": "<string>",
        "metadata": {
          "cpu": {
            "average": 123,
            "cores": [
              123
            ]
          },
          "gpu": {
            "gpus": [
              {
                "load": 123,
                "name": "<string>",
                "vram": {
                  "free": 123,
                  "total": 123
                }
              }
            ],
            "average": 123
          },
          "ram": {
            "free": 123,
            "total": 123
          },
          "storage": {
            "hard_drives": [
              {
                "free_capacity": 123,
                "model": "<string>",
                "name": "<string>",
                "total_capacity": 123
              }
            ]
          }
        },
        "node": "<string>",
        "node_hardware": "<string>",
        "account": "<string>"
      },
      "current_hardware": {
        "memory": {
          "ram_bytes_total": 123,
          "base_clock_mhz": 123,
          "device_id": "<string>"
        },
        "storage": {
          "capacity_bytes_free": 123,
          "capacity_bytes_total": 123,
          "device_id": "<string>"
        },
        "object": "node_hardware",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "uuid": "<string>",
        "node": "<string>",
        "node_uuid": "<string>",
        "cpus": [],
        "gpus": [],
        "machine_id": "<string>",
        "checksum_sha256": "<string>",
        "_id": "<string>",
        "operating_system": {
          "architecture": "<string>",
          "brand": "<string>",
          "name": "<string>",
          "version": "<string>"
        },
        "schema_version": 0
      },
      "current_software": {
        "object": "node_software",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "uuid": "<string>",
        "node": "<string>",
        "node_uuid": "<string>",
        "capabilities": [],
        "cached_image_tags": [
          "ubuntu:22.04",
          "pytorch/pytorch:latest"
        ],
        "schema_version": 0,
        "docker": {
          "images": [],
          "version": null
        },
        "nvidia_driver": {
          "version": null
        },
        "operating_system": {
          "architecture": null,
          "brand": "",
          "name": "",
          "version": ""
        },
        "zernet_client": {
          "version": null
        }
      },
      "ipv4_address": "<string>",
      "ipv6_address": "<string>",
      "mac_address": "<string>",
      "operator_account": {
        "email": "[e-mail]",
        "object": "account",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "uuid": "<string>",
        "active_roles": [
          {
            "name": "<string>",
            "uuid": "<string>"
          }
        ],
        "last_login": "2023-11-07T05:31:56Z",
        "consumer_profile": {
          "is_active": true,
          "is_compute_billing_enabled": true,
          "object": "consumer_profile",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "uuid": "<string>",
          "account_uuid": "<string>",
          "render_user_id": "<string>",
          "allowed_region_codes": [],
          "deleted_at": "2023-11-07T05:31:56Z"
        },
        "operator_profile": {
          "is_active": true,
          "object": "operator_profile",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "uuid": "<string>",
          "account_uuid": "<string>",
          "wallet_address": "<string>",
          "deleted_at": "2023-11-07T05:31:56Z"
        },
        "user_profile": {
          "email_verified": true,
          "object": "user_profile",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "uuid": "<string>",
          "account_uuid": "<string>",
          "name": "<string>",
          "given_name": "<string>",
          "family_name": "<string>",
          "middle_name": "<string>",
          "preferred_username": "<string>",
          "oauth_provider": "<string>",
          "oauth_subject": "<string>"
        },
        "deleted_at": "2023-11-07T05:31:56Z"
      },
      "operator_account_uuid": "<string>",
      "reputation": 0,
      "suspended_at": "2023-11-07T05:31:56Z",
      "current_suspension": {
        "started_at": "2023-11-07T05:31:56Z",
        "reason_code": "ABUSE",
        "reason": "<string>",
        "follow_up": "<string>",
        "object": "node_suspension",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "uuid": "<string>",
        "node_uuid": "<string>",
        "ended_at": "2023-11-07T05:31:56Z"
      },
      "deleted_at": "2023-11-07T05:31:56Z",
      "cpus": [],
      "gpus": [],
      "hard_drives": [],
      "operating_system": {
        "brand": "<string>",
        "name": "<string>",
        "version": "<string>"
      },
      "rams": [],
      "ramTotal": 0
    }
  ],
  "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[region_code] · enum<string> | null

Coarse geographic-network region identifier (AWS-style naming).

Available options: ca-central-1, ca-west-1, mx-central-1, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2, eu-central-1, eu-central-2, eu-north-1, eu-south-1, eu-south-2, eu-west-1, eu-west-2, eu-west-3, ap-east-1, ap-east-2, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-south-1, ap-south-2, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-4, ap-southeast-5, ap-southeast-6, ap-southeast-7, cn-north-1, cn-northwest-1, af-south-1, il-central-1, me-central-1, me-south-1, null

Example:

"us-west-2"

filter[node_client_version] · string

Find Nodes with this Node Client version.

Required string length: 1 - 128

Example:

"1.8.0"

filter[created_at] · string

Example:

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

filter[last_seen_at] · string

Example:

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

filter[status] · enum<string>

Available options: AVAILABLE, ASSIGNED, PREPARING, WORKING, STOPPING, OFFLINE, DELETED, RESOURCE_BUSY, OUTDATED_CLIENT

Example:

"AVAILABLE"

filter[name] · string

filter[operator_account_uuid] · string

filter[country_iso_code] · string

Example:

"US"

filter[continent_code] · enum<string>

Available options: AF, AN, AS, EU, NA, OC, SA

Example:

"NA"

filter[subdivision_iso_code] · string

Example:

"US-CA"

filter[compliance_tags] · enum<string>

Available options: GDPR, EEA

Example:

"GDPR"

filter[uuid] · string

filter[include_deleted] · boolean | null

Response

200

application/json

List of Nodes

data · object[] · required

Show child attributes

limit · integer · required

page · integer · required

total · integer · required