Tenable Reason API

The reason why a AD object is marked as deviant

OpenAPI Specification

tenable-reason-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  version: 1.0.0
  title: Downloads About Reason 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: Reason
  description: The reason why a AD object is marked as deviant
paths:
  /api/reasons:
    get:
      summary: Retrieve all reason instances.
      description: 'Required license type: ioe'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                description: Validates the get /reasons response
                type: array
                items:
                  description: Reason
                  type: object
                  additionalProperties: false
                  required:
                  - id
                  - codename
                  properties:
                    id:
                      type: number
                    codename:
                      type: string
                    name:
                      type: string
                      default: null
                      nullable: true
                    description:
                      type: string
                      default: null
                      nullable: true
        '401':
          description: Unauthorized
        '500':
          description: Internal server error
      tags:
      - Reason
      x-tenablead-required-product-license-type:
      - ioe
      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: []
  /api/reasons/{id}:
    get:
      summary: Get reason instance by id.
      description: 'Required license type: ioe'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                description: Reason
                type: object
                additionalProperties: false
                required:
                - id
                - codename
                properties:
                  id:
                    type: number
                  codename:
                    type: string
                  name:
                    type: string
                    default: null
                    nullable: true
                  description:
                    type: string
                    default: null
                    nullable: true
        '401':
          description: Unauthorized
        '500':
          description: Internal server error
      tags:
      - Reason
      x-tenablead-required-product-license-type:
      - ioe
      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
      - name: id
        in: path
        schema:
          type: string
          pattern: ^[0-9]+$
          x-patternError: should be a numerical string
        required: true
        deprecated: false
      security:
      - ApiKey: []
  /api/profiles/{profileId}/checkers/{checkerId}/reasons:
    get:
      summary: Retrieve all reason instances that have deviances for a specific profile and checker.
      description: 'Required license type: ioe'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                description: Validates GET /profiles/:profileId/checkers/:checkerId/reasons response
                type: array
                items:
                  description: Reason
                  type: object
                  additionalProperties: false
                  required:
                  - id
                  - codename
                  properties:
                    id:
                      type: number
                    codename:
                      type: string
                    name:
                      type: string
                      default: null
                      nullable: true
                    description:
                      type: string
                      default: null
                      nullable: true
        '401':
          description: Unauthorized
        '500':
          description: Internal server error
      tags:
      - Reason
      x-tenablead-required-product-license-type:
      - ioe
      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
      - name: profileId
        in: path
        schema:
          type: string
          pattern: ^[0-9]+$
          x-patternError: should be a numerical string
        required: true
        deprecated: false
      - name: checkerId
        in: path
        schema:
          type: string
          pattern: ^[0-9]+$
          x-patternError: should be a numerical string
        required: true
        deprecated: false
      security:
      - ApiKey: []
  /api/profiles/{profileId}/infrastructures/{infrastructureId}/directories/{directoryId}/events/{eventId}/reasons:
    get:
      summary: Retrieve all reason instances for which we have deviances for a specific profile, directory and event.
      description: 'Required license type: ioe'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                description: Validates the GET /profiles/:profileId/infrastructures/:infrastructureId/directories/:directoryId/events/:eventId/reasons response
                type: array
                items:
                  description: Reason
                  type: object
                  additionalProperties: false
                  required:
                  - id
                  - codename
                  properties:
                    id:
                      type: number
                    codename:
                      type: string
                    name:
                      type: string
                      default: null
                      nullable: true
                    description:
                      type: string
                      default: null
                      nullable: true
        '401':
          description: Unauthorized
        '500':
          description: Internal server error
      tags:
      - Reason
      x-tenablead-required-product-license-type:
      - ioe
      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
      - name: profileId
        in: path
        schema:
          type: string
          pattern: ^[0-9]+$
          x-patternError: should be a numerical string
        required: true
        deprecated: false
      - name: infrastructureId
        in: path
        schema:
          type: string
          pattern: ^[0-9]+$
          x-patternError: should be a numerical string
        required: true
        deprecated: false
      - name: directoryId
        in: path
        schema:
          type: string
          pattern: ^[0-9]+$
          x-patternError: should be a numerical string
        required: true
        deprecated: false
      - name: eventId
        in: path
        schema:
          type: string
          pattern: ^[0-9]+$
          x-patternError: should be a numerical string
        required: true
        deprecated: false
      security:
      - ApiKey: []
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