SPARKs

Get Sparks

get

Returns a list of SPARKs in your organization.

Authorizations

Bearer

AuthorizationstringRequired

Query parameters

cursorstringOptional

uuidstring · uuid[] · max: 50 · nullableOptional

machinestring · uuid[] · max: 50 · nullableOptional

sitestring · uuid[] · max: 50 · nullableOptional

data-sourcestring · uuid[] · max: 50 · nullableOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get/v2/sparks

HTTPcURLJavaScriptPython

GET /api/v2/sparks HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "created_at": "2026-07-18T23:08:13.190Z",
      "site": "123e4567-e89b-12d3-a456-426614174000",
      "network_interfaces": [
        {
          "interface_name": "eth0",
          "mac_address": "80:a9:97:0d:3f:7a",
          "addresses": [
            {
              "ip": "0.0.0.0",
              "dhcp_enabled": true,
              "gateway_ip": "0.0.0.0",
              "net_mask": "0.0.0.0"
            }
          ],
          "state": "down"
        }
      ],
      "status": {
        "last_seen_at": "2026-07-18T23:08:13.190Z",
        "state": {
          "type": "online"
        }
      }
    }
  ],
  "metadata": {
    "next_cursor": "text"
  }
}