Skip to main content
GET
Get the project's scan schedule

Authorizations

Authorization
string
header
required

Clerk API key. Create one from your account settings under API Keys.

Path Parameters

id
string<uuid>
required

Response

Successful response

configured
boolean
required

False until a schedule is saved for the project.

enabled
boolean
required
frequency
enum<string>
required
Available options:
daily,
weekly,
monthly
hour
integer
required
deprecated

UTC hour of startsAt (9 until configured). Prefer startsAt + timezone.

Required range: 0 <= x <= 23
startsAt
string<date-time> | null
required

The first run; later runs repeat from it in timezone. Null until configured.

timezone
string | null
required

IANA time zone the schedule repeats in. Null until configured.

nextScheduledRunAt
string<date-time> | null
required

The next run while the schedule is on; null while it is off.

upcomingRunAt
string<date-time> | null
required

When the schedule would run next, on or off: its next run, or the next occurrence of its start. Null until configured.

pauseReason
string | null
required
allowedCadences
enum<string>[]
required
Available options:
daily,
weekly,
monthly
plan
string
required
multiCountryEnabled
boolean
required

Whether the plan can schedule more than one country.

scope
object
required
estimate
object
required

Inputs for the schedule's monthly credit estimate.