openapi: 3.1.0
info:
  title: Tufin SecureChange REST Compliance API
  description: The Tufin SecureChange REST API automates security policy change workflows, enabling programmatic submission and management of access request tickets, approval workflows, and change implementation across network infrastructure. SecureChange integrates with ITSM platforms including ServiceNow, Jira, and Remedy for end-to-end change automation. Authentication uses HTTP Basic Auth.
  version: R25-2
  contact:
    name: Tufin Support
    url: https://www.tufin.com/support
  license:
    name: Tufin Terms of Use
    url: https://www.tufin.com/terms-of-use
servers:
- url: https://{tos_host}/securechangeworkflow/api/securechange
  description: Tufin SecureChange Server
  variables:
    tos_host:
      description: Hostname or IP address of the TOS server
      default: tufin.example.com
tags:
- name: Compliance
  description: Policy compliance and risk analysis
paths:
  /risk:
    get:
      operationId: getRiskAnalysis
      summary: Get Risk Analysis
      description: Retrieve risk analysis findings including policy violations and cleanup tasks.
      tags:
      - Compliance
      security:
      - basicAuth: []
      parameters:
      - name: device_id
        in: query
        description: Filter by device ID
        schema:
          type: integer
      responses:
        '200':
          description: Risk analysis results
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RiskFinding'
components:
  schemas:
    RiskFinding:
      type: object
      description: A risk analysis finding
      properties:
        rule_id:
          type: integer
          description: Rule identifier with the finding
        device_id:
          type: integer
          description: Device with the finding
        risk_type:
          type: string
          description: Type of risk (violation, unused_rule, shadowed_rule)
        severity:
          type: string
          description: Risk severity level
        description:
          type: string
          description: Description of the risk finding
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using Tufin Orchestration Suite credentials. The authenticated user's TOS permissions apply to all API requests.
externalDocs:
  description: Tufin SecureChange REST API Documentation
  url: https://forum.tufin.com/support/kc/latest/Content/Suite/RESTAPI/12309.htm