Skip to main content
GET
Get Sandbox Schedule

Authorizations

Authorization
string
header
required

OAuth2 authentication with JWT tokens

Scopes

sandboxes:get

Get sandbox details

Path Parameters

sandboxName
string
required

Name of the Sandbox

scheduleId
string
required

Id of the Schedule

Response

200 - application/json

successful operation

A scheduled task that executes a process inside the sandbox at specified times. Stored in the dedicated schedules table (no longer embedded in the sandbox spec).

createdAt
string
read-only

Creation timestamp (read-only).

id
string

Unique identifier for this schedule within its sandbox. Auto-generated if not provided.

Example:

"schedule-0"

input
object

Process execution configuration for a scheduled sandbox task

maxExecutions
integer

Maximum number of execution records kept for this schedule. Once reached, recording a new execution deletes the oldest. Defaults to 100.

Example:

100

sandbox
string
read-only

Name of the sandbox this schedule belongs to.

type
enum<string>

Type of schedule timing. 'cron' for recurring (5-field expression), 'at' for a specific RFC 3339 datetime, 'sleep' for a duration from now (resolved to 'at' on creation).

Available options:
cron,
at,
sleep
Example:

"cron"

value
string

Timing value. For 'cron': a 5-field cron expression (e.g. '0 8 * * 1-5'). For 'at': an RFC 3339 datetime (e.g. '2026-07-01T09:00:00Z'). For 'sleep': a duration (e.g. '2h', '30m', '7d').

Example:

"0 8 * * 1-5"