openapi: 3.1.0
info:
  title: F5 Load Balancer F5 BIG-IP Application Services 3 Extension (AS3) Config System API
  description: The Application Services 3 Extension (AS3) provides a declarative API for managing application-specific configurations on BIG-IP systems. AS3 uses JSON declarations to describe the desired state of Layer 4-7 application services, enabling infrastructure-as-code workflows for load balancing, SSL offloading, and traffic management. Rather than issuing imperative commands, users submit a complete declaration and AS3 configures the BIG-IP to match the declared state.
  version: 3.50.0
  contact:
    name: F5 Networks Support
    email: support@f5.com
    url: https://www.f5.com/services/support
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  termsOfService: https://www.f5.com/company/policies/terms-of-use
servers:
- url: https://{bigip_host}/mgmt/shared/appsvcs
  description: BIG-IP AS3 Extension Endpoint
  variables:
    bigip_host:
      default: 192.168.1.245
      description: Hostname or IP address of the BIG-IP device
security:
- basicAuth: []
- tokenAuth: []
tags:
- name: System
  description: Access system-level information and configuration including device status, software versions, and global settings.
paths:
  /sys:
    get:
      operationId: getSystemInfo
      summary: F5 Load Balancer Get system information
      description: Retrieves top-level system information and available sub-collections for the BIG-IP system.
      tags:
      - System
      responses:
        '200':
          description: Successfully retrieved system information
          content:
            application/json:
              schema:
                type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
  /sys/version:
    get:
      operationId: getSystemVersion
      summary: F5 Load Balancer Get system software version
      description: Retrieves the software version information for the BIG-IP system including product name, version, build number, and edition.
      tags:
      - System
      responses:
        '200':
          description: Successfully retrieved system version
          content:
            application/json:
              schema:
                type: object
                properties:
                  kind:
                    type: string
                  selfLink:
                    type: string
                    format: uri
        '401':
          $ref: '#/components/responses/Unauthorized'
  /sys/device:
    get:
      operationId: listDevices
      summary: F5 Load Balancer List BIG-IP devices
      description: Retrieves information about all BIG-IP devices in the device trust group, including hostname, management address, failover state, and device group membership.
      tags:
      - System
      responses:
        '200':
          description: Successfully retrieved device collection
          content:
            application/json:
              schema:
                type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
          description: HTTP status code.
        message:
          type: string
          description: Human-readable error message.
        errorStack:
          type: array
          items:
            type: string
          description: Stack trace for debugging purposes.
  responses:
    Unauthorized:
      description: Authentication credentials were missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using BIG-IP admin credentials.
    tokenAuth:
      type: apiKey
      in: header
      name: X-F5-Auth-Token
      description: Token-based authentication obtained from the /mgmt/shared/authn/login endpoint.
externalDocs:
  description: F5 BIG-IP AS3 Documentation
  url: https://clouddocs.f5.com/products/extensions/f5-appsvcs-extension/latest/