Get

/dboxes/{id}/

This endpoint returns details of a DBox.

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

DBox ID

Responses

200

object

id

integer

guid

string

name

string

title

string

arch_type

string

uid

string

Unique h/w identifier

state

string

cluster

string

Parent Cluster

cluster_id

integer

description

string

Description

drive_type

string

dtray

string

url

string

sync

string

Synchronization state with leader

sync_time

string

Synchronization time with leader

is_conclude_possible

boolean

True if all of the DBox's NVRAM and SSD slots are empty and therefore 'replacement conclude' function can be run, which removes the DBox and its DNodes from the cluster. This is the final step in the replacement of a DBox.

is_replace_possible

boolean

True if DBox replacement is currently an available option

is_migrate_target

boolean

Flag that indicates target DBox for migration

is_migrate_source

boolean

Flag that indicates source DBox for migration

rack_id

integer

Minimum1

rack_name

string

subsystem

integer

Minimum0

index_in_rack

integer

Minimum1

box_vendor

string

Shows DBox vendor and model.

hardware_type

string

Hardware type (e.x. sanmina/ceres/ceres_v2)

Return Details of a DBox