Skip to main content
POST
/
assessments
/
{assessmentId}
/
stop
Stop an assessment and cancel the latest run
curl --request POST \
  --url https://api.gominerva.com/risk-assessments/v2/assessments/{assessmentId}/stop \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "run_id": "<string>",
  "reason": "<string>"
}
'
{
  "status": 200,
  "msg": "OK",
  "result": {}
}

Authorizations

​
Authorization
string
header
required

Use the format Api-Key YOUR_API_KEY.

Path Parameters

​
assessmentId
string
required

Risk assessment id.

Body

application/json
​
run_id
string
​
reason
string

Response

Accepted

​
status
integer
required
Example:

200

​
msg
string
required
Example:

"OK"

​
result
object
required