VAST Data

VAST Data ssds API

SSDs represent flash SSDs resident in the cluster's DBoxes.

GitHub OpenAPI

Operations 5

GET /ssds/ List SSDs #
GET /ssds/{id}/ Return Details of an SSD #
PATCH /ssds/{id}/ Activate/Deactivate an SSD #
PATCH /ssds/{id}/control_led/ Turn SSD identification LED on and off #
PATCH /ssds/{id}/format/ Format SSD #

Documentation

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

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/vastdata/refs/heads/main/openapi/vastdata-ssds-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-ssds-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-ssds-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: VAST Management API definition
  title: VAST API Swagger Schema activedirectory Ssds API
  version: '1.0'
security:
- ApiToken: []
tags:
- description: SSDs represent flash SSDs resident in the cluster's DBoxes.
  name: ssds
paths:
  /ssds/:
    get:
      description: This endpoint lists SSDs.
      operationId: ssds_list
      parameters:
      - in: query
        name: page_size
        schema:
          type: string
      - in: query
        name: page
        schema:
          type: string
      - description: Filter by SSD state
        in: query
        name: state
        schema:
          enum:
          - UNKNOWN
          - HEALTHY
          - FAILED
          - LOGIN_FAILED
          - ACTIVATING
          - INACTIVE
          - DEACTIVATING
          - FAILING
          - PHASING_OUT
          - ENTER_PHASING_OUT
          - EXIT_PHASING_OUT
          - ACTIVE
          type: string
      - description: Filter by SSD serial number
        in: query
        name: sn
        schema:
          type: string
      - description: Filter by SSD model
        in: query
        name: model
        schema:
          type: string
      - description: Filter by parent DBox name
        in: query
        name: dbox__name
        schema:
          type: string
      - description: Filter by parent DBox ID
        in: query
        name: dbox__id
        schema:
          type: string
      - description: Filter by SSD firmware version
        in: query
        name: fw_version
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/SSD'
                title: SSDs
                type: array
          description: SSD information
      summary: List SSDs
      tags:
      - ssds
  /ssds/{id}/:
    get:
      description: This endpoint returns information about an SSD.
      operationId: ssds_read
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SSD'
          description: ''
      summary: Return Details of an SSD
      tags:
      - ssds
    patch:
      description: This endpoint activates or deactivates an SSD.
      operationId: ssds_partial_update
      parameters:
      - description: SSD ID
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                enabled:
                  description: True for activate, False for deactivate
                  type: boolean
              type: object
        x-originalParamName: SSDModifyParams
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskInResponse'
          description: ''
      summary: Activate/Deactivate an SSD
      tags:
      - ssds
  /ssds/{id}/control_led/:
    patch:
      description: This endpoint controls the ON/OFF state of the specified SSD's identification LED.
      operationId: ssd_control_led
      parameters:
      - description: SSD ID
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                control:
                  description: LED state
                  enum:
                  - true
                  - false
                  type: string
              type: object
        x-originalParamName: SsdControlLed
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskInResponse'
          description: ''
      summary: Turn SSD identification LED on and off
      tags:
      - ssds
  /ssds/{id}/format/:
    patch:
      description: This endpoint formats an SSD.
      operationId: ssd_format
      parameters:
      - description: SSD ID
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskInResponse'
          description: ''
      summary: Format SSD
      tags:
      - ssds
components:
  schemas:
    AsyncTaskInResponse:
      properties:
        async_task:
          description: Creation Async task properties
          type: object
      type: object
    SSD:
      properties:
        arch_type:
          type: string
        attached_dnode_names:
          description: Attached DNodes
          type: string
        carrier:
          description: The carrier number ssd resides in
          type: integer
          x-cli-header: Slot-Index
        carrier_hw_version:
          description: Carrier hw version
          type: string
        carrier_serial:
          type: string
        carrier_sw_version:
          description: Carrier sw version
          type: string
        cluster:
          description: Parent Cluster
          type: string
        cluster_id:
          type: integer
        dbox:
          description: Parent DBox name
          type: string
          x-cli-header: DBox
        dbox_id:
          description: ID of parent DBox
          type: integer
        display_name:
          type: string
        dnode1_attached:
          type: boolean
        dnode2_attached:
          type: boolean
        enabled:
          description: SSD enabled
          type: boolean
        fail_reason:
          description: SSD failure reason
          enum:
          - NONE
          - IO_ERROR
          - DETACHED
          - FAILURE_DOMAIN_CHANGED
          - TEST_FAILED
          - SYSTEM_MISMATCH
          - DNODE_FAILURE
          - LOCKING_FAILED
          - CARRIER_VERSION_MISMATCH
          - FW_VERSION_MISMATCH
          - FAILED_CONNECT
          - HEALTH_CHECK_ERROR
          - TEMPERATURE_EXCEEDED_THRESHOLD
          - WRONG_DEVICE_LINK_PROPERTIES
          - INVALID_CARRIER_SERIAL
          type: string
          x-cli-header: Failure-Reason
        fw_version:
          description: SSD firmware version
          type: string
          x-cli-header: Firmware-Version
        guid:
          description: Global unique ID
          type: string
        id:
          type: integer
          x-cli-header: ID
        index_in_carrier:
          description: SSD index in carrier
          type: integer
          x-cli-header: Index-In-Carrier
        insertion_time:
          format: date-time
          type: string
          x-format: datetime2display
        led_status:
          type: string
          x-cli-header: Slot LED Status
        model:
          description: SSD model
          type: string
        name:
          type: string
          x-cli-header: Name
        shelf:
          description: The shelf
          enum:
          - FRONT
          - REAR
          - LEFT
          - RIGHT
          - N/A
          type: string
        size:
          description: Total SSD space
          format: int64
          type: integer
          x-cli-header: Total-Space
          x-display-base-type: capacity
          x-display-units: TB
          x-display-units-alt: TiB
          x-format: bytes2tb
        slot:
          description: SSD slot
          type: integer
        sn:
          description: SSD serial number
          type: string
          x-cli-header: Serial-Number
        space_in_use:
          description: SSD space in use
          format: int64
          type: integer
          x-cli-header: Space-In-Use
          x-display-base-type: capacity
          x-display-units: TB
          x-display-units-alt: TiB
        state:
          description: SSD state
          enum:
          - UNKNOWN
          - HEALTHY
          - FAILED
          - LOGIN_FAILED
          - ACTIVATING
          - INACTIVE
          - DEACTIVATING
          - FAILING
          - PHASING_OUT
          - ENTER_PHASING_OUT
          - EXIT_PHASING_OUT
          - ACTIVE
          type: string
        title:
          type: string
      type: object
  securitySchemes:
    ApiToken:
      description: Send current valid API token in an Authorization header with format Api-Token <token>.
      in: header
      name: ApiToken
      type: apiKey
    basicAuth:
      description: Basic authentication using VMS user name and password
      scheme: basic
      type: http