F5 Load Balancer Tasks API

openapi: 3.2.0
info:
  title: F5 Load Balancer Tasks API
  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
  version: '1.0'
  description: 'Operations tagged Tasks across 2 of this provider''s published API definitions: f5-load-balancer-as3-openapi.yml, f5-load-balancer-declarative-onboarding-openapi.yml. Each path carries the servers of the definition it was published in.'
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
- url: https://{bigip_host}/mgmt/shared/declarative-onboarding
  description: BIG-IP Declarative Onboarding Endpoint
  variables:
    bigip_host:
      default: 192.168.1.245
      description: Hostname or IP address of the BIG-IP device. Use port 8443 for single-NIC BIG-IP deployments.
security:
- basicAuth: []
- tokenAuth: []
tags:
- name: Tasks
  description: Monitor the status of asynchronous declaration processing tasks.
paths:
  /task:
    get:
      operationId: listTasks
      summary: F5 Load Balancer List all AS3 tasks
      description: Retrieves a list of all asynchronous AS3 declaration processing tasks and their statuses.
      tags:
      - Tasks
      responses:
        '200':
          description: Task list retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AS3TaskList'
        '401':
          $ref: '#/components/responses/Unauthorized'
    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
  /task/{taskId}:
    parameters:
    - $ref: '#/components/parameters/TaskIdParam'
    get:
      operationId: getTask
      summary: F5 Load Balancer Get status of a specific task
      description: Retrieves the status and result of a specific asynchronous AS3 declaration processing task identified by its task ID.
      tags:
      - Tasks
      responses:
        '200':
          description: Task status retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AS3TaskResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    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
components:
  schemas:
    AS3TaskList:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/AS3TaskResponse'
    AS3TaskResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique task identifier.
        results:
          type: array
          items:
            type: object
            properties:
              code:
                type: integer
              message:
                type: string
              tenant:
                type: string
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
    DOTaskResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique task identifier.
        result:
          type: object
          properties:
            class:
              type: string
            code:
              type: integer
            status:
              type: string
              enum:
              - OK
              - ERROR
              - ROLLING_BACK
              - RUNNING
              - REBOOTING
            message:
              type: string
            errors:
              type: array
              items:
                type: string
        declaration:
          type: object
  parameters:
    TaskIdParam:
      name: taskId
      in: path
      required: true
      description: Unique identifier of the asynchronous task.
      schema:
        type: string
        format: uuid
    TaskIdParam_2:
      name: taskId
      in: path
      required: true
      description: Unique identifier for the DO processing task.
      schema:
        type: string
  responses:
    Unauthorized:
      description: Authentication credentials were missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: The requested tenant or task was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound_2:
      description: The requested resource was not found.
      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.
x-refined-from:
- f5-load-balancer-as3-openapi.yml
- f5-load-balancer-declarative-onboarding-openapi.yml