VAST Data versions API

The cluster platform and VMS software is installed and upgraded via packages that have a version number per release and a software build number. The versions path exposes the cluster's version history.

OpenAPI Specification

vastdata-versions-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  description: VAST Management API definition
  title: VAST API Swagger Schema activedirectory versions API
  version: '1.0'
security:
- ApiToken: []
tags:
- description: The cluster platform and VMS software is installed and upgraded via packages that have a version number per release and a software build number. The versions path exposes the cluster's version history.
  name: versions
paths:
  /versions/:
    get:
      description: This endpoint lists the version deployment history.
      operationId: versions_list
      parameters:
      - in: query
        name: page
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Version'
                title: Versions History
                type: array
          description: Versions History
      summary: List Versions
      tags:
      - versions
  /versions/{id}/:
    get:
      description: This endpoint lists the version deployment history.
      operationId: versions_read
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Version'
          description: ''
      summary: List Version Deployment History
      tags:
      - versions
components:
  schemas:
    Version:
      properties:
        build:
          type: string
        carriers_fw_version:
          type: string
        cluster:
          type: string
          x-cli-header: cluster
        created:
          format: date-time
          type: string
          x-cli-header: Deployment time
          x-format: datetime2display
        enable_dr:
          type: boolean
          x-cli-header: Enable DR
          x-format: bool2str
        force:
          type: boolean
          x-cli-header: Force
          x-format: bool2str
        guid:
          type: string
        id:
          type: integer
          x-cli-header: ID
        name:
          type: string
        os_version:
          type: string
        skip_hw_check:
          type: boolean
          x-cli-header: Skip HW check
          x-format: bool2str
        status:
          type: string
        sys_version:
          type: string
        title:
          type: string
        url:
          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