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
}'
import requests
import json
url = "https://mythic-analytics.gulp.workers.dev/client/v1/replay-vision/scouts/123e4567-e89b-12d3-a456-426614174000"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
"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
}
response = requests.patch(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://mythic-analytics.gulp.workers.dev/client/v1/replay-vision/scouts/123e4567-e89b-12d3-a456-426614174000", {
method: "PATCH",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
},
body: JSON.stringify({
"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
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"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
}`)
req, err := http.NewRequest("PATCH", "https://mythic-analytics.gulp.workers.dev/client/v1/replay-vision/scouts/123e4567-e89b-12d3-a456-426614174000", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://mythic-analytics.gulp.workers.dev/client/v1/replay-vision/scouts/123e4567-e89b-12d3-a456-426614174000')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
"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
}'
response = http.request(request)
puts response.body
{
"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"
}
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Error",
"message": "feature_not_in_plan: the client's plan does not include Logs.",
"code": 402
}
{
"error": "Forbidden",
"message": "You don't have permission to access this resource",
"code": 403
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
{
"error": "Conflict",
"message": "The request conflicts with the current state of the resource",
"code": 409,
"details": "Resource already exists"
}
{
"error": "Unprocessable Entity",
"message": "The request was well-formed but contains semantic errors",
"code": 422,
"details": [
{
"field": "password",
"message": "Password must be at least 8 characters long"
}
]
}
{
"error": "Service Unavailable",
"message": "The service is temporarily unavailable. Please try again later",
"code": 503
}
/client/v1/replay-vision/scouts/{id}Target server for requests. Edit to use your own host.
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.
ak_) only; a location secret key (sk_) gets 403 agency_required. Agency-wide scoped keys (mcp_) need replay_vision:read or replay_vision:write.The media type of the request body
Immutable: may only restate the Scout's current sources; a change is 422 sources_immutable.
Read-only text instructions; replace explicit placeholder values, not ordinary API/CRM uppercase words. Omit for template defaults.
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
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
Immutable: may only restate the Scout's current sources; a change is 422 sources_immutable.
Read-only text instructions; replace explicit placeholder values, not ordinary API/CRM uppercase words. Omit for template defaults.
Input schedule fields are optional and merge with template/current defaults. Public Scouts always have kind/time/timezone; weekly also has day_of_week.