LogoLogo
API DocumentationIntegrationsPlexTrac.com
  • Product Documentation
    • Using This Site
    • Security Advisories
    • Deployment and Maintenance Policy
    • Supported Applications
  • PlexTrac Modules
    • Dashboard
    • Clients
      • Clients Components
      • Creating a Client
      • Managing Clients
      • Managing Client Users
      • Adding Assets to a Client
      • Managing Assets
    • Schedule
      • Schedule Components
      • Creating an Engagement
      • Requesting an Engagement
      • Managing Engagements
      • Engagement Status
    • Assessments
      • Assessment Components
      • Managing Questionnaires
      • Starting an Assessment
      • Taking an Assessment
      • Reviewing an Assessment
      • Submitting an Assessment
    • Reports
      • Report Components
      • Creating a Report
      • Adding from NarrativesDB
      • Editing a Report
      • Using Short Codes in Reports
      • Findings
        • Creating a Finding
        • Collaborative Editing
        • Importing Findings from a File
        • CSV Findings Templates
          • Using Report Findings CSV Template
        • Importing Findings via an Integration
        • Importing Findings from WriteupsDB
        • Finding Status
        • Creating Jira Tickets
        • CVSS Scoring
        • Affected Assets
      • Importing a Report
      • Exporting a Report
    • Priorities
      • Priorities Components
      • Creating a Priority
      • Linking Findings and Assets
      • Managing Priorities
      • Priorities Metrics
    • Content Library
      • Types of Repositories
      • NarrativesDB
        • NarrativesDB Home Page
        • Managing Repositories
        • Managing Users
        • Creating a Repository
        • Managing Sections
        • Creating a Section
      • WriteupsDB
        • WriteupsDB Home Page
        • Managing Repositories
        • Managing Users
        • Creating a Repository
        • Creating a Writeup
        • Copying a Writeup
        • Adding to a Report
        • Importing via CSV Template
      • RunbooksDB
        • RunbooksDB Home Page
        • Managing Repositories
        • Managing Users
        • Creating a Repository
        • Creating a Procedure
        • Creating a Technique
        • Creating a Tactic
        • Creating a Methodology
    • Analytics
      • Findings
      • Assets
      • Runbooks
      • Trends & SLAs
    • Runbooks
      • Managing Engagements
        • Starting an Engagement
        • Submitting an Engagement
      • Managing Test Plans
        • Creating a Test Plan
        • Exporting a Test Plan
  • Tenant Management
    • Account Management
      • Profile (Personal Settings)
        • Managing User Profile
        • Managing Password
        • Setting Up Two-Factor Authentication
      • Account Admin
        • Tenant Settings
          • Account Information
          • General Settings
          • Email Settings
          • Tags Settings
          • Service-Level Agreements (SLAs)
          • Short Codes
        • Customizations
          • Layouts
          • Templates
            • Report Templates
            • Export Templates
            • Style Guides
          • Theme
        • Automations
          • Risk Scoring
            • Creating Equations
            • Managing Priority Equations
          • Parser Actions
        • Integrations & Webhooks
          • Integrations (API)
            • Cobalt
            • Edgescan
            • HackerOne
            • Jira
            • ServiceNow
            • Tenable Vulnerability Management
            • Tenable Security Center
          • Webhooks
        • Security & User Management
          • Audit Log
          • Security
            • Authentication Methods
              • OAuth/OpenID Setup
                • Microsoft Entra ID
                • Google OAuth
                • Okta
                • OpenID Connect
              • SAML Setup
            • General Authentication Settings
            • Authorization
            • Role Based Access (RBAC)
              • Custom Roles
            • Classification Tiers
          • Users
            • Adding Users
            • Managing Users
        • Licensing
          • Licensing
          • Priorities
          • Plex AI
            • Using AI
        • White Labeling
      • Help Center
      • Logout
    • Integrations and File Imports
      • Acunetix
      • BlindSPOT
      • Burp Suite
      • Checkmarx
      • Core Impact
      • HCL AppScan
      • Invicti
      • Nessus
      • Nexpose
      • Nipper
      • Nmap (Assets)
      • Nmap Vulners NSE
      • Nodeware
      • NodeZero
      • OpenVAS
      • OWASP ZAP
      • Pentera
      • Qualys (VM Parser)
      • Qualys (Web App Scanner)
      • RapidFire
      • Scythe
      • Veracode
  • API Documentation
    • Overview
    • Concept Definitions
    • Getting Started
    • Retrieving Parameter IDs
    • Object Structures
      • Client Object
      • Report Object
      • Finding Object
      • Asset Object
      • Evidence Object
    • Use Cases
    • API Change Policy
      • API Change Log
    • Webhooks
      • Webhook Payload Structure
      • Verifying Sender Requests
Powered by GitBook
On this page
  • PlexTrac Application
  • Self-Consumed API
  • Driving Action
  • API vs. PlexTrac Platform

Was this helpful?

Export as PDF
  1. API Documentation

Concept Definitions

PreviousOverviewNextGetting Started

Last updated 2 months ago

Was this helpful?

Resources

  • Privacy Policy
  • Terms of Use
  • Vulnerability Policy

© 2025 PlexTrac, Inc. All rights reserved.

PlexTrac Application

PlexTrac is an application that helps users collect, transform, display, and analyze vulnerability data. It consists of two parts: the backend, which stores and manages the data, and the frontend (the PlexTrac platform), which allows the user to view and interact with it.

The API is the connecting link between the two parts. It's a set of instructions that informs the backend to create, delete, update, or return data to the user.

The frontend sends requests to the backend to store or modify data and queries it to display the required information to the user. The backend executes these requests and returns the necessary data.

Each customer instance of PlexTrac is an independent app with a frontend, backend, and API.

Self-Consumed API

Developers can benefit from using a web app that self-consumes its API, allowing it to utilize its API resources. This ensures the API is tested and reliable as the app uses it. PlexTrac is an example of a web app that self-consumes its API, enabling UI interactions to be treated as API requests directly sent to the server.

This allows external applications to integrate with PlexTrac and will enable users to manage data with custom scripts. All functionality within the platform is accessible through the API, making it a reliable and efficient way for developers to access data or services that would typically require manual processes or multiple UI interactions.

Driving Action

To use the backend database, a user must initiate an action by sending requests. This is made possible through the PlexTrac platform, which serves as the frontend interface for sending API requests. By interacting with the UI components, users can become the driving force behind the requests sent to the backend by simply clicking a button on the Plextrac platform.

When interacting with the backend, one can send API requests through various means, including the PlexTrac platform, command line, Postman API Platform, custom scripts, or a personalized frontend. Regardless of the chosen method, the process involves the user initiating a driving action, such as:

  • entering the request on the command line

  • creating and sending a Postman request

  • executing a script

The extent of what can be achieved with the API depends on the resources involved, whether a simple command-line request or a custom frontend that replaces the PlexTrac platform.

API vs. PlexTrac Platform

Some key factors should be considered when deciding whether to use the API or the platform. One of the main advantages of using the platform is its simplicity. The API may not be needed if a task can be completed with just one click.

The API is a superior option for interacting with and managing data. It offers developers a dependable and effective way to access data or services that would otherwise require manual procedures or numerous user interface interactions.

In addition, using APIs instead of the platform is beneficial because scripts allow for automation. Scripts can perform multiple interactions simultaneously, enabling bulk operations and saving time.