h1, h2, h3, h4 {
    font-weight: 600 !important;
}

.codeblock-dark div:not(:last-child) {
    color: #fafafa;
}

#footer div:nth-of-type(2) {
    display: none;
}


Initiates an immediate run of the specified scan schedule. Rate limited to prevent rapid restarts. Requires authorization to access the schedule.

Start Scheduled Scan Manually

bearerAuth

Scan start request accepted. The scan will run asynchronously.

Unauthorized - Missing or invalid Bearer token.

Forbidden - Insufficient permissions/scope for the action.

Resource not found (e.g., invalid Schedule UUID, Scan UUID).

Too Many Requests - Scan start rate limit exceeded (prevents duplicate starts within 24 hours).

Altostrat Documentation

Altostrat SDX is designed for both small networks and large-scale deployments, providing robust tools to simplify management, bolster security, and maximize uptime-using your existing, compatible hardware.

Introduction

Prepare your MikroTik device with a clean configuration and updated firmware before integrating it with Altostrat SDX.

Initial Configuration

Learn how to create your personal Altostrat SDX user account via self-registration or by accepting a team invitation.

User Registration

Follow these steps to integrate your prepared MikroTik router with the Altostrat SDX platform.

Adding a MikroTik Router to Altostrat SDX

How to securely access your MikroTik router using WinBox, even behind NAT.

Remote WinBox Login

Secure, on-demand credentials for MikroTik devices behind NAT firewalls.

Transient Access

Learn how to configure a Captive Portal instance and enable network-level authentication.

Captive Portal Setup

Organize users into teams for resource ownership, collaboration, and scoped access control in Altostrat SDX.

Teams

Manage portal users and notification recipients, assign roles within teams, and understand resource access in Altostrat SDX.

User Management

Control user access levels in Altostrat SDX using roles, which group granular permission scopes for accessing resources and performing actions via the UI and API.

Roles & Permissions

Manage and restrict access to undesirable or harmful web content across your network using DNS-based policies.

Content Filtering

Leverage BGP-delivered threat intelligence feeds to automatically block malicious traffic at your network edge.

Threat Feeds

Configure inbound management services (WinBox, SSH, API) and firewall rules at scale in Altostrat.

Control Plane

Define, manage, and route alerts for important network events in Altostrat.

Notifications

Define groups of users, schedules, and alert types for more targeted notifications.

Notification Groups

Enhance reliability by combining multiple internet mediums for uninterrupted cloud connectivity.

WAN Failover

Create, reorder, and troubleshoot WAN Failover configurations for reliable multi-link setups.

Managing WAN Failover

How MikroTik devices connect securely to Altostrat for real-time monitoring and management.

Management VPN

Track scripts, API calls, and automated tasks performed by Altostrat on your MikroTik devices.

Orchestration Log

Monitor and troubleshoot disruptions or issues in your network via Altostrat.

Faults

Manage and schedule configuration backups for MikroTik devices through Altostrat.

Backups

Organize and categorize your MikroTik devices with custom tags in Altostrat.

Device Tags

Simplify long, signed URLs into user-friendly short links for Altostrat notifications and emails.

Short Links

Improve performance and minimize single points of failure with globally distributed clusters.

Regional Servers

Overview of how Altostrat connects with external platforms for notifications, authentication, and more.

Integrations Overview

Integrate Altostrat notifications and alerts into Microsoft Teams channels.

Microsoft Teams

Send Altostrat alerts to Slack channels for quick incident collaboration.

Slack

Connect Altostrat with Google Cloud for user authentication and secure OAuth 2.0 flows.

Google Cloud Integration

Use Microsoft Entra (Azure AD) for secure user authentication in Altostrat.

Microsoft Azure Integration

Configure external OAuth 2.0 or SSO providers like Google, Azure, or GitHub for Altostrat authentication.

Identity Providers

Requirements for secure user passwords in Altostrat.

Password Policy

List of countries where Altostrat's SMS delivery is enabled, plus any high-risk or unsupported regions.

Supported SMS Regions

Learn how to install Altostrat's Progressive Web App (PWA) for an app-like experience and offline support.

Installable PWA

Securely authenticate requests to the Altostrat SDX API using API Keys or OAuth 2.0.

Getting Started

OIDC, RBAC, and Billing

ARP and Devices

Developers API

Asynchronous (MikroTik)

Backups

BGP Feeds And Content Filter

Captive Portal

Control Plane Filter

CVE Scans

Elastic IP Addressing

Logging

Metrics

Monitoring & Health

Notifications

Scheduled Scripts

Schedules

SLA Reports

VPN

WAN Failover

Webhooks

Start Scheduled Scan Manually

Authorizations

Path Parameters

Response