Pools

Set one complete action policy

Requires an account admin. Approve and auto require active Predict and Route with accepted current terms and the kill switch off. Auto also requires a recent complete trusted matching shadow cycle. Off and recommend can be saved without activation. Recommendations require Predict. Saving a policy does not execute an action.

put/v1/pools/{id}/action-policies

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

Set one complete action policy

pool_idstring required
kill_switchboolean required

Changes

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