POST
/
scheduled
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.

Response

201
application/json

Scan schedule created successfully.

The response is of type object.