Skip to main content
PUT
Set run window

Authorizations

cc-key
string
header
required

API key-based authentication. Provide your CloudCruise API key in the cc-key header.

Headers

cc-key
string

CloudCruise API key for authentication

Path Parameters

workflow_id
string
required

The ID of the workflow

Body

application/json

A run window. For any date, dated special hours win over recurring special hours, which win over regular hours. Needs at least one regular period or one active special entry.

time_zone
string
required

IANA time zone the hours are evaluated in

Example:

"America/Chicago"

regular_hours
object[]
required
special_hours
object[]

Response

The stored run window, whether it is open now, and any warnings

run_window
object | null

A run window. For any date, dated special hours win over recurring special hours, which win over regular hours. Needs at least one regular period or one active special entry.

state
object | null
warnings
object[]