Instances
Get all instances for a project
Authorizations
Query parameters
next_cursorany ofOptional
anyOptional
nullOptional
sort_bystring · enum | nullableOptionalPossible values:
sort_dirstring · enum | nullableOptionalPossible values:
projectstringRequired
instance_typestring | nullableOptionalExample:
it_abc123456
regionstring | nullableOptionalExample:
us-central1-a
bid_fid_instring[] | nullableOptional
Comma-separated list of bid FIDs
reservation_fid_instring[] | nullableOptional
Comma-separated list of reservation FIDs
limitinteger | nullableOptional
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /v2/instances HTTP/1.1
Host: api.mlfoundry.com
Authorization: Bearer fkey_<key>
Accept: */*
{
"data": [
{
"fid": "inst_abc123456",
"name": "text",
"project": "proj_abc123456",
"created_at": "2024-01-01T00:00:00Z",
"instance_type": "it_abc123456",
"region": "us-central1-a",
"bid": "bid_abc123456",
"reservation": "res_abc123456",
"ssh_destination": "text",
"private_ip": "text",
"status": "STATUS_RUNNING"
}
],
"next_cursor": "text"
}