ScoutsChange a report's status

Change a report's status

Triage a report. Allowed moves: open to resolved, dismissed or snoozed; snoozed to open, resolved or dismissed; dismissed to open; suppressed to open or dismissed. Resolved is terminal: a recurrence is filed as a new report. Dismissing needs a reason, which the scout reads on its next runs (for 30 days) so it stops filing the same thing. Snoozing needs snoozed_until, a future time within 90 days; the report reopens when it passes. Same read rules as GET.

curl -X PATCH "https://mythic-analytics.gulp.workers.dev/client/v1/scouts/reports/123e4567-e89b-12d3-a456-426614174000" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "status": "open",
  "reason": "example_string",
  "snoozed_until": "2024-12-25T10:00:00Z"
}'
{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "location_id": "example_string",
    "scout_id": "123e4567-e89b-12d3-a456-426614174000",
    "scout_name": "John Doe",
    "skill": "example_string",
    "run_id": "123e4567-e89b-12d3-a456-426614174000",
    "title": "example_string",
    "priority": "P0",
    "actionability": "immediately_actionable",
    "status": "open",
    "dedupe_key": "exceptions:4f2a9c",
    "families": [
      "example_string"
    ],
    "snoozed_until": "2024-12-25T10:00:00Z",
    "dismiss_reason": "example_string",
    "created_at": "2024-12-25T10:00:00Z",
    "updated_at": "2024-12-25T10:00:00Z",
    "status_changed_at": "2024-12-25T10:00:00Z",
    "edit_count": 10,
    "summary_md": "example_string",
    "actionability_explanation": "example_string",
    "suggested_action": "example_string",
    "evidence": [
      {
        "call_id": "c4",
        "run_id": "123e4567-e89b-12d3-a456-426614174000",
        "tool": "get_exception_digest",
        "family": "exceptions",
        "args": {},
        "status": 200,
        "truncated": true,
        "excerpt": "example_string",
        "note": "example_string",
        "added_at": "2024-12-25T10:00:00Z"
      }
    ],
    "history": [
      {
        "at": "2024-12-25T10:00:00Z",
        "kind": "filed",
        "run_id": "123e4567-e89b-12d3-a456-426614174000",
        "scout_id": "123e4567-e89b-12d3-a456-426614174000",
        "status": "example_string",
        "by": "example_string",
        "note": "example_string"
      }
    ],
    "provider": "example_string",
    "model_used": "example_string"
  }
}
PATCH
/client/v1/scouts/reports/{id}
PATCH
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Agency key (ak_) only; a location secret key (sk_) gets 403 agency_required. Agency-wide scoped keys (mcp_) need scouts:read or scouts:write, plus the read scope of every surface a scout's skill reads to create or run it, and of every surface a report's run read to open it.

Agency key (ak_) only; a location secret key (sk_) gets 403 agency_required. Agency-wide scoped keys (mcp_) need scouts:read or scouts:write, plus the read scope of every surface a scout's skill reads to create or run it, and of every surface a report's run read to open it.
Content-Typestring
Required

The media type of the request body

Options: application/json
statusstring
Required
Options: open, snoozed, resolved, dismissed
reasonstring

Required when dismissing. Optional note otherwise; recorded in history.

Max length: 1000
snoozed_untilstring

Required when snoozing; only valid when snoozing.

Format: date-time
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Agency key (ak_) only; a location secret key (sk_) gets 403 agency_required. Agency-wide scoped keys (mcp_) need scouts:read or scouts:write, plus the read scope of every surface a scout's skill reads to create or run it, and of every surface a report's run read to open it.

Path Parameters

Body

application/json
statusstring
Required
Allowed values:opensnoozedresolveddismissed
reasonstring

Required when dismissing. Optional note otherwise; recorded in history.

snoozed_untilstring

Required when snoozing; only valid when snoozing.

Responses

successboolean
datastring