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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
VAST Data

VAST Data clusters API

VMS manages configuration of a single VAST cluster. The clusters path provides access to many configurations and settings that apply to the cluster.

Documentation Provider Profile APIs.io OpenAPI GitHub

VAST Data clusters 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 Cluster. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and SDKs.

This API exposes 69 operations across 60 paths, and defines 46 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

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

69 operations 60 paths 46 schemas 7 DELETE27 GET14 PATCH21 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 clusters 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 69

Across 60 paths, the API surfaces 69 operations — 7 DELETE, 27 GET, 14 PATCH, 21 POST. Each is listed below with its method, path, parameters, and response codes.

clusters 69

VMS manages configuration of a single VAST cluster. The clusters path provides access to many configurations and settings that apply to the cluster.

GET
/clusters/
List Clusters
clusters_list 1 param → 200
POST
/clusters/
Create Cluster
clusters_create body → 201
PATCH
/clusters/add_boxes/
Start Add Boxes procedure
add_boxes body → 200
GET
/clusters/bgp_table/
Return BGP Connections Table
bgp_table → 200
PATCH
/clusters/block_providers/
Block Authentication Providers
cluster_block_providers body → 200
POST
/clusters/close_open_files/
Close open files
close_open_files body → 200
DELETE
/clusters/close_protocol_handle/
Close open protocol filehandles
close_protocol_handle 4 params → 200400503
POST
/clusters/dbox_migration/
Dbox migration
dbox_migration_start body → 200
GET
/clusters/dbox_migration_status/
DBox migration status
dbox_migration_status 1 param → 200
GET
/clusters/dbox_migration_update_source_target
Dbox migration update source target info
dbox_migration_update_source_target → 200
PATCH
/clusters/dbox_migration_update_source_target
Dbox migration update source target
dbox_migration_update_source_target body → 200
GET
/clusters/dbox_migration_validate/
DBox migration validate
dbox_migration_validate → 200
GET
/clusters/dbox_migration_validate_state/
DBox migration validate state
dbox_migration_validate_state → 200
GET
/clusters/dboxes_total_capacity/
DBoxes total capacity
dboxes_total_capacity 1 param → 200
GET
/clusters/get_shard_expansion_status/
System shard expansion status
get_shard_expansion_status → 200
GET
/clusters/get_snapshoted_paths/
Return Paths that have Snapshots
get_snapshoted_paths 1 param → 200
GET
/clusters/list_clone_snapshoted_paths_remote/
List snapshots on a remote replication peer
list_clone_snapshoted_paths_remote 3 params → 200
GET
/clusters/list_open_protocol_handles/
Query open protocol filehandles
list_open_protocol_handles 2 params → 200400503
GET
/clusters/list_prefetch_paths_info/
List Prefetch Path Information
list_prefetch_folders_info → 200
GET
/clusters/list_smb_client_connections/
Query SMB client connections
list_smb_client_connections 2 params → 200
GET
/clusters/list_smb_open_files/
Query SMB open files
list_smb_open_files 2 params → 200
GET
/clusters/list_snapshoted_paths_remote/
List snapshoted paths on remote target
list_snapshoted_paths_remote 2 params → 200
GET
/clusters/list_tenants_remote/
List tenants on remote target
list_tenants_remote 1 param → 200
POST
/clusters/rotate_master_encryption_group_key/
Rotate master encryption group key.
rotate_master_encryption_group_key → 204409503
PATCH
/clusters/run_hardware_check/
Run Hardware Validations
run_hardware_check body → 200
POST
/clusters/shard_expand/
Shard expansion
shard_expand body → 200
POST
/clusters/wipe/
Stop Cluster s/w on All Nodes
clusters_wipe body → 200
DELETE
/clusters/{id}/
Delete Cluster
clusters_delete 1 param → 204
GET
/clusters/{id}/
Detail Cluster Properties
clusters_read 1 param → 200
PATCH
/clusters/{id}/
Manage Cluster
clusters_partial_update 1 param body → 200
POST
/clusters/{id}/add_ekm/
Add EKM
cluster_add_ekm 1 param body → 204
GET
/clusters/{id}/advanced/
Aggregated information about the cluster
cluster_advanced_metrics 1 param → 200
GET
/clusters/{id}/auditing/
Show Cluster Audit Settings
cluster_auditing_show 1 param → 200
PATCH
/clusters/{id}/auditing/
Modify Cluster Audit Settings
cluster_auditing_modify 1 param body → 200
GET
/clusters/{id}/celery_queue/
List celery queue
celery_queue 2 params → 200
DELETE
/clusters/{id}/celery_remove_queued_task/
Delete all tasks of a specific name from the celery queue
celery_remove_queued_task 2 params → 204
GET
/clusters/{id}/celery_reserved/
List celery reserved queue
celery_reserved 1 param → 200
GET
/clusters/{id}/celery_scheduled/
List celery scheduled queue
celery_scheduled 1 param → 200
GET
/clusters/{id}/celery_status/
Show the full celery stats
celery_status 1 param → 200
DELETE
/clusters/{id}/delete_folder/
Delete Cluster Folder
clusters_delete_folder 1 param body → 204
POST
/clusters/{id}/expand/
Expand Cluster
clusters_expand 1 param body → 200
POST
/clusters/{id}/generate_unfreeze_token/
Generate Token to Unlock Indestructibility
generate_unfreeze_token 1 param body → 201
DELETE
/clusters/{id}/locks/
Deletes NLM Locks
cluster_locks_delete 1 param body → 204
POST
/clusters/{id}/locks/
List NLM Locks
cluster_locks_list 1 param body → 200
POST
/clusters/{id}/notify_new_version/
Notify of New Version Available for Download
notify_new_version 1 param body → 200
GET
/clusters/{id}/pre_upgrade_validation_exceptions/
Run Pre-Upgrade Validation
pre_upgrade_validation_exceptions 1 param → 200
DELETE
/clusters/{id}/release_recursive_locks/
Deletes NLM Locks Recursively
cluster_locks_delete_recursively 1 param body → 200
PATCH
/clusters/{id}/resume_deploy/
Resume failed deploy
resume_deploy 1 param → 201
PATCH
/clusters/{id}/rpc/
This endpoint runs cluster rpc.
clusters_rpc 1 param body → 200
GET
/clusters/{id}/s3_true_ip_config/
Get S3 True IP Configuration
clusters_get_s3_true_ip_config 1 param → 200
PATCH
/clusters/{id}/s3_true_ip_config/
Set S3 True IP Configuration
clusters_set_s3_true_ip_config 1 param body → 204
POST
/clusters/{id}/set_certificates/
Update EKM certificates
cluster_set_certificates 1 param body → 204
POST
/clusters/{id}/set_drive_fw_upgrade/
Set true/false to upgrade non-active drives fw
set_drive_fw_upgrade 1 param body → 200
PATCH
/clusters/{id}/set_password/
Change Cluster Passwords
clusters_set_password 1 param body → 200
POST
/clusters/{id}/should_upload/
Detect Need for Bundle Upload
should_upload 1 param body → 200424
POST
/clusters/{id}/stop_upgrade/
Stop Running Upgrade
stop_upgrade 1 param → 200
PATCH
/clusters/{id}/system_settings/
Set Cluster System Settings
clusters_system_settings 1 param body → 204
POST
/clusters/{id}/unfreeze/
Unfreeze Cluster
unfreeze 1 param body → 204
PATCH
/clusters/{id}/update_polling_interval/
Change interval for a polling task
update_polling_interval 1 param body → 200
PATCH
/clusters/{id}/upgrade/
Upgrade Cluster
clusters_upgrade 1 param body → 200
POST
/clusters/{id}/upgrade_optane/
Upgrade Optane NVRAM
upgrade_optane 1 param body → 200
POST
/clusters/{id}/upgrade_ssd/
Upgrade SSD
upgrade_ssd 1 param body → 200
POST
/clusters/{id}/upgrade_without_file/
Upgrade Cluster from Pre-Uploaded Bundle
upgrade_without_file 1 param body → 200
DELETE
/clusters/{id}/upload_bundle/
Delete Upgrade Bundle from Cluster
delete_bundle 1 param → 204
POST
/clusters/{id}/upload_bundle/
Upload Upgrade Bundle to Cluster
upload_bundle 1 param body → 200
POST
/clusters/{id}/upload_from_s3/
Upload Upgrade Bundle from S3 URL
upload_from_s3 1 param body → 200
GET
/clusters/{id}/vast_db/
Show Cluster Vast DB Settings
cluster_vast_db_show 1 param → 200
PATCH
/clusters/{id}/vast_db/
Modify Cluster Vast DB Settings
cluster_vast_db_modify 1 param body → 200
GET
/hosts/discovered_hosts/
Return new discovered hosts
discovered_hosts 1 param → 200

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are Cluster (239 properties), CNode (48 properties), Host (47 properties), DNode (44 properties). Each schema is shown below with its type and property counts.

CNode
object
48 properties 1 required
RequestTruncatedQOS
object
1 property
SmbClientConnection
object
VastInstallInfo
object
11 properties
ClusterAuditingReadOnly
DNode
object
44 properties 1 required
AddBoxesCBoxesHostsParams
array
TruncatedQOSStaticLimits
object
12 properties 12 required
DBoxMigrationResponse
object
RequestTruncatedQOSStaticLimits
object
Performance limits per view. Maximum limits define maximum provisioning in the absence of resource contention. Valid values: 0-4294967296. 0 means unlimited.
12 properties
ClusterAdvanced
object
12 properties
ChallengeToken
object
6 properties 1 required
SystemShardExpandResponse
object
ListPrefetchItem
object
2 properties
DBoxMigrationUpdateSourceTargetResponse
object
2 properties
ClusterLocksParams
PreUpgradeValidationExceptions
object
1 property 1 required
CeleryInfo
object
ErrorResponse
object
1 property
AddBoxesParams
object
16 properties 10 required
BGPTableItem
object
8 properties
DBoxTotalCapacity
object
4 properties
ArbitraryFloatsObject
object
FileHandle
object
8 properties
ClusterVastDB
object
2 properties 2 required
ClusterLocksRequestParams
ClusterAuditing
object
11 properties
DBoxMigrationStatusResponse
object
ClusterAuditingReadOnlyWithAsyncTask
AddBoxesDBoxesHostsParams
array
ProtocolHandle
object
3 properties
Cluster
object
239 properties 1 required
AsyncCluster
Lock
object
18 properties
OpenProtocolHandle
object
13 properties
ClusterCreateRackUpdate
object
4 properties
TruncatedQOS
object
1 property 1 required
ArbitraryStringsObject
object
Host
object
47 properties 2 required
DBoxMigrationValidateResponse
object
2 properties
ListPrefetchPathItem
object
6 properties
ShouldUpgrade
object
2 properties 2 required
TenantIdBody
object
1 property
Generic
object
ClusterVastDBModify
object
2 properties
AsyncTaskInResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vastdata-clusters-api-openapi.yml Raw ↑

Other APIs VAST Data publishes across the network.

VAST Data activedirectory API
AE Profile APIs.io
VAST Data alarms API
AE Profile APIs.io
VAST Data apitokens API
AE Profile APIs.io
VAST Data basicsettings API
AE Profile APIs.io
VAST Data bgpconfigs API
AE Profile APIs.io
VAST Data Blob Expansions API
AE Profile APIs.io
VAST Data Block Hosts API
AE Profile APIs.io
VAST Data blockhosts API
AE Profile APIs.io
VAST Data blockmappings API
AE Profile APIs.io
VAST Data callhomeconfigs API
AE Profile APIs.io
VAST Data capacity API
AE Profile APIs.io
VAST Data carriers API
AE Profile APIs.io
#Cluster
← Back to V APIs
API Details
ID
vastdata:vastdata-clusters-api
Base URL
https://{vms-host}/api
Docs
https://www.vastdata.com/platform/developers
Provider
VAST Data
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=vastdata-clusters-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/vastdata-clusters-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of VAST Data clusters 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.