Skip to main content
POST
/
api
/
projects
/
{project_id}
/
schedule
Upsert Project Schedule
curl --request POST \
  --url https://api.example.com/api/projects/{project_id}/schedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scan_types": [
    "<string>"
  ],
  "enabled": true,
  "day_of_week": 123,
  "time_of_day": "03:00"
}
'
{
  "uuid": "<string>",
  "enabled": true,
  "scan_types": [
    "<string>"
  ],
  "frequency": "<string>",
  "time_of_day": "<string>",
  "dataset_id": 123,
  "project_id": 123,
  "day_of_week": 123,
  "last_run_at": "2023-11-07T05:31:56Z",
  "next_run_at": "2023-11-07T05:31:56Z",
  "last_run_status": "<string>",
  "run_count": 0,
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

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

Headers

X-API-Key
string | null

Path Parameters

project_id
string
required

Cookies

antidote_session
string | null

Body

application/json
scan_types
string[]
required
frequency
enum<string>
required
Available options:
daily,
weekly,
monthly
enabled
boolean
default:true
day_of_week
integer | null
time_of_day
string
default:03:00

Response

Successful Response

uuid
string
required
enabled
boolean
required
scan_types
string[]
required
frequency
string
required
time_of_day
string
required
dataset_id
integer | null
project_id
integer | null
day_of_week
integer | null
last_run_at
string<date-time> | null
next_run_at
string<date-time> | null
last_run_status
string | null
run_count
integer
default:0
created_at
string<date-time> | null