Armada

Armada Admin Settings API

The Admin Settings API from Armada — 1 operation(s) for admin settings.

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-admin-settings-api-openapi.yml

Other Resources

🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/armada/refs/heads/main/apis.yml

OpenAPI Specification

armada-admin-settings-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Orchestrator Admin Settings 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: Admin Settings
paths:
  /settings:
    get:
      tags:
      - Admin Settings
      summary: Get admin settings
      operationId: getSettings
      responses:
        '200':
          description: Settings
        '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'
    patch:
      tags:
      - Admin Settings
      summary: Update admin settings
      operationId: updateSettings
      responses:
        '200':
          description: Settings updated
        '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'
components:
  responses:
    InternalServerError:
      description: Internal Server Error - server error
    Unauthorized:
      description: Unauthorized - missing or invalid authentication
    BadRequest:
      description: Bad Request - invalid or malformed request
    NotFound:
      description: Not Found - resource does not exist
    Forbidden:
      description: Forbidden - insufficient permissions
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT from auth middleware