Skip to main content
PATCH
/
api
/
v0
/
repositories
/
{repo_id}
/
findings
/
{finding_ref}
/
escalate
Escalate an existing finding in a repository and make a comment explaining why.
curl --request PATCH \
  --url https://api.example.com/api/v0/repositories/{repo_id}/findings/{finding_ref}/escalate \
  --header 'Content-Type: application/json' \
  --data '
{
  "commentContent": "<string>"
}
'
import requests

url = "https://api.example.com/api/v0/repositories/{repo_id}/findings/{finding_ref}/escalate"

payload = { "commentContent": "<string>" }
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({commentContent: '<string>'})
};

fetch('https://api.example.com/api/v0/repositories/{repo_id}/findings/{finding_ref}/escalate', 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.example.com/api/v0/repositories/{repo_id}/findings/{finding_ref}/escalate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'commentContent' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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.example.com/api/v0/repositories/{repo_id}/findings/{finding_ref}/escalate"

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

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

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.patch("https://api.example.com/api/v0/repositories/{repo_id}/findings/{finding_ref}/escalate")
.header("Content-Type", "application/json")
.body("{\n \"commentContent\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v0/repositories/{repo_id}/findings/{finding_ref}/escalate")

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

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

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
{
"msg": "<string>"
}
{
"msg": "<string>"
}
{
"msg": "<string>"
}
{
"msg": "<string>"
}
{
"msg": "<string>"
}

Path Parameters

repo_id
string<uuid>
required
finding_ref
required

Reference to a finding, either a finding id or finding number.

Body

application/json
commentContent
string
required

Comment will always created as a new thread (i.e. parent set to null) and as a publicly visible comment (i.e. visibility set to public).

Response

Finding escalated, returns the id of the comment

id
string<uuid>
required