UPupstash
Schedules

Get a Schedule

Changed on

Get details of a specific schedule

get/v2/schedules/{scheduleId}

Request

Path parameters

scheduleIdstring required

The ID of the schedule to retrieve.

Response

scheduleIdstring required

Unique identifier for the schedule

cronstring required

The cron expression used to schedule the message

destinationstring required

The destination URL or URL Group name

createdAtinteger required

The creation timestamp of the schedule in unix milliseconds

methodstring required

The HTTP method used for the scheduled message

headerobject

Map of header names to arrays of header values

bodystring

The body of the scheduled message

retriesinteger

The number of retries for the scheduled message

delayinteger

The delay in seconds before the scheduled message is sent

callbackstring

The callback URL for the scheduled message

failureCallbackstring

The failure callback URL for the scheduled message

callerIpstring

The IP address of the client that created the schedule

isPausedboolean required

Whether the schedule is paused

flowControlKeystring

The flow control key used for rate limiting

parallelisminteger

The parallelism value used for flow control

rateinteger

The rate value used for flow control

periodinteger

The period value used for flow control

retryDelayExpressionstring

The retry delay expression used for calculating retry delays

labelstring

The label assigned to the scheduled message. Deprecated in favor of labels.

labelsstring[]

The list of labels assigned to the scheduled message.

lastScheduleTimeinteger

The last time the schedule was triggered in unix milliseconds

nextScheduleTimeinteger

The next scheduled trigger time in unix milliseconds

lastScheduleStatesobject

The states of the last scheduled messages

Changes

  • d30bd0904328Revision changes
    • info

      added the optional property to the response with the status

    • info

      response property label deprecated

  • d859c277ced2Revision changes
    • warning

      removed the optional property from the response with the status

    • info

      response property label reactivated