Skip to main content
GET
List your instances

Authorizations

Authorization
string
header
required

An API key issued by Hive Compute support. See Authentication above for how to request one.

Query Parameters

cursor
string

Opaque cursor from a previous response's pagination.next. Omit to start at the first page.

size
integer
default:50

Number of items per page.

Required range: 1 <= x <= 200
status
enum<string>

Return only instances in this state.

Available options:
running,
stopped,
terminated,
errored
region
string

Return only instances in this region, e.g. eu-west.

gpu_type
string

Return only instances on this GPU model, e.g. RTX 4090.

date_range_begin
string<date-time>

Return only instances created at or after this ISO 8601 timestamp.

date_range_end
string<date-time>

Return only instances created at or before this ISO 8601 timestamp.

Match against instance name, region and GPU type.

Maximum string length: 255
sort_field
enum<string>

Field to order by. Defaults to creation time, newest first.

Available options:
NAME,
GPU_TYPE,
SIZE,
REGION,
HOURLY_RATE,
CURRENT_COST,
STATUS
sort_direction
enum<string>

Order direction. Defaults to DESC.

Available options:
ASC,
DESC

Response

A page of instances.

data
object[]
pagination
object

Cursor pagination metadata.