Skip to main content
PATCH
/
projects
/
{id}
/
schedule
Update the project's scan schedule
curl --request PATCH \
  --url https://openlens.com/api/projects/{id}/schedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true,
  "hour": 11
}
'
{
  "enabled": true,
  "hour": 123,
  "nextScheduledRunAt": "2023-11-07T05:31:56Z",
  "pauseReason": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.openlens.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Body

application/json
​
enabled
boolean
required
​
frequency
enum<string>
Available options:
daily,
weekly,
monthly
​
hour
integer
Required range: 0 <= x <= 23

Response

Successful response

​
enabled
boolean
​
frequency
enum<string>
Available options:
daily,
weekly,
monthly
​
hour
integer
​
nextScheduledRunAt
string<date-time> | null
​
pauseReason
string | null