Tenable Attack type configuration API

The attack type per directory configuration

OpenAPI Specification

tenable-attack-type-configuration-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  version: 1.0.0
  title: Downloads About Attack type configuration 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: Attack type configuration
  description: The attack type per directory configuration
paths:
  /api/attack-type-configuration:
    get:
      summary: Get the attack type configuration
      description: 'Required license type: ioa, ioaPreview'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                description: Response payload of the GET /attack-type-configuration route
                type: object
                additionalProperties: false
                required:
                - version
                - configuration
                - permissions
                properties:
                  version:
                    type: integer
                  configuration:
                    type: array
                    items:
                      type: object
                      required:
                      - attackTypeId
                      - directoryId
                      - detectedEvents
                      - autoDisabledForPerfAt
                      properties:
                        attackTypeId:
                          type: integer
                        directoryId:
                          type: integer
                        detectedEvents:
                          type: boolean
                        autoDisabledForPerfAt:
                          type: string
                          format: date-time
                          nullable: true
                  permissions:
                    type: object
                    properties:
                      canEdit:
                        type: boolean
                    required:
                    - canEdit
        '401':
          description: Unauthorized
        '500':
          description: Internal server error
      tags:
      - Attack type configuration
      x-tenablead-required-product-license-type:
      - ioa
      - ioaPreview
      parameters:
      - name: x-api-key
        description: The user's API key
        in: header
        schema:
          type: string
          default: put-your-api-key-here
        required: true
        deprecated: false
      security:
      - ApiKey: []
    patch:
      summary: Update the attack type configuration
      description: 'Required license type: ioa, ioaPreview'
      responses:
        '204':
          description: ''
          content:
            application/json:
              schema:
                description: Validates the patch /attack-type-configuration response
                nullable: true
        '401':
          description: Unauthorized
        '500':
          description: Internal server error
      tags:
      - Attack type configuration
      x-tenablead-required-product-license-type:
      - ioa
      - ioaPreview
      parameters:
      - name: x-api-key
        description: The user's API key
        in: header
        schema:
          type: string
          default: put-your-api-key-here
        required: true
        deprecated: false
      security:
      - ApiKey: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              description: Validates the patch /attack-type-configuration payload
              type: object
              additionalProperties: false
              properties:
                configuration:
                  type: array
                  items:
                    type: object
                    required:
                    - attackTypeId
                    - directoryId
                    properties:
                      attackTypeId:
                        type: integer
                      directoryId:
                        type: integer
components:
  securitySchemes:
    Bearer:
      type: apiKey
      in: header
      name: Authorization
      description: 'Example: Bearer {{token}}'
x-readme:
  proxy-enabled: false
  explorer-enabled: true
  samples-enabled: true
  samples-languages:
  - python
  - curl
  - node
  - powershell
  - ruby
  - javascript
  - objectivec
  - java
  - php
  - csharp
  - go
  - swift
  - kotlin