openapi: 3.2.0
info:
  title: 'Forward: Legacy Collection API'
  summary: Configure configuration and state collection from network devices
  description: |-
    Use these resources to query the state of a network’s Collector, to trigger a collection of configuration and state
    from a network’s devices, or to cancel an in-progress collection.
  contact:
    email: support@forwardnetworks.com
  license:
    name: MIT
    url: https://spdx.org/licenses/MIT
  version: 26.8
servers:
  - url: /api
security:
  - api_token: []
tags:
  - name: Network Collection
    description: Configure and run the collection of configuration and state from a network
  - name: Legacy Collection
    description: Configure configuration and state collection from network devices
    parent: Network Collection
paths:
  /networks/{networkId}/cancelcollection:
    post:
      tags:
        - Legacy Collection
      summary: Cancel an in-progress network collection
      description: |-
        **Deprecated for removal in release 26.10.** Use
        [Stop a collector task](https://docs.fwd.app/latest/api/collector-tasks/stop-collector-task/) instead.
      operationId: cancelCollect
      x-position: 3
      parameters:
        - name: networkId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      deprecated: true
  /networks/{networkId}/collector/status:
    get:
      tags:
        - Legacy Collection
      summary: Get the status of a network’s collector
      description: |-
        **Deprecated for removal in release 26.10.** Use [Get a collector
        task](https://docs.fwd.app/latest/api/collector-tasks/get-collector-task/) instead to check the status of
        a task.
      operationId: getCollectorState
      x-position: 1
      parameters:
        - name: networkId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectorState'
      deprecated: true
  /networks/{networkId}/startcollection:
    post:
      tags:
        - Legacy Collection
      summary: Trigger a network collection
      description: |-
        **Deprecated for removal in release 26.10.** Use
        [Add a collector task](https://docs.fwd.app/latest/api/collector-tasks/add-collector-task/) instead.
      operationId: collect
      x-position: 2
      parameters:
        - name: networkId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      deprecated: true
components:
  schemas:
    CollectorState:
      type: object
      required:
        - isSet
      properties:
        isSet:
          type: boolean
          description: Whether the network has a Collector assigned
        busyStatus:
          $ref: '#/components/schemas/CollectorStatus'
          description: Absent if the network has no Collector assigned
    CollectorStatus:
      type: string
      enum:
        - OFFLINE
        - IDLE
        - TESTING
        - COLLECTING
        - COLLECTION_QUEUED
        - DISCOVERING
        - UPDATING
  securitySchemes:
    api_token:
      type: http
      scheme: basic
