Pools

Start a future shadow observation cycle

Requires an account admin, active Predict, active Route authorization and the kill switch off. Starts at the next complete UTC hour and runs for 168 hours. Starting the same configuration within one hour returns the existing cycle. No action is applied by shadow mode.

post/v1/pools/{id}/shadow-runs

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    HTTP bearer

Path parameters

idstring required

Request body

kind'idle_reclaim' | 'defragment' | 'drain_window' | 'wait_tuning' required
level'off' | 'recommend' | 'approve' | 'auto' required
window_cronstring required

Weekly UTC minute hour * * weekday. Minute, hour and weekday accept *, integer lists and inclusive ranges. No steps, names, macros, duplicate values or leading zeros. Weekday 0 is Sunday.

parallelism_capinteger required

Response

Start a future shadow observation cycle

idstring required
pool_idstring required
kind'idle_reclaim' | 'defragment' | 'drain_window' | 'wait_tuning' required
window_cronstring required

Weekly UTC minute hour * * weekday. Minute, hour and weekday accept *, integer lists and inclusive ranges. No steps, names, macros, duplicate values or leading zeros. Weekday 0 is Sunday.

parallelism_capinteger required
cycle_startstring date-time required
cycle_endstring date-time required
state'running' | 'completed' required
ended_atstring date-time nullable required
trusted_hoursinteger required
elapsed_hoursinteger required
gap_hoursinteger required
would_have_actedinteger required

Sum of counterfactual action counts from trusted observations. Never measured savings or an applied-action count.

producer_availableboolean required
qualifies_autoboolean required

This exact cycle has 168 trusted hours, is completed and ended within 30 days. Current entitlement, policy, permissions and kill switch are checked separately.

Changes

No recorded changes to this operation across all 70 revisions of this API.