Skip to main content
POST
/
scheduled
Create Scan Schedule
curl --request POST \
  --url https://api.altostrat.io/scans/cve/scheduled \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "Weekly Corporate Network Scan",
  "day_of_week": 1,
  "time_of_day": "02:00",
  "every_n_weeks": 4,
  "timezone": "Australia/Sydney",
  "min_cvss": 4,
  "warning_threshold": 7,
  "ignore_offline_sites": false,
  "sites": [
    {
      "id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
      "subnet": "192.168.1.0/24"
    }
  ],
  "notify": [
    "a1b2c3d4-e5f6-7890-1234-567890abcdef"
  ],
  "notification_group": "b2c3d4e5-f6a7-8901-2345-67890abcdef0"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "day_of_week": 123,
  "time_of_day": "02:00",
  "every_n_weeks": 123,
  "timezone": "<string>",
  "min_cvss": 123,
  "warning_threshold": 123,
  "ignore_offline_sites": true,
  "next_scan_at": "2025-05-05T02:00:00+10:00",
  "running": true,
  "sites": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "subnet": "<string>"
    }
  ],
  "notify": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "created_at": "2025-04-08T10:00:00+10:00",
  "updated_at": "2025-04-08T14:30:00+10:00",
  "latest_scan": {},
  "status": "ready",
  "last_run_at": "2025-04-01T02:00:00+10:00",
  "notification_group": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Authentication token obtained via Altostrat platform login.

Body

application/json

Data required to create or update a scan schedule.

​
description
string
required

User-friendly description for the scan schedule.

Example:

"Weekly Corporate Network Scan"

​
day_of_week
integer
required

Day of the week to run the scan (0=Sunday, 6=Saturday).

Required range: 0 <= x <= 6
Example:

1

​
time_of_day
string<time>
required

Time of day to run the scan (HH:MM format) in the specified timezone.

Example:

"02:00"

​
every_n_weeks
integer
required

Frequency of the scan (run every N weeks).

Required range: 2 <= x <= 52
Example:

4

​
timezone
string
required

Timezone for the schedule (e.g., 'UTC', 'America/New_York'). Must be a valid PHP timezone identifier.

Example:

"Australia/Sydney"

​
min_cvss
number
required

Minimum CVSS score threshold for reporting (must be less than warning_threshold).

Required range: 0 <= x <= 10
Example:

4

​
warning_threshold
number
required

CVSS score at or above which triggers a warning state (must be greater than min_cvss).

Required range: 0 <= x <= 10
Example:

7

​
sites
object[]
required

List of sites and their subnets to be included in this schedule.

Minimum length: 1
​
ignore_offline_sites
boolean | null

If true, the scan run will proceed even if some associated sites are offline. Default is false.

Example:

false

​
notify
string<uuid>[] | null

List of user UUIDs to notify upon scan completion. Requires users to exist in the Altostrat system.

​
notification_group
string<uuid> | null

A UUID representing a notification group to send results to, overriding individual user notifications if provided.

Example:

"b2c3d4e5-f6a7-8901-2345-67890abcdef0"

Response

Scan schedule created successfully.

​
id
string<uuid>
​
description
string
​
day_of_week
integer
​
time_of_day
string<time>
Example:

"02:00"

​
every_n_weeks
integer
​
timezone
string
​
min_cvss
number
​
warning_threshold
number
​
ignore_offline_sites
boolean
​
next_scan_at
string<date-time>

Calculated next run time based on schedule settings and last run.

Example:

"2025-05-05T02:00:00+10:00"

​
running
boolean

Indicates if any scan instances related to this schedule are currently active.

​
sites
object[]
​
notify
string<uuid>[]
​
created_at
string<date-time>
Example:

"2025-04-08T10:00:00+10:00"

​
updated_at
string<date-time>
Example:

"2025-04-08T14:30:00+10:00"

​
latest_scan
object | null

Summary of the most recent completed scan for this schedule (if available).

​
status
enum<string>

Current operational status of the schedule.

Available options:
running,
ready,
processing,
starting,
stopping,
billing
Example:

"ready"

​
last_run_at
string<date-time> | null

Timestamp when the last scan associated with this schedule was initiated.

Example:

"2025-04-01T02:00:00+10:00"

​
notification_group
string<uuid> | null
⌘I