Skip to main content
POST
/
api
/
detections
/
hits
/
{hitId}
/
status
cURL
curl -X POST "https://app.cotool.ai/api/detections/hits/:hitId/status" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"open","reason":"string"}'
{
  "hit": {
    "id": "<string>",
    "detectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "detectionName": "<string>",
    "detectionDescription": "<string>",
    "detectionCategory": "<string>",
    "detectionSiemType": "<string>",
    "runId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "runTitle": "<string>",
    "runCreatedAt": "<string>",
    "status": "open",
    "statusHistory": [
      {
        "status": "open",
        "at": "2023-11-07T05:31:56Z",
        "by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "reason": "<string>"
      }
    ],
    "entityType": "<string>",
    "confidence": 123,
    "evidence": [
      "<string>"
    ],
    "summary": "<string>",
    "headline": "<string>",
    "cta": "<string>",
    "statistics": [
      "<string>"
    ],
    "severity": "low",
    "entity": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.cotool.ai/llms.txt

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

Authorizations

Authorization
string
header
required

API Key authentication for programmatic access. Include your API key in the Authorization header as: Bearer your_api_key_here

Path Parameters

hitId
string<uuid>
required

Detection hit UUID

Body

application/json
status
enum<string>
required

New lifecycle status for the hit

Available options:
open,
dismissed_fp,
dismissed_tpb,
resolved_tp,
dismissed_old
reason
string

Optional analyst comment explaining the status change

Required string length: 1 - 2000

Response

200 - application/json

Successful response

hit
object
required