API Reference

Update schedule

put
https://platform-reporting.vertexcloud.com/api/v1/schedules/

Update an existing schedule. All updatable fields are replaced with the values provided in the request.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

UUID of the schedule

Body Params
string

Human-readable name of the schedule

string | null

Optional description of the schedule

string
enum

Schedule type

Allowed:
string
enum

Recurrence frequency for a schedule

Allowed:
date | null

Last date on which the schedule can run (inclusive). null means the schedule does not have a fixed end date

string | null
enum

Day of the week for weekly recurrence

Allowed:
int32 | null
1 to 31

Day of month on which the schedule runs when using MONTHLY frequency

string

Time of day at which the schedule triggers, in HH:mm format

boolean

Indicates whether the schedule is enabled

Responses

Updated 3 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 3 months ago