Skip to main content
POST
/
schedules
Create a schedule
curl --request POST \
  --url https://app.strix.ai/api/v1/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cron_expression": "<string>",
  "timezone": "<string>",
  "name": "<string>",
  "domain_ids": [
    "<string>"
  ],
  "repository_ids": [
    "<string>"
  ],
  "concerns": "<string>",
  "focus": "<string>",
  "context": "<string>",
  "also_run_now": true
}
'
{
  "schedule_id": "<string>",
  "name": "<string>",
  "scan_id": "<string>",
  "scan_error": "<string>"
}

Authorizations

Authorization
string
header
required

API token from Settings > API Access

Body

application/json
cron_expression
string
required

Cron expression (e.g. 0 9 * * 1)

timezone
string
required

IANA timezone (e.g. America/New_York)

name
string

Schedule name (auto-generated if omitted)

domain_ids
string[]

Domain IDs to pentest

repository_ids
string[]

Repository IDs to pentest

concerns
string
focus
string
context
string
also_run_now
boolean

Trigger an immediate pentest in addition to the schedule

Response

200 - application/json

Schedule created

schedule_id
string
name
string
scan_id
string | null

Set if also_run_now was true

scan_error
string | null