ScoutsRun a scout now

Run a scout now

Queue a run now. The body must be empty or {}. The scout must be enabled (409 scout_paused) with no run pending or running (409 run_in_progress). Same plan, model key and scope checks as a create, on the scout's stored provider. Runs start within a minute and usually take 1 to 5 minutes; follow them with GET /scouts/{id}/runs.

curl -X POST "https://mythic-analytics.gulp.workers.dev/client/v1/scouts/123e4567-e89b-12d3-a456-426614174000/run" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "success": true,
  "data": {
    "run_id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "pending"
  }
}
POST
/client/v1/scouts/{id}/run
POST
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
No request body parameters defined
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
dataobject
Required

Raw application/json data

Responses