Tenable Filters API

openapi: 3.0.0
info:
  version: 1.0.0
  title: Downloads About Filters API
  description: 'The Downloads API enables customers to access and download installation and update files for available Tenable products. You can use the API endpoints to list product pages, list downloads available for a specific product, and to download a file. The endpoints can also be used to determine and download the latest version of a file to facilitate the automation of an installation.


    **Note:** The Tenable Downloads API uses a different server URL than the Tenable Vulnerability Management API:


    `https://www.tenable.com/downloads/api/v2/pages`.


    ### Authentication


    Like the Downloads website, certain files require authentication to download. When files have a `"requires_auth": true` attribute on the product list page, the Downloads API uses bearer token authentication and requires a valid token in the Authorization header to download the file:

    ```

    Authorization: Bearer AbCdEf123456

    ```


    To access or reset your authentication token, navigate to the [Authentication Token](https://www.tenable.com/downloads/api-docs) page.


    Examples of product downloads that **do not** require authentication include Nessus and Nessus Agents.'
servers:
- url: https://www.tenable.com/downloads/api/v2
security:
- Bearer: []
tags:
- name: Filters
  description: "The Tenable Managed Security Service Provider (MSSP) Portal API provides a secure and accessible way for MSSP administrators to manage and maintain multiple customer instances of Tenable products. Filters endpoints in the Tenable MSSP Portal API enables customers to list the filtering capabilities for the other MSSP endpoints that support filtering. \n\nFor more information about the Tenable MSSP Portal, see the [Tenable MSSP Portal User Guide](https://docs.tenable.com/managed-security-service-provider/Content/Welcome.htm)."
paths:
  /filters/mssp/accounts:
    get:
      tags:
      - Filters
      summary: List account filters
      description: Lists the filtering capabilities for account endpoints that support filtering. <div class="perms-callout">Requires the Basic [16] user role. See [Roles](doc:roles).</div>
      operationId: io-mssp-filters-account-list
      responses:
        '200':
          description: Returned if the list of account filters was retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  wildcard_fields:
                    $ref: '#/components/schemas/wildcard_fields'
                  filters:
                    $ref: '#/components/schemas/filters'
              examples:
                response:
                  value:
                    wildcard_fields:
                    - container_name
                    - custom_name
                    - licensed_apps
                    - region
                    - notes
                    filters:
                    - name: container_name
                      readable_name: Account Name
                      control:
                        readable_regex: TEXT
                        type: entry
                        regex: .*
                      operators:
                      - eq
                      - neq
                      - match
                      - nmatch
                    - name: uuid
                      readable_name: Account UUID
                      control:
                        readable_regex: 01234567-abcd-ef01-2345-6789abcdef01
                        type: entry
                        regex: '[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}(,[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})*'
                      operators:
                      - eq
                      - neq
                    - name: licensed_assets
                      readable_name: Licenses Provisioned
                      control:
                        readable_regex: e.g. 1111111,2222222
                        type: entry
                        regex: 0|(-?[1-9][0-9]*)
                      operators:
                      - lte
                      - gte
                      - lt
                      - gt
                      - eq
                      - neq
                    - name: license_utilization
                      readable_name: License Utilization
                      control:
                        readable_regex: e.g. 1111111,2222222
                        type: entry
                        regex: 0|(-?[1-9][0-9]*)
                      operators:
                      - lte
                      - gte
                      - lt
                      - gt
                      - eq
                      - neq
                    - name: license_expiration_date
                      readable_name: License Expiring
                      control:
                        readable_regex: Enter no. of days, eg. 90
                        type: entry
                        regex: ^[0-9]+$
                        maxlength: '6'
                      operators:
                      - lte
                      - gte
                      - lt
                      - gt
                    - name: licensed_apps
                      readable_name: Licensed Apps
                      control:
                        type: dropdown_multi
                        list:
                        - name: WAS
                          id: was
                        - name: LUMIN
                          id: lumin
                      operators:
                      - eq
                      - neq
                    - name: region
                      readable_name: Region
                      control:
                        type: dropdown_multi
                        list:
                        - name: QA-STAGING
                          id: qa-staging
                      operators:
                      - eq
                      - neq
        '400':
          description: Returned if you specify invalid input parameters.
        '401':
          description: Returned if the API keys specified in your request are invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    statusCode: 401
                    error: Unauthorized
                    message: Invalid credentials.
        '429':
          description: Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).
          content:
            text/html:
              examples:
                response:
                  value: "<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"
        '500':
          description: Returned if an internal error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    statusCode: 500
                    error: Internal Server Error
                    message: An internal server error occurred. Please wait a moment and try your request again.
  /filters/scans/agents:
    get:
      summary: List agent filters
      description: Lists the filtering, sorting, and pagination capabilities available for agent records on endpoints that support them.<div class="perms-callout">Requires the Basic [16] user role. See [Roles](doc:roles).</div>
      operationId: io-filters-agents-list
      tags:
      - Filters
      responses:
        '200':
          description: Returned if the agent filters was retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  wildcard_fields:
                    $ref: '#/components/schemas/filters_wildcard_fields'
                  filters:
                    $ref: '#/components/schemas/filters_filters'
                  sort:
                    $ref: '#/components/schemas/filters_sort'
              examples:
                response:
                  value:
                    wildcard_fields:
                    - core_version
                    - distro
                    - groups
                    - ip
                    - name
                    - platform
                    - status
                    filters:
                    - name: core_version
                      readable_name: Version
                      operators:
                      - match
                      - lt
                      - neq
                      - eq
                      - nmatch
                      - gt
                      control:
                        readable_regex: X.Y.Z
                        type: entry
                        regex: .*
                    - name: distro
                      readable_name: Distro
                      operators:
                      - match
                      - nmatch
                      control:
                        readable_regex: Distro Name (e.g. es7-x86-64)
                        type: entry
                        regex: .*
                    - name: groups
                      readable_name: Member of Group
                      operators:
                      - eq
                      - neq
                      control:
                        type: dropdown
                        list:
                        - name: None
                          id: -1
                        - name: NA1
                          id: 738777
                    - name: ip
                      readable_name: IP Address
                      operators:
                      - eq
                      - neq
                      - match
                      - nmatch
                      control:
                        readable_regex: 192.168.1.1
                        type: entry
                        regex: .*
                    - name: last_connect
                      readable_name: Last Connection
                      operators:
                      - date-lt
                      - date-gt
                      - date-eq
                      - date-neq
                      - lt
                      - gt
                      - exists
                      - nexists
                      control:
                        readable_regex: yyyy/MM/dd OR 1234567890
                        type: datefield
                        regex: ^(?:[0-9]{4}/[0-9]{2}/[0-9]{2}|[0-9]{1,11})$
                    - name: last_scanned
                      readable_name: Last Scanned
                      operators:
                      - date-lt
                      - date-gt
                      - date-eq
                      - date-neq
                      - lt
                      - gt
                      - exists
                      - nexists
                      control:
                        readable_regex: yyyy/MM/dd OR 1234567890
                        type: datefield
                        regex: ^(?:[0-9]{4}/[0-9]{2}/[0-9]{2}|[0-9]{1,11})$
                    - name: name
                      readable_name: Name
                      operators:
                      - eq
                      - neq
                      - match
                      - nmatch
                      control:
                        readable_regex: TEXT
                        type: entry
                        regex: .*
                    - name: platform
                      readable_name: Platform
                      operators:
                      - eq
                      - neq
                      - match
                      - nmatch
                      control:
                        readable_regex: Platform Name (e.g. Linux)
                        type: entry
                        regex: .*
                    - name: plugin_feed_id
                      readable_name: Last Plugin Update
                      operators:
                      - date-lt
                      - date-gt
                      - date-eq
                      - date-neq
                      - lt
                      - gt
                      - exists
                      - nexists
                      control:
                        readable_regex: yyyy/MM/dd OR 1234567890
                        type: datefield
                        regex: ^(?:[0-9]{4}/[0-9]{2}/[0-9]{2}|[0-9]{1,11})$
                    - name: status
                      readable_name: Status
                      operators:
                      - eq
                      - neq
                      control:
                        type: dropdown
                        list:
                        - Online
                        - Offline
                        - Initializing
                    - name: uuid
                      readable_name: UUID
                      operators:
                      - eq
                      - neq
                      control:
                        readable_regex: agent uuid
                        type: entry
                        regex: .*
                    - name: network_uuid
                      readable_name: Network UUID
                      operators:
                      - eq
                      - neq
                      control:
                        readable_regex: Network UUID
                        type: entry
                        regex: .*
                    - name: network_name
                      readable_name: Network Name
                      operators:
                      - eq
                      - neq
                      control:
                        readable_regex: Network Name
                        type: entry
                        regex: .*
                    - name: profile_uuid
                      readable_name: Assigned to Profile
                      operators:
                      - eq
                      - neq
                      control:
                        type: dropdown
                        list:
                        - name: Default
                          id: 00000000-0000-0000-0000-000000000000
                        - name: NA1
                          id: e302aaa5-aaa5-aaa5-aaa5-703dd25faaa5
                    - name: health
                      readable_name: Health
                      operators:
                      - eq
                      - neq
                      control:
                        type: dropdown
                        list:
                        - Healthy
                        - Warning
                        - Critical
                        - Safe Mode
                        - Unknown
                    - name: safe_mode
                      readable_name: Safe Mode
                      operators:
                      - eq
                      - neq
                      control:
                        type: dropdown
                        list:
                        - Enabled
                        - Disabled
                        - N/A
                    - name: linked_on
                      readable_name: Linked On
                      operators:
                      - date-lt
                      - date-gt
                      - date-eq
                      - date-neq
                      - lt
                      - gt
                      - exists
                      - nexists
                      control:
                        readable_regex: yyyy/MM/dd OR 1234567890
                        type: datefield
                        regex: ^(?:[0-9]{4}/[0-9]{2}/[0-9]{2}|[0-9]{1,11})$
                    sort:
                      sortable_fields:
                      - core_version
                      - distro
                      - health
                      - ip
                      - last_connect
                      - last_scanned
                      - name
                      - platform
                      - plugin_feed_id
                      - linked_on
                      - safe_mode
        '401':
          description: Returned if the API keys specified in your request are invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filters_ErrorResponse'
              examples:
                response:
                  value:
                    statusCode: 401
                    error: Unauthorized
                    message: Invalid credentials.
        '429':
          description: Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).
          content:
            text/html:
              examples:
                response:
                  value: "<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"
        '500':
          description: Returned if an internal error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filters_ErrorResponse'
              examples:
                response:
                  value:
                    statusCode: 500
                    error: Internal Server Error
                    message: An internal server error occurred. Please wait a moment and try your request again.
      security:
      - filters_cloud: []
  /filters/workbenches/assets:
    get:
      summary: List asset filters
      description: Lists the filtering, sorting, and pagination capabilities available for assets on endpoints that support them. For more information about these filters, see [Workbench Filters](doc:workbench-filters).<div class="perms-callout">Requires the Basic [16] user role. See [Roles](doc:roles).</div>
      operationId: io-filters-assets-list
      tags:
      - Filters
      responses:
        '200':
          description: Returned if the asset filters was retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  wildcard_fields:
                    $ref: '#/components/schemas/filters_wildcard_fields'
                  filters:
                    $ref: '#/components/schemas/filters_filters'
                  sort:
                    $ref: '#/components/schemas/filters_sort'
              examples:
                response:
                  value:
                    filters:
                    - name: acr_score
                      readable_name: ACR Score
                      operators:
                      - eq
                      - gte
                      - lte
                      control:
                        type: entry
                        regex: ^([1-9]|10)$
                        readable_regex: NUMBER
                    - name: acr_severity
                      readable_name: ACR Severity
                      operators:
                      - eq
                      control:
                        type: dropdown_multi
                        list:
                        - name: Critical
                          value: '4'
                        - name: High
                          value: '3'
                        - name: Medium
                          value: '2'
                        - name: Low
                          value: '1'
                        - name: Unclassified
                          value: '-1'
                    - name: exposure_score
                      readable_name: AES
                      operators:
                      - eq
                      - gte
                      - lte
                      control:
                        type: entry
                        regex: ^\s*[+-]?[0-9]+\s*$
                        readable_regex: NUMBER
                    - control:
                        list:
                        - name: 'true'
                          value: 'true'
                        - name: 'false'
                          value: 'false'
                        - name: unclassified
                          value: unclassified
                        - name: vpr comp predicted
                          value: vpr_comp_predicted
                        - name: acr comp predicted
                          value: acr_comp_predicted
                        - name: vpr and acr comp predicted
                          value: vpr_and_acr_comp_predicted
                        type: dropdown_multi
                      name: aes_score_prediction
                      operators:
                      - eq
                      readable_name: AES Prediction
                    - name: exposure_severity
                      readable_name: AES Severity
                      operators:
                      - eq
                      control:
                        type: dropdown_multi
                        list:
                        - name: High
                          value: '3'
                        - name: Medium
                          value: '2'
                        - name: Low
                          value: '1'
                        - name: Unclassified
                          value: '-1'
                    - control:
                        type: dropdown
                        list:
                        - 'true'
                        - 'false'
                      name: asset_assessed
                      operators:
                      - eq
                      readable_name: Asset Assessed
                    - control:
                        type: entry
                        regex: '[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}(,[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})*'
                        readable_regex: 01234567-abcd-ef01-2345-6789abcdef01
                      name: host.id
                      operators:
                      - eq
                      - neq
                      readable_name: Asset ID
                    - control:
                        list:
                        - name: us-east-1a
                          value: us-east-1a
                        - name: us-east-1b
                          value: us-east-1b
                        type: dropdown
                      name: aws_availability_zone
                      operators:
                      - eq
                      - neq
                      readable_name: AWS Availability Zone
                    - control:
                        readable_regex: e.g. ami-12345678
                        type: entry
                        regex: .*
                      name: aws_ec2_instance_ami_id
                      operators:
                      - eq
                      - neq
                      readable_name: AWS EC2 AMI ID
                    - control:
                        readable_regex: e.g. i-1234567890abcdef0
                        type: entry
                        regex: .*
                      name: aws_ec2_instance_id
                      operators:
                      - eq
                      - neq
                      readable_name: AWS EC2 Instance ID
                    - control:
                        readable_regex: e.g. aws-server1
                        type: entry
                        regex: .*
                      name: aws_ec2_name
                      operators:
                      - eq
                      - neq
                      readable_name: AWS EC2 Name
                    - control:
                        readable_regex: e.g. amzn-ami-hvm-2016.03.0.x86_64-ebs
                        type: entry
                        regex: .*
                      name: aws_ec2_product_code
                      operators:
                      - eq
                      - neq
                      readable_name: AWS EC2 Product Code
                    - control:
                        list:
                        - pending
                        - rebooting
                        - running
                        - shutting-down
                        - stopped
                        - stopping
                        - terminated
                        type: dropdown
                      name: aws_ec2_instance_state_name
                      operators:
                      - eq
                      - neq
                      readable_name: AWS Instance State
                    - control:
                        list:
                        - g2.8xlarge
                        - g3.4xlarge
                        - g3.8xlarge
                        type: dropdown
                      name: aws_ec2_instance_type
                      operators:
                      - eq
                      - neq
                      readable_name: AWS Instance Type
                    - control:
                        readable_regex: e.g. 123456789012
                        type: entry
                        regex: .*
                      name: aws_owner_id
                      operators:
                      - eq
                      - neq
                      readable_name: AWS Owner
                    - control:
                        list:
                        - name: US East (N. Virginia)
                          value: us-east-1
                        - name: US East (Ohio)
                          value: us-east-2
                        type: dropdown
                      name: aws_region
                      operators:
                      - eq
                      - neq
                      readable_name: AWS Region
                    - control:
                        readable_regex: e.g. sg-edcd9784
                        type: entry
                        regex: .*
                      name: aws_ec2_instance_group_name
                      operators:
                      - eq
                      - neq
                      readable_name: AWS Security Group
                    - control:
                        readable_regex: e.g. subnet-ae552f1b
                        type: entry
                        regex: .*
                      name: aws_subnet_id
                      operators:
                      - eq
                      - neq
                      readable_name: AWS Subnet ID
                    - control:
                        readable_regex: e.g. vpc-f4fbc091
                        type: entry
                        regex: .*
                      name: aws_vpc_id
                      operators:
                      - eq
                      - neq
                      readable_name: AWS VPC ID
                    - control:
                        readable_regex: e.g. eastus
                        type: entry
                        regex: .*
                      name: azure_location
                      operators:
                      - eq
                      - neq
                      readable_name: Azure Location
                    - control:
                        readable_regex: e.g. my-resource-group
                        type: entry
                        regex: .*
                      name: azure_resource_group
                      operators:
                      - eq
                      - neq
                      readable_name: Azure Resource Group
                    - control:
                        readable_regex: e.g. /subscriptions/63e28077-2511-4165-b747-dd05978431e9/resourceGroups/my-resource-group/providers/Microsoft.Compute/virtualMachines/vm-name
                        type: entry
                        regex: .*
                      name: azure_resource_id
                      operators:
                      - eq
                      - neq
                      - match
                      - nmatch
                      readable_name: Azure Resource ID
                    - control:
                        readable_regex: e.g. Microsoft.Compute/virtualMachines
                        type: entry
                        regex: .*
                      name: azure_type
                      operators:
                      - eq
                      - neq
                      readable_name: Azure Resource Type
                    - control:
                        readable_regex: e.g. 5cff7d6e-0f3d-4bd8-a09f-2c654a0d8947,63e28077-2511-4165-b747-dd05978431e9
                        type: entry
                        regex: .*
                      name: azure_subscription_id
                      operators:
                      - eq
                      - neq
                      readable_name: Azure Subscription ID
                    - control:
                        readable_regex: e.g. 5cff7d6e-0f3d-4bd8-a09f-2c654a0d8947,63e28077-2511-4165-b747-dd05978431e9
                        type: entry
                        regex: .*
                      name: azure_vm_id
                      operators:
                      - eq
                      - neq
                      readable_name: Azure VM ID
                    - control:
                        list:
                        - 'true'
                        - 'false'
                        type: dropdown
                      name: belongs_to_access_group
                      operators:
                      - eq
                      readable_name: Belongs to Access Group
                    - control:
                        readable_regex: e.g. 12315195
                        type: entry
                        regex: .*
                      name: bigfix_asset_id
                      operators:
                      - eq
                      - neq
                      readable_name: BigFix Asset ID
                    - control:
                        type: dropdown
                        list:
                        - name: 7 Days Ago
                          value: '2024-07-08T16:10:31.960Z'
                        - name: 14 Days Ago
                          value: '2024-07-01T16:10:31.960Z'
                        - name: 30 Days Ago
                          value: '2024-06-15T16:10:31.960Z'
                        - name: 90 Days Ago
                          value: '2024-04-16T16:10:31.960Z'
                      name: deleted_at
                      operators:
                      - date-lt
                      - date-gt
                      readable_name: Deleted Date
                    - control:
                        list:
                        - name: pbx
                          value: pbx
                        - name: telephony
                          value: telephony
                        - name: tele conferencing
                          value: tele_conferencing
                        - name: multimedia endpoint
                          value: multimedia_endpoint
                        - name: remote console manager
                          value: remote_console_manager
                        - name: kvm switch
                          value: kvm_switch
                        - name: firewall vpn
                          value: firewall_vpn
                        - name: security gateway
                          value: security_gateway
                        - name: media gateway
                          value: media_gateway
                        - name: network router
                          value: network_router
                        - name: network switch
                          value: network_switch
                        - name: optical networking
                          value: optical_networking
                        - name: wap
                          value: wap
                        - name: load balancer
                          value: load_balancer
                        - name: enterprise storage
                          value: enterprise_storage
                        - name: consumer storage
                          value: consumer_storage
                        - name: power management


# --- truncated at 32 KB (119 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tenable/refs/heads/main/openapi/tenable-filters-api-openapi.yml