schedules

Update Schedule

patch/api/v1/schedules/{schedule_id}

Request

  • Base URL: https://api.badgeia.com
  • URL: https://api.badgeia.com/api/v1/schedules/{schedule_id}
  • Auth: none declared

Path parameters

schedule_idstring uuid required

Request body

is_activeboolean nullable
cadence'daily' | 'weekly' | 'on_blueprint_change' nullable
hour_utcinteger nullable
weekdayinteger nullable
window_minutesinteger nullable
run_count_kinteger nullable

Response

Successful Response

idstring uuid required
agent_idstring uuid required
team_idstring uuid nullable required
run_requestobject required
cadence'daily' | 'weekly' | 'on_blueprint_change' required
hour_utcinteger required
weekdayinteger nullable required
window_minutesinteger required
run_count_kinteger required
budget_cap_usd_per_runstring nullable required
budget_cap_usd_per_monthstring nullable required
spent_usd_monthstring required
consecutive_failuresinteger required
paused_reason'budget' | 'endpoint_failures' | 'owner' | 'access_lost' | 'plan' | 'config' nullable required
is_activeboolean required
next_run_atstring date-time nullable required
last_run_atstring date-time nullable required
last_screening_session_idstring uuid nullable required
created_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.