Replay VisionUpdate Scout

Update Scout

Merged configuration; scanner/template/sources immutable (422 sources_immutable), unknown fields rejected. Pause cancels pending runs, finish rechecks lifecycle. Version conflict 409. Any PATCH of a Scout that reads server logs re-checks logs:read, the Logs plan feature and privacy; a pause-only PATCH ({enabled:false}) skips the plan and privacy checks.

curl -X PATCH "https://mythic-analytics.gulp.workers.dev/client/v1/replay-vision/scouts/123e4567-e89b-12d3-a456-426614174000" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "name": "John Doe",
  "sources": [
    "observations"
  ],
  "instructions": "example_string",
  "schedule": {
    "kind": "daily",
    "time": "example_string",
    "day_of_week": 42,
    "timezone": "example_string"
  },
  "delivery": {
    "channel_ids": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  },
  "enabled": true
}'
{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "scanner_id": "123e4567-e89b-12d3-a456-426614174000",
    "location_id": "example_string",
    "name": "John Doe",
    "template": "example_string",
    "instructions": "example_string",
    "schedule": {
      "kind": "daily",
      "time": "example_string",
      "day_of_week": 42,
      "timezone": "example_string"
    },
    "delivery": {
      "channel_ids": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    },
    "enabled": true,
    "version": 42,
    "next_run_at": "2024-12-25T10:00:00Z",
    "last_run_at": "2024-12-25T10:00:00Z",
    "last_report_at": "2024-12-25T10:00:00Z",
    "last_error": "example_string",
    "latest_report_id": "123e4567-e89b-12d3-a456-426614174000",
    "sources": [
      "observations"
    ],
    "current_run": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "pending",
      "scheduled_for": "2024-12-25T10:00:00Z",
      "triggered_by": "schedule",
      "attempts": 42
    },
    "can_run_now": true,
    "created_at": "2024-12-25T10:00:00Z",
    "updated_at": "2024-12-25T10:00:00Z"
  }
}
PATCH
/client/v1/replay-vision/scouts/{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 replay_vision:read or replay_vision:write.

Agency key (ak_) only; a location secret key (sk_) gets 403 agency_required. Agency-wide scoped keys (mcp_) need replay_vision:read or replay_vision:write.
Content-Typestring
Required

The media type of the request body

Options: application/json
namestring
Min length: 1 • Max length: 120
sourcesarray

Immutable: may only restate the Scout's current sources; a change is 422 sources_immutable.

instructionsstring

Read-only text instructions; replace explicit placeholder values, not ordinary API/CRM uppercase words. Omit for template defaults.

Min length: 1 • Max length: 12000
scheduleobject

Input schedule fields are optional and merge with template/current defaults. Public Scouts always have kind/time/timezone; weekly also has day_of_week.

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 replay_vision:read or replay_vision:write.

Path Parameters

Body

application/json
sourcesarray

Immutable: may only restate the Scout's current sources; a change is 422 sources_immutable.

instructionsstring

Read-only text instructions; replace explicit placeholder values, not ordinary API/CRM uppercase words. Omit for template defaults.

scheduleobject

Input schedule fields are optional and merge with template/current defaults. Public Scouts always have kind/time/timezone; weekly also has day_of_week.

deliveryobject

Responses

successboolean
dataobject