---
updatedAt: 2026-05-12T10:00:33.000Z
---

# Add vulnerability note

This operation allows you to create a new note regarding the specified vulnerability on the specified asset.

# OpenAPI definition

```json
{
  "components": {
    "responses": {
      "BadRequestResponse": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorMessage"
            }
          }
        },
        "description": "BadRequestResponse indicates a request with invalid parameters"
      },
      "GenericError": {
        "description": "GenericError generic error"
      },
      "UnauthorizedResponse": {
        "description": "UnauthorizedResponse signals an unauthorized API access"
      },
      "VulnerabilityNotesResponse": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/vulnerabilityNotesMessage"
            }
          }
        },
        "description": "VulnerabilityNotesResponse provides a list of vuln notes"
      }
    },
    "schemas": {
      "ErrorMessage": {
        "description": "ErrorMessage describes the error",
        "properties": {
          "code": {
            "format": "int64",
            "type": "integer"
          },
          "reason": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "VulnNotes": {
        "description": "VulnNotes is vulnerability developer notes",
        "properties": {
          "asset_id": {
            "format": "int64",
            "type": "integer"
          },
          "content": {
            "type": "string"
          },
          "created_time": {
            "format": "date-time",
            "type": "string"
          },
          "id": {
            "format": "int64",
            "type": "integer"
          },
          "username": {
            "type": "string"
          },
          "vulnerability_id": {
            "format": "int64",
            "type": "integer"
          }
        },
        "type": "object"
      },
      "VulnerabilityNoteInput": {
        "description": "VulnerabilityNoteInput is note add by customer for specific vulnerability",
        "properties": {
          "content": {
            "type": "string"
          }
        },
        "required": [
          "content"
        ],
        "type": "object"
      },
      "findingsPageData": {
        "properties": {
          "currentPage": {
            "format": "int64",
            "type": "integer"
          },
          "filteredCount": {
            "format": "int64",
            "type": "integer"
          },
          "totalCount": {
            "format": "int64",
            "type": "integer"
          },
          "totalPages": {
            "format": "int64",
            "type": "integer"
          }
        },
        "type": "object"
      },
      "vulnerabilityNotesMessage": {
        "properties": {
          "collection": {
            "items": {
              "$ref": "#/components/schemas/VulnNotes"
            },
            "type": "array"
          },
          "page": {
            "$ref": "#/components/schemas/findingsPageData"
          }
        },
        "type": "object"
      }
    }
  },
  "info": {
    "license": {
      "name": "(c) Copyright 2022 WhiteHat Security"
    },
    "title": "Findings API",
    "version": "2.0.0"
  },
  "openapi": "3.0.1",
  "paths": {
    "/api/findings/{vulnIDassetID}/notes": {
      "post": {
        "description": "This operation allows you to create a new note regarding the specified vulnerability on the specified asset.",
        "operationId": "vulnerabilityNotes",
        "parameters": [
          {
            "description": "vulnIDassetID is a combination of {vulnID};assetID={assetID}\ne.g  /api/findings/{vulnID};assetID={assetID}/notes",
            "in": "path",
            "name": "vulnIDassetID",
            "required": true,
            "schema": {
              "type": "string"
            },
            "x-go-name": "VulnIDassetID"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VulnerabilityNoteInput"
              }
            }
          },
          "description": "Body of the request holds the note add by customer for specific vulnerability",
          "required": true,
          "x-go-name": "Body"
        },
        "responses": {
          "201": {
            "$ref": "#/components/responses/VulnerabilityNotesResponse"
          },
          "400": {
            "$ref": "#/components/responses/BadRequestResponse"
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedResponse"
          },
          "500": {
            "$ref": "#/components/responses/GenericError"
          }
        },
        "summary": "Add vulnerability note",
        "tags": [
          "Findings API v2.0"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://sentinel.whitehatsec.com/"
    }
  ],
  "tags": [
    {
      "name": "Findings API v2.0"
    }
  ],
  "x-explorer-enabled": false,
  "x-readme": {
    "proxy-enabled": true
  }
}
```