Skip to main content
PUT

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organization_id
string
required

The unique identifier of the organization

Maximum string length: 24
Pattern: ^[0-9a-f]{24}$
workspace_group_id
string
required

The unique identifier of the workspace group

Maximum string length: 24
Pattern: ^[0-9a-f]{24}$
schedule_id
string
required

The unique ID of the schedule to be updated.

Maximum string length: 24
Pattern: ^[0-9a-f]{24}$

Body

application/json
cron_expression
string
required

Cron expression that defines when the schedule should be executed. Format: minute hour day-of-month month day-of-week. Examples: '0 8 * * 1-5' (8 AM weekdays), '0 0 * * 0' (midnight on Sunday), '30 14 * * (2:30 PM daily). Day-of-week: 0=Sunday, 1=Monday, ..., 6=Saturday. Supports ranges (1-5), lists (1,3,5), and wildcards (). Must be a valid cron expression format with 5 space-separated fields.

Example:

"0 8 * * 1-5"

time_zone
string
required

Timezone for the execution of the schedule. Supports IANA identifiers (e.g., 'America/New_York') and Windows identifiers (e.g., 'Pacific Standard Time').

Example:

"Eastern Standard Time"

type
enum<string>
required

Type of power operation to perform. START: Turns on the group's Workspaces. STOP: Turns off the group's Workspaces. RESTART: Restarts the group's Workspaces.

Available options:
start,
stop,
restart
Example:

"start"

intermediate_device
string

Optional. The unique identifier of the Workspace intermediate device. If provided, indicates that an intermediate device should be used for Wake-on-LAN operations. Only applicable to START schedules. Used for secure network Wake-on-LAN actions. The Workspace must exist and belong to the organization. To remove an intermediate device, omit this field.

Maximum string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"507f1f77bcf86cd799439050"

Response

Schedule updated successfully. The response contains the updated schedule resource.

id
string
required

The unique identifier of the schedule

Pattern: ^[0-9a-f]{24}$
Example:

"507f1f77bcf86cd799439060"

cron_expression
string
required

Cron expression defining when the schedule runs. Format: minute hour day-of-month month day-of-week.

Example:

"0 8 * * 1-5"

time_zone
string
required

Timezone for the execution of the schedule. Supports IANA identifiers (e.g., 'America/New_York') and Windows identifiers (e.g., 'Pacific Standard Time').

Example:

"Eastern Standard Time"

type
enum<string>
required

Power operation type: START (switch on), STOP (switch off), RESTART (restart Workspaces)

Available options:
start,
stop,
restart
intermediate_device
string | null

The unique identifier of the intermediate device Workspace, if configured. Used for Wake on LAN actions in secure networks.

Pattern: ^[0-9a-f]{24}$
Example:

"507f1f77bcf86cd799439050"

created_by
string | null

User ID who created the schedule

Pattern: ^[0-9a-f]{24}$
Example:

"507f1f77bcf86cd799439070"