VAST Data dataspace API

openapi: 3.0.3
info:
  description: VAST Management API definition
  title: VAST API Swagger Schema activedirectory dataspace API
  version: '1.0'
security:
- ApiToken: []
tags:
- name: dataspace
paths:
  /mcvms/tasks/:
    get:
      description: This endpoint returns a list of dataspace tasks.
      operationId: dataspace_task_list
      parameters:
      - description: Time preference header (e.g., 'time=gmt' for GMT timezone)
        in: header
        name: Prefer
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  properties:
                    created_at:
                      description: Creation datetime
                      example: '2024-02-20 09:36:22.164145+00:00'
                      format: date-time
                      type: string
                    display_name:
                      description: User-facing name of the task
                      example: create cluster
                      type: string
                    flow_guid:
                      description: Flow GUID
                      type: string
                    flow_name:
                      description: User-facing name of the tasks group
                      example: Create replication
                      type: string
                    guid:
                      description: Task ID
                      format: uuid
                      type: string
                    host_ip:
                      description: Host IP address
                      format: ipv4
                      type: string
                    name:
                      description: Internal name of the task
                      example: create_cluster_task
                      type: string
                    parameters:
                      description: Task parameters
                      type: object
                    prerequisites:
                      description: List of prerequisite task IDs
                      items:
                        format: uuid
                        type: string
                      type: array
                    result:
                      description: Task result
                      type: object
                    state:
                      description: State of the task
                      enum:
                      - Pending
                      - Ready
                      - Failed
                      - Running
                      - Done
                      type: string
                  type: object
                type: array
          description: List of tasks
      summary: List Tasks
      tags:
      - dataspace
  /mcvms/tasks/{guid}:
    delete:
      description: This endpoint archives and deletes a task and its associated flow.
      operationId: dataspace_task_delete
      parameters:
      - description: Task ID (UUID)
        in: path
        name: guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    example: task deleted
                    type: string
                type: object
          description: Task deleted successfully
        '404':
          content:
            application/json:
              schema:
                properties:
                  detail:
                    example: task not found
                    type: string
                type: object
          description: Task not found
      summary: Delete Task
      tags:
      - dataspace
components:
  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