How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

VAST Data dboxes API

A DBox is an NVMe-oF JBOF, otherwise known as a VAST enclosure, or an enclosure containing NVMe-oF controller cards and flash SSDs. The dboxes path represents the DBoxes in the cluster, exposes information about the DBoxes and maintenance operations. There are two types of DBoxes. The legacy type DBox has two DNodes. The CERES Dbox, newly introduced in some deployments, has two DTrays and four DNodes.

VAST Data dboxes API is one of 126 APIs that VAST Data publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include dboxes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and SDKs.

This API exposes 10 operations across 8 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against the base URL https://{vms-host}/api.

10 operations 8 paths 3 schemas 1 DELETE2 GET3 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://{vms-host}/api
Authentication
API Key, HTTP Basic
Resource Areas
1

Authentication & Security 2

VAST Data dboxes API declares 2 security schemes for authenticating requests. An API key is passed in the header as ApiToken (ApiToken). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • ApiToken — Send current valid API token in an Authorization header with format Api-Token .
  • basicAuth — Basic authentication using VMS user name and password

Paths & Operations 10

Across 8 paths, the API surfaces 10 operations — 1 DELETE, 2 GET, 3 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

dboxes 10

A DBox is an NVMe-oF JBOF, otherwise known as a VAST enclosure, or an enclosure containing NVMe-oF controller cards and flash SSDs. The dboxes path represents the DBoxes in the cl…

GET
/dboxes/
List DBoxes
dboxes_list 2 params → 200
POST
/dboxes/add/
Add DBox
dboxes_add body → 201
POST
/dboxes/decommission/
DBox Removal
dbox_decommission body → 200400
POST
/dboxes/decommission/dry-run/
Validate DBox Removal
dbox_decommission_dry_run body → 200409
POST
/dboxes/decommission/resume/
Resume DBox Removal
dbox_decommission_resume → 200400
DELETE
/dboxes/{id}/
Delete a DBox
dboxes_delete 1 param → 200
GET
/dboxes/{id}/
Return Details of a DBox
dboxes_read 1 param → 200
PATCH
/dboxes/{id}/
Modify a DBox Description
dboxes_partial_update 1 param body → 200
PATCH
/dboxes/{id}/control_led/
Control DBox LEDs
control_led 1 param body → 200
PATCH
/dboxes/{id}/reset_dp_i2c/
Reset dp i2c
reset_dp_i2c 1 param → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are DBox (25 properties), ErrorResponse (1 property), AsyncTaskInResponse (1 property). Each schema is shown below with its type and property counts.

DBox
object
25 properties 1 required
AsyncTaskInResponse
object
1 property
ErrorResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vastdata-dboxes-api-openapi.yml Raw ↑

Other APIs VAST Data publishes across the network.

VAST Data activedirectory API
VAST Data alarms API
VAST Data apitokens API
VAST Data basicsettings API
VAST Data bgpconfigs API
VAST Data Blob Expansions API
VAST Data Block Hosts API
VAST Data blockhosts API
VAST Data blockmappings API
VAST Data callhomeconfigs API
VAST Data capacity API
VAST Data carriers API
Where this information came from

This is an independent, third-party profile of VAST Data dboxes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.