API Reference | Vulnotes Docs

Skip to content

Main Navigation Home Getting Started Reports Template Design Administration API MCP

Appearance

Sidebar Navigation

Getting Started

Introduction

On-Premise Installation

SaaS Setup

Initial Setup

Migration & Import

Reports

Report Sections & Content

Findings

Kill Chains

Attachments

Review & Approval Workflow

Exporting Reports

Vulnerabilities

Vulnerability Library

Creating Vulnerabilities

Vulnerability Templates

Template Design

Introduction

Elements

Table

Image

Table of Content

Chart

Kill Chain

Link

Variables & Templating

Syntax

Variables

Filters

Custom Variables

Examples

Styling Templates

Pages

Theme

Companies & Clients

Managing Companies

Client Portal

Overview

Settings

Reports

Vulnerabilities

Statistics

Jira Integration

Planning & Calendar

Events

Availability

Conflict Detection

AI Features

Overview & Providers

Vulnerability Generation

Content Improvement

Translation

Vision (Screenshot to Finding)

Anonymization

Administration

User Management

Users & Invitations

Teams

Roles & Permissions

Authentication

Local Authentication

LDAP Integration

Google OAuth

Two-Factor Authentication

Settings

Report Settings

API Keys

Webhooks

Import Data

MCP

API

Companies

GET Get all companies

GET Search companies

GET Get company by ID

POST Create a company

PUT Update a company

DELETE Delete a company

Report Templates

GET Get all templates

GET Search templates

GET Get template by ID

GET Get template content

GET Preview template

Vulnerability Templates

GET Get all templates

GET Search templates

GET Get template by ID

GET Get report templates

Vulnerability Library

GET List vulnerabilities

GET Search vulnerabilities

GET Get vulnerability

POST Create vulnerability

PUT Update vulnerability

DELETE Delete vulnerability

Reports

GET List all reports

POST Create a report

GET Search reports

POST Sync from template

POST Import report

GET Get a report

PUT Update a report

DELETE Delete a report

POST Export as PDF

GET Export as PDF (legacy)

POST Export as ZIP

GET Export as JSON

GET Get archived PDF

Findings

GET Get all findings

PUT Replace all findings

POST Add a finding

PUT Update a finding

DELETE Delete a finding

Snapshots

GET Get snapshot history

POST Create a snapshot

GET Get active snapshot

GET Get a snapshot

GET Get snapshot diff

Review Comments

GET Get all comments

POST Create a comment

GET Get comment counts

PUT Update a comment

DELETE Delete a comment

PATCH Toggle resolved

Report Notes

GET Get notes for report

POST Create report note

GET Get a note

PUT Update a note

DELETE Delete a note

Attachments

GET Get all attachments

POST Upload attachment

GET Get report attachments

DELETE Delete attachment

AI

POST Generate vulnerability

POST Translate vulnerability

POST Generate report content

POST Improve report content

POST Generate finding

Images

GET Get all images

POST Upload image

GET Get note images

GET Get template images

DELETE Delete image

Troubleshooting

Login & Authentication

Reset a User Password (Container)

SSO / LDAP Issues

Connection Issues

Upload Failures

Export Failures

Template Rendering Errors

Performance Issues

Error Messages Reference

Getting Support

Support

API Reference

On this page

Loading API Reference...

Pager

Next pageIntroduction