Skip to content
Sluice

listInstances

GET
/api/v1/instances
curl --request GET \
  --url https://example.com/api/v1/instances

Responses

Section titled “ Responses ”

200

Section titled “200”

OK

Media typeapplication/json
object
items
required
Array<object>
object
executors
required
Array<string>
heartbeat_at
required
string format: date-time
hostname
required
string
id
required
string
online
required
boolean
pools
required
Array<string>
started_at
required
string format: date-time
version
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
  "items": [
    {
      "executors": [
        "example"
      ],
      "heartbeat_at": "2026-04-15T12:00:00Z",
      "hostname": "example",
      "id": "example",
      "online": true,
      "pools": [
        "example"
      ],
      "started_at": "2026-04-15T12:00:00Z",
      "version": "example"
    }
  ]
}

default

Section titled “default”

Error

Media typeapplication/json
object
error
required
object
code
required
string
details
message
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
  "error": {
    "code": "example",
    "details": "example",
    "message": "example"
  }
}