{
  "opencollection": "1.0.0",
  "info": {
    "name": "Downloads About Agents API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Agents",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List agents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.tenable.com/downloads/api/v2/scanners/null/agents",
            "params": [
              {
                "name": "f",
                "value": "",
                "type": "query",
                "description": "Apply a filter in the format `::`. For example, `field1:match:sometext` would match any records where the value of field1 contains `sometext`. You can use multiple query filters. \n\nUse the [List agent filters](ref:io-filters-agents-list) endpoint to retrieve the list of supported filters, including their valid operators and value types."
              },
              {
                "name": "ft",
                "value": "",
                "type": "query",
                "description": "Filter type. If the filter type is `and`, the record is only returned if all filters match. If the filter type is `or`, the record is returned if any of the filters match."
              },
              {
                "name": "w",
                "value": "",
                "type": "query",
                "description": "Wildcard filter text. Wildcard search is a mechanism where multiple fields of a record are filtered against one specific filter string. If any one of the wildcard\\_fields' values matches against the filter string, then the record matches the wildcard filter. For a record to be returned, it must pass the wildcard filter (if there is one) AND the set of standard filters. For example, if `w=wild&f=field1:match:one&f=field2:match:two&ft=or`, the record would match if the value of any supported wildcard\\_fields contained `wild`, AND either field1's value contained `one` or field2's value contained `two`."
              },
              {
                "name": "wf",
                "value": "",
                "type": "query",
                "description": "A comma-delimited subset of wildcard\\_fields to search when applying the wildcard filter. For example, `field1,field2`. If `w` is provided, but `wf` is not, then all wildcard\\_fields' values are searched against the wildcard filter text."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The number of records to retrieve. If this parameter is omitted, Tenable Vulnerability Management uses the default value of `50`. The minimum supported limit is `1`, and the maximum supported limit is `5000`."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The starting record to retrieve. If this parameter is omitted, Tenable Vulnerability Management uses the default value of `0`."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "The field you want to use to sort the results by along with the sort order. The field is specified first, followed by a colon, and the order is specified second (`asc` or `desc`). For example, `name:desc` would sort results by the `name` field in descending order.\n\nIf you specify multiple fields, the fields must be separated by commas. For example, `name:desc,platform:asc` would first sort results by the `name` field in descending order and then by the `platform` field in ascending order.\n\nSort can only be applied to the sortable_fields specified by the filter capabilities. There may be no more than max_sort_fields number of columns used in the sort, as specified by the filter capabilities."
              }
            ]
          },
          "docs": "Returns a list of agents for the specified scanner.<div class=\"perms-callout\">Requires the Scan Manager [40] user role. See [Roles](doc:roles).</div>"
        },
        {
          "info": {
            "name": "List agents by group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.tenable.com/downloads/api/v2/scanners/null/agent-groups/:agent_group_id/agents",
            "params": [
              {
                "name": "agent_group_id",
                "value": "",
                "type": "path",
                "description": "The ID of the agent group to query for agents. You can find the ID by using the [GET /scanners/{scanner_id}/agent-groups](ref:agent-groups-list) endpoint."
              },
              {
                "name": "f",
                "value": "",
                "type": "query",
                "description": "Apply a filter in the format `::`. For example, `field1:match:sometext` would match any records where the value of field1 contains `sometext`. You can use multiple query filters. \n\nUse the [List agent filters](ref:io-filters-agents-list) endpoint to retrieve the list of supported filters, including their valid operators and value types."
              },
              {
                "name": "ft",
                "value": "",
                "type": "query",
                "description": "Filter type. If the filter type is `and`, the record is only returned if all filters match. If the filter type is `or`, the record is returned if any of the filters match."
              },
              {
                "name": "w",
                "value": "",
                "type": "query",
                "description": "Wildcard filter text. Wildcard search is a mechanism where multiple fields of a record are filtered against one specific filter string. If any one of the wildcard\\_fields' values matches against the filter string, then the record matches the wildcard filter. For a record to be returned, it must pass the wildcard filter (if there is one) AND the set of standard filters. For example, if `w=wild&f=field1:match:one&f=field2:match:two&ft=or`, the record would match if the value of any supported wildcard\\_fields contained `wild`, AND either field1's value contained `one` or field2's value contained `two`."
              },
              {
                "name": "wf",
                "value": "",
                "type": "query",
                "description": "A comma-delimited subset of wildcard\\_fields to search when applying the wildcard filter. For example, `field1,field2`. If `w` is provided, but `wf` is not, then all wildcard\\_fields' values are searched against the wildcard filter text."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The number of records to retrieve. If this parameter is omitted, Tenable Vulnerability Management uses the default value of `50`. The minimum supported limit is `1`, and the maximum supported limit is `5000`."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The starting record to retrieve. If this parameter is omitted, Tenable Vulnerability Management uses the default value of `0`."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "The field you want to use to sort the results by along with the sort order. The field is specified first, followed by a colon, and the order is specified second (`asc` or `desc`). For example, `name:desc` would sort results by the `name` field in descending order.\n\nIf you specify multiple fields, the fields must be separated by commas. For example, `name:desc,platform:asc` would first sort results by the `name` field in descending order and then by the `platform` field in ascending order.\n\nSort can only be applied to the sortable_fields specified by the filter capabilities. There may be no more than max_sort_fields number of columns used in the sort, as specified by the filter capabilities."
              }
            ]
          },
          "docs": "Returns a list of agents for the specified agent group.<div class=\"perms-callout\">Requires the Scan Manager [40] user role. See [Roles](doc:roles).</div>"
        },
        {
          "info": {
            "name": "Get agent safe mode summary",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.tenable.com/downloads/api/v2/agents/safe-mode-summary"
          },
          "docs": "Returns a summary of agents in safe mode for your container. The summary includes the total number of agents along with breakdowns by agent version and operating system platform. \n\n**Note:** Agent safe mode is supported by agent version 10.9.0 and later. \n\nFor more information about agent safe mode, see [Agent Safe Mode](https://docs.tenable.com/vulnerability-management/Content/Settings/Sensors/agent-safe-mode.htm) in the _Tenable Vulnerability Management User Guide_ and [Safe Mode](https://docs"
        },
        {
          "info": {
            "name": "Get agent details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.tenable.com/downloads/api/v2/scanners/null/agents/:agent_id",
            "params": [
              {
                "name": "agent_id",
                "value": "",
                "type": "path",
                "description": "The ID of the agent to query."
              }
            ]
          },
          "docs": "Returns the specified agent details for the specified scanner.<div class=\"perms-callout\">Requires the Scan Manager [40] user role. See [Roles](doc:roles).</div>"
        },
        {
          "info": {
            "name": "Rename agent",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://www.tenable.com/downloads/api/v2/scanners/null/agents/:agent_id",
            "params": [
              {
                "name": "agent_id",
                "value": "",
                "type": "path",
                "description": "The ID or UUID of the agent to rename."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Renames an agent. <div class=\"perms-callout\">Requires the Scan Manager [40] user role. See [Roles](doc:roles).</div>"
        },
        {
          "info": {
            "name": "Unlink agent",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://www.tenable.com/downloads/api/v2/scanners/null/agents/:agent_id",
            "params": [
              {
                "name": "agent_id",
                "value": "",
                "type": "path",
                "description": "The ID of the agent to unlink."
              }
            ]
          },
          "docs": "Unlinks an agent. For more information on unlinked agent data, see [Unlink an Agent](https://docs.tenable.com/vulnerability-management/Content/Settings/Sensors/UnlinkAnAgent.htm).<div class=\"perms-callout\">Requires the Scan Manager [40] user role. See [Roles](doc:roles).</div>"
        }
      ]
    }
  ],
  "bundled": true
}