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.

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 69

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

Documentation

📖
Documentation
https://support.vastdata.com/s/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/vastdata/refs/heads/main/openapi/vastdata-clusters-api-openapi.yml

SDKs

📦
SDK
https://github.com/vast-data/vastpy

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/vastdata-clusters-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

vastdata-clusters-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: VAST Management API definition
  title: VAST API Swagger Schema Clusters API
  version: '1.0'
security:
- ApiToken: []
tags:


# --- truncated at 32 KB (167 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vastdata/refs/heads/main/openapi/vastdata-clusters-api-openapi.yml