Skip to main content
GET
/
scheduled
/
{scanSchedule}
Get Scan Schedule Details
curl --request GET \
  --url https://api.altostrat.io/scans/cve/scheduled/{scanSchedule} \
  --header 'Authorization: Bearer <token>'
{
  "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.

Path Parameters

​
scanSchedule
string<uuid>
required

The UUID of the Scan Schedule.

Response

Scan schedule details.

​
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