Windmill volume API

The volume API from Windmill — 4 operation(s) for volume.

OpenAPI Specification

windmill-volume-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  version: 1.694.0
  title: Windmill admin volume API
  contact:
    name: Windmill Team
    email: contact@windmill.dev
    url: https://windmill.dev
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: https://windmill.dev/img/windmill.svg
servers:
- url: /api
security:
- bearerAuth: []
- cookieAuth: []
tags:
- name: volume
paths:
  /w/{workspace}/volumes/list:
    get:
      summary: List All Volumes in the Workspace
      operationId: listVolumes
      tags:
      - volume
      parameters:
      - $ref: '#/components/parameters/WorkspaceId'
      responses:
        '200':
          description: list of volumes
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Volume'
  /w/{workspace}/volumes/storage:
    get:
      summary: Get the Volume Storage Name (secondary Storage) or Null for Primary
      operationId: getVolumeStorage
      tags:
      - volume
      parameters:
      - $ref: '#/components/parameters/WorkspaceId'
      responses:
        '200':
          description: volume storage name or null
          content:
            application/json:
              schema:
                type: string
                nullable: true
  /w/{workspace}/volumes/create:
    post:
      summary: Create a New Volume
      operationId: createVolume
      tags:
      - volume
      parameters:
      - $ref: '#/components/parameters/WorkspaceId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              properties:
                name:
                  type: string
      responses:
        '200':
          description: volume created
          content:
            text/plain:
              schema:
                type: string
  /w/{workspace}/volumes/delete/{name}:
    delete:
      summary: Delete a Volume (admin Only)
      operationId: deleteVolume
      tags:
      - volume
      parameters:
      - $ref: '#/components/parameters/WorkspaceId'
      - name: name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: volume deleted
          content:
            text/plain:
              schema:
                type: string
components:
  parameters:
    WorkspaceId:
      name: workspace
      in: path
      required: true
      schema:
        type: string
  schemas:
    Volume:
      type: object
      required:
      - name
      - size_bytes
      - file_count
      - created_at
      - created_by
      properties:
        name:
          type: string
        size_bytes:
          type: integer
          format: int64
        file_count:
          type: integer
        created_at:
          type: string
          format: date-time
        created_by:
          type: string
        updated_at:
          type: string
          format: date-time
          nullable: true
        last_used_at:
          type: string
          format: date-time
          nullable: true
        extra_perms:
          type: object
          additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    cookieAuth:
      type: apiKey
      in: cookie
      name: token
externalDocs:
  description: documentation portal
  url: https://windmill.dev