{
  "opencollection": "1.0.0",
  "info": {
    "name": "Forward Networks: Complete Aliases Network Collection API",
    "version": "26.6"
  },
  "items": [
    {
      "info": {
        "name": "Network Collection",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Add a collector task",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/collector-tasks",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "query"
              },
              {
                "name": "type",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Signals the system to begin collecting a new network Snapshot as soon as a Collector is available. Use [Get a\ncollector task](https://docs.fwd.app/latest/api/network-collection/get-collector-task/) to check a task’s\nstatus.\n\nA network can have only one network collection task running at a time."
        },
        {
          "info": {
            "name": "Get a collector task",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/collector-tasks/:taskId",
            "params": [
              {
                "name": "taskId",
                "value": "",
                "type": "path",
                "description": "The identifier of the collector task to retrieve"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get information about a recent collector task. Use\n[Add a collector task](https://docs.fwd.app/latest/api/network-collection/add-collector-task/) to create a task."
        },
        {
          "info": {
            "name": "Cancel an in-progress network collection",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/networks/:networkId/cancelcollection",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Cancel an in-progress network collection"
        },
        {
          "info": {
            "name": "Get a network’s collection schedules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/networks/:networkId/collection-schedules",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get a network’s collection schedules"
        },
        {
          "info": {
            "name": "Add a network collection schedule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/networks/:networkId/collection-schedules",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Add a network collection schedule"
        },
        {
          "info": {
            "name": "Get a network collection schedule",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/networks/:networkId/collection-schedules/:scheduleId",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path"
              },
              {
                "name": "scheduleId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get a network collection schedule"
        },
        {
          "info": {
            "name": "Replace a network collection schedule",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/networks/:networkId/collection-schedules/:scheduleId",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path"
              },
              {
                "name": "scheduleId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Replace a network collection schedule"
        },
        {
          "info": {
            "name": "Delete a network collection schedule",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/networks/:networkId/collection-schedules/:scheduleId",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path"
              },
              {
                "name": "scheduleId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Delete a network collection schedule"
        },
        {
          "info": {
            "name": "Get the status of a network’s collector",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/networks/:networkId/collector/status",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "**Deprecated for removal in release 26.10.** Use [Get a collector\ntask](https://docs.fwd.app/latest/api/network-collection/get-collector-task/) instead to check the status of\na task."
        },
        {
          "info": {
            "name": "Trigger a network collection",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/networks/:networkId/startcollection",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "**Deprecated for removal in release 26.10.** Use\n[Add a collector task](https://docs.fwd.app/latest/api/network-collection/add-collector-task/) instead."
        }
      ]
    }
  ],
  "bundled": true
}