GET
Get Instance

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.

Path Parameters

id
string
required

Response

Success.

id
string

Core Instance Information

name
string
displayName
string
state
string
instanceType
string

Resource Information maps to serviceofferingname

cpuNumber
integer<int32>
cpuSpeed
integer<int32>
memoryKbs
integer<int64>
hypervisor
string
ipAddress
string

Network Information

networkKbsRead
integer<int64>
networkKbsWrite
integer<int64>
receivedBytes
integer<int64>
sentBytes
integer<int64>
diskKbsRead
integer<int64>

Storage Information

diskKbsWrite
integer<int64>
diskIoRead
integer<int64>
diskIoWrite
integer<int64>
osDisplayName
string

Instance Details

haEnabled
boolean
deleteProtection
boolean
created
string<date-time>
lastUpdated
string<date-time>
account
string

Additional Information

domain
string
tags
object
details
object
cpuUtilization
string

Add to InstanceDTO class

memoryUtilization
string
templateId
string

Template Information

templateName
string
templateType
string
templateFormat
string
templateDisplayText
string
serviceOfferingId
string

Service Offering Information

serviceOfferingName
string
diskOfferingId
string
diskOfferingName
string
zoneId
string

Zone and Host Information

zoneName
string
hostId
string
hostname
string
hostControlState
string
memory
integer<int32>

Memory Information (both raw and formatted) in MB

cpuTotal
string

formatted string like "0.5 Ghz"

memoryTotal
string

formatted string like "0.50 GiB"

instanceName
string

Instance Name

passwordEnabled
boolean

Additional flags

displayVm
boolean
isDynamicallyScalable
boolean
userId
string

User Information

username
string
domainId
string
guestOsId
string

OS Information

osTypeId
string
rootDeviceId
integer<int32>

Root Device Information

rootDeviceType
string
bootMode
string

Boot Information

bootType
string
poolType
string
arch
string
hasAnnotations
boolean

Additional flags

backupOfferingId
string

Backup Offering

backupOfferingName
string