Get the project's scan schedule

curl --request GET \
  --url https://openlens.com/api/projects/{id}/schedule \
  --header 'Authorization: Bearer <token>'

{
  "enabled": true,
  "hour": 11,
  "nextScheduledRunAt": "2023-11-07T05:31:56Z",
  "pauseReason": "<string>"
}

GET

projects

{id}

schedule

Get the project's scan schedule

curl --request GET \
  --url https://openlens.com/api/projects/{id}/schedule \
  --header 'Authorization: Bearer <token>'

{
  "enabled": true,
  "hour": 11,
  "nextScheduledRunAt": "2023-11-07T05:31:56Z",
  "pauseReason": "<string>"
}

Authorization

string

header

required

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

string<uuid>

required

Successful response

enabled

boolean

frequency

enum<string>

Available options:

daily,

weekly,

monthly

hour

integer

Required range: 0 <= x <= 23

nextScheduledRunAt

string<date-time> | null

pauseReason

string | null

Documentation Index