VAST Data config API

The config API from VAST Data — 3 operation(s) for config.

OpenAPI Specification

vastdata-config-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  description: VAST Management API definition
  title: VAST API Swagger Schema activedirectory config API
  version: '1.0'
security:
- ApiToken: []
tags:
- name: config
paths:
  /config/:
    get:
      operationId: config_list
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/DynamicConfig'
                title: configs
                type: array
          description: Dynamic configs information
      summary: List dynamic configs
      tags:
      - config
  /config/reset/:
    post:
      operationId: config_reset
      responses:
        '204':
          description: OK
      summary: Reset all dynamic configs to their default values
      tags:
      - config
  /config/{key}/:
    delete:
      operationId: config_delete
      parameters:
      - $ref: '#/components/parameters/DynamicConfigKey'
      responses:
        '204':
          description: OK
      summary: Restore dynamic config to its default by key
      tags:
      - config
    get:
      operationId: config_read
      parameters:
      - $ref: '#/components/parameters/DynamicConfigKey'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DynamicConfig'
          description: Dynamic configs information
      summary: Show dynamic configs
      tags:
      - config
    patch:
      operationId: config_update
      parameters:
      - $ref: '#/components/parameters/DynamicConfigKey'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModifyDynamicKeyParams'
        x-originalParamName: ModifyDynamicKeyParams
      responses:
        '204':
          description: OK
      summary: Modify dynamic configs
      tags:
      - config
components:
  schemas:
    ModifyDynamicKeyParams:
      properties:
        value:
          description: The equivalent JSON-serialized of the config value
          type: string
      required:
      - value
      type: object
    DynamicConfig:
      properties:
        is_modified:
          description: Dynamic Config is modified flag
          type: boolean
          x-cli-header: Is modified?
        key:
          description: Dynamic Config Key
          type: string
          x-cli-header: Key
        value:
          description: Dynamic Config Value
          type: string
          x-cli-header: Value
      required:
      - key
      - is_modified
      type: object
  parameters:
    DynamicConfigKey:
      description: Dynamic Config key to filter by
      in: path
      name: key
      required: true
      schema:
        type: string
  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