Armada

Armada Storage API

The Storage API from Armada — 6 operation(s) for storage.

GitHub OpenAPI

Documentation

📖
APIReference
https://docs.armada.ai/bridge/api
📖
Documentation
https://docs.armada.ai/bridge/overview

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/armada/refs/heads/main/openapi/armada-storage-api-openapi.yml

OpenAPI Specification

armada-storage-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Orchestrator Admin Settings Storage API
  description: 'API for the GPUaaS Orchestrator microservice. Handles tenants, clusters, VMs,

    storage, networking, catalogs, quotas, and related infrastructure operations.

    '
  version: 1.0.0
  contact:
    name: GPUaaS Platform
servers:
- url: /
  description: Relative base (prefix with deployment base URL)
security:
- bearerAuth: []
tags:
- name: Storage
paths:
  /tenants/{tenant}/storage:
    get:
      tags:
      - Storage
      summary: Get all storages by tenant
      parameters:
      - name: tenant
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of storages
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    post:
      tags:
      - Storage
      summary: Create storage
      parameters:
      - name: tenant
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Storage created
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '201':
          $ref: '#/components/responses/Created'
        '409':
          $ref: '#/components/responses/Conflict'
  /tenants/{tenant}/storage/{computeNodeName}:
    get:
      tags:
      - Storage
      summary: Get storage by compute node name
      parameters:
      - name: tenant
        in: path
        required: true
        schema:
          type: string
      - name: computeNodeName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Storage
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    delete:
      tags:
      - Storage
      summary: Delete storage
      parameters:
      - name: tenant
        in: path
        required: true
        schema:
          type: string
      - name: computeNodeName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Deleted
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '204':
          $ref: '#/components/responses/NoContent'
  /tenants/{tenant}/storage/volumes:
    get:
      tags:
      - Storage
      summary: Get volumes by tenant
      parameters:
      - name: tenant
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of volumes
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    post:
      tags:
      - Storage
      summary: Create volume
      parameters:
      - name: tenant
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Volume created
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '201':
          $ref: '#/components/responses/Created'
        '409':
          $ref: '#/components/responses/Conflict'
  /tenants/{tenant}/storage/volumes/{id}:
    get:
      tags:
      - Storage
      summary: Get volume by ID
      parameters:
      - name: tenant
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Volume
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    delete:
      tags:
      - Storage
      summary: Delete volume
      parameters:
      - name: tenant
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Deleted
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '204':
          $ref: '#/components/responses/NoContent'
  /tenants/{tenant}/storage/volume-mounts:
    get:
      tags:
      - Storage
      summary: Get volume mounts by tenant
      parameters:
      - name: tenant
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of volume mounts
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    post:
      tags:
      - Storage
      summary: Create volume mount
      parameters:
      - name: tenant
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Mount created
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '201':
          $ref: '#/components/responses/Created'
        '409':
          $ref: '#/components/responses/Conflict'
  /tenants/{tenant}/storage/volume-mounts/{id}:
    get:
      tags:
      - Storage
      summary: Get volume mount by ID
      parameters:
      - name: tenant
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Volume mount
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    delete:
      tags:
      - Storage
      summary: Delete volume mount
      parameters:
      - name: tenant
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Deleted
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '204':
          $ref: '#/components/responses/NoContent'
components:
  responses:
    NoContent:
      description: No Content - success with no response body
    InternalServerError:
      description: Internal Server Error - server error
    Unauthorized:
      description: Unauthorized - missing or invalid authentication
    BadRequest:
      description: Bad Request - invalid or malformed request
    Conflict:
      description: Conflict - resource conflict (e.g. duplicate)
    NotFound:
      description: Not Found - resource does not exist
    Forbidden:
      description: Forbidden - insufficient permissions
    Created:
      description: Created - resource created successfully
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT from auth middleware