disableSchedule

Agent Runtimes

---

Agent Runtimes / api/scheduler/schedules / disableSchedule

Function: disableSchedule()

disableSchedule(token, scheduleUid, baseUrl?): Promise<ScheduleResponse>

Defined in: src/api/scheduler/schedules.ts:151

Disable a schedule by uid.

Parameters

token

string

Authentication token

scheduleUid

string

The schedule uid

baseUrl?

string = DEFAULT_SERVICE_URLS.SCHEDULER

Base URL for the scheduler service (defaults to production)

Returns

Promise<ScheduleResponse>

Promise resolving to the disabled schedule