Altostrat Networks

altostratnetworks.mintlify.dev

Developer Tools

Personalised network security and compliance

llms.txt

Altostrat Documentation

Docs

CLAUDE
Generate a temporary access token: Generates a short-lived JSON Web Token (JWT) that can be used to provide…
Read a shared health dashboard: Returns the fault list associated with a shared health-dashboard token.
Attach Tag to Container
Create Container
Delete Container: Deletes a container. The container must be empty (no child containers or…
Detach Tag from Container
Get Container
List Containers: Retrieve a list of account containers. Can be filtered by parent or leve…
Move Container: Initiates an asynchronous job to move a container (and its entire subtre…
Pin Container: Pins a container to the user's dashboard/sidebar for quick access.
Transfer Users: Bulk transfer all users from this container to another container.
Unpin Container: Removes a container from the user's pinned list.
Update Container
Attach Tag to Account
Create an Account
Delete an Account
Detach Tag from Account
List Account Groups
List Accounts
Move Account: Move an account to a different container.
Retrieve an Account
Update an Account
Generate Script from Prompt: Submits a natural language prompt to the AI engine to generate a MikroTi…
Get top faulty resources: Retrieves a list of the top 10 most frequently faulting resources over t…
List faults from the last seven days: Returns recent fault records for the last seven days for dashboard and h…
Create an API key: Creates an API key with the selected permissions. The secret is shown…
Delete an API key: Revokes an API key and removes its backing machine-to-machine applicatio…
List API keys: Returns the API keys owned by the current organization. Secrets are neve…
Retrieve an API key: Returns metadata for one API key. The secret is not returned.
Rotate an API key secret: Rotates the API key secret and invalidates the previous secret. The new…
Search ARP Entries: Performs a paginated search for ARP entries across one or more sites, wi…
Update ARP Entry: Updates metadata for a specific ARP entry, such as assigning it to a gro…
List audit log events: Retrieve a list of audit log events for your organization. This endpoint…
Create an auth integration: Creates a new authentication integration for use with captive portal ins…
Delete an auth integration: Permanently deletes an authentication integration. This action cannot be…
List all auth integrations: Retrieves a list of all OAuth2 authentication integrations (IDPs) config…
Retrieve an auth integration: Retrieves the details of a specific authentication integration by its un…
Update an auth integration: Updates the configuration of an existing authentication integration.
Create a workflow authorization URL: Creates an authorization flow URL that lets a workflow act on behalf of…
Delete a workflow authorization: Deletes a workflow authorization so workflows can no longer use that del…
List workflow authorizations: Returns workflow account authorizations available to the authenticated u…
List Backups for a Site: Retrieves a list of all available configuration backup files for a speci…
List discovered site subnets: Returns the subnet routes discovered from the latest configuration data…
Request a New Backup: Asynchronously triggers a new configuration backup for the specified sit…
Retrieve a Specific Backup: Fetches the contents of a specific backup file. The format of the respon…
Create a BGP Threat Intelligence Policy: Creates a new BGP policy, specifying which IP reputation lists to use fo…
Delete a BGP Policy: Permanently deletes a BGP policy. This operation will fail if the policy…
List BGP IP Reputation Lists: Retrieves a list of all available BGP IP reputation lists that can be in…
List BGP Threat Intelligence Policies: Retrieves a list of all BGP Threat Intelligence policies associated with…
Retrieve a BGP Policy: Retrieves the details of a specific BGP Threat Intelligence policy by it…
Update a BGP Policy: Updates the properties of an existing BGP policy, including its name, st…
Create a billing account: Creates a new billing account within a workspace. This also creates a co…
Delete a billing account: Permanently deletes a billing account. This action cannot be undone. A b…
List billing accounts: Returns a list of billing accounts associated with a workspace.
Retrieve a billing account: Retrieves the details of a specific billing account.
Update a billing account: Updates the details of a billing account. Any parameters not provided wi…
Create a captive portal instance: Creates a new captive portal instance with a basic configuration. Furthe…
Delete a captive portal instance: Permanently deletes a captive portal instance and all associated subnets…
List all captive portal instances: Retrieves a list of all captive portal instances accessible to the authe…
Retrieve a captive portal instance: Retrieves the complete details of a specific captive portal instance by…
Update a captive portal instance: Updates the configuration of a specific captive portal instance, includi…
Upload an instance image: Uploads a logo or icon for a specific captive portal instance. The image…
Download Client CA
Download NAS Certificate
Download NAS Private Key
Fetch a VPN client configuration: Returns the VPN client configuration for a share token. The portal calls…
Add a comment to a fault: Adds a new comment to an existing fault. Comments are useful for trackin…
Get Raw README Content: Downloads the raw, plain-text markdown content of a community script's R…
Get Raw Script Content: Downloads the raw, plain-text content of a community script, suitable fo…
List Community Scripts: Retrieves a paginated list of scripts from the public community reposito…
Retrieve a Community Script: Fetches detailed information about a specific community script, includin…
Submit a Community Script: Submits a new script to the community repository by providing a URL to a…
Create a coupon schedule: Creates a new schedule to automatically generate coupons on a recurring…
Delete a coupon schedule: Permanently deletes a coupon schedule. This will not delete coupons that…
Generate a signed coupon URL: Creates a temporary, signed URL that can be used to retrieve the list of…
List coupon schedules: Retrieves a list of all coupon generation schedules for a specific capti…
Retrieve a coupon schedule: Retrieves the details of a specific coupon schedule by its ID.
Run a coupon schedule now: Manually triggers a coupon schedule to generate a new batch of coupons i…
Update a coupon schedule: Updates the configuration of an existing coupon schedule.
Create coupons: Generates a batch of one-time use coupons for a specified captive portal…
List valid coupons for an instance: Retrieves a list of all valid (unredeemed and not expired) coupons for a…
Get Data Transferred Volume: Retrieves the total volume of data transferred (in bytes) across specifi…
Get Network Throughput: Retrieves time-series data representing the average network throughput (…
Delete Job
Download Example CSV: Download a template CSV file for bulk import.
Get Columns
Get Job Status
Get Upload URL
List Jobs
Preview File
Start Dry Run
Start Import
Queue an asynchronous RouterOS script: Queues a RouterOS script for execution on a managed site. Use asynchrono…
Run a synchronous RouterOS command: Runs a RouterOS command against a managed site and returns the router re…
Get router metadata: Get router metadata exposed by the SDX developer API for a managed route…
Get router metrics summary: Get router metrics summary exposed by the SDX developer API for a manage…
Get router OEM data: Get router OEM data exposed by the SDX developer API for a managed route…
List developer API routers: Lists routers that the authenticated API key or user can access through…
List router faults: List router faults exposed by the SDX developer API for a managed router.
List router jobs: List router jobs exposed by the SDX developer API for a managed router.
Get Device Heartbeat History: Retrieves the device's heartbeat and connectivity status over the past 2…
Get Last Seen Time: Returns the time since the device at the specified site last reported it…
Get Recent Device Health Stats: Retrieves a time-series of key health metrics (CPU, memory, disk, uptime…
Retrieve Site Stats Over a Date Range: Fetches time-series performance metrics (CPU, memory, disk, uptime) for…
JSON Web Key Set (JWKS) Endpoint: Provides the set of public keys used to verify the signature of JWTs iss…
OIDC Discovery Endpoint: Returns a JSON document containing the OpenID Provider's configuration m…
Create a DNS Content Filtering Policy: Creates a new DNS Content Filtering policy with specified filtering rule…
Delete a DNS Policy: Permanently deletes a DNS policy. This operation will fail if the policy…
List Application Categories: Retrieves a list of all available application categories. Each category…
List DNS Content Filtering Policies: Retrieves a list of all DNS Content Filtering policies associated with y…
List Safe Search Services: Retrieves a list of services (e.g., Google, YouTube) for which Safe Sear…
Retrieve a DNS Policy: Retrieves the details of a specific DNS Content Filtering policy by its…
Update a DNS Policy: Updates the properties of an existing DNS policy. You can change its nam…
Search Altostrat Documentation: Use this endpoint to integrate Altostrat's official help and developer d…
Search for Platform Entities: This endpoint allows for a powerful, full-text search across all indexed…
Activate Failover Service: Activates the WAN Failover service for a specified site. This is the fir…
Deactivate Failover Service: Deactivates the WAN Failover service for a site, removing all associated…
Get Failover Service Status: Checks the status of the WAN Failover service for a specific site, retur…
List Sites with Failover Service: Retrieves a list of all sites associated with the authenticated user tha…
Create a fault: Manually creates a new fault object. This is typically used for creating…
Delete a fault: Permanently deletes a fault object. This action cannot be undone.
List all faults: Returns a paginated list of fault objects for your account. The faults a…
Retrieve a fault: Retrieves the details of an existing fault. You need only supply the uni…
Update a fault: Updates the specified fault by setting the values of the parameters pass…
Delete a Generated Report: Permanently deletes a previously generated report and its associated PDF…
List Generated Reports: Retrieves a paginated list of all historically generated reports for the…
Export dashboard panel CSV: Exports a single Grafana dashboard panel as CSV for reporting, audit, or…
List dashboards: Lists available Grafana dashboards with their variables and panel metada…
List dashboards in a folder: Lists Grafana dashboards from a specific folder.
Query a dashboard: Executes the Prometheus queries defined by a Grafana dashboard, optional…
Attach Tag to Group
Create Group
Delete Group
Detach Tag from Group
List Accounts in Group
List Groups
Retrieve Group
Update Group
List Router Interfaces: Retrieves a list of available physical and logical network interfaces fr…
List Router Interfaces for Failover: Retrieves available physical and logical interfaces from the router at t…
Look up Eligible Gateways: For a given router interface, this endpoint attempts to detect eligible…
Look up Eligible Gateways for Failover: Detects eligible upstream gateway IP addresses for a router interface us…
Active Sessions Count
Auth Events History
Authentication Latency
Authentication Outliers
Disconnection Stats
Frequent Disconnects
Misconfigured NAS
Most Active NAS
NAS Disconnect Reasons
Network Health Snapshot
Peak Concurrency
Session Duration History
Session Termination History
Short Lived Sessions
Simultaneous Use Violations
Top Talkers
Create a VPN instance: Provisions a new VPN server instance in a specified region with a unique…
Delete a VPN instance: Permanently decommissions a VPN instance and all its associated servers…
List all VPN instances: Retrieves a list of all VPN instances accessible by the authenticated us…
Retrieve a VPN instance: Fetches the details of a specific VPN instance by its unique identifier.
Retrieve instance bandwidth: Fetches the bandwidth usage statistics for the primary server associated…
Update a VPN instance: Modifies the configuration of an existing VPN instance, such as its name…
API Reference: Find generated OpenAPI reference material for public Altostrat SDX endpo…
List invoices: Returns a list of invoices for a billing account. Invoices are returned…
Preview an invoice: Previews an upcoming invoice for a billing account, showing the financia…
Cancel a Pending Job: Deletes a job that has not yet started execution. Jobs that are in progr…
Create a Job for a Site: Creates and queues a new job to be executed on the specified site. The j…
List Jobs for a Site: Retrieves a list of all jobs that have been created for a specific site,…
Retrieve a Job: Retrieves the complete details of a specific job by its unique identifie…
List Account Logs
List NAS Logs
Create a metadata object: Creates a new metadata object for a given resource, or fully overwrites…
Delete a metadata object: Deletes all custom metadata associated with a resource. This action clea…
List all metadata objects: Retrieves a collection of all resources that have metadata associated wi…
Retrieve a metadata object: Fetches the metadata object for a single resource, identified by its uni…
Update a metadata object: Updates the metadata for a specific resource. This operation performs a…
Create NAS Device
Delete NAS Device
List NAS Devices
Retrieve NAS Device
Update NAS Device
Get BGP Security Report: Generates a BGP security report for a site based on the last 24 hours of…
Get DNS Security Report: Generates a DNS security report for a site based on the last 24 hours of…
Get Site Syslog Entries: Retrieves a paginated list of syslog messages for a specific site, order…
Create a Notification Group: Creates a new notification group. This allows you to define a new rule f…
Delete a Notification Group: Permanently deletes a notification group. This action cannot be undone.
List Notification Groups: Retrieves a list of all notification groups configured for the authentic…
Retrieve a Notification Group: Fetches the details of a specific notification group by its unique ID.
Update a Notification Group: Updates the configuration of an existing notification group. This operat…
Exchange Code or Refresh Token for Tokens: Used to exchange an authorization_code for tokens, or to use a `refres…
Get User Profile: Retrieves the profile of the user associated with the provided `access_t…
Initiate User Authentication: This is the starting point for user authentication. The Altostrat web ap…
Log Out User (Legacy): Logs the user out of their Altostrat session and redirects them back to…
Log Out User (OIDC Compliant): This endpoint conforms to the OIDC Session Management specification. It…
Revoke Token: Revokes an access_token or refresh_token, invalidating it immediatel…
Create a child organization: Creates a new organization as a direct child of the specified parent org…
Create an organization: Creates a new top-level organization within a workspace. To create a chi…
Delete an organization: Permanently deletes an organization. An organization cannot be deleted i…
Export organization usage as CSV: Generates and downloads a CSV file detailing the resource usage and limi…
Export organization usage as PDF: Generates and downloads a PDF file detailing the resource usage and limi…
List all descendant organizations: Returns a flat list of all organizations that are descendants (children,…
List child organizations: Returns a list of immediate child organizations of a specified parent or…
List organizations: Returns a list of all organizations within the specified workspace.
Retrieve an organization: Retrieves the details of a specific organization within a workspace.
Retrieve organization limits: Retrieves a detailed breakdown of usage, limits, and available capacity…
Retrieve parent organization: Retrieves the parent organization of a specified child organization. If…
Update an organization: Updates specified attributes of an organization. This endpoint can be us…
Create a Setup Intent: Creates a Stripe Setup Intent to collect payment method details for futu…
Detach a payment method: Detaches a payment method from a billing account. You cannot detach the…
List payment methods: Returns a list of payment methods attached to a billing account.
Set default payment method: Sets a specified payment method as the default for a billing account. Th…
Create a peer: Creates a new peer (a client or a site) and associates it with a VPN ins…
Delete a peer: Permanently removes a peer from a VPN instance. This revokes its access.
List all peers for an instance: Retrieves a list of all peers (clients and sites) associated with a spec…
Retrieve a peer: Fetches the details of a specific peer by its unique identifier.
Update a peer: Modifies the configuration of an existing peer, such as its subnets or r…
Get Workspace Statistics
List Available RADIUS Attributes
Create a policy: Creates a new security policy. You can define rules for services like Wi…
Delete a policy: Deletes a policy. You cannot delete the default policy. Any sites using…
List all policies: Retrieves a list of all security policies belonging to your workspace. P…
Retrieve a policy: Retrieves the details of a specific policy, including its rules and a li…
Update a policy: Updates the specified policy by setting the values of the parameters pas…
Create a prefix list: Creates a new prefix list with a defined set of CIDR blocks and initial…
Delete a prefix list: Permanently deletes a prefix list. This action will fail if the prefix l…
List prefix lists: Retrieves a list of all prefix lists within your organization. This endp…
Retrieve a prefix list: Retrieves the complete details of a specific prefix list, including its…
Update a prefix list: Updates an existing prefix list by fully replacing its attributes, inclu…
List Products: Returns a paginated list of MikroTik products. The list can be filtered…
Retrieve a Product: Retrieves the complete details of a single MikroTik product, identified…
Execute a Prometheus query: Executes a Prometheus query through the SDX metrics gateway and scopes t…
List label values: Returns Prometheus values for a label available to the authenticated wor…
List metric labels: Returns Prometheus label names available to the authenticated workspace…
List metric names: Returns metric names available to the authenticated workspace and organi…
Retrieve coupons from a signed URL: Returns valid coupons for a coupon schedule when called with the signed…
Get public branding information: Retrieves the public branding information for an organization, such as i…
Resolve login hint: Given a unique login hint (e.g., a short company name like 'acme'), this…
Create Realm
Delete Realm
Get Realm
List Realms
Update Realm
List common services: Retrieves a list of common network services and their standard port numb…
List supported protocols: Retrieves a list of all supported network protocols and their correspond…
List Resellers: Returns a paginated list of official MikroTik resellers. This allows you…
Retrieve a Runbook: Retrieves the details of a specific runbook, including its name and the…
Start a Scan: Manually triggers a scan for a given schedule, overriding its normal tim…
Start On-Demand Multi-IP Scan: Initiates an immediate, on-demand scan for a specific list of IP address…
Start On-Demand Single-IP Scan: Initiates an immediate, on-demand scan for a single IP address. This use…
Stop a Scan: Forcefully stops a scan that is currently in progress for a given schedu…
Get Latest Scan Status: Retrieves the status of the most recent scan associated with a specific…
List Scan Reports: Retrieves a list of completed scan reports for your account, ordered by…
Retrieve a Scan Report: Fetches the detailed report for a specific completed scan run. The repor…
Create Scan Schedule: Creates a new recurring CVE scan schedule. You must define the timing, f…
Delete a Scan Schedule: Permanently deletes a scan schedule. This action cannot be undone and wi…
List Scan Schedules: Retrieves a list of all CVE scan schedules configured for your account.…
Retrieve a Scan Schedule: Fetches the details of a specific scan schedule by its unique identifier.
Update a Scan Schedule: Updates the configuration of an existing scan schedule. All fields are r…
Cancel or Delete a Scheduled Script: This endpoint has dual functionality. If the script is 'unauthorized' an…
Get Execution Progress: Retrieves the real-time execution progress for a script that has been la…
Immediately Run a Scheduled Script: Triggers an immediate execution of an already authorized script, overrid…
List Scheduled Scripts: Retrieves a list of all scripts scheduled for execution that are accessi…
Request Script Authorization: Initiates the authorization workflow for an 'unauthorized' script. This…
Retrieve a Scheduled Script: Fetches the detailed information for a single scheduled script, includin…
Run a Test Execution: Immediately dispatches the script for execution on the designated 'test_…
Schedule a New Script: Creates a new scheduled script entry. This involves defining the script…
Update a Scheduled Script: Modifies an existing scheduled script. This is only possible if the scri…
Create a new schedule: Creates a new schedule with a defined set of recurring time slots. Upon…
Delete a schedule: Permanently deletes a schedule, including all of its associated time slo…
List all schedules: Retrieves a list of all schedule objects belonging to your workspace. Th…
Retrieve a schedule: Retrieves the details of an existing schedule by its unique identifier.
Update a schedule: Updates the specified schedule by setting the properties of the request…
Create a Script Template: Creates a new, private script template for the user's organization. This…
Delete a Script Template: Permanently removes a private script template. This action cannot be und…
List Script Templates: Retrieves a collection of script templates. Templates can be filtered to…
Retrieve a Script Template: Fetches the details of a specific script template, including its content.
Update a Script Template: Modifies an existing script template. This action is only permitted on t…
Create a security group: Creates a new security group with a defined set of firewall rules and in…
Delete a security group: Permanently deletes a security group. This action cannot be undone. An a…
List security groups: Retrieves a list of all security groups within your organization. This e…
Retrieve a security group: Retrieves the complete details of a specific security group, including i…
Update a security group: Updates an existing security group by fully replacing its attributes, in…
Create a site note: Creates a new markdown note and attaches it to the specified site.
Delete a document file: Permanently deletes a document file from a site.
Delete a media file: Permanently deletes a media file from a site.
Delete a site note: Permanently deletes a note from a site.
Download a document file: Downloads a specific document file associated with a site.
Download a media file: Downloads a specific media file associated with a site.
Get document upload URL: Requests a pre-signed URL that can be used to upload a document file (e.…
Get media upload URL: Requests a pre-signed URL that can be used to upload a media file (e.g.,…
Get site note content: Downloads the raw Markdown content of a specific site note.
List site notes: Retrieves a list of all markdown notes associated with a specific site.
Get Interface Metrics: Fetches time-series traffic metrics (ifInOctets for inbound, ifOutOctets…
List Site Interfaces: Retrieves a list of all network interfaces monitored via SNMP for a spec…
Get site note: Returns the note metadata stored for a managed site.
Update site note: Creates or replaces the note stored for a managed site.
Get API credentials for a site: Retrieves the current API credentials for a site. These credentials are…
Get management server for a site: Retrieves the hostname of the Altostrat management server currently resp…
Perform an action on a site: Sends a command to a site to perform a specific, predefined action. This…
Resend bootstrap scheduler: Re-sends the SDX bootstrap scheduler to a managed router. Use this when…
Rotate API credentials for a site: Generates new API credentials for the specified site. The old credential…
Attach BGP Policy to a Site: Attaches a BGP Threat Intelligence policy to a specific site, activating…
Attach DNS Policy to a Site: Attaches a DNS Content Filtering policy to a specific site, activating i…
Detach BGP Policy from a Site: Detaches the currently active BGP Threat Intelligence policy from a spec…
Detach DNS Policy from a Site: Detaches the currently active DNS Content Filtering policy from a specif…
List All Site Security Configurations: Retrieves a list of all sites (tunnels) associated with your account and…
Retrieve a Site's Security Configuration: Retrieves the current DNS and BGP policy attachments for a specific site.
Delete a Site: Schedules a site for deletion. The device will be sent a command to remo…
List Recent Sites: Returns a list of the 5 most recently accessed sites for the authenticat…
List Sites: Retrieves a paginated list of all MikroTik sites associated with the aut…
List Sites (Minimal): Retrieves a condensed list of MikroTik sites, suitable for UI elements l…
Retrieve a Site: Retrieves the complete details of a specific MikroTik site by its unique…
Update a Site: Updates the mutable properties of a site, such as its name, location, or…
Create SLA Report Schedule: Creates a new SLA report schedule. This schedule defines a recurring rep…
Delete a Report Schedule: Permanently deletes an SLA report schedule. This action cannot be undone.
List SLA Report Schedules: Retrieves a list of all configured SLA report schedules for the authenti…
Retrieve a Report Schedule: Retrieves the details of a single SLA report schedule by its unique ID.
Run a Report On-Demand: Triggers an immediate, on-demand generation of a report for a specified…
Update a Report Schedule: Updates the configuration of an existing SLA report schedule.
Cancel a subscription: Cancels a subscription at the end of the current billing period. This op…
Check trial eligibility: Checks if a workspace is eligible for a 14-day free trial. A workspace i…
Create a subscription: Creates a new Stripe subscription for a billing account. If the workspac…
List subscriptions: Returns a list of subscriptions associated with a billing account.
Retrieve a subscription: Retrieves the details of a specific subscription.
Update a subscription: Updates a subscription. This endpoint supports multiple distinct operati…
Apply a tag to a resource: Applies a tag with a specific value to a resource, identified by its `co…
Find resources by tag value: Retrieves a list of all resources that have a specific tag applied with…
List tags for a resource: Retrieves all tags that have been applied to a specific resource.
List unique values for a tag: Retrieves a list of unique values that have been applied to resources us…
Remove a tag from a resource: Removes a specific tag from a resource. This does not delete the tag def…
Update a tag on a resource: Updates the value of a tag on a specific resource. This is effectively t…
Create a tag definition: Creates a new tag definition. A tag definition acts as a template or cat…
Create Tag
Delete a tag definition: Permanently deletes a tag definition and all of its associated values fr…
Delete Tag
Get Tag
List Accounts by Tag
List all tag definitions: Retrieves a list of all tag definitions for your workspace. Each tag def…
List Containers by Tag
List Groups by Tag
List Tags
Retrieve a tag definition: Retrieves the details of a specific tag definition by its unique ID. Thi…
Update a tag definition: Updates the properties of an existing tag definition, such as its key or…
Update Tag
List Available Topics: Retrieves a list of all available notification topics. These are the eve…
Create a transient access session: Creates a temporary, secure session for accessing a site via Winbox or S…
List transient accesses for a site: Retrieves a list of all active and expired transient access sessions for…
Retrieve a transient access session: Retrieves the details of a single transient access session.
Revoke a transient access session: Immediately revokes an active transient access session, terminating the…
Create a transient port forward: Creates a temporary, secure port forwarding rule. This allows you to acc…
List transient port forwards for a site: Retrieves a list of all active and expired transient port forwarding rul…
Retrieve a transient port forward: Retrieves the details of a single transient port forwarding rule.
Revoke a transient port forward: Immediately revokes an active port forwarding rule, closing the connecti…
List available node types: Retrieves a list of all available node types (triggers, actions, and con…
List available server regions: Retrieves a structured list of all available geographical regions where…
List subnets for a site: Retrieves a list of available subnets for a specific site, which is usef…
Test a single node: Executes a single workflow node in isolation with a provided context. Th…
Create a vault item: Creates a new item in the vault for storing sensitive information like A…
Delete a vault item: Permanently deletes a vault item. This action cannot be undone. Any work…
List vault items: Retrieves a list of all secret items stored in your organization's vault…
Retrieve a vault item: Retrieves the details of a single vault item by its prefixed ID. The sec…
Update a vault item: Updates an existing vault item, such as its name, secret value, or expir…
Get CVEs by MAC Address: Retrieves all discovered vulnerabilities (CVEs) associated with a specif…
Get Mitigation Steps: Provides AI-generated, actionable mitigation steps for a specific CVE id…
List All Scanned MAC Addresses: Retrieves a list of all unique MAC addresses that have been discovered a…
List CVE Statuses: Retrieves a list of all managed CVE statuses. You can filter the results…
Update CVE Status: Updates the status of a specific CVE for a given MAC address. Use this t…
Create a walled garden entry: Adds a new IP address or subnet to the walled garden for a specific site…
Delete a walled garden entry: Removes an entry from the walled garden, blocking pre-authentication acc…
List walled garden entries for a site: Retrieves a list of all walled garden entries (allowed pre-authenticatio…
Retrieve a walled garden entry: Retrieves the details of a specific walled garden entry.
Update a walled garden entry: Updates the details of a walled garden entry, such as its name. The IP a…
Get Aggregated Ping Statistics: Fetches aggregated time-series data for latency, jitter (mdev), and pack…
Get WAN tunnel ping statistics: Fetches aggregated time-series data for latency, jitter (mdev), and pack…
List Site WAN Tunnels: Retrieves a list of all configured SD-WAN tunnels for a specific site.
Add a new WAN Tunnel: Creates a new, unconfigured WAN tunnel for the site, up to the maximum a…
Add a new WAN Tunnel: Creates a new, unconfigured WAN tunnel for the site, up to the maximum a…
Configure a WAN Tunnel: Updates the configuration of a specific WAN tunnel. This is the primary…
Delete a WAN Tunnel: Permanently deletes a WAN tunnel from the failover configuration. The sy…
Get a Specific Tunnel: Retrieves the detailed configuration and status of a single WAN tunnel.
List Tunnels for a Site: Retrieves a detailed list of all WAN tunnels configured for a specific s…
List Tunnels for a Site: Retrieves a detailed list of all WAN tunnels configured for a specific s…
List WAN tunnels across accessible sites: Returns WAN tunnels across the sites available to the authenticated user…
List WAN tunnels across accessible sites: Returns WAN tunnels across the sites available to the authenticated user…
Update Tunnel Priorities: Re-orders the failover priority for all tunnels associated with a site.…
Trigger a workflow via webhook: A public endpoint to trigger a workflow that has a webhook_trigger. Au…
Get workflow log statistics: Returns aggregate counts for a workflow log stream.
List recent workflow logs: Returns recent workflow log entries across workflows available to the au…
List workflow logs: Returns logs for workflow executions. You can filter by level, node, run…
Execute a workflow: Manually triggers the execution of a workflow. The workflow will run asy…
List workflow runs: Retrieves a paginated list of all past and current executions (runs) for…
Re-run a workflow: Creates a new workflow run using the same initial trigger payload as a p…
Resume a failed workflow: Resumes a failed workflow run from a specific, successfully completed no…
Retrieve a workflow run: Retrieves the details of a single workflow run, including its status, tr…
Create a new workflow: Creates a new workflow definition, including its nodes and edges that de…
Delete a workflow: Permanently deletes a workflow and all of its associated runs and logs.…
Execute a synchronous workflow: Executes a workflow that contains a sync_request_trigger and immediate…
List all workflows: Retrieves a list of all workflows belonging to your organization. This e…
List triggerable workflows: Returns active workflows that can be triggered by another workflow or se…
Retrieve a workflow: Retrieves the complete details of a single workflow by its prefixed ID,…
Update a workflow: Updates an existing workflow. You can update any property, including the…
Validate a workflow definition: Validates a workflow graph before you create or update it. Use this to c…
Add a member to a workspace: Adds a new user to a workspace with a specified role. Only workspace own…
List workspace members: Returns a list of users who are members of the specified workspace, incl…
Remove a member from a workspace: Removes a member from a workspace. A user can remove themselves, or an o…
Update a member's role: Updates the role of an existing member in a workspace. Role changes are…
Archive a workspace: Archives a workspace, preventing any further modifications. A workspace…
Create a workspace: Creates a new workspace, which acts as a top-level container for your re…
List workspaces: Returns a list of workspaces the authenticated user is a member of.
Retrieve a workspace: Retrieves the details of an existing workspace. You must be a member of…
Update a workspace: Updates the specified workspace by setting the values of the parameters…
Architecture and Scale: Understand how ArcRadius uses a global RadSec data plane, management con…
CoA and PoD: Configure Change of Authorization and Packet of Disconnect for RADIUS NA…
Folders and Users: Organize RADIUS users with folders, bulk actions, user profiles, credent…
Getting Started with RADIUS: Configure your first RADIUS device, group, user, and test authentication…
Groups and Attributes: Use RADIUS groups to manage reusable check attributes, reply attributes,…
RADIUS Overview: Learn how the Altostrat Radius web UI organizes devices, users, groups,…
Limits and Availability: Review ArcRadius feature coverage, availability targets, retention, perf…
Live Monitoring and Logs: Use RADIUS Live View, log filters, user dashboards, device dashboards, m…
NAS Devices: Register and manage RADIUS clients, RadSec configuration, certificates,…
Realms: Use RADIUS realms to match username suffixes and automatically apply gro…
Settings, Labels, Metadata, and Shortcuts: Customize RADIUS labels, use metadata fields, and create global metadata…
Supported Dictionaries: Review the RADIUS attribute dictionaries, vendors, operators, value type…
RADIUS Troubleshooting: Troubleshoot RADIUS rejects, bad passwords, missing attributes, suspende…
Api base instructions
Billing and Subscriptions: Review billing accounts, subscriptions, license allocation, usage, and l…
Account & Billing: Understand the account structures that organize SDX workspaces, teams, u…
User and Team Management: Add users, organize teams, assign roles, and use notification-only users…
Workspaces and Organizations: Model your business or customer structure with workspaces, organizations…
Generative AI: Use AI-assisted features in Altostrat SDX for workflow text transforms,…
Automation and AI: Use workflows, scheduled scripts, templates, and AI-assisted tools to au…
Script Management: Create, test, authorize, schedule, and monitor RouterOS scripts across A…
Workflow Authorizations: Understand how workflow authorizations let SDX workflows perform actions…
Build Workflows: Design Altostrat SDX workflows with triggers, actions, conditions, varia…
Workflow Node Reference: A practical reference for the trigger, action, condition, and loop nodes…
AI Text Transform: Format text and data using AI prompts.
API Call: Make HTTP requests to Altostrat API endpoints.
Attach Policy: Attach a policy to a site.
Detach Policy: Remove a policy from a site.
Get Resource Tags: Retrieve tags associated with a resource (site).
Get Site: Retrieve detailed site information and configuration.
Get WAN Tunnel: Retrieve detailed WAN tunnel information and status.
MikroTik Script: Run scripts or config changes on a site.
MikroTik API: Run a real-time API command on a specific site.
Set Resource Tags: Add or update tag key-value pairs for a resource.
Update WAN Priorities: Update WAN failover link priorities for a site.
Filter Array: Create a new array with only the items that match your conditions.
Shorten Link: Create a short link from a long URL.
CVE Scan Multiple IPs: Initiate an immediate CVE scan for multiple IP addresses.
Data Mapper: Create or modify objects and arrays by mapping data.
Date Transform: Modify dates, add/subtract time, or change formats.
Ingest Metrics: Send custom metrics to Prometheus for monitoring and analysis.
IPv4 Address Tool: Analyze an IPv4 address or CIDR range.
JSON Parser: Parse JSON data and extract values.
Markdown to PDF: Convert Markdown content to PDF format.
Overview: Reference for workflow action nodes, including action categories, typica…
Send Notification: Send notifications via email or WhatsApp.
Send Email (SMTP): Send an email via a custom SMTP server.
SOAP Request: Interact with legacy SOAP web services.
SSH Command: Execute commands on a remote server via SSH.
String Transform: Perform a series of transformations on a string.
Terminate: Stop the workflow with a 'Completed' or 'Failed' status.
Text Transform: Format text and data using custom templates.
Trigger Another Workflow: Start another workflow from this one.
Validate Data: Validate an object or array using Laravel rules.
Webhook API Call: Send HTTP requests to external APIs and webhook endpoints.
WireGuard Key Generator: Generate a new key pair or derive a public key.
Array Condition: Check conditions on arrays and their elements.
Boolean Condition: Check conditions on boolean values.
Date Condition: Check conditions on dates and times.
Logical Group (AND/OR): Combine multiple conditions with complex AND/OR logic.
Number Condition: Check conditions on numbers and numeric values.
Overview: Condition nodes branch workflow execution by evaluating expressions agai…
Resource Has Tags: Check if a resource has specific tags or any tags at all.
String Condition: Check conditions on strings and text.
Switch: Create multiple branches based on different conditions.
Loop / Iterator Node: Reference for the Loop / Iterator node, including when to use it, how it…
Overview: Reference for workflow trigger nodes, including scheduling, event-driven…
Scheduled Trigger: Run this workflow on a recurring schedule.
Site Added: Trigger this workflow when a new site is added.
Site Offline: Trigger when a site fails to check in with the management system for mor…
Site Online: Trigger when a site comes back online and resumes sending heartbeats.
Site Removed: Trigger this workflow when a site is removed.
API Trigger (Synchronous): Trigger this workflow via API call with synchronous execution.
Manual Trigger: Start this workflow via an API call or the UI.
WAN Interface Offline: Trigger when a WAN interface from a WAN failover goes offline.
WAN Interface Online: Trigger when a WAN interface from a WAN failover comes online.
WAN Packet Loss: Trigger when a WAN interface from a WAN failover experiences packet loss.
WAN Packet Loss Resolved: Trigger when a WAN interface from a WAN failover recovers from packet lo…
Trigger by Another Workflow: Call this workflow from another workflow.
Workflow Triggers: Choose the right trigger for manual runs, schedules, API requests, site…
Use The Workflow Vault: Store workflow secrets, generated API keys, and signing material without…
Changelog: Weekly updates to Altostrat SDX — from launch in October 2024 through ac…
Configure Captive Portals: Create captive portal auth integrations, instances, site assignments, an…
Captive Portals: Understand captive portal instances, OAuth2 identity providers, coupons,…
Connectivity and SD-WAN: Plan and operate Altostrat SDX connectivity services, including WAN fail…
VPN Instances and Peers: Create a managed VPN instance, add site and client peers, and make pract…
Managed VPN: Understand VPN instances, peers, protocols, and routing choices in Altos…
WAN Failover: Configure and monitor prioritized WAN links for an Altostrat SDX managed…
Configuration Backups: Request, review, compare, and use MikroTik configuration backups as the…
Control Plane Policies: Use control plane policies to define which router management services ar…
Fleet Management: Manage MikroTik sites at scale with SDX sites, policies, remote access,…
Managing Sites and Devices: Create, review, update, and retire SDX sites while understanding how hea…
Metadata, Tags, and Site Files: Use tags, metadata, notes, media, and documents to make your SDX fleet s…
Secure Remote Access: Use time-limited transient access and transient port forwarding to reach…
Core Concepts: Learn the SDX terms you need before managing sites, policies, workflows,…
Introduction to Altostrat SDX: Understand what Altostrat SDX does, how it fits around your MikroTik fle…
Operational Model: Understand how SDX uses heartbeats, queued jobs, live commands, faults,…
Onboard Your First Router: Create your first SDX site, run the bootstrap command on RouterOS, and v…
Dashboards and Metrics: Use SDX dashboards to inspect fleet health, site state, WAN behavior, in…
Fault Logging: Investigate active and resolved site, WAN, and service faults with times…
Monitoring & Analytics: Understand how Altostrat SDX turns heartbeats, metrics, faults, reports,…
Notifications: Route operational events to the right responders with notification group…
Reporting: Schedule SLA reports, choose business-hour or all-hour calculations, and…
Best Practices: Operate Altostrat SDX safely across sites, policies, connectivity, autom…
Glossary: Definitions for common Altostrat SDX terms used across documentation, th…
Platform Resources: Use Altostrat SDX platform references for endpoint planning, troubleshoo…
Management VPN: Understand the SDX management VPN used for router management, monitoring…
Regional Servers: Understand how SDX regional infrastructure relates to router management…
Short Links: Create temporary short links in workflows with configurable expiration.
Troubleshooting: Follow practical troubleshooting paths for offline sites, management VPN…
Trusted IPs and Endpoints: Plan firewall allowlists, control-plane trusted networks, and outbound S…
Audit Logs: Search workspace activity to investigate changes, access, errors, and se…
Security Essentials: Use continuously updated threat mitigation lists to reduce exposure to k…
DNS Content Filtering: Create DNS policies that combine category filtering, SafeSearch enforcem…
Security & Compliance: Understand the policy layers Altostrat SDX gives you for content control…
Security Groups: Create reusable firewall policies with ordered rules, services, ports, C…
Vulnerability Scanning: Schedule CVE scans, review affected hosts, and track remediation status…
AI Copilot: Use Copilot modes, approvals, context attachment, slash commands, stream…
Agent and local runtime: The Electron + Go-sidecar architecture that runs SSH, packet capture, em…
AI provider and data flow: Where Studio's AI inference actually happens, which models are used, wha…
Audit and telemetry: What Studio records about your work, what it sends to third parties, wha…
Connectors and MCP safety: How third-party API credentials are stored, how connector and MCP tool c…
Human in the loop: How Studio classifies tool calls by risk, presents approvals the operato…
Identity and access: How Studio authenticates users, derives short-term AWS credentials, isol…
Known limits and roadmap: The honest list of what Studio's safety story does not cover yet, what's…
AI safety in Studio: How Altostrat Studio runs AI against production networks safely — the ar…
Supply chain and updates: How Studio gets from our source repo to your machine intact — code signi…
Threat model: What Studio is built to defend against, what it explicitly is not, the a…
Vault and keys: The cryptographic core of Studio: per-organization customer master keys…
Changelog: Weekly updates to Altostrat Studio — new features, improvements, and fix…
Connectors and MCP: Extend Copilot with your own systems — named REST and SOAP connectors, a…
Files and artifacts: Find the reports, tables, code, diagrams, and diffs Copilot produced in…
Hosts and credentials: Build device inventory, attach multiple protocols per host, and reuse cr…
Install and sign in: Download Studio for macOS or Windows, sign in with your Altostrat accoun…
Keyboard shortcuts: Workspace, tabs, search, terminal, diagrams, and editor shortcuts in one…
Memories and search: Save structured facts you or Copilot want to recall later, and find anyt…
Network diagrams: Draw and edit network maps with Cisco and cloud service shape libraries,…
Procedures: Promote a successful chat into a parameterized runbook — markdown with a…
Remote desktop: Open Windows hosts over RDP in a Studio tab — a live streamed desktop wi…
Security and privacy: Where your data lives, what's encrypted before it leaves your machine, h…
Settings: Control how Studio looks, how Copilot thinks, how updates land, and what…
Shared sessions: Collaborate inside a terminal with owner, co-worker, and viewer roles, i…
System requirements: Desktop platforms, network reach, privileges, and usage limits you shoul…
Teams and organizations: How Studio scopes your work to an organization, how the org switcher wor…
Terminal: Open network-aware terminal sessions with clickable IPs and interfaces,…
Tour the workspace: Learn the Studio shell: activity bar, primary sidebar, main canvas with…
Troubleshooting: Common symptoms in Studio and the first things to check when you see the…
Capacity upgrade: 100 Mbps to 1 Gbps transit cutover: Plan, procure, and cut over a 10x capacity uplift on a regional transit…
CGNAT pool exhaustion: alert to expanded capacity: NetFlow flags CGNAT port-pool exhaustion on a regional aggregator. Add p…
CPE bulk firmware rollout: advisory to verified updates: A vendor advisory drops mid-week. Stage the firmware through the TR-069…
DDoS mitigation activation and customer comms: A NetFlow anomaly flags a volumetric attack on a hosted customer. Confir…
Fiber cut response: OTDR alarm to restored service: An OTDR fires a fibre-break alarm mid-morning. Identify the segment, dis…
New PON deployment: 64 subscribers from site approval to first login: Plan, order, configure, and activate a 64-subscriber GPON tree — OLT pro…
Subscriber data-usage dispute: RADIUS evidence to credit note: A subscriber disputes their data-usage bill. Pull the RADIUS accounting…
Upstream provider outage: bulk customer comms in one workflow: Multiple monitoring triggers light up. Confirm the outage is upstream, o…
Cisco IOS-XE firmware upgrade across 12 sites with change approval: Plan, approve, schedule, and execute a fleet firmware upgrade — Jira cha…
Compromised account: alert to containment to incident report: A Microsoft Defender alert flags impossible-travel sign-ins for a custom…
Onboard a new MSP customer fleet: Take a customer's CSV inventory and a contract handoff, and turn it into…
End-of-life hardware refresh: vuln scan to install date: A vulnerability scan flags an EOL Catalyst 2960. Build the replacement B…
Weekly executive report for managed customers: Pull the week's uptime, ticket backlog, change activity, backup health,…
MFA enforcement rollout to a 200-user customer: Move a customer's 200 users from optional to enforced MFA — pull the use…
Office 365 outage triage and bulk customer comms: A PRTG sensor flips red across multiple managed customers. Confirm the u…
Dell R720 disk failure: Kayako to RMA in one workspace: Triage a Kayako ticket, confirm a failed disk on a Dell PowerEdge R720 o…
Ransomware containment: alert to clean restore: A SIEM detection fires on lateral movement and SMB encryption activity.…
WiFi deployment from survey to customer report: Take an Ekahau predictive survey, provision the access points, validate…
Use cases: Real workflows MSPs, ISPs, WISPs, and VoIP carriers run inside Studio —…
E911 address validation campaign across the customer base: Pull every active DID, cross-reference E911 registered addresses with th…
Voice DR failover drill: scheduled, executed, validated, reverted: Run the quarterly disaster-recovery drill — fail the SBC and RADIUS to t…
One-way audio complaint: ticket to fix in one session: A customer reports they can hear callers but callers can't hear them. Pu…
PSTN trunk provisioning for a new tenant: Sales hands over a new business customer. Reserve a DID block, configure…
SIP trunk exhaustion: alarm to expanded capacity in one shift: Concurrent-call counters peak above the contracted limit. Confirm legiti…
STIR/SHAKEN spoofing complaint: trace, mitigate, escalate: A subscriber complains they're being called by their own number. Pull th…
Microsoft Teams Direct Routing migration for an enterprise tenant: Migrate a 1,200-seat enterprise from a legacy PBX to Microsoft Teams Dir…
Welcome to Studio: Altostrat Studio is a network operations IDE for engineers who need term…
Why Studio: Studio is built so every session makes the next one faster. Device ident…
Workspace Billing Modes: Single vs Assigned vs Pooled Resource Allocation: Complete guide to workspace billing modes including Single mode for unif…
Workspace Management: Complete Guide to Billing, Organizations & Multi-Tenant Architecture: Complete guide to workspace architecture including billing accounts, org…
Workspace System Limits: Organization, Billing & Performance Constraints: Complete reference for workspace system limitations including organizati…
Business Structure Modeling: Franchise, Enterprise, MSP & Partner Network Examples: Complete guide to modeling business structures with workspace billing mo…
Organization Hierarchies: Multi-Level Structure Design with Usage Tracking & Limits: Complete guide to building organization hierarchies with up to 10 levels…
Subscription Management & Invoicing: Resource Pooling, Billing Cycles & Payment Processing: Complete guide to workspace subscription management including resource p…