Instances

Get Instances

get

Get all instances for a project

Authorizations

MithrilAPIKey

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

next_cursorany · nullableOptional

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 · min: 1 · max: 100 · nullableOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v2/instances

HTTPcURLJavaScriptPython

GET /v2/instances?project=text HTTP/1.1
Host: api.mithril.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "fid": "inst_abc123456",
      "name": "text",
      "project": "proj_abc123456",
      "created_at": "2024-01-01T00:00:00Z",
      "created_by": "user_abc123456",
      "instance_type": "it_abc123456",
      "region": "us-central1-a",
      "bid": "bid_abc123456",
      "reservation": "res_abc123456",
      "ssh_destination": "text",
      "private_ip": "text",
      "status": "STATUS_NEW"
    }
  ],
  "next_cursor": "text"
}

Get Instance Status

get

Get the status of a specific instance by its ID

Authorizations

MithrilAPIKey

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

instance_idstringRequiredExample: inst_abc123456

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v2/instances/{instance_id}/status

HTTPcURLJavaScriptPython

GET /v2/instances/{instance_id}/status HTTP/1.1
Host: api.mithril.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "fid": "inst_abc123456",
  "name": "text",
  "bid": "bid_abc123456",
  "reservation": "res_abc123456",
  "status": "STATUS_NEW",
  "end_time": "2024-01-01T00:00:00Z"
}