Skip to main content
PATCH
/
api
/
v0
/
repositories
/
{repo_id}
/
findings
/
{finding_ref}
Update an existing finding in a repository.
curl --request PATCH \
  --url https://api.example.com/api/v0/repositories/{repo_id}/findings/{finding_ref} \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "reward": "<string>",
  "fixedBy": [
    "<string>"
  ],
  "duplicateOf": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "duplicateGroup": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "category": "<string>",
  "relatedFiles": [
    {
      "path": "<string>",
      "lines": {
        "start": 123,
        "end": 123
      },
      "action": "add"
    }
  ],
  "labels": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "action": "add"
    }
  ],
  "assetGroup": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assetIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "action": "replace"
  },
  "safeHarborAssetIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "assignedTo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "locked": true,
  "note": "<string>"
}
'
import requests

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

payload = {
    "title": "<string>",
    "description": "<string>",
    "reward": "<string>",
    "fixedBy": ["<string>"],
    "duplicateOf": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "duplicateGroup": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "category": "<string>",
    "relatedFiles": [
        {
            "path": "<string>",
            "lines": {
                "start": 123,
                "end": 123
            },
            "action": "add"
        }
    ],
    "labels": [
        {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "action": "add"
        }
    ],
    "assetGroup": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "assetIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
        "action": "replace"
    },
    "safeHarborAssetIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "assignedTo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "locked": True,
    "note": "<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({
    title: '<string>',
    description: '<string>',
    reward: '<string>',
    fixedBy: ['<string>'],
    duplicateOf: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    duplicateGroup: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    category: '<string>',
    relatedFiles: [{path: '<string>', lines: {start: 123, end: 123}, action: 'add'}],
    labels: [{id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', action: 'add'}],
    assetGroup: {
      id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      assetIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
      action: 'replace'
    },
    safeHarborAssetIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    assignedTo: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    locked: true,
    note: '<string>'
  })
};

fetch('https://api.example.com/api/v0/repositories/{repo_id}/findings/{finding_ref}', 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}",
  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([
    'title' => '<string>',
    'description' => '<string>',
    'reward' => '<string>',
    'fixedBy' => [
        '<string>'
    ],
    'duplicateOf' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'duplicateGroup' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'category' => '<string>',
    'relatedFiles' => [
        [
                'path' => '<string>',
                'lines' => [
                                'start' => 123,
                                'end' => 123
                ],
                'action' => 'add'
        ]
    ],
    'labels' => [
        [
                'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'action' => 'add'
        ]
    ],
    'assetGroup' => [
        'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'assetIds' => [
                '3c90c3cc-0d44-4b50-8888-8dd25736052a'
        ],
        'action' => 'replace'
    ],
    'safeHarborAssetIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'assignedTo' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'locked' => true,
    'note' => '<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}"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"reward\": \"<string>\",\n  \"fixedBy\": [\n    \"<string>\"\n  ],\n  \"duplicateOf\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"duplicateGroup\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"category\": \"<string>\",\n  \"relatedFiles\": [\n    {\n      \"path\": \"<string>\",\n      \"lines\": {\n        \"start\": 123,\n        \"end\": 123\n      },\n      \"action\": \"add\"\n    }\n  ],\n  \"labels\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"action\": \"add\"\n    }\n  ],\n  \"assetGroup\": {\n    \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"assetIds\": [\n      \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    ],\n    \"action\": \"replace\"\n  },\n  \"safeHarborAssetIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"assignedTo\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"locked\": true,\n  \"note\": \"<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}")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"reward\": \"<string>\",\n  \"fixedBy\": [\n    \"<string>\"\n  ],\n  \"duplicateOf\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"duplicateGroup\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"category\": \"<string>\",\n  \"relatedFiles\": [\n    {\n      \"path\": \"<string>\",\n      \"lines\": {\n        \"start\": 123,\n        \"end\": 123\n      },\n      \"action\": \"add\"\n    }\n  ],\n  \"labels\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"action\": \"add\"\n    }\n  ],\n  \"assetGroup\": {\n    \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"assetIds\": [\n      \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    ],\n    \"action\": \"replace\"\n  },\n  \"safeHarborAssetIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"assignedTo\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"locked\": true,\n  \"note\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

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

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  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"reward\": \"<string>\",\n  \"fixedBy\": [\n    \"<string>\"\n  ],\n  \"duplicateOf\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"duplicateGroup\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"category\": \"<string>\",\n  \"relatedFiles\": [\n    {\n      \"path\": \"<string>\",\n      \"lines\": {\n        \"start\": 123,\n        \"end\": 123\n      },\n      \"action\": \"add\"\n    }\n  ],\n  \"labels\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"action\": \"add\"\n    }\n  ],\n  \"assetGroup\": {\n    \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"assetIds\": [\n      \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    ],\n    \"action\": \"replace\"\n  },\n  \"safeHarborAssetIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"assignedTo\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"locked\": true,\n  \"note\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "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
​
title
string | null
​
description
string | null
​
reward
string | null
​
status
null | enum<string>

Status of a [Finding]. Note that the in_review status is only applicable within bounties.

Available options:
new,
in_review,
disputed,
rejected,
spam,
duplicate,
confirmed,
acknowledged,
fixed,
withdrawn
​
fixedBy
string[] | null

When this field is set it overwrites the existing value, i.e. all URLs must be provided.

​
duplicateOf

Only valid if the status is set to duplicate.

​
duplicateGroup
string<uuid> | null
​
severity
null | enum<string>

Severity of a [Finding].

Available options:
critical,
high,
medium,
low,
informational,
gas_optimization
​
likelihood
null | enum<string>

Likelihood of a [Finding].

Available options:
high,
medium,
low
​
impact
null | enum<string>

Impact of a [Finding].

Available options:
high,
medium,
low
​
quality
null | enum<string>

Can only be set by judges, triagers and admins.

Available options:
high,
medium,
low
​
category
string | null

Can only be set by admins.

​
relatedFiles
object[]

Delete or add a related file to a finding.

​
labels
object[]

Delete or add labels to a finding.

​
assetGroup
object

Delete or add asset groups to a finding.

​
safeHarborAssetIds
string<uuid>[] | null
​
assignedTo
string<uuid> | null

Assign the finding to a user by id.

​
locked
boolean | null

Update the locked state of the finding.

​
note
string | null

Note field for additional finding information.

Response

Finding updated