Get

/virtual-machines/{id}/

This endpoint returns details of a specific virtual machine.

Security

HTTP

Type basic

Basic authentication using VMS user name and password

API Key: ApiToken

Header parameter nameApiToken

Send current valid API token in an Authorization header with format Api-Token .

Path parameters

id

stringRequired

virtual machine ID

Responses

200

object

id

integer

ID of the virtual machine.

guid

string

Globally unique identifier

name

string

title

string

Title

arch_type

string

System architecture. e.g. x86_64

uid

string

Unique h/w identifier

state

string

State. e.g. ACTIVE

cluster

string

Parent Cluster

cluster_id

integer

ID of parent cluster

description

string

Description

drive_type

string

dtray

string

url

string

REST API endpoint for the virtual machine object.

sync

string

Synchronization state with leader

sync_time

string

Synchronization time with leader

is_conclude_possible

boolean

Flag that indicates a replacement conclude possibility

is_replace_possible

boolean

Flag that indicates replacement availability

rack_id

integer

ID of a rack to which the machine is assigned, if applicable. Rack assignment is intended for data center management purposes. Can be relevant to EBoxes.

Minimum1

subsystem

integer

An index used in the formation of IP addresses allocated on the cluster's internal network. Each subsystem enables allocation of 254 IPs. Default is 0.

Minimum0

index_in_rack

integer

Index of unit position in rack.

Minimum1

box_vendor

string

Shows vendor and model.

led_status

string

LED Status

external_machine_id

string

Instance name in cloud provider

Return Details of a virtual machine