GET
Get All Instances

Authorizations

Authorization
string
header
required

The access token from a signed-in console session, sent as Authorization: Bearer <token>. It must be issued for the Simnet API audience — an identity token, or a token for another application, is refused with 401.

There are no API keys, client secrets or service accounts yet, so this is a personal, short-lived credential carrying your full account access. Programmatic credentials with role-based access are on the roadmap. See Authentication.

Headers

X-Region-Context
string<uuid>

The region to run this request against, as a region UUID. Omit it to use your default region — your primary region if you have one, otherwise the first active one. See Regions.

Query Parameters

state
string

Response

Success. Rows are under virtualmachines.

Recovered from the code that builds this response. Rows arrive under virtualmachines — the compute platform's own key, not content.

virtualmachines
object[]

The rows, under virtualmachines.

count
integer

Total rows matching the query.

totalElements
integer

Same value as count.

currentPage
integer

Same value as page.

page
integer

The page you are on, counting from 1.

pageSize
integer

Rows per page.

totalPages
integer

Number of pages.

hasNext
boolean
hasPrevious
boolean