Tenable Plugins API

The Plugins API from Tenable — 7 operation(s) for plugins.

OpenAPI Specification

tenable-plugins-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  version: 1.0.0
  title: Downloads About Plugins 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: Plugins
  x-displayName: Plugins
paths:
  /plugins/plugin:
    get:
      summary: List plugins
      description: 'Returns a paginated list of Tenable plugins sorted by plugin ID with detailed plugin information.


        You can filter the list on the value of the `last_updated` date field. However, note that the `last_updated` parameter does not take VPR updates into account. See the note on the `last_updated` parameter description for special considerations.<div class="perms-callout">Requires the Basic [16] user role. See [Roles](doc:roles).</div>'
      operationId: io-plugins-list
      tags:
      - Plugins
      parameters:
      - description: "The last updated date to filter on in the `YYYY-MM-DD` format. Tenable Vulnerability Management returns only the plugins that have been updated after the specified date. \n\n**Note:** This parameter does not take VPR updates into account. If you need to filter the plugin list by VPR update date, you should use a `last_updated` date of `1970-01-01` to return all plugins, and then filter the result set manually based on the `updated` field in the `vpr` object."
        required: false
        name: last_updated
        in: query
        schema:
          type: string
      - description: The number of records to include in the result set. Default is 1,000. The maximum size is 10,000.
        required: false
        name: size
        in: query
        schema:
          type: integer
          format: int32
      - description: The index of the page to return relative to the specified page size. For example, to return records 10-19 with page size 10, you must specify page 2. If you omit this parameter, Tenable Vulnerability Management applies the default value of 1.
        required: false
        name: page
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Returned if the paginated list of available plugins was retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/plugins_plugins_list_response'
              examples:
                response:
                  value:
                    data:
                      plugin_details:
                      - id: 13670
                        name: 'Fedora Core 1 : kernel-2.4.22-1.2140.nptl (2003-047)'
                        attributes:
                          plugin_modification_date: '2018-07-19T00:00:00Z'
                          plugin_version: '1.17'
                          exploited_by_malware: false
                          description: "Various RTC drivers had the potential to leak small amounts of kernel memory to userspace through IOCTL's. \n\nThe Common Vulnerabilities and Exposures project (cve.mitre.org) has assigned the name CVE-2003-0984 to this issue.\n\nNote that Tenable Network Security has extracted the preceding description block directly from the Fedora security advisory. Tenable has attempted to automatically clean and format it as much as possible without introducing additional issues."
                          unsupported_by_vendor: false
                          cvss_temporal_score: 0
                          patch_publication_date: '2004-01-07T00:00:00Z'
                          see_also:
                          - http://www.nessus.org/u?07bc9e7f
                          default_account: false
                          exploit_available: false
                          cve:
                          - CVE-2003-0984
                          exploit_framework_canvas: false
                          cvss_base_score: 4.6
                          solution: Update the affected packages.
                          cvss_vector:
                            raw: AV:L/AC:L/Au:N/C:P/I:P/A:P
                            AccessVector: Local-access
                            Availability-Impact: Partial
                            Authentication: None required
                            Integrity-Impact: Partial
                            AccessComplexity: Low
                            Confidentiality-Impact: Partial
                          exploit_framework_exploithub: false
                          cpe:
                          - p-cpe:/a:fedoraproject:fedora:kernel-source
                          - cpe:/o:fedoraproject:fedora_core:1
                          - p-cpe:/a:fedoraproject:fedora:kernel-BOOT
                          - p-cpe:/a:fedoraproject:fedora:kernel-debuginfo
                          - p-cpe:/a:fedoraproject:fedora:kernel
                          - p-cpe:/a:fedoraproject:fedora:kernel-doc
                          - p-cpe:/a:fedoraproject:fedora:kernel-smp
                          plugin_publication_date: '2004-07-23T00:00:00Z'
                          exploit_framework_core: false
                          in_the_news: false
                          has_patch: true
                          xref:
                          - FEDORA:2003-047
                          malware: false
                          exploit_framework_d2_elliot: false
                          xrefs:
                          - type: FEDORA
                            id: 2003-047
                          risk_factor: Medium
                          synopsis: The remote Fedora Core host is missing a security update.
                          cvss3_temporal_score: 0
                          exploited_by_nessus: false
                          cvss3_base_score: 0
                          exploit_framework_metasploit: false
                          plugin_type: local
                      - id: 13671
                        name: 'Fedora Core 1 : mc-4.6.0-8.4 (2004-058)'
                        attributes:
                          plugin_modification_date: '2018-07-19T00:00:00Z'
                          plugin_version: '1.14'
                          exploited_by_malware: false
                          description: "- Sat Jan 31 2004 Jakub Jelinek <jakub at redhat.com>     4.6.0-8.4\n\n  - fix previous patch\n\n  - Fri Jan 30 2004 Jakub Jelinek <jakub at redhat.com>     4.6.0-8.3\n\n  - update php.syntax file (#112645)\n\n    - fix crash with large syntax file (#112644)\n\n  - Fri Jan 23 2004 Jakub Jelinek <jakub at redhat.com>     4.6.0-8.2\n\n  - update CVE-2003-1023 fix to still make vfs symlinks     relative, but with bounds checking\n\n  - Sat Jan 17 2004 Warren Togami <wtogami at redhat.com>     4.6.0-8.1\n\n  - rebuild for FC1\n\n  - Sat Jan 17 2004 Warren Togami <wtogami at redhat.com>     4.6.0-7\n\n  - BuildRequires glib2-devel, slang-devel, XFree86-devel,     e2fsprogs-devel, gettext\n\n  - Copyright -> License\n\n    - PreReq -> Requires\n\n    - Explicit zero epoch in versioned dev dep\n\n    - /usr/share/mc directory ownership\n\n    - Improve summary\n\n    - (Seth Vidal QA) fix for CVE-2003-1023 (Security)\n\nNote that Tenable Network Security has extracted the preceding description block directly from the Fedora security advisory. Tenable has attempted to automatically clean and format it as much as possible without introducing additional issues."
                          unsupported_by_vendor: false
                          cvss_temporal_score: 0
                          patch_publication_date: '2004-02-09T00:00:00Z'
                          see_also:
                          - http://www.nessus.org/u?ea1a95cb
                          default_account: false
                          exploit_available: false
                          cve:
                          - CVE-2003-1023
                          exploit_framework_canvas: false
                          cvss_base_score: 7.5
                          solution: Update the affected mc and / or mc-debuginfo packages.
                          cvss_vector:
                            raw: AV:N/AC:L/Au:N/C:P/I:P/A:P
                            AccessVector: Network
                            Availability-Impact: Partial
                            Authentication: None required
                            Integrity-Impact: Partial
                            AccessComplexity: Low
                            Confidentiality-Impact: Partial
                          exploit_framework_exploithub: false
                          cpe:
                          - cpe:/o:fedoraproject:fedora_core:1
                          - p-cpe:/a:fedoraproject:fedora:mc-debuginfo
                          - p-cpe:/a:fedoraproject:fedora:mc
                          plugin_publication_date: '2004-07-23T00:00:00Z'
                          exploit_framework_core: false
                          in_the_news: false
                          has_patch: true
                          xref:
                          - FEDORA:2004-058
                          malware: false
                          exploit_framework_d2_elliot: false
                          xrefs:
                          - type: FEDORA
                            id: 2004-058
                          risk_factor: High
                          synopsis: The remote Fedora Core host is missing a security update.
                          cvss3_temporal_score: 0
                          exploited_by_nessus: false
                          cvss3_base_score: 0
                          exploit_framework_metasploit: false
                          plugin_type: local
                      - id: 13672
                        name: 'Fedora Core 1 : mailman-2.1.4-1 (2004-060)'
                        attributes:
                          plugin_modification_date: '2018-07-19T00:00:00Z'
                          plugin_version: '1.12'
                          exploited_by_malware: false
                          description: 'A cross-site scripting (XSS) vulnerability exists in the admin CGI script for Mailman before 2.1.4. This update moves Mailman to version 2.1.4 which is not vulnerable to this issue.


                            Updated packages were made available in February 2004 however the original update notification email did not make it to fedora-announce-list at that time.


                            Note that Tenable Network Security has extracted the preceding description block directly from the Fedora security advisory. Tenable has attempted to automatically clean and format it as much as possible without introducing additional issues.'
                          unsupported_by_vendor: false
                          cvss_temporal_score: 0
                          patch_publication_date: '2004-02-26T00:00:00Z'
                          see_also:
                          - http://www.nessus.org/u?564bb3fe
                          default_account: false
                          exploit_available: false
                          exploit_framework_canvas: false
                          cvss_base_score: 0
                          solution: Update the affected mailman and / or mailman-debuginfo packages.
                          exploit_framework_exploithub: false
                          cpe:
                          - cpe:/o:fedoraproject:fedora_core:1
                          - p-cpe:/a:fedoraproject:fedora:mailman-debuginfo
                          - p-cpe:/a:fedoraproject:fedora:mailman
                          plugin_publication_date: '2004-07-23T00:00:00Z'
                          exploit_framework_core: false
                          in_the_news: false
                          has_patch: true
                          xref:
                          - FEDORA:2004-060
                          malware: false
                          exploit_framework_d2_elliot: false
                          xrefs:
                          - type: FEDORA
                            id: 2004-060
                          risk_factor: High
                          synopsis: The remote Fedora Core host is missing a security update.
                          cvss3_temporal_score: 0
                          exploited_by_nessus: false
                          cvss3_base_score: 0
                          exploit_framework_metasploit: false
                          plugin_type: local
                    size: 1000
                    params:
                      page: 3
                      size: 1000
                      last_updated: '2018-01-01'
                    total_count: 75621
        '401':
          description: Returned if the API keys specified in your request are invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/plugins_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/plugins_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:
      - plugins_cloud: []
  /plugins/plugin/{id}:
    get:
      summary: Get plugin details
      description: Returns details for a specified plugin.<div class="perms-callout">Requires the Basic [16] user role. See [Roles](doc:roles).</div>
      operationId: io-plugins-details
      tags:
      - Plugins
      parameters:
      - description: The ID of the plugin.
        required: true
        name: id
        in: path
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Returned if the details for the specified plugin were retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/plugins_plugin'
              examples:
                response:
                  value:
                    attributes:
                    - attribute_value: aix_IY19744.nasl
                      attribute_name: fname
                    - attribute_value: 'AIX 5.1 : IY19744'
                      attribute_name: plugin_name
                    - attribute_value: '$Revision: 1.5 $'
                      attribute_name: script_version
                    - attribute_value: http://www-912.ibm.com/eserver/support/fixes/
                      attribute_name: solution
                    - attribute_value: High
                      attribute_name: risk_factor
                    - attribute_value: 'The remote host is missing AIX Critical Security Patch number IY19744

                        (SECURITY: Buffer Overflow in xntpd).


                        You should install this patch for your system to be up-to-date.'
                      attribute_name: description
                    - attribute_value: 2006/09/16
                      attribute_name: plugin_publication_date
                    - attribute_value: The remote host is missing a vendor-supplied security patch
                      attribute_name: synopsis
                    family_name: AIX Local Security Checks
                    name: 'AIX 5.1 : IY19744'
                    id: 22372
        '401':
          description: Returned if the API keys specified in your request are invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/plugins_ErrorResponse'
              examples:
                response:
                  value:
                    statusCode: 401
                    error: Unauthorized
                    message: Invalid credentials.
        '404':
          description: Returned if Tenable Vulnerability Management could not find the specified plugin ID.
          content: {}
        '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/plugins_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:
      - plugins_cloud: []
  /plugins/families:
    get:
      summary: List plugin families
      description: Returns the list of plugin families.<div class="perms-callout">Requires the Basic [16] user role. See [Roles](doc:roles).</div>
      operationId: io-plugins-families-list
      tags:
      - Plugins
      parameters:
      - description: Specifies whether to return all plugin families. If `true`, the plugin families hidden in Tenable Vulnerability Management UI, for example, Port Scanners, are included in the list.
        required: false
        name: all
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: Returned if the list of plugin families was retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  families:
                    type: array
                    items:
                      properties:
                        count:
                          type: integer
                          description: The number of plugins in the family.
                        name:
                          type: string
                          description: The name of the family.
                        id:
                          type: integer
                          description: The unique ID of the family.
              examples:
                response:
                  value:
                    families:
                    - count: 11342
                      name: AIX Local Security Checks
                      id: 1
                    - count: 1164
                      name: Amazon Linux Local Security Checks
                      id: 35
                    - count: 114
                      name: Backdoors
                      id: 17
        '401':
          description: Returned if the API keys specified in your request are invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/plugins_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/plugins_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:
      - plugins_cloud: []
  /plugins/families/{id}:
    get:
      summary: List plugins in family (ID)
      description: Returns the list of plugins for the specified family ID.<div class="perms-callout">Requires the Basic [16] user role. See [Roles](doc:roles).</div>
      operationId: io-plugins-family-details-id
      tags:
      - Plugins
      parameters:
      - description: The ID of the plugin family you want to retrieve the list of plugins for.
        required: true
        name: id
        in: path
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Returned if the list of plugins for the specified family ID was retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/plugins_ResponsePluginsList'
              examples:
                response:
                  value:
                    plugins:
                    - id: 22372
                      name: 'AIX 5.1 : IY19744'
                    - id: 22373
                      name: 'AIX 5.1 : IY20486'
                    - id: 22374
                      name: 'AIX 5.1 : IY21309'
                    name: AIX Local Security Checks
                    id: 1
        '401':
          description: Returned if the API keys specified in your request are invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/plugins_ErrorResponse'
              examples:
                response:
                  value:
                    statusCode: 401
                    error: Unauthorized
                    message: Invalid credentials.
        '404':
          description: Returned if Tenable Vulnerability Management could not find the specified plugin family ID.
          content: {}
        '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/plugins_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:
      - plugins_cloud: []
  /plugins/families/_byName:
    post:
      summary: List plugins in family (name)
      description: Returns the list of plugins for the specified family name.<div class="perms-callout">Requires the Basic [16] user role. See [Roles](doc:roles).</div>
      operationId: io-plugins-family-details-name
      tags:
      - Plugins
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              properties:
                name:
                  type: string
                  description: The name of the plugin family you want to retrieve the list of plugins for.
                  format: uuid
      responses:
        '200':
          description: Returned if the list of plugins for the specified family name was retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/plugins_ResponsePluginsList'
              examples:
                response:
                  value:
                    plugins:
                    - id: 79798
                      name: HP Network Node Manager i (NNMi) 8.x / 9.0x / 9.1x / 9.20 Unspecified XSS
                    - id: 79799
                      name: HP Network Node Manager i (NNMi) XSS (HPSBMU03035)
                    - id: 79801
                      name: HP Network Node Manager i Remote Code Execution (HPSBMU03075)
                    - id: 59189
                      name: HP SNMP Agents < 9.0.0 Multiple Vulnerabilities (HPSBMU02771 SSRT100558) (Red Hat)
                    name: Red Hat Local Security Checks
                    id: 43
        '400':
          description: Returned if your request specified invalid parameters or if your request was improperly formatted.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: A description of the error.
              examples:
                response:
                  value:
                    error: 'Invalid ''name'' field: missing'
        '401':
          description: Returned if the API keys specified in your request are invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/plugins_ErrorResponse'
              examples:
                response:
                  value:
                    statusCode: 401
                    error: Unauthorized
                    message: Invalid credentials.
        '404':
          description: Returned if Tenable Vulnerability Management could not find the specified plugin family name.
          content: {}
        '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/plugins_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:
      - plugins_cloud: []
  /was/v2/plugins:
    get:
      summary: List plugins
      description: Returns a list of plugins used in Tenable Web App Scanning scans. <div class="perms-callout">Requires the Basic [16] user role or the `WAS.TOGGLE_WAS.USE` custom role privilege. See [Roles](doc:roles).</div>
      operationId: was-v2-plugins-list
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/sort-plugins'
      tags:
      - Plugins
      responses:
        '200':
          description: Returns a list of plugins.
          headers:
            Cache-Control:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                required:
                - pagination
                - items
                properties:
                  pagination:
                    $ref: '#/components/schemas/PaginationResponse'
                  items:
                    type: array
                    description: A list of plugins.
                    items:
                      $ref: '#/components/schemas/Plugin'
              examples:
                response:
                  value:
                    pagination:
                      total: 1266
                      offset: 0
                      limit: 10
                      sort:
                      - name: plugin_id
                        order: asc
                    items:
                    - plugin_id: 98000
                      name: Scan Information
                      family: General
                      policy: []
                    - plugin_id: 98003
                      name: OS Detection
                      family: General
                      policy: []
                    - plugin_id: 98007
                      name: URI Blocked Due to Exclusion Rule
                      family: General
                      policy: []
                    - plugin_id: 98009
                      name: Web Application Sitemap
                      family: General
                      policy: []
                    - plugin_id: 98019
                      name: Network Timeout Encountered
                      family: General
                      policy: []
                    - plugin_id: 98024
                      name: HTTP Server Authentication Detected
                      family: Authentication & Session
                      policy: []
                    - plugin_id: 98025
                      name: HTTP Server Authentication Succeeded
                      family: Authentication & Session
                      policy: []
                    - plugin_id: 98026
                      name: HTTP Server Authentication Failed
                      family: Authentication & Session
                      policy: []
                    - plugin_id: 98033
                      name: Login Form Detected
                      family: Authentication & Session
                      policy: []
                    - plugin_id: 98034
                      name: Login Form Authentication Failed
                      family: Authentication & Session
                      policy: []
        '401':
          description: Returned if the API keys specified in your request are invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    status

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