openapi: 3.1.0
info:
  title: Nine Fives Programmable REST Attenuator Network API
  version: '1.0'
  description: JSON REST API served on port 80 by the Nine Fives POE-ATTEN-6G programmable RF attenuator for programmatic control and monitoring. Faithfully transcribed from the published device reference manual; the device also exposes SCPI over raw TCP (port 5025) and HiSLIP (port 4880). No authentication is required — the API is served directly by the device over the local network (Ethernet or USB-C).
  contact:
    name: Nine Fives
    url: https://ninefives.com
  x-generated: '2026-07-20'
  x-method: generated
  x-source: https://docs.ninefives.com/attenuator/rest-api/overview/
servers:
- url: http://{deviceIp}
  description: Device-hosted API on port 80 (default Ethernet fallback IP 192.168.0.95, USB-C 192.168.42.95)
  variables:
    deviceIp:
      default: 192.168.0.95
      description: The IP address of the attenuator device on the local network
tags:
- name: Network
  description: Ethernet and USB-C interface configuration
paths:
  /api/network/config:
    get:
      operationId: getNetworkConfig
      tags:
      - Network
      summary: Get network configuration
      description: Returns network configuration for both the Ethernet and USB-C interfaces, including configured settings and live interface information.
      responses:
        '200':
          description: Network configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConfig'
    post:
      operationId: setNetworkConfig
      tags:
      - Network
      summary: Update network configuration
      description: Updates network configuration and applies it immediately. Ethernet, USB-C, or both interfaces may be updated in a single request; only include fields to change. Changing network settings while connected may result in loss of connectivity.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkConfig'
      responses:
        '200':
          description: Configuration applied
        '400':
          description: Bad Request — invalid input or parameters
  /api/network/reset:
    post:
      operationId: resetNetworkConfig
      tags:
      - Network
      summary: Reset network configuration to factory defaults
      responses:
        '200':
          description: Network reset
components:
  schemas:
    DhcpServer:
      type: object
      properties:
        range_start:
          type: string
        range_end:
          type: string
        lease_time:
          type: string
    NetworkConfig:
      type: object
      properties:
        ethernet:
          $ref: '#/components/schemas/EthernetConfig'
        usb_gadget:
          $ref: '#/components/schemas/UsbGadgetConfig'
    EthernetConfig:
      type: object
      properties:
        mode:
          type: string
          enum:
          - dhcp_client_fallback
          - static
          - dhcp_client
          description: dhcp_client_fallback is factory default
        ip_address:
          type: string
        netmask:
          type: string
        gateway:
          type: string
        dhcp_fallback_timeout:
          type: integer
        dhcp_server:
          $ref: '#/components/schemas/DhcpServer'
        live_ip:
          type: string
          readOnly: true
        mac:
          type: string
          readOnly: true
    UsbGadgetConfig:
      type: object
      properties:
        mode:
          type: string
          enum:
          - dhcp_host
          - static
          - disabled
          description: dhcp_host is factory default
        ip_address:
          type: string
        netmask:
          type: string
        enabled:
          type: boolean
        dhcp_server:
          $ref: '#/components/schemas/DhcpServer'
        live_ip:
          type: string
          readOnly: true
        mac:
          type: string
          readOnly: true