> For the complete documentation index, see [llms.txt](https://docs.enlyze.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.enlyze.com/enlyze-api/api-referenz/sparks.md).

# SPARKs

## Get Sparks

> Returns a list of SPARKs in your organization.

```json
{"openapi":"3.1.0","info":{"title":"ENLYZE API","version":"v2"},"tags":[{"name":"SPARKs"}],"servers":[{"url":"/api"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"PaginatedSparks":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Spark"},"type":"array","title":"Data"},"metadata":{"$ref":"#/components/schemas/Metadata","description":"This field contains pagination metadata."}},"additionalProperties":false,"type":"object","required":["data","metadata"],"title":"PaginatedSparks"},"Spark":{"properties":{"uuid":{"type":"string","format":"uuid","title":"UUID","description":"The UUID of the SPARK."},"name":{"type":"string","title":"Name","description":"The human readable name of the SPARK."},"created_at":{"type":"string","format":"date-time","title":"Created at"},"site":{"type":"string","format":"uuid","title":"Site","description":"The UUID of the Site the SPARK is located at."},"network_interfaces":{"items":{"$ref":"#/components/schemas/NetworkInterface"},"type":"array","title":"Network Interfaces","description":"The list of the SPARK's network interfaces."},"last_seen_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last seen at","description":"Last heartbeat timestamp of the SPARK. Use status instead.","deprecated":true},"status":{"$ref":"#/components/schemas/SparkStatus","title":"Status","description":"Status of the SPARK."}},"type":"object","required":["uuid","name","created_at","site","network_interfaces","status"],"title":"Spark"},"NetworkInterface":{"properties":{"interface_name":{"type":"string","title":"Interface Name","description":"The name of the network interface."},"mac_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"MAC Address","description":"The MAC address of the network interface."},"addresses":{"items":{"$ref":"#/components/schemas/NetworkAddress"},"type":"array","title":"Addresses","description":"The set of network addresses associated with the network interface."},"state":{"$ref":"#/components/schemas/NetworkInterfaceState","title":"Network Interface State","description":"The state of the network interface."}},"type":"object","required":["interface_name","mac_address","addresses","state"],"title":"NetworkInterface"},"NetworkAddress":{"properties":{"ip":{"type":"string","format":"ipv4","title":"IP","description":"The IP of the network interface."},"dhcp_enabled":{"type":"boolean","title":"DHCP Enabled","description":"Indicates whether DHCP is used to configure the IP address."},"gateway_ip":{"anyOf":[{"type":"string","format":"ipv4"},{"type":"null"}],"title":"Gateway IP","description":"The IP of the network gateway."},"net_mask":{"anyOf":[{"type":"string","format":"ipv4"},{"type":"null"}],"title":"Netmask","description":"Subnet mask in dot-decimal notation (like IPv4 address)."}},"type":"object","required":["ip","dhcp_enabled","gateway_ip","net_mask"],"title":"NetworkAddress"},"NetworkInterfaceState":{"type":"string","enum":["down","unknown","up"],"title":"NetworkInterfaceState"},"SparkStatus":{"properties":{"last_seen_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last seen at","description":"Last heartbeat timestamp of the SPARK."},"state":{"oneOf":[{"$ref":"#/components/schemas/OnlineSparkStatus"},{"$ref":"#/components/schemas/OfflineSparkStatus"}],"title":"State","discriminator":{"propertyName":"type","mapping":{"offline":"#/components/schemas/OfflineSparkStatus","online":"#/components/schemas/OnlineSparkStatus"}}}},"type":"object","required":["state"],"title":"SparkStatus"},"OnlineSparkStatus":{"properties":{"type":{"type":"string","const":"online","title":"Type","default":"online"}},"type":"object","title":"OnlineSparkStatus"},"OfflineSparkStatus":{"properties":{"type":{"type":"string","const":"offline","title":"Type","default":"offline"}},"type":"object","title":"OfflineSparkStatus"},"Metadata":{"properties":{"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor","description":"Pagination continuation point. Specify its value as the `cursor` parameter in a request with otherwise the same parameters to fetch the next page. `None`, if there is no more data to be fetched from the server."}},"additionalProperties":false,"type":"object","required":["next_cursor"],"title":"Metadata"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/v2/sparks":{"get":{"tags":["SPARKs"],"summary":"Get Sparks","description":"Returns a list of SPARKs in your organization.","operationId":"get_sparks_v2_sparks_get","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"type":"string","title":"Get page starting at cursor"}},{"name":"uuid","in":"query","required":false,"schema":{"anyOf":[{"type":"array","uniqueItems":true,"items":{"type":"string","format":"uuid"},"maxItems":50},{"type":"null"}],"title":"Filter by one or more SPARK UUIDs."}},{"name":"machine","in":"query","required":false,"schema":{"anyOf":[{"type":"array","uniqueItems":true,"items":{"type":"string","format":"uuid"},"maxItems":50},{"type":"null"}],"title":"Filter by one or more machine UUIDs."}},{"name":"site","in":"query","required":false,"schema":{"anyOf":[{"type":"array","uniqueItems":true,"items":{"type":"string","format":"uuid"},"maxItems":50},{"type":"null"}],"title":"Filter by one or more site UUIDs."}},{"name":"data-source","in":"query","required":false,"schema":{"anyOf":[{"type":"array","uniqueItems":true,"items":{"type":"string","format":"uuid"},"maxItems":50},{"type":"null"}],"title":"Filter by one or more data source UUIDs."}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedSparks"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```