Skip to main content
POST
/
api
/
org
/
projects
/
{shortcode}
/
findings
/
{ref}
curl --request POST \
  --url https://{host}/api/org/projects/{shortcode}/findings/{ref} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Token: <api-key>' \
  --data '
{
  "action": "comment",
  "comment": "This is a test comment"
}
'
{
  "msg": "OK"
}

Authorizations

​
X-API-Token
string
header
required

API key for authentication

Path Parameters

​
shortcode
string
required

Project shortcode identifier

​
ref
string
required

Issue/finding reference identifier

Body

application/json
​
action
enum<string>
required

Action type for adding a comment

Available options:
comment
​
comment
string
required

The comment text to add

Response

Action performed successfully

​
msg
string
Example:

"OK"