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
      }
    }
  ],
  "labels": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "assetGroup": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assetIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  },
  "safeHarborAssetIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "assignedTo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "locked": true,
  "note": "<string>"
}
'
{
  "msg": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.cantina.xyz/llms.txt

Use this file to discover all available pages before exploring further.

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.

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