API Reference

Get Internal Instance Status

get

Combined polling endpoint for mithril-authenticated VMs.

Returns instance status, bid status, and end_time in a single request. Uses lightweight DB queries and cached authentication.

Authorizations

MithrilAPIKey

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

instance_fidstringRequiredExample: inst_abc123456

bid_fidstring · nullableOptionalExample: bid_abc123456

Responses

200

Successful Response

application/json

Response for the combined mithril polling endpoint.

instance_fidstringRequiredExample: inst_abc123456

instance_statusstring · enumRequiredPossible values:

instance_namestringRequired

bid_fidstring · nullableOptionalExample: bid_abc123456

bid_statusstring · enum · nullableOptionalPossible values:

end_timestring · datetime · nullableOptionalExample: 2024-01-01T00:00:00Z

422

Validation Error

application/json

get

/v2/internal/status

HTTPcURLJavaScriptPython

GET /v2/internal/status?instance_fid=inst_abc123456 HTTP/1.1
Host: api.mithril.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "instance_fid": "inst_abc123456",
  "instance_status": "STATUS_NEW",
  "instance_name": "text",
  "bid_fid": "bid_abc123456",
  "bid_status": "Open",
  "end_time": "2024-01-01T00:00:00Z"
}