Skip to main content
GET
List Instances

Headers

Authorization
string
required

Bearer authentication format, e.g.: Bearer {{API_KEY}}.

Query Parameters

limit
integer

Maximum number of items to return. Uses the server default when omitted or 0. Integer, value >= 0.

cursor
string

Cursor for the next page. Leave empty for the first request, then pass the next_cursor from the previous response. String, length: 0-1024 characters.

name
string

Fuzzy match on instance name or ID. String, length: 0-255 characters.

status
string

Filter by instance status. String, length: 0-63 characters.

regions
string

Filter by region. Multiple regions are comma-separated. String, length: 0-1024 characters.

billing_mode
enum<string>

Filter by billing mode. Allowed values: postpaid, prepaid, spot. Use an empty string to skip filtering.

Available options:
postpaid,
prepaid,
spot

Response

200 - application/json

OK

data
object[]

Instance list

next_cursor
string

Cursor for the next page. Empty string when there is no next page

Example:

"next-cursor-token"

has_more
boolean

Whether there are more pages

Example:

true

Last modified on June 23, 2026