Instances

Get Instances

Get all instances for a project

get

/v2/instances

Authorizations

Query parameters

next_cursorany of

sort_bystring · enum | nullable

Options: created_at, instance_status, instance_type_fid

sort_dirstring · enum | nullable

Options: asc, desc

projectstringrequired

instance_typestring | nullable

Example: it_abc123456

regionstring | nullable

Example: us-central1-a

status_instring · enum[] | nullable

Comma-separated list of instance statuses

order_type_instring · enum[] | nullable

Comma-separated list of order types

bid_fid_instring[] | nullable

Comma-separated list of bid FIDs

reservation_fid_instring[] | nullable

Comma-separated list of reservation FIDs

limitinteger | nullable

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.mlfoundry.com/v2/instances?project=text' \
  --header 'Authorization: Bearer fkey_<key>'

200

422

200

{
  "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"
}

Successful Response