Cayra Admin Vm Pool API

openapi: 3.2.0
info:
  title: Cayra License Server Admin Vm Pool API
  description: '# Cayra Chat Agent - License Management Server


    Centralized license management for on-premise deployments.


    ## Features


    - 🔑 License key generation (installation, update, trial)

    - ⏰ Dynamic expiry management (extend/shorten licenses)

    - 🔄 Activation tracking and monitoring

    - 💓 Heartbeat mechanism (1-hour intervals)

    - 📊 Audit logging for compliance

    - 🔐 JWT tokens with RSA-4096 encryption


    ## API Categories


    ### Admin Endpoints (Requires API Key)

    Manage licenses, view activations, update expiry dates.


    ### Client Endpoints (Public)

    Activate licenses, send heartbeats, check status.


    ## Authentication


    Admin endpoints require API key in header:

    ```

    X-Admin-API-Key: your-admin-key-here

    ```


    ## Security


    - 🔒 RSA-4096 asymmetric encryption

    - 🔐 JWT tokens for offline validation

    - 📝 Complete audit trail

    - 🛡️ Rate limiting (Phase 6)'
  contact:
    name: Cayra AI Team
    email: support@cayra.ai
  license:
    name: Proprietary
  version: 1.0.0
tags:
- name: admin-vm-pool
paths:
  /api/v1/admin/vm-pool/status:
    get:
      tags:
      - admin-vm-pool
      summary: Get VM pool status
      description: Return a summary of the current VM pool state.
      operationId: get_vm_pool_status_api_v1_admin_vm_pool_status_get
      parameters:
      - name: x-admin-api-key
        in: header
        required: false
        schema:
          type: string
          title: X-Admin-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PoolStatusResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/admin/vm-pool/replenish:
    post:
      tags:
      - admin-vm-pool
      summary: Trigger VM pool replenishment
      description: 'Synchronously attempt to bring the pool up to the target size.


        Note: this is a blocking call — it will run to completion or return

        an error. For large pools this may take several minutes.'
      operationId: trigger_vm_pool_replenish_api_v1_admin_vm_pool_replenish_post
      parameters:
      - name: x-admin-api-key
        in: header
        required: false
        schema:
          type: string
          title: X-Admin-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplenishResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/admin/vm-pool/retire/{pool_entry_id}:
    post:
      tags:
      - admin-vm-pool
      summary: Retire a pool entry
      description: 'Forcefully retire a pool entry (mark it as retired so it is no longer

        claimed and a replacement is created by the next replenishment run).'
      operationId: retire_pool_entry_api_v1_admin_vm_pool_retire__pool_entry_id__post
      parameters:
      - name: pool_entry_id
        in: path
        required: true
        schema:
          type: string
          title: Pool Entry Id
      - name: x-admin-api-key
        in: header
        required: false
        schema:
          type: string
          title: X-Admin-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                title: Response Retire Pool Entry Api V1 Admin Vm Pool Retire  Pool Entry Id  Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PoolStatusResponse:
      properties:
        enabled:
          type: boolean
          title: Enabled
        target_size:
          anyOf:
          - type: integer
          - type: 'null'
          title: Target Size
        golden_image_version:
          anyOf:
          - type: string
          - type: 'null'
          title: Golden Image Version
        provider:
          anyOf:
          - type: string
          - type: 'null'
          title: Provider
        region:
          anyOf:
          - type: string
          - type: 'null'
          title: Region
        ready:
          anyOf:
          - type: integer
          - type: 'null'
          title: Ready
        counts:
          anyOf:
          - type: object
          - type: 'null'
          title: Counts
        entries:
          anyOf:
          - items: {}
            type: array
          - type: 'null'
          title: Entries
        reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Reason
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
      type: object
      required:
      - enabled
      title: PoolStatusResponse
    ReplenishResponse:
      properties:
        message:
          type: string
          title: Message
        triggered:
          type: boolean
          title: Triggered
      type: object
      required:
      - message
      - triggered
      title: ReplenishResponse
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError