Dismiss vulnerability

POST

vulnerabilities

{vulnerabilityId}

dismiss

curl --request POST \
  --url https://api.perfai.ai/v1/vulnerabilities/{vulnerabilityId}/dismiss \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "comment": "<string>"
}
'

import requests

url = "https://api.perfai.ai/v1/vulnerabilities/{vulnerabilityId}/dismiss"

payload = { "comment": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({comment: '<string>'})
};

fetch('https://api.perfai.ai/v1/vulnerabilities/{vulnerabilityId}/dismiss', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.perfai.ai/v1/vulnerabilities/{vulnerabilityId}/dismiss",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'comment' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.perfai.ai/v1/vulnerabilities/{vulnerabilityId}/dismiss"

	payload := strings.NewReader("{\n  \"comment\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.perfai.ai/v1/vulnerabilities/{vulnerabilityId}/dismiss")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"comment\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.perfai.ai/v1/vulnerabilities/{vulnerabilityId}/dismiss")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"comment\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": "DISMISSED",
  "vulnerability": {
    "id": "<string>",
    "label": "<string>",
    "title": "<string>",
    "severity": "Critical",
    "path": "<string>",
    "method": "<string>",
    "uiPath": "<string>",
    "updated_severity": "<string>",
    "impact": "<string>",
    "issueType": "<string>",
    "action": "<string>",
    "intent": "<string>",
    "owasp": "<string>",
    "cwe": "<string>",
    "cvss_score": 123,
    "cvss_vector": "<string>",
    "isPII": true,
    "isPCI": true,
    "isHIPAA": true,
    "explainer": "<string>",
    "remediation": "<string>",
    "additionalDetails": {},
    "request": "<string>",
    "response": {},
    "unsecureRequest": "<string>",
    "unsecuredResponse": {},
    "requestSchema": {},
    "responseSchema": {},
    "fields": [
      {}
    ],
    "isFixed": true,
    "isDismissed": true,
    "fixClaimed": true,
    "fixClaimedAt": "2023-11-07T05:31:56Z",
    "fixClaimedByEmail": "<string>",
    "fixComment": "<string>",
    "isCustomIssue": true,
    "created_on": "2023-11-07T05:31:56Z",
    "updated_on": "2023-11-07T05:31:56Z"
  }
}

{
  "type": "<string>",
  "title": "<string>"
}

Authorizations

Authorization

string

header

required

JWT login token tied to your Perfai user (not a separate API key). Obtain it via POST /api/v1/auth/token with your username and password (use the returned id_token) — the same login the web console performs. Carries org, user, and role; short-lived.

Path Parameters

vulnerabilityId

string

required

MongoDB ObjectId of the finding — the id of an item from GET /apps/{appId}/vulnerabilities.

Body

application/json

comment

string

Why the finding was dismissed or marked fixed. Stored on the finding and, for dismissals, on the audit record.

Maximum string length: 1000

Response

Finding dismissed.

status

enum<string>

required

State of the finding after the action.

Available options:

DISMISSED,

FIX_CLAIMED,

OPEN

vulnerability

object

required

A security finding, projected onto the public contract — internal test plumbing (token, decodedKey, errors, buildDetails) is never emitted. This is the same detail the Perfai dashboard shows a user. Only id, label, severity, path and method are present on every finding; every other field is conditional and omitted when the scan produced no value for it.

Show child attributes

Dismiss vulnerability

curl --request POST \
  --url https://api.perfai.ai/v1/vulnerabilities/{vulnerabilityId}/dismiss \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "comment": "<string>"
}
'

import requests

url = "https://api.perfai.ai/v1/vulnerabilities/{vulnerabilityId}/dismiss"

payload = { "comment": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({comment: '<string>'})
};

fetch('https://api.perfai.ai/v1/vulnerabilities/{vulnerabilityId}/dismiss', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.perfai.ai/v1/vulnerabilities/{vulnerabilityId}/dismiss",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'comment' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.perfai.ai/v1/vulnerabilities/{vulnerabilityId}/dismiss"

	payload := strings.NewReader("{\n  \"comment\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.perfai.ai/v1/vulnerabilities/{vulnerabilityId}/dismiss")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"comment\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.perfai.ai/v1/vulnerabilities/{vulnerabilityId}/dismiss")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"comment\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": "DISMISSED",
  "vulnerability": {
    "id": "<string>",
    "label": "<string>",
    "title": "<string>",
    "severity": "Critical",
    "path": "<string>",
    "method": "<string>",
    "uiPath": "<string>",
    "updated_severity": "<string>",
    "impact": "<string>",
    "issueType": "<string>",
    "action": "<string>",
    "intent": "<string>",
    "owasp": "<string>",
    "cwe": "<string>",
    "cvss_score": 123,
    "cvss_vector": "<string>",
    "isPII": true,
    "isPCI": true,
    "isHIPAA": true,
    "explainer": "<string>",
    "remediation": "<string>",
    "additionalDetails": {},
    "request": "<string>",
    "response": {},
    "unsecureRequest": "<string>",
    "unsecuredResponse": {},
    "requestSchema": {},
    "responseSchema": {},
    "fields": [
      {}
    ],
    "isFixed": true,
    "isDismissed": true,
    "fixClaimed": true,
    "fixClaimedAt": "2023-11-07T05:31:56Z",
    "fixClaimedByEmail": "<string>",
    "fixComment": "<string>",
    "isCustomIssue": true,
    "created_on": "2023-11-07T05:31:56Z",
    "updated_on": "2023-11-07T05:31:56Z"
  }
}

{
  "type": "<string>",
  "title": "<string>"
}

Getting Started

Core Concepts

Hybrid Deployment

Changelog

Authorizations

Path Parameters

Body

Response