Add a steering note
Steer the scout with a short note, such as ignore /docs pages or Black Friday sale runs Nov 25-30. At most 500 characters and 20 active notes per scout (422 note_limit).
curl -X POST "https://mythic-analytics.gulp.workers.dev/client/v1/scouts/123e4567-e89b-12d3-a456-426614174000/notes" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
"body": "example_string",
"expires_at": "2024-12-25T10:00:00Z"
}'
import requests
import json
url = "https://mythic-analytics.gulp.workers.dev/client/v1/scouts/123e4567-e89b-12d3-a456-426614174000/notes"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
"body": "example_string",
"expires_at": "2024-12-25T10:00:00Z"
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://mythic-analytics.gulp.workers.dev/client/v1/scouts/123e4567-e89b-12d3-a456-426614174000/notes", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
},
body: JSON.stringify({
"body": "example_string",
"expires_at": "2024-12-25T10:00:00Z"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"body": "example_string",
"expires_at": "2024-12-25T10:00:00Z"
}`)
req, err := http.NewRequest("POST", "https://mythic-analytics.gulp.workers.dev/client/v1/scouts/123e4567-e89b-12d3-a456-426614174000/notes", 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/scouts/123e4567-e89b-12d3-a456-426614174000/notes')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
"body": "example_string",
"expires_at": "2024-12-25T10:00:00Z"
}'
response = http.request(request)
puts response.body
{
"success": true,
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"scout_id": "123e4567-e89b-12d3-a456-426614174000",
"body": "example_string",
"expires_at": "2024-12-25T10:00:00Z",
"active": true,
"source_report_id": "123e4567-e89b-12d3-a456-426614174000",
"families": [
"example_string"
],
"created_by": "example_string",
"created_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": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
{
"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"
}
]
}
/client/v1/scouts/{id}/notesTarget 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 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.
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.The media type of the request body
When the note stops applying: a future time within 366 days. Null or omitted: no end.
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 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
When the note stops applying: a future time within 366 days. Null or omitted: no end.