# Altostrat Documentation ## Docs - [CLAUDE](https://altostrat.io/docs/CLAUDE.md) - [Generate a temporary access token](https://altostrat.io/docs/api/en/access-tokens/generate-a-temporary-access-token.md): Generates a short-lived JSON Web Token (JWT) that can be used to provide temporary, read-only access to specific fault data, typically for embedding in external dashboards. - [Read a shared health dashboard](https://altostrat.io/docs/api/en/access-tokens/read-a-shared-health-dashboard.md): Returns the fault list associated with a shared health-dashboard token. - [Attach Tag to Container](https://altostrat.io/docs/api/en/account-containers/attach-tag-to-container.md) - [Create Container](https://altostrat.io/docs/api/en/account-containers/create-container.md) - [Delete Container](https://altostrat.io/docs/api/en/account-containers/delete-container.md): Deletes a container. The container must be empty (no child containers or accounts). - [Detach Tag from Container](https://altostrat.io/docs/api/en/account-containers/detach-tag-from-container.md) - [Get Container](https://altostrat.io/docs/api/en/account-containers/get-container.md) - [List Containers](https://altostrat.io/docs/api/en/account-containers/list-containers.md): Retrieve a list of account containers. Can be filtered by parent or level for tree traversal. Includes a separate list of pinned containers. - [Move Container](https://altostrat.io/docs/api/en/account-containers/move-container.md): Initiates an asynchronous job to move a container (and its entire subtree) to a new parent. - [Pin Container](https://altostrat.io/docs/api/en/account-containers/pin-container.md): Pins a container to the user's dashboard/sidebar for quick access. - [Transfer Users](https://altostrat.io/docs/api/en/account-containers/transfer-users.md): Bulk transfer all users from this container to another container. - [Unpin Container](https://altostrat.io/docs/api/en/account-containers/unpin-container.md): Removes a container from the user's pinned list. - [Update Container](https://altostrat.io/docs/api/en/account-containers/update-container.md) - [Attach Tag to Account](https://altostrat.io/docs/api/en/accounts/attach-tag-to-account.md) - [Create an Account](https://altostrat.io/docs/api/en/accounts/create-an-account.md) - [Delete an Account](https://altostrat.io/docs/api/en/accounts/delete-an-account.md) - [Detach Tag from Account](https://altostrat.io/docs/api/en/accounts/detach-tag-from-account.md) - [List Account Groups](https://altostrat.io/docs/api/en/accounts/list-account-groups.md) - [List Accounts](https://altostrat.io/docs/api/en/accounts/list-accounts.md) - [Move Account](https://altostrat.io/docs/api/en/accounts/move-account.md): Move an account to a different container. - [Retrieve an Account](https://altostrat.io/docs/api/en/accounts/retrieve-an-account.md) - [Update an Account](https://altostrat.io/docs/api/en/accounts/update-an-account.md) - [Generate Script from Prompt](https://altostrat.io/docs/api/en/ai-script-generation/generate-script-from-prompt.md): Submits a natural language prompt to the AI engine to generate a MikroTik RouterOS script. The response includes the generated script content, a flag indicating if the script is potentially destructive, and any errors or warnings from the AI. - [Get top faulty resources](https://altostrat.io/docs/api/en/analytics/get-top-faulty-resources.md): Retrieves a list of the top 10 most frequently faulting resources over the last 14 days, along with a sample of their most recent fault events. This is useful for identifying problematic areas in your network. - [List faults from the last seven days](https://altostrat.io/docs/api/en/analytics/list-faults-from-the-last-seven-days.md): Returns recent fault records for the last seven days for dashboard and health views. - [Create an API key](https://altostrat.io/docs/api/en/api-keys/create-an-api-key.md): Creates an API key with the selected permissions. The `secret` is shown exactly once in the response, so store it in a secret manager before you close the dialog or discard the response body. - [Delete an API key](https://altostrat.io/docs/api/en/api-keys/delete-an-api-key.md): Revokes an API key and removes its backing machine-to-machine application. - [List API keys](https://altostrat.io/docs/api/en/api-keys/list-api-keys.md): Returns the API keys owned by the current organization. Secrets are never returned from this endpoint. - [Retrieve an API key](https://altostrat.io/docs/api/en/api-keys/retrieve-an-api-key.md): Returns metadata for one API key. The secret is not returned. - [Rotate an API key secret](https://altostrat.io/docs/api/en/api-keys/rotate-an-api-key-secret.md): Rotates the API key secret and invalidates the previous secret. The new `secret` is shown exactly once in the response. - [Search ARP Entries](https://altostrat.io/docs/api/en/arp-inventory/search-arp-entries.md): Performs a paginated search for ARP entries across one or more sites, with options for filtering and sorting. This is the primary endpoint for building an inventory of connected devices. - [Update ARP Entry](https://altostrat.io/docs/api/en/arp-inventory/update-arp-entry.md): Updates metadata for a specific ARP entry, such as assigning it to a group or setting a custom alias. - [List audit log events](https://altostrat.io/docs/api/en/audit-logs/list-audit-log-events.md): Retrieve a list of audit log events for your organization. This endpoint supports powerful filtering and pagination to help you find specific events for security, compliance, or debugging purposes. - [Create an auth integration](https://altostrat.io/docs/api/en/auth-integrations/create-an-auth-integration.md): Creates a new authentication integration for use with captive portal instances that have an 'oauth2' strategy. - [Delete an auth integration](https://altostrat.io/docs/api/en/auth-integrations/delete-an-auth-integration.md): Permanently deletes an authentication integration. This action cannot be undone and may affect captive portal instances that rely on it. - [List all auth integrations](https://altostrat.io/docs/api/en/auth-integrations/list-all-auth-integrations.md): Retrieves a list of all OAuth2 authentication integrations (IDPs) configured for the user's account. - [Retrieve an auth integration](https://altostrat.io/docs/api/en/auth-integrations/retrieve-an-auth-integration.md): Retrieves the details of a specific authentication integration by its unique ID. - [Update an auth integration](https://altostrat.io/docs/api/en/auth-integrations/update-an-auth-integration.md): Updates the configuration of an existing authentication integration. - [Create a workflow authorization URL](https://altostrat.io/docs/api/en/authorizations/create-a-workflow-authorization-url.md): Creates an authorization flow URL that lets a workflow act on behalf of the current user. - [Delete a workflow authorization](https://altostrat.io/docs/api/en/authorizations/delete-a-workflow-authorization.md): Deletes a workflow authorization so workflows can no longer use that delegated account context. - [List workflow authorizations](https://altostrat.io/docs/api/en/authorizations/list-workflow-authorizations.md): Returns workflow account authorizations available to the authenticated user. - [List Backups for a Site](https://altostrat.io/docs/api/en/backups/list-backups-for-a-site.md): Retrieves a list of all available configuration backup files for a specific site, sorted from newest to oldest. This allows you to see the entire history of captured configurations for a device. - [List discovered site subnets](https://altostrat.io/docs/api/en/backups/list-discovered-site-subnets.md): Returns the subnet routes discovered from the latest configuration data for a site. SDX uses this when you attach site subnets to captive portal, VPN, CVE scan, and other network services. - [Request a New Backup](https://altostrat.io/docs/api/en/backups/request-a-new-backup.md): Asynchronously triggers a new configuration backup for the specified site. The backup process runs in the background. This endpoint returns immediately with a status indicating the request has been accepted for processing. - [Retrieve a Specific Backup](https://altostrat.io/docs/api/en/backups/retrieve-a-specific-backup.md): Fetches the contents of a specific backup file. The format of the response can be controlled via HTTP headers to return JSON metadata, raw text, highlighted HTML, or a downloadable file. - [Create a BGP Threat Intelligence Policy](https://altostrat.io/docs/api/en/bgp-threat-intelligence/create-a-bgp-threat-intelligence-policy.md): Creates a new BGP policy, specifying which IP reputation lists to use for blocking traffic. - [Delete a BGP Policy](https://altostrat.io/docs/api/en/bgp-threat-intelligence/delete-a-bgp-policy.md): Permanently deletes a BGP policy. This operation will fail if the policy is currently attached to one or more sites. - [List BGP IP Reputation Lists](https://altostrat.io/docs/api/en/bgp-threat-intelligence/list-bgp-ip-reputation-lists.md): Retrieves a list of all available BGP IP reputation lists that can be included in a BGP policy. - [List BGP Threat Intelligence Policies](https://altostrat.io/docs/api/en/bgp-threat-intelligence/list-bgp-threat-intelligence-policies.md): Retrieves a list of all BGP Threat Intelligence policies associated with your account. - [Retrieve a BGP Policy](https://altostrat.io/docs/api/en/bgp-threat-intelligence/retrieve-a-bgp-policy.md): Retrieves the details of a specific BGP Threat Intelligence policy by its unique identifier. - [Update a BGP Policy](https://altostrat.io/docs/api/en/bgp-threat-intelligence/update-a-bgp-policy.md): Updates the properties of an existing BGP policy, including its name, status, selected IP lists, and site attachments. - [Create a billing account](https://altostrat.io/docs/api/en/billing-accounts/create-a-billing-account.md): Creates a new billing account within a workspace. This also creates a corresponding Customer object in Stripe. The behavior is constrained by the workspace's billing mode; for `single` mode, only one billing account can be created. For `pooled` and `assigned` modes, up to 10 can be created. - [Delete a billing account](https://altostrat.io/docs/api/en/billing-accounts/delete-a-billing-account.md): Permanently deletes a billing account. This action cannot be undone. A billing account cannot be deleted if it has any active subscriptions. - [List billing accounts](https://altostrat.io/docs/api/en/billing-accounts/list-billing-accounts.md): Returns a list of billing accounts associated with a workspace. - [Retrieve a billing account](https://altostrat.io/docs/api/en/billing-accounts/retrieve-a-billing-account.md): Retrieves the details of a specific billing account. - [Update a billing account](https://altostrat.io/docs/api/en/billing-accounts/update-a-billing-account.md): Updates the details of a billing account. Any parameters not provided will be left unchanged. This operation also updates the corresponding Customer object in Stripe. - [Create a captive portal instance](https://altostrat.io/docs/api/en/captive-portal-instances/create-a-captive-portal-instance.md): Creates a new captive portal instance with a basic configuration. Further details, such as themes and sites, can be added via an update operation. - [Delete a captive portal instance](https://altostrat.io/docs/api/en/captive-portal-instances/delete-a-captive-portal-instance.md): Permanently deletes a captive portal instance and all associated subnets, sites, coupons, and assets. This action cannot be undone. - [List all captive portal instances](https://altostrat.io/docs/api/en/captive-portal-instances/list-all-captive-portal-instances.md): Retrieves a list of all captive portal instances accessible to the authenticated user. - [Retrieve a captive portal instance](https://altostrat.io/docs/api/en/captive-portal-instances/retrieve-a-captive-portal-instance.md): Retrieves the complete details of a specific captive portal instance by its unique ID. - [Update a captive portal instance](https://altostrat.io/docs/api/en/captive-portal-instances/update-a-captive-portal-instance.md): Updates the configuration of a specific captive portal instance, including its theme, sites, subnets, and other settings. - [Upload an instance image](https://altostrat.io/docs/api/en/captive-portal-instances/upload-an-instance-image.md): Uploads a logo or icon for a specific captive portal instance. The image will be stored and served via a signed URL in the instance's theme. - [Download Client CA](https://altostrat.io/docs/api/en/certificates/download-client-ca.md) - [Download NAS Certificate](https://altostrat.io/docs/api/en/certificates/download-nas-certificate.md) - [Download NAS Private Key](https://altostrat.io/docs/api/en/certificates/download-nas-private-key.md) - [Fetch a VPN client configuration](https://altostrat.io/docs/api/en/client-configuration/fetch-a-vpn-client-configuration.md): Returns the VPN client configuration for a share token. The portal calls this endpoint with the share token in the bearer `Authorization` header. - [Add a comment to a fault](https://altostrat.io/docs/api/en/comments/add-a-comment-to-a-fault.md): Adds a new comment to an existing fault. Comments are useful for tracking troubleshooting steps, adding context, or communicating with team members about an incident. - [Get Raw README Content](https://altostrat.io/docs/api/en/community-scripts/get-raw-readme-content.md): Downloads the raw, plain-text markdown content of a community script's README file, if one exists. - [Get Raw Script Content](https://altostrat.io/docs/api/en/community-scripts/get-raw-script-content.md): Downloads the raw, plain-text content of a community script, suitable for direct use or inspection. - [List Community Scripts](https://altostrat.io/docs/api/en/community-scripts/list-community-scripts.md): Retrieves a paginated list of scripts from the public community repository. This is a valuable resource for finding pre-built solutions for common MikroTik tasks. - [Retrieve a Community Script](https://altostrat.io/docs/api/en/community-scripts/retrieve-a-community-script.md): Fetches detailed information about a specific community script, including its content, description, and metadata about the author and source repository. - [Submit a Community Script](https://altostrat.io/docs/api/en/community-scripts/submit-a-community-script.md): Submits a new script to the community repository by providing a URL to a raw `.rsc` file on GitHub. The system will then fetch the script content and associated repository metadata. - [Create a coupon schedule](https://altostrat.io/docs/api/en/coupon-schedules/create-a-coupon-schedule.md): Creates a new schedule to automatically generate coupons on a recurring basis (daily, weekly, or monthly). - [Delete a coupon schedule](https://altostrat.io/docs/api/en/coupon-schedules/delete-a-coupon-schedule.md): Permanently deletes a coupon schedule. This will not delete coupons that have already been generated by the schedule. - [Generate a signed coupon URL](https://altostrat.io/docs/api/en/coupon-schedules/generate-a-signed-coupon-url.md): Creates a temporary, signed URL that can be used to retrieve the list of valid coupons generated by a specific schedule. This is useful for distributing coupons to third-party systems without exposing API keys. The URL is valid for 24 hours. - [List coupon schedules](https://altostrat.io/docs/api/en/coupon-schedules/list-coupon-schedules.md): Retrieves a list of all coupon generation schedules for a specific captive portal instance. - [Retrieve a coupon schedule](https://altostrat.io/docs/api/en/coupon-schedules/retrieve-a-coupon-schedule.md): Retrieves the details of a specific coupon schedule by its ID. - [Run a coupon schedule now](https://altostrat.io/docs/api/en/coupon-schedules/run-a-coupon-schedule-now.md): Manually triggers a coupon schedule to generate a new batch of coupons immediately, outside of its normal recurrence. - [Update a coupon schedule](https://altostrat.io/docs/api/en/coupon-schedules/update-a-coupon-schedule.md): Updates the configuration of an existing coupon schedule. - [Create coupons](https://altostrat.io/docs/api/en/coupons/create-coupons.md): Generates a batch of one-time use coupons for a specified captive portal instance. - [List valid coupons for an instance](https://altostrat.io/docs/api/en/coupons/list-valid-coupons-for-an-instance.md): Retrieves a list of all valid (unredeemed and not expired) coupons for a specific captive portal instance. - [Get Data Transferred Volume](https://altostrat.io/docs/api/en/dashboard/get-data-transferred-volume.md): Retrieves the total volume of data transferred (in bytes) across specified sites, aggregated into time buckets. Use this endpoint to analyze data consumption and usage patterns. - [Get Network Throughput](https://altostrat.io/docs/api/en/dashboard/get-network-throughput.md): Retrieves time-series data representing the average network throughput (in bits per second) across specified sites over a given time window. Use this endpoint to visualize traffic rates for dashboards and reports. - [Delete Job](https://altostrat.io/docs/api/en/data-migration/delete-job.md) - [Download Example CSV](https://altostrat.io/docs/api/en/data-migration/download-example-csv.md): Download a template CSV file for bulk import. - [Get Columns](https://altostrat.io/docs/api/en/data-migration/get-columns.md) - [Get Job Status](https://altostrat.io/docs/api/en/data-migration/get-job-status.md) - [Get Upload URL](https://altostrat.io/docs/api/en/data-migration/get-upload-url.md) - [List Jobs](https://altostrat.io/docs/api/en/data-migration/list-jobs.md) - [Preview File](https://altostrat.io/docs/api/en/data-migration/preview-file.md) - [Start Dry Run](https://altostrat.io/docs/api/en/data-migration/start-dry-run.md) - [Start Import](https://altostrat.io/docs/api/en/data-migration/start-import.md) - [Queue an asynchronous RouterOS script](https://altostrat.io/docs/api/en/developer-api/queue-an-asynchronous-routeros-script.md): Queues a RouterOS script for execution on a managed site. Use asynchronous scripts for configuration changes, backups, and work that should be tracked as a device job. - [Run a synchronous RouterOS command](https://altostrat.io/docs/api/en/developer-api/run-a-synchronous-routeros-command.md): Runs a RouterOS command against a managed site and returns the router response. Use synchronous commands for reads or short diagnostics, not long-running configuration changes. - [Get router metadata](https://altostrat.io/docs/api/en/developer-routers/get-router-metadata.md): Get router metadata exposed by the SDX developer API for a managed router. - [Get router metrics summary](https://altostrat.io/docs/api/en/developer-routers/get-router-metrics-summary.md): Get router metrics summary exposed by the SDX developer API for a managed router. - [Get router OEM data](https://altostrat.io/docs/api/en/developer-routers/get-router-oem-data.md): Get router OEM data exposed by the SDX developer API for a managed router. - [List developer API routers](https://altostrat.io/docs/api/en/developer-routers/list-developer-api-routers.md): Lists routers that the authenticated API key or user can access through the developer API. - [List router faults](https://altostrat.io/docs/api/en/developer-routers/list-router-faults.md): List router faults exposed by the SDX developer API for a managed router. - [List router jobs](https://altostrat.io/docs/api/en/developer-routers/list-router-jobs.md): List router jobs exposed by the SDX developer API for a managed router. - [Get Device Heartbeat History](https://altostrat.io/docs/api/en/device-health-&-status/get-device-heartbeat-history.md): Retrieves the device's heartbeat and connectivity status over the past 24 hours, aggregated hourly. This helps identify periods of downtime or missed check-ins. - [Get Last Seen Time](https://altostrat.io/docs/api/en/device-health-&-status/get-last-seen-time.md): Returns the time since the device at the specified site last reported its status. - [Get Recent Device Health Stats](https://altostrat.io/docs/api/en/device-health-&-status/get-recent-device-health-stats.md): Retrieves a time-series of key health metrics (CPU, memory, disk, uptime) for a specific site's device from the last 8 hours. - [Retrieve Site Stats Over a Date Range](https://altostrat.io/docs/api/en/device-stats/retrieve-site-stats-over-a-date-range.md): Fetches time-series performance metrics (CPU, memory, disk, uptime) for a site within a specified date range. For ranges over 48 hours, data is automatically aggregated hourly to ensure a fast response. For shorter ranges, raw data points are returned. - [JSON Web Key Set (JWKS) Endpoint](https://altostrat.io/docs/api/en/discovery/json-web-key-set-jwks-endpoint.md): Provides the set of public keys used to verify the signature of JWTs issued by the authentication server. Clients should use the `kid` (Key ID) from a JWT's header to select the correct key for validation. - [OIDC Discovery Endpoint](https://altostrat.io/docs/api/en/discovery/oidc-discovery-endpoint.md): Returns a JSON document containing the OpenID Provider's configuration metadata. OIDC-compliant clients use this endpoint to automatically discover the locations of the authorization, token, userinfo, and JWKS endpoints, as well as all supported capabilities. - [Create a DNS Content Filtering Policy](https://altostrat.io/docs/api/en/dns-content-filtering/create-a-dns-content-filtering-policy.md): Creates a new DNS Content Filtering policy with specified filtering rules, application blocks, and safe search settings. - [Delete a DNS Policy](https://altostrat.io/docs/api/en/dns-content-filtering/delete-a-dns-policy.md): Permanently deletes a DNS policy. This operation will fail if the policy is currently attached to one or more sites. - [List Application Categories](https://altostrat.io/docs/api/en/dns-content-filtering/list-application-categories.md): Retrieves a list of all available application categories. Each category contains a list of applications that can be targeted in DNS policies. - [List DNS Content Filtering Policies](https://altostrat.io/docs/api/en/dns-content-filtering/list-dns-content-filtering-policies.md): Retrieves a list of all DNS Content Filtering policies associated with your account. - [List Safe Search Services](https://altostrat.io/docs/api/en/dns-content-filtering/list-safe-search-services.md): Retrieves a list of services (e.g., Google, YouTube) for which Safe Search can be enforced in a DNS policy. - [Retrieve a DNS Policy](https://altostrat.io/docs/api/en/dns-content-filtering/retrieve-a-dns-policy.md): Retrieves the details of a specific DNS Content Filtering policy by its unique identifier. - [Update a DNS Policy](https://altostrat.io/docs/api/en/dns-content-filtering/update-a-dns-policy.md): Updates the properties of an existing DNS policy. You can change its name, application blocks, safe search settings, and site attachments. - [Search Altostrat Documentation](https://altostrat.io/docs/api/en/documentation-search/search-altostrat-documentation.md): Use this endpoint to integrate Altostrat's official help and developer documentation search directly into your tools. It's designed to provide quick answers and code references, helping developers resolve issues and build integrations faster. - [Search for Platform Entities](https://altostrat.io/docs/api/en/entity-search/search-for-platform-entities.md): This endpoint allows for a powerful, full-text search across all indexed entities within a user's tenancy scope. By default, it searches all resources within the user's organization. You can narrow the scope to a specific workspace or apply fine-grained filters based on entity type and creation date… - [Activate Failover Service](https://altostrat.io/docs/api/en/failover-service/activate-failover-service.md): Activates the WAN Failover service for a specified site. This is the first step to enabling SD-WAN capabilities. Activating the service automatically creates two default, unconfigured WAN tunnels. - [Deactivate Failover Service](https://altostrat.io/docs/api/en/failover-service/deactivate-failover-service.md): Deactivates the WAN Failover service for a site, removing all associated WAN tunnels and their configurations from both the Altostrat platform and the on-site router. This action is irreversible. - [Get Failover Service Status](https://altostrat.io/docs/api/en/failover-service/get-failover-service-status.md): Checks the status of the WAN Failover service for a specific site, returning the subscription ID if it is active. - [List Sites with Failover Service](https://altostrat.io/docs/api/en/failover-service/list-sites-with-failover-service.md): Retrieves a list of all sites associated with the authenticated user that have the WAN Failover service currently activated. - [Create a fault](https://altostrat.io/docs/api/en/faults/create-a-fault.md): Manually creates a new fault object. This is typically used for creating faults from external systems or for testing purposes. For automated ingestion, other microservices push events that are processed into faults. - [Delete a fault](https://altostrat.io/docs/api/en/faults/delete-a-fault.md): Permanently deletes a fault object. This action cannot be undone. - [List all faults](https://altostrat.io/docs/api/en/faults/list-all-faults.md): Returns a paginated list of fault objects for your account. The faults are returned in reverse chronological order by creation time. You can filter the results using the query parameters. - [Retrieve a fault](https://altostrat.io/docs/api/en/faults/retrieve-a-fault.md): Retrieves the details of an existing fault. You need only supply the unique fault identifier that was returned upon fault creation. - [Update a fault](https://altostrat.io/docs/api/en/faults/update-a-fault.md): Updates the specified fault by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This is useful for changing a fault's severity or manually resolving it. - [Delete a Generated Report](https://altostrat.io/docs/api/en/generated-reports/delete-a-generated-report.md): Permanently deletes a previously generated report and its associated PDF and JSON data from storage. - [List Generated Reports](https://altostrat.io/docs/api/en/generated-reports/list-generated-reports.md): Retrieves a paginated list of all historically generated reports for the workspace, sorted by creation date in descending order. - [Export dashboard panel CSV](https://altostrat.io/docs/api/en/grafana-dashboards/export-dashboard-panel-csv.md): Exports a single Grafana dashboard panel as CSV for reporting, audit, or billing workflows. - [List dashboards](https://altostrat.io/docs/api/en/grafana-dashboards/list-dashboards.md): Lists available Grafana dashboards with their variables and panel metadata. - [List dashboards in a folder](https://altostrat.io/docs/api/en/grafana-dashboards/list-dashboards-in-a-folder.md): Lists Grafana dashboards from a specific folder. - [Query a dashboard](https://altostrat.io/docs/api/en/grafana-dashboards/query-a-dashboard.md): Executes the Prometheus queries defined by a Grafana dashboard, optionally limiting the request to selected panels. - [Attach Tag to Group](https://altostrat.io/docs/api/en/groups/attach-tag-to-group.md) - [Create Group](https://altostrat.io/docs/api/en/groups/create-group.md) - [Delete Group](https://altostrat.io/docs/api/en/groups/delete-group.md) - [Detach Tag from Group](https://altostrat.io/docs/api/en/groups/detach-tag-from-group.md) - [List Accounts in Group](https://altostrat.io/docs/api/en/groups/list-accounts-in-group.md) - [List Groups](https://altostrat.io/docs/api/en/groups/list-groups.md) - [Retrieve Group](https://altostrat.io/docs/api/en/groups/retrieve-group.md) - [Update Group](https://altostrat.io/docs/api/en/groups/update-group.md) - [List Router Interfaces](https://altostrat.io/docs/api/en/helper-endpoints/list-router-interfaces.md): Retrieves a list of available physical and logical network interfaces from the router at the specified site. This is useful for identifying the correct `interface` name when configuring a tunnel. - [List Router Interfaces for Failover](https://altostrat.io/docs/api/en/helper-endpoints/list-router-interfaces-for-failover.md): Retrieves available physical and logical interfaces from the router at the specified site for WAN failover configuration. - [Look up Eligible Gateways](https://altostrat.io/docs/api/en/helper-endpoints/look-up-eligible-gateways.md): For a given router interface, this endpoint attempts to detect eligible upstream gateway IP addresses. This helps automate the process of finding the correct `gateway` IP for a tunnel configuration. - [Look up Eligible Gateways for Failover](https://altostrat.io/docs/api/en/helper-endpoints/look-up-eligible-gateways-for-failover.md): Detects eligible upstream gateway IP addresses for a router interface used in WAN failover configuration. - [Active Sessions Count](https://altostrat.io/docs/api/en/insights/active-sessions-count.md) - [Auth Events History](https://altostrat.io/docs/api/en/insights/auth-events-history.md) - [Authentication Latency](https://altostrat.io/docs/api/en/insights/authentication-latency.md) - [Authentication Outliers](https://altostrat.io/docs/api/en/insights/authentication-outliers.md) - [Disconnection Stats](https://altostrat.io/docs/api/en/insights/disconnection-stats.md) - [Frequent Disconnects](https://altostrat.io/docs/api/en/insights/frequent-disconnects.md) - [Misconfigured NAS](https://altostrat.io/docs/api/en/insights/misconfigured-nas.md) - [Most Active NAS](https://altostrat.io/docs/api/en/insights/most-active-nas.md) - [NAS Disconnect Reasons](https://altostrat.io/docs/api/en/insights/nas-disconnect-reasons.md) - [Network Health Snapshot](https://altostrat.io/docs/api/en/insights/network-health-snapshot.md) - [Peak Concurrency](https://altostrat.io/docs/api/en/insights/peak-concurrency.md) - [Session Duration History](https://altostrat.io/docs/api/en/insights/session-duration-history.md) - [Session Termination History](https://altostrat.io/docs/api/en/insights/session-termination-history.md) - [Short Lived Sessions](https://altostrat.io/docs/api/en/insights/short-lived-sessions.md) - [Simultaneous Use Violations](https://altostrat.io/docs/api/en/insights/simultaneous-use-violations.md) - [Top Talkers](https://altostrat.io/docs/api/en/insights/top-talkers.md) - [Create a VPN instance](https://altostrat.io/docs/api/en/instances/create-a-vpn-instance.md): Provisions a new VPN server instance in a specified region with a unique hostname. This is the first step in setting up a new VPN. - [Delete a VPN instance](https://altostrat.io/docs/api/en/instances/delete-a-vpn-instance.md): Permanently decommissions a VPN instance and all its associated servers and peers. This action cannot be undone. - [List all VPN instances](https://altostrat.io/docs/api/en/instances/list-all-vpn-instances.md): Retrieves a list of all VPN instances accessible by the authenticated user. - [Retrieve a VPN instance](https://altostrat.io/docs/api/en/instances/retrieve-a-vpn-instance.md): Fetches the details of a specific VPN instance by its unique identifier. - [Retrieve instance bandwidth](https://altostrat.io/docs/api/en/instances/retrieve-instance-bandwidth.md): Fetches the bandwidth usage statistics for the primary server associated with a VPN instance. - [Update a VPN instance](https://altostrat.io/docs/api/en/instances/update-a-vpn-instance.md): Modifies the configuration of an existing VPN instance, such as its name, DNS settings, or pushed routes. - [API Reference](https://altostrat.io/docs/api/en/introduction.md): Find generated OpenAPI reference material for public Altostrat SDX endpoints. - [List invoices](https://altostrat.io/docs/api/en/invoices/list-invoices.md): Returns a list of invoices for a billing account. Invoices are returned in reverse chronological order. - [Preview an invoice](https://altostrat.io/docs/api/en/invoices/preview-an-invoice.md): Previews an upcoming invoice for a billing account, showing the financial impact of potential subscription changes, such as adding products or changing quantities. This does not modify any existing subscriptions. - [Cancel a Pending Job](https://altostrat.io/docs/api/en/jobs/cancel-a-pending-job.md): Deletes a job that has not yet started execution. Jobs that are in progress, completed, or failed cannot be deleted. - [Create a Job for a Site](https://altostrat.io/docs/api/en/jobs/create-a-job-for-a-site.md): Creates and queues a new job to be executed on the specified site. The job's payload is a raw RouterOS script, and metadata is provided via headers. - [List Jobs for a Site](https://altostrat.io/docs/api/en/jobs/list-jobs-for-a-site.md): Retrieves a list of all jobs that have been created for a specific site, ordered by creation date (most recent first). - [Retrieve a Job](https://altostrat.io/docs/api/en/jobs/retrieve-a-job.md): Retrieves the complete details of a specific job by its unique identifier (UUID). - [List Account Logs](https://altostrat.io/docs/api/en/logs/list-account-logs.md) - [List NAS Logs](https://altostrat.io/docs/api/en/logs/list-nas-logs.md) - [Create a metadata object](https://altostrat.io/docs/api/en/metadata/create-a-metadata-object.md): Creates a new metadata object for a given resource, or fully overwrites an existing one for that resource. The metadata itself is a flexible key-value store. - [Delete a metadata object](https://altostrat.io/docs/api/en/metadata/delete-a-metadata-object.md): Deletes all custom metadata associated with a resource. This action clears the `metadata` field but does not delete the resource itself. - [List all metadata objects](https://altostrat.io/docs/api/en/metadata/list-all-metadata-objects.md): Retrieves a collection of all resources that have metadata associated with them for the current customer. - [Retrieve a metadata object](https://altostrat.io/docs/api/en/metadata/retrieve-a-metadata-object.md): Fetches the metadata object for a single resource, identified by its unique ID. - [Update a metadata object](https://altostrat.io/docs/api/en/metadata/update-a-metadata-object.md): Updates the metadata for a specific resource. This operation performs a merge; any keys you provide will be added or will overwrite existing keys, while keys you don't provide will be left untouched. To remove a key, set its value to `null` or an empty string. - [Create NAS Device](https://altostrat.io/docs/api/en/nas-devices/create-nas-device.md) - [Delete NAS Device](https://altostrat.io/docs/api/en/nas-devices/delete-nas-device.md) - [List NAS Devices](https://altostrat.io/docs/api/en/nas-devices/list-nas-devices.md) - [Retrieve NAS Device](https://altostrat.io/docs/api/en/nas-devices/retrieve-nas-device.md) - [Update NAS Device](https://altostrat.io/docs/api/en/nas-devices/update-nas-device.md) - [Get BGP Security Report](https://altostrat.io/docs/api/en/network-logs/get-bgp-security-report.md): Generates a BGP security report for a site based on the last 24 hours of data. The report includes top 10 destination ports, top 10 blocklists triggered, and top 10 source IPs initiating blocked traffic. - [Get DNS Security Report](https://altostrat.io/docs/api/en/network-logs/get-dns-security-report.md): Generates a DNS security report for a site based on the last 24 hours of data. The report includes top 10 blocked categories, top 10 blocked applications, and top 10 internal source IPs making blocked requests. - [Get Site Syslog Entries](https://altostrat.io/docs/api/en/network-logs/get-site-syslog-entries.md): Retrieves a paginated list of syslog messages for a specific site, ordered by the most recent first. - [Create a Notification Group](https://altostrat.io/docs/api/en/notification-groups/create-a-notification-group.md): Creates a new notification group. This allows you to define a new rule for who gets notified about which topics, for which sites, and on what schedule. - [Delete a Notification Group](https://altostrat.io/docs/api/en/notification-groups/delete-a-notification-group.md): Permanently deletes a notification group. This action cannot be undone. - [List Notification Groups](https://altostrat.io/docs/api/en/notification-groups/list-notification-groups.md): Retrieves a list of all notification groups configured for the authenticated user's workspace. Each group represents a specific set of rules for routing alerts. - [Retrieve a Notification Group](https://altostrat.io/docs/api/en/notification-groups/retrieve-a-notification-group.md): Fetches the details of a specific notification group by its unique ID. - [Update a Notification Group](https://altostrat.io/docs/api/en/notification-groups/update-a-notification-group.md): Updates the configuration of an existing notification group. This operation replaces the entire group object with the provided data. - [Exchange Code or Refresh Token for Tokens](https://altostrat.io/docs/api/en/oauth-20-&-oidc/exchange-code-or-refresh-token-for-tokens.md): Used to exchange an `authorization_code` for tokens, or to use a `refresh_token` to get a new `access_token`. Client authentication can be performed via `client_secret_post` (in the body), `client_secret_basic` (HTTP Basic Auth), or `private_key_jwt`. - [Get User Profile](https://altostrat.io/docs/api/en/oauth-20-&-oidc/get-user-profile.md): Retrieves the profile of the user associated with the provided `access_token`. The claims returned are based on the scopes granted during authentication. - [Initiate User Authentication](https://altostrat.io/docs/api/en/oauth-20-&-oidc/initiate-user-authentication.md): This is the starting point for user authentication. The Altostrat web application redirects the user's browser to this endpoint to begin the OAuth 2.0 Authorization Code Flow with PKCE. - [Log Out User (Legacy)](https://altostrat.io/docs/api/en/oauth-20-&-oidc/log-out-user-legacy.md): Logs the user out of their Altostrat session and redirects them back to a specified URL. - [Log Out User (OIDC Compliant)](https://altostrat.io/docs/api/en/oauth-20-&-oidc/log-out-user-oidc-compliant.md): This endpoint conforms to the OIDC Session Management specification. It logs the user out and can redirect them back to the application. - [Revoke Token](https://altostrat.io/docs/api/en/oauth-20-&-oidc/revoke-token.md): Revokes an `access_token` or `refresh_token`, invalidating it immediately. This is useful for scenarios like password changes or user-initiated logouts from all devices. - [Create a child organization](https://altostrat.io/docs/api/en/organizations/create-a-child-organization.md): Creates a new organization as a direct child of the specified parent organization. The hierarchy cannot exceed 10 levels of depth, and a parent cannot have more than 100 direct children. - [Create an organization](https://altostrat.io/docs/api/en/organizations/create-an-organization.md): Creates a new top-level organization within a workspace. To create a child organization, use the `/organizations/{organizationId}/children` endpoint. A workspace cannot have more than 1,000 organizations in total. - [Delete an organization](https://altostrat.io/docs/api/en/organizations/delete-an-organization.md): Permanently deletes an organization. An organization cannot be deleted if it or any of its descendants have active resource usage. - [Export organization usage as CSV](https://altostrat.io/docs/api/en/organizations/export-organization-usage-as-csv.md): Generates and downloads a CSV file detailing the resource usage and limits for all organizations within the specified workspace. - [Export organization usage as PDF](https://altostrat.io/docs/api/en/organizations/export-organization-usage-as-pdf.md): Generates and downloads a PDF file detailing the resource usage and limits for all organizations within the specified workspace. - [List all descendant organizations](https://altostrat.io/docs/api/en/organizations/list-all-descendant-organizations.md): Returns a flat list of all organizations that are descendants (children, grandchildren, etc.) of the specified parent organization. - [List child organizations](https://altostrat.io/docs/api/en/organizations/list-child-organizations.md): Returns a list of immediate child organizations of a specified parent organization. - [List organizations](https://altostrat.io/docs/api/en/organizations/list-organizations.md): Returns a list of all organizations within the specified workspace. - [Retrieve an organization](https://altostrat.io/docs/api/en/organizations/retrieve-an-organization.md): Retrieves the details of a specific organization within a workspace. - [Retrieve organization limits](https://altostrat.io/docs/api/en/organizations/retrieve-organization-limits.md): Retrieves a detailed breakdown of usage, limits, and available capacity for each meterable product type for a specific organization. This takes into account the organization's own limits, limits inherited from its parents, and the total capacity available from its subscription. - [Retrieve parent organization](https://altostrat.io/docs/api/en/organizations/retrieve-parent-organization.md): Retrieves the parent organization of a specified child organization. If the organization is at the top level, this endpoint will return a 204 No Content response. - [Update an organization](https://altostrat.io/docs/api/en/organizations/update-an-organization.md): Updates specified attributes of an organization. This endpoint can be used to change the organization's name, update its resource limits, or modify branding settings. You only need to provide the fields you want to change. - [Create a Setup Intent](https://altostrat.io/docs/api/en/payment-methods/create-a-setup-intent.md): Creates a Stripe Setup Intent to collect payment method details for future payments. This returns a `client_secret` that you can use with Stripe.js or the mobile SDKs to display a payment form. A billing account cannot have more than 5 payment methods. - [Detach a payment method](https://altostrat.io/docs/api/en/payment-methods/detach-a-payment-method.md): Detaches a payment method from a billing account. You cannot detach the only payment method on an account, nor can you detach the default payment method if there are active subscriptions. - [List payment methods](https://altostrat.io/docs/api/en/payment-methods/list-payment-methods.md): Returns a list of payment methods attached to a billing account. - [Set default payment method](https://altostrat.io/docs/api/en/payment-methods/set-default-payment-method.md): Sets a specified payment method as the default for a billing account. This payment method will be used for all future subscription invoices. - [Create a peer](https://altostrat.io/docs/api/en/peers/create-a-peer.md): Creates a new peer (a client or a site) and associates it with a VPN instance. - [Delete a peer](https://altostrat.io/docs/api/en/peers/delete-a-peer.md): Permanently removes a peer from a VPN instance. This revokes its access. - [List all peers for an instance](https://altostrat.io/docs/api/en/peers/list-all-peers-for-an-instance.md): Retrieves a list of all peers (clients and sites) associated with a specific VPN instance. - [Retrieve a peer](https://altostrat.io/docs/api/en/peers/retrieve-a-peer.md): Fetches the details of a specific peer by its unique identifier. - [Update a peer](https://altostrat.io/docs/api/en/peers/update-a-peer.md): Modifies the configuration of an existing peer, such as its subnets or routing behavior. - [Get Workspace Statistics](https://altostrat.io/docs/api/en/platform/get-workspace-statistics.md) - [List Available RADIUS Attributes](https://altostrat.io/docs/api/en/platform/list-available-radius-attributes.md) - [Create a policy](https://altostrat.io/docs/api/en/policies/create-a-policy.md): Creates a new security policy. You can define rules for services like Winbox, SSH, and HTTP/S, including which networks are allowed to access them. - [Delete a policy](https://altostrat.io/docs/api/en/policies/delete-a-policy.md): Deletes a policy. You cannot delete the default policy. Any sites using the deleted policy will be reassigned to the default policy. - [List all policies](https://altostrat.io/docs/api/en/policies/list-all-policies.md): Retrieves a list of all security policies belonging to your workspace. Policies define the firewall rules and service access configurations applied to your sites. - [Retrieve a policy](https://altostrat.io/docs/api/en/policies/retrieve-a-policy.md): Retrieves the details of a specific policy, including its rules and a list of sites it is applied to. - [Update a policy](https://altostrat.io/docs/api/en/policies/update-a-policy.md): Updates the specified policy by setting the values of the parameters passed. Any parameters not provided will be left unchanged. - [Create a prefix list](https://altostrat.io/docs/api/en/prefix-lists/create-a-prefix-list.md): Creates a new prefix list with a defined set of CIDR blocks and initial site associations. Site associations and address list deployments are handled asynchronously. - [Delete a prefix list](https://altostrat.io/docs/api/en/prefix-lists/delete-a-prefix-list.md): Permanently deletes a prefix list. This action will fail if the prefix list is currently referenced by any security group rule. An asynchronous process will remove the corresponding address list from all associated sites. - [List prefix lists](https://altostrat.io/docs/api/en/prefix-lists/list-prefix-lists.md): Retrieves a list of all prefix lists within your organization. This endpoint provides a summary view and does not include the detailed list of prefixes or sites for performance. To get full details, retrieve a specific prefix list by its ID. - [Retrieve a prefix list](https://altostrat.io/docs/api/en/prefix-lists/retrieve-a-prefix-list.md): Retrieves the complete details of a specific prefix list, including its name, description, status, associated sites, and a full list of its prefixes. - [Update a prefix list](https://altostrat.io/docs/api/en/prefix-lists/update-a-prefix-list.md): Updates an existing prefix list by fully replacing its attributes, including its name, description, prefixes, and site associations. This is a full replacement operation (PUT); any omitted fields will result in those items being removed. - [List Products](https://altostrat.io/docs/api/en/products/list-products.md): Returns a paginated list of MikroTik products. The list can be filtered by product name or model number, allowing for powerful search and cataloging capabilities. - [Retrieve a Product](https://altostrat.io/docs/api/en/products/retrieve-a-product.md): Retrieves the complete details of a single MikroTik product, identified by its unique slug. This endpoint provides an exhaustive set of specifications, including core hardware details, performance test results, included accessories, and downloadable assets. - [Execute a Prometheus query](https://altostrat.io/docs/api/en/prometheus-querying/execute-a-prometheus-query.md): Executes a Prometheus query through the SDX metrics gateway and scopes the result to the authenticated workspace and organization. - [List label values](https://altostrat.io/docs/api/en/prometheus-querying/list-label-values.md): Returns Prometheus values for a label available to the authenticated workspace and organization. - [List metric labels](https://altostrat.io/docs/api/en/prometheus-querying/list-metric-labels.md): Returns Prometheus label names available to the authenticated workspace and organization for the requested time window. - [List metric names](https://altostrat.io/docs/api/en/prometheus-querying/list-metric-names.md): Returns metric names available to the authenticated workspace and organization for the requested time window. - [Retrieve coupons from a signed URL](https://altostrat.io/docs/api/en/public-coupon-urls/retrieve-coupons-from-a-signed-url.md): Returns valid coupons for a coupon schedule when called with the signed query string generated by `GET /captive/instances/{instanceId}/coupon-schedules/{scheduleId}/generate_url`. - [Get public branding information](https://altostrat.io/docs/api/en/public/get-public-branding-information.md): Retrieves the public branding information for an organization, such as its display name, logo, and theme colors. You can use either the organization's primary ID (`org_...`) or its external UUID as the identifier. This is a public, unauthenticated endpoint. - [Resolve login hint](https://altostrat.io/docs/api/en/public/resolve-login-hint.md): Given a unique login hint (e.g., a short company name like 'acme'), this endpoint returns the corresponding organization ID. This is useful for pre-filling organization details in a login flow. This is a public, unauthenticated endpoint. - [Create Realm](https://altostrat.io/docs/api/en/realms/create-realm.md) - [Delete Realm](https://altostrat.io/docs/api/en/realms/delete-realm.md) - [Get Realm](https://altostrat.io/docs/api/en/realms/get-realm.md) - [List Realms](https://altostrat.io/docs/api/en/realms/list-realms.md) - [Update Realm](https://altostrat.io/docs/api/en/realms/update-realm.md) - [List common services](https://altostrat.io/docs/api/en/reference-data/list-common-services.md): Retrieves a list of common network services and their standard port numbers to aid in the creation of firewall rules. - [List supported protocols](https://altostrat.io/docs/api/en/reference-data/list-supported-protocols.md): Retrieves a list of all supported network protocols and their corresponding integer values, which are required when creating firewall rules. - [List Resellers](https://altostrat.io/docs/api/en/resellers/list-resellers.md): Returns a paginated list of official MikroTik resellers. This allows you to find resellers based on their geographical location or name, providing valuable information for procurement and partnership purposes. - [Retrieve a Runbook](https://altostrat.io/docs/api/en/runbooks/retrieve-a-runbook.md): Retrieves the details of a specific runbook, including its name and the bootstrap command used to onboard new devices with this configuration. - [Start a Scan](https://altostrat.io/docs/api/en/scan-execution/start-a-scan.md): Manually triggers a scan for a given schedule, overriding its normal timetable. The scan will be queued for execution immediately. - [Start On-Demand Multi-IP Scan](https://altostrat.io/docs/api/en/scan-execution/start-on-demand-multi-ip-scan.md): Initiates an immediate, on-demand scan for a specific list of IP addresses. This uses the configuration of an existing scan schedule but targets only the specified IPs within a particular site. - [Start On-Demand Single-IP Scan](https://altostrat.io/docs/api/en/scan-execution/start-on-demand-single-ip-scan.md): Initiates an immediate, on-demand scan for a single IP address. This uses the configuration of an existing scan schedule but targets only the specified IP within a particular site. - [Stop a Scan](https://altostrat.io/docs/api/en/scan-execution/stop-a-scan.md): Forcefully stops a scan that is currently in progress for a given schedule. - [Get Latest Scan Status](https://altostrat.io/docs/api/en/scan-results/get-latest-scan-status.md): Retrieves the status of the most recent scan associated with a specific schedule, whether it is running, completed, or failed. - [List Scan Reports](https://altostrat.io/docs/api/en/scan-results/list-scan-reports.md): Retrieves a list of completed scan reports for your account, ordered by the most recent first. Each item in the list is a summary of a scan run. - [Retrieve a Scan Report](https://altostrat.io/docs/api/en/scan-results/retrieve-a-scan-report.md): Fetches the detailed report for a specific completed scan run. The report includes scan metadata and links to download the full JSON or PDF report. - [Create Scan Schedule](https://altostrat.io/docs/api/en/scan-schedules/create-scan-schedule.md): Creates a new recurring CVE scan schedule. You must define the timing, frequency, target sites and subnets, and notification settings. A successful creation returns the full schedule object. - [Delete a Scan Schedule](https://altostrat.io/docs/api/en/scan-schedules/delete-a-scan-schedule.md): Permanently deletes a scan schedule. This action cannot be undone and will stop any future scans for this schedule. - [List Scan Schedules](https://altostrat.io/docs/api/en/scan-schedules/list-scan-schedules.md): Retrieves a list of all CVE scan schedules configured for your account. This is useful for displaying all configured scans in a dashboard or for programmatic management. - [Retrieve a Scan Schedule](https://altostrat.io/docs/api/en/scan-schedules/retrieve-a-scan-schedule.md): Fetches the details of a specific scan schedule by its unique identifier. - [Update a Scan Schedule](https://altostrat.io/docs/api/en/scan-schedules/update-a-scan-schedule.md): Updates the configuration of an existing scan schedule. All fields are replaced by the new values provided in the request body. - [Cancel or Delete a Scheduled Script](https://altostrat.io/docs/api/en/scheduled-scripts/cancel-or-delete-a-scheduled-script.md): This endpoint has dual functionality. If the script is 'unauthorized' and has not been launched, it will be permanently deleted. If the script is 'scheduled' or 'launched', it will be marked as 'cancelled' to prevent further execution, but the record will be retained. - [Get Execution Progress](https://altostrat.io/docs/api/en/scheduled-scripts/get-execution-progress.md): Retrieves the real-time execution progress for a script that has been launched. It provides lists of sites where the script has completed, failed, or is still pending. - [Immediately Run a Scheduled Script](https://altostrat.io/docs/api/en/scheduled-scripts/immediately-run-a-scheduled-script.md): Triggers an immediate execution of an already authorized script, overriding its scheduled 'launch_at' time. This is useful for urgent deployments. The script must be in an 'authorized' state to be run immediately. - [List Scheduled Scripts](https://altostrat.io/docs/api/en/scheduled-scripts/list-scheduled-scripts.md): Retrieves a list of all scripts scheduled for execution that are accessible by the authenticated user. This provides an overview of pending, in-progress, and completed automation tasks. - [Request Script Authorization](https://altostrat.io/docs/api/en/scheduled-scripts/request-script-authorization.md): Initiates the authorization workflow for an 'unauthorized' script. This action sends notifications (e.g., WhatsApp, email) to the configured recipients, containing a unique link to approve the script's execution. - [Retrieve a Scheduled Script](https://altostrat.io/docs/api/en/scheduled-scripts/retrieve-a-scheduled-script.md): Fetches the detailed information for a single scheduled script, including its current status, progress, and configuration. - [Run a Test Execution](https://altostrat.io/docs/api/en/scheduled-scripts/run-a-test-execution.md): Immediately dispatches the script for execution on the designated 'test_site_id'. This allows for validation of the script's logic and impact in a controlled environment before a full-scale launch. The script does not need to be authorized to run a test. - [Schedule a New Script](https://altostrat.io/docs/api/en/scheduled-scripts/schedule-a-new-script.md): Creates a new scheduled script entry. This involves defining the script content, selecting target devices (sites), specifying a launch time, and configuring notification recipients. The script will be in an 'unauthorized' state until an authorization workflow is completed. - [Update a Scheduled Script](https://altostrat.io/docs/api/en/scheduled-scripts/update-a-scheduled-script.md): Modifies an existing scheduled script. This is only possible if the script has not yet been launched. Updating a script will reset its authorization status to 'unauthorized', requiring re-approval before it can be executed. - [Create a new schedule](https://altostrat.io/docs/api/en/schedules/create-a-new-schedule.md): Creates a new schedule with a defined set of recurring time slots. Upon creation, the schedule's `active` status is automatically calculated based on the current time and the provided slots. - [Delete a schedule](https://altostrat.io/docs/api/en/schedules/delete-a-schedule.md): Permanently deletes a schedule, including all of its associated time slots and metadata. This action cannot be undone. - [List all schedules](https://altostrat.io/docs/api/en/schedules/list-all-schedules.md): Retrieves a list of all schedule objects belonging to your workspace. The schedules are returned sorted by creation date, with the most recently created schedules appearing first. - [Retrieve a schedule](https://altostrat.io/docs/api/en/schedules/retrieve-a-schedule.md): Retrieves the details of an existing schedule by its unique identifier. - [Update a schedule](https://altostrat.io/docs/api/en/schedules/update-a-schedule.md): Updates the specified schedule by setting the properties of the request body. Any properties not provided will be left unchanged. When updating `hours`, the entire array is replaced. When updating `metadata`, providing a key with a `null` value will delete that metadata entry. - [Create a Script Template](https://altostrat.io/docs/api/en/script-templates/create-a-script-template.md): Creates a new, private script template for the user's organization. This allows for the storage and reuse of standardized scripts within a team. - [Delete a Script Template](https://altostrat.io/docs/api/en/script-templates/delete-a-script-template.md): Permanently removes a private script template. This action cannot be undone and is only permitted on templates that the user is authorized to edit. - [List Script Templates](https://altostrat.io/docs/api/en/script-templates/list-script-templates.md): Retrieves a collection of script templates. Templates can be filtered to show public (global), private (organization-specific), or all accessible templates. They can also be searched by name or description. - [Retrieve a Script Template](https://altostrat.io/docs/api/en/script-templates/retrieve-a-script-template.md): Fetches the details of a specific script template, including its content. - [Update a Script Template](https://altostrat.io/docs/api/en/script-templates/update-a-script-template.md): Modifies an existing script template. This action is only permitted on templates that are private to the user's organization and were created by the user. Global templates are read-only. - [Create a security group](https://altostrat.io/docs/api/en/security-groups/create-a-security-group.md): Creates a new security group with a defined set of firewall rules and initial site associations. The group is created atomically. Site associations and rule deployments are handled asynchronously. The response will indicate a `syncing` status if there are sites to update. - [Delete a security group](https://altostrat.io/docs/api/en/security-groups/delete-a-security-group.md): Permanently deletes a security group. This action cannot be undone. An asynchronous process will remove the corresponding firewall rules from all associated sites. - [List security groups](https://altostrat.io/docs/api/en/security-groups/list-security-groups.md): Retrieves a list of all security groups within your organization. This endpoint provides a summary view of each group and does not include the detailed list of rules or associated sites for performance reasons. To get full details, retrieve a specific security group by its ID. - [Retrieve a security group](https://altostrat.io/docs/api/en/security-groups/retrieve-a-security-group.md): Retrieves the complete details of a specific security group, including its name, description, status, associated sites, and a full list of its firewall rules. - [Update a security group](https://altostrat.io/docs/api/en/security-groups/update-a-security-group.md): Updates an existing security group by fully replacing its attributes, including its name, description, rules, and site associations. This is a full replacement operation (PUT); any omitted fields in the `rules` or `sites` arrays will result in those items being removed. - [Create a site note](https://altostrat.io/docs/api/en/site-files/create-a-site-note.md): Creates a new markdown note and attaches it to the specified site. - [Delete a document file](https://altostrat.io/docs/api/en/site-files/delete-a-document-file.md): Permanently deletes a document file from a site. - [Delete a media file](https://altostrat.io/docs/api/en/site-files/delete-a-media-file.md): Permanently deletes a media file from a site. - [Delete a site note](https://altostrat.io/docs/api/en/site-files/delete-a-site-note.md): Permanently deletes a note from a site. - [Download a document file](https://altostrat.io/docs/api/en/site-files/download-a-document-file.md): Downloads a specific document file associated with a site. - [Download a media file](https://altostrat.io/docs/api/en/site-files/download-a-media-file.md): Downloads a specific media file associated with a site. - [Get document upload URL](https://altostrat.io/docs/api/en/site-files/get-document-upload-url.md): Requests a pre-signed URL that can be used to upload a document file (e.g., PDF, DOCX) directly to secure storage. You should perform a PUT request to the returned `signed_url` with the file content as the request body. - [Get media upload URL](https://altostrat.io/docs/api/en/site-files/get-media-upload-url.md): Requests a pre-signed URL that can be used to upload a media file (e.g., image, video) directly to secure storage. You should perform a PUT request to the returned `signed_url` with the file content as the request body. - [Get site note content](https://altostrat.io/docs/api/en/site-files/get-site-note-content.md): Downloads the raw Markdown content of a specific site note. - [List site notes](https://altostrat.io/docs/api/en/site-files/list-site-notes.md): Retrieves a list of all markdown notes associated with a specific site. - [Get Interface Metrics](https://altostrat.io/docs/api/en/site-interfaces-&-metrics/get-interface-metrics.md): Fetches time-series traffic metrics (ifInOctets for inbound, ifOutOctets for outbound) for a specific network interface over a given time period. The values are returned as bits per second. - [List Site Interfaces](https://altostrat.io/docs/api/en/site-interfaces-&-metrics/list-site-interfaces.md): Retrieves a list of all network interfaces monitored via SNMP for a specific site. - [Get site note](https://altostrat.io/docs/api/en/site-notes/get-site-note.md): Returns the note metadata stored for a managed site. - [Update site note](https://altostrat.io/docs/api/en/site-notes/update-site-note.md): Creates or replaces the note stored for a managed site. - [Get API credentials for a site](https://altostrat.io/docs/api/en/site-operations/get-api-credentials-for-a-site.md): Retrieves the current API credentials for a site. These credentials are used by the Altostrat platform to manage the device. - [Get management server for a site](https://altostrat.io/docs/api/en/site-operations/get-management-server-for-a-site.md): Retrieves the hostname of the Altostrat management server currently responsible for the site's secure tunnel. This is useful for diagnostics. - [Perform an action on a site](https://altostrat.io/docs/api/en/site-operations/perform-an-action-on-a-site.md): Sends a command to a site to perform a specific, predefined action. This is used for remote operations like rebooting or clearing firewall rules. - [Resend bootstrap scheduler](https://altostrat.io/docs/api/en/site-operations/resend-bootstrap-scheduler.md): Re-sends the SDX bootstrap scheduler to a managed router. Use this when the router is reachable but scheduled check-ins need to be repaired. - [Rotate API credentials for a site](https://altostrat.io/docs/api/en/site-operations/rotate-api-credentials-for-a-site.md): Generates new API credentials for the specified site. The old credentials will be invalidated and replaced on the device. - [Attach BGP Policy to a Site](https://altostrat.io/docs/api/en/site-security-configuration/attach-bgp-policy-to-a-site.md): Attaches a BGP Threat Intelligence policy to a specific site, activating IP reputation blocking for that site. - [Attach DNS Policy to a Site](https://altostrat.io/docs/api/en/site-security-configuration/attach-dns-policy-to-a-site.md): Attaches a DNS Content Filtering policy to a specific site, activating its rules for all traffic from that site. - [Detach BGP Policy from a Site](https://altostrat.io/docs/api/en/site-security-configuration/detach-bgp-policy-from-a-site.md): Detaches the currently active BGP Threat Intelligence policy from a specific site, deactivating IP reputation blocking. - [Detach DNS Policy from a Site](https://altostrat.io/docs/api/en/site-security-configuration/detach-dns-policy-from-a-site.md): Detaches the currently active DNS Content Filtering policy from a specific site, deactivating its rules. - [List All Site Security Configurations](https://altostrat.io/docs/api/en/site-security-configuration/list-all-site-security-configurations.md): Retrieves a list of all sites (tunnels) associated with your account and their current security policy attachments. - [Retrieve a Site's Security Configuration](https://altostrat.io/docs/api/en/site-security-configuration/retrieve-a-sites-security-configuration.md): Retrieves the current DNS and BGP policy attachments for a specific site. - [Delete a Site](https://altostrat.io/docs/api/en/sites/delete-a-site.md): Schedules a site for deletion. The device will be sent a command to remove its bootstrap scheduler, and after a grace period, the site record and all associated data will be permanently removed. - [List Recent Sites](https://altostrat.io/docs/api/en/sites/list-recent-sites.md): Returns a list of the 5 most recently accessed sites for the authenticated user, ordered by most recent access. - [List Sites](https://altostrat.io/docs/api/en/sites/list-sites.md): Retrieves a paginated list of all MikroTik sites associated with the authenticated user's workspace. - [List Sites (Minimal)](https://altostrat.io/docs/api/en/sites/list-sites-minimal.md): Retrieves a condensed list of MikroTik sites, suitable for UI elements like navigation menus where only essential information is needed. - [Retrieve a Site](https://altostrat.io/docs/api/en/sites/retrieve-a-site.md): Retrieves the complete details of a specific MikroTik site by its unique identifier (UUID). - [Update a Site](https://altostrat.io/docs/api/en/sites/update-a-site.md): Updates the mutable properties of a site, such as its name, location, or timezone. Only the fields provided in the request body will be updated. - [Create SLA Report Schedule](https://altostrat.io/docs/api/en/sla-report-schedules/create-sla-report-schedule.md): Creates a new SLA report schedule. This schedule defines a recurring report, including its frequency, site selection criteria, and SLA targets. The `id` for the schedule will be generated by the server. - [Delete a Report Schedule](https://altostrat.io/docs/api/en/sla-report-schedules/delete-a-report-schedule.md): Permanently deletes an SLA report schedule. This action cannot be undone. - [List SLA Report Schedules](https://altostrat.io/docs/api/en/sla-report-schedules/list-sla-report-schedules.md): Retrieves a list of all configured SLA report schedules for the authenticated customer's workspace. - [Retrieve a Report Schedule](https://altostrat.io/docs/api/en/sla-report-schedules/retrieve-a-report-schedule.md): Retrieves the details of a single SLA report schedule by its unique ID. - [Run a Report On-Demand](https://altostrat.io/docs/api/en/sla-report-schedules/run-a-report-on-demand.md): Triggers an immediate, on-demand generation of a report for a specified date range. This does not affect the regular schedule. The report generation is asynchronous and the result will appear in the Generated Reports list when complete. - [Update a Report Schedule](https://altostrat.io/docs/api/en/sla-report-schedules/update-a-report-schedule.md): Updates the configuration of an existing SLA report schedule. - [Cancel a subscription](https://altostrat.io/docs/api/en/subscriptions/cancel-a-subscription.md): Cancels a subscription at the end of the current billing period. This operation cannot be performed if it would leave the workspace or billing account with insufficient capacity for its current resource usage. - [Check trial eligibility](https://altostrat.io/docs/api/en/subscriptions/check-trial-eligibility.md): Checks if a workspace is eligible for a 14-day free trial. A workspace is eligible if it has only one billing account and no existing subscriptions. - [Create a subscription](https://altostrat.io/docs/api/en/subscriptions/create-a-subscription.md): Creates a new Stripe subscription for a billing account. If the workspace is eligible for a trial, a 14-day trial subscription is created without requiring a payment method. Otherwise, a default payment method must be present on the billing account. - [List subscriptions](https://altostrat.io/docs/api/en/subscriptions/list-subscriptions.md): Returns a list of subscriptions associated with a billing account. - [Retrieve a subscription](https://altostrat.io/docs/api/en/subscriptions/retrieve-a-subscription.md): Retrieves the details of a specific subscription. - [Update a subscription](https://altostrat.io/docs/api/en/subscriptions/update-a-subscription.md): Updates a subscription. This endpoint supports multiple distinct operations. You can change product quantities, add or remove products, update metadata, or perform an action like `pause`, `resume`, or `sync`. Only one type of operation (e.g., `product_quantities`, `add_products`, `action`) is allowe… - [Apply a tag to a resource](https://altostrat.io/docs/api/en/tag-values/apply-a-tag-to-a-resource.md): Applies a tag with a specific value to a resource, identified by its `correlation_id` and `correlation_type`. If a tag with the same value (case-insensitive) already exists for this tag definition, the existing canonical value will be used. - [Find resources by tag value](https://altostrat.io/docs/api/en/tag-values/find-resources-by-tag-value.md): Retrieves a list of all resources that have a specific tag applied with a specific value. This is a powerful query for filtering resources based on their classifications. - [List tags for a resource](https://altostrat.io/docs/api/en/tag-values/list-tags-for-a-resource.md): Retrieves all tags that have been applied to a specific resource. - [List unique values for a tag](https://altostrat.io/docs/api/en/tag-values/list-unique-values-for-a-tag.md): Retrieves a list of unique values that have been applied to resources using a specific tag definition. This is useful for populating dropdowns or autocomplete fields in a UI. - [Remove a tag from a resource](https://altostrat.io/docs/api/en/tag-values/remove-a-tag-from-a-resource.md): Removes a specific tag from a resource. This does not delete the tag definition itself. - [Update a tag on a resource](https://altostrat.io/docs/api/en/tag-values/update-a-tag-on-a-resource.md): Updates the value of a tag on a specific resource. This is effectively the same as creating a new tag value, as it will overwrite any existing value for that tag on the resource. - [Create a tag definition](https://altostrat.io/docs/api/en/tags/create-a-tag-definition.md): Creates a new tag definition. A tag definition acts as a template or category (e.g., "Site Type", "Priority") that can then be applied to various resources. - [Create Tag](https://altostrat.io/docs/api/en/tags/create-tag.md) - [Delete a tag definition](https://altostrat.io/docs/api/en/tags/delete-a-tag-definition.md): Permanently deletes a tag definition and all of its associated values from all resources. This action cannot be undone. - [Delete Tag](https://altostrat.io/docs/api/en/tags/delete-tag.md) - [Get Tag](https://altostrat.io/docs/api/en/tags/get-tag.md) - [List Accounts by Tag](https://altostrat.io/docs/api/en/tags/list-accounts-by-tag.md) - [List all tag definitions](https://altostrat.io/docs/api/en/tags/list-all-tag-definitions.md): Retrieves a list of all tag definitions for your workspace. Each tag definition includes its key, color, and a list of all values currently applied to resources. This is useful for understanding the available classification schemes in your environment. - [List Containers by Tag](https://altostrat.io/docs/api/en/tags/list-containers-by-tag.md) - [List Groups by Tag](https://altostrat.io/docs/api/en/tags/list-groups-by-tag.md) - [List Tags](https://altostrat.io/docs/api/en/tags/list-tags.md) - [Retrieve a tag definition](https://altostrat.io/docs/api/en/tags/retrieve-a-tag-definition.md): Retrieves the details of a specific tag definition by its unique ID. This includes all the values that have been applied to resources using this tag. - [Update a tag definition](https://altostrat.io/docs/api/en/tags/update-a-tag-definition.md): Updates the properties of an existing tag definition, such as its key or color. - [Update Tag](https://altostrat.io/docs/api/en/tags/update-tag.md) - [List Available Topics](https://altostrat.io/docs/api/en/topics/list-available-topics.md): Retrieves a list of all available notification topics. These are the event categories that notification groups can subscribe to. - [Create a transient access session](https://altostrat.io/docs/api/en/transient-access/create-a-transient-access-session.md): Creates a temporary, secure session for accessing a site via Winbox or SSH. The session is automatically revoked after the specified duration. - [List transient accesses for a site](https://altostrat.io/docs/api/en/transient-access/list-transient-accesses-for-a-site.md): Retrieves a list of all active and expired transient access sessions for a specific site. - [Retrieve a transient access session](https://altostrat.io/docs/api/en/transient-access/retrieve-a-transient-access-session.md): Retrieves the details of a single transient access session. - [Revoke a transient access session](https://altostrat.io/docs/api/en/transient-access/revoke-a-transient-access-session.md): Immediately revokes an active transient access session, terminating the connection and preventing further access. - [Create a transient port forward](https://altostrat.io/docs/api/en/transient-port-forwarding/create-a-transient-port-forward.md): Creates a temporary, secure port forwarding rule. This allows you to access a device (e.g., a server or camera) on the LAN behind your MikroTik site from a specific public IP address. - [List transient port forwards for a site](https://altostrat.io/docs/api/en/transient-port-forwarding/list-transient-port-forwards-for-a-site.md): Retrieves a list of all active and expired transient port forwarding rules for a specific site. - [Retrieve a transient port forward](https://altostrat.io/docs/api/en/transient-port-forwarding/retrieve-a-transient-port-forward.md): Retrieves the details of a single transient port forwarding rule. - [Revoke a transient port forward](https://altostrat.io/docs/api/en/transient-port-forwarding/revoke-a-transient-port-forward.md): Immediately revokes an active port forwarding rule, closing the connection. - [List available node types](https://altostrat.io/docs/api/en/utilities/list-available-node-types.md): Retrieves a list of all available node types (triggers, actions, and conditions) that can be used to build workflows, along with their configuration schemas. - [List available server regions](https://altostrat.io/docs/api/en/utilities/list-available-server-regions.md): Retrieves a structured list of all available geographical regions where a VPN instance can be deployed. - [List subnets for a site](https://altostrat.io/docs/api/en/utilities/list-subnets-for-a-site.md): Retrieves a list of available subnets for a specific site, which is useful when configuring site-to-site peers. - [Test a single node](https://altostrat.io/docs/api/en/utilities/test-a-single-node.md): Executes a single workflow node in isolation with a provided context. This is a powerful debugging tool to test a node's logic without running an entire workflow. - [Create a vault item](https://altostrat.io/docs/api/en/vault/create-a-vault-item.md): Creates a new item in the vault for storing sensitive information like API keys or passwords. The secret value is encrypted at rest and can only be used by workflows. - [Delete a vault item](https://altostrat.io/docs/api/en/vault/delete-a-vault-item.md): Permanently deletes a vault item. This action cannot be undone. Any workflows using this item will fail. - [List vault items](https://altostrat.io/docs/api/en/vault/list-vault-items.md): Retrieves a list of all secret items stored in your organization's vault. The secret values themselves are never returned. - [Retrieve a vault item](https://altostrat.io/docs/api/en/vault/retrieve-a-vault-item.md): Retrieves the details of a single vault item by its prefixed ID. The secret value is never returned. - [Update a vault item](https://altostrat.io/docs/api/en/vault/update-a-vault-item.md): Updates an existing vault item, such as its name, secret value, or expiration date. - [Get CVEs by MAC Address](https://altostrat.io/docs/api/en/vulnerability-intelligence/get-cves-by-mac-address.md): Retrieves all discovered vulnerabilities (CVEs) associated with a specific list of MAC addresses across all historical scans. This is the primary endpoint for tracking a device's vulnerability history. - [Get Mitigation Steps](https://altostrat.io/docs/api/en/vulnerability-intelligence/get-mitigation-steps.md): Provides AI-generated, actionable mitigation steps for a specific CVE identifier. The response is formatted in Markdown for easy rendering. - [List All Scanned MAC Addresses](https://altostrat.io/docs/api/en/vulnerability-intelligence/list-all-scanned-mac-addresses.md): Retrieves a list of all unique MAC addresses that have been discovered across all scans for your account. This can be used to populate a device inventory or to discover which devices to query for CVEs. - [List CVE Statuses](https://altostrat.io/docs/api/en/vulnerability-management/list-cve-statuses.md): Retrieves a list of all managed CVE statuses. You can filter the results by MAC address, CVE ID, or status to find specific records. - [Update CVE Status](https://altostrat.io/docs/api/en/vulnerability-management/update-cve-status.md): Updates the status of a specific CVE for a given MAC address. Use this to mark a vulnerability as 'accepted' (e.g., a false positive or acceptable risk) or 'mitigated' (e.g., a patch has been applied or a workaround is in place). Each update creates a new historical record. - [Create a walled garden entry](https://altostrat.io/docs/api/en/walled-garden/create-a-walled-garden-entry.md): Adds a new IP address or subnet to the walled garden for a specific site, allowing users to access it before authenticating. - [Delete a walled garden entry](https://altostrat.io/docs/api/en/walled-garden/delete-a-walled-garden-entry.md): Removes an entry from the walled garden, blocking pre-authentication access to the specified IP address or subnet. - [List walled garden entries for a site](https://altostrat.io/docs/api/en/walled-garden/list-walled-garden-entries-for-a-site.md): Retrieves a list of all walled garden entries (allowed pre-authentication destinations) for a specific site. - [Retrieve a walled garden entry](https://altostrat.io/docs/api/en/walled-garden/retrieve-a-walled-garden-entry.md): Retrieves the details of a specific walled garden entry. - [Update a walled garden entry](https://altostrat.io/docs/api/en/walled-garden/update-a-walled-garden-entry.md): Updates the details of a walled garden entry, such as its name. The IP address cannot be changed. - [Get Aggregated Ping Statistics](https://altostrat.io/docs/api/en/wan-tunnels-&-performance/get-aggregated-ping-statistics.md): Fetches aggregated time-series data for latency, jitter (mdev), and packet loss for one or more WAN tunnels over a specified time period. If no tunnels are specified, it returns an aggregated average across all tunnels. This endpoint is optimized for creating performance charts with a specified numb… - [Get WAN tunnel ping statistics](https://altostrat.io/docs/api/en/wan-tunnels-&-performance/get-wan-tunnel-ping-statistics.md): Fetches aggregated time-series data for latency, jitter (mdev), and packet loss for one or more WAN tunnels over a specified time period. If no tunnels are specified, it returns an aggregated average across all tunnels. This endpoint is optimized for creating performance charts with a specified numb… - [List Site WAN Tunnels](https://altostrat.io/docs/api/en/wan-tunnels-&-performance/list-site-wan-tunnels.md): Retrieves a list of all configured SD-WAN tunnels for a specific site. - [Add a new WAN Tunnel](https://altostrat.io/docs/api/en/wan-tunnels/add-a-new-wan-tunnel.md): Creates a new, unconfigured WAN tunnel for the site, up to the maximum allowed by the subscription. After creation, use `PUT /failover/{site_id}/tunnels/{tunnel_id}` to configure properties like interface and gateway. - [Add a new WAN Tunnel](https://altostrat.io/docs/api/en/wan-tunnels/add-a-new-wan-tunnel-1.md): Creates a new, unconfigured WAN tunnel for the site, up to the maximum allowed by the subscription. After creation, use `PUT /failover/{site_id}/tunnels/{tunnel_id}` to configure properties like interface and gateway. - [Configure a WAN Tunnel](https://altostrat.io/docs/api/en/wan-tunnels/configure-a-wan-tunnel.md): Updates the configuration of a specific WAN tunnel. This is the primary endpoint for defining how a WAN connection operates, including its router interface, gateway, and connection type. - [Delete a WAN Tunnel](https://altostrat.io/docs/api/en/wan-tunnels/delete-a-wan-tunnel.md): Permanently deletes a WAN tunnel from the failover configuration. The system will automatically re-prioritize the remaining tunnels. - [Get a Specific Tunnel](https://altostrat.io/docs/api/en/wan-tunnels/get-a-specific-tunnel.md): Retrieves the detailed configuration and status of a single WAN tunnel. - [List Tunnels for a Site](https://altostrat.io/docs/api/en/wan-tunnels/list-tunnels-for-a-site.md): Retrieves a detailed list of all WAN tunnels configured for a specific site. - [List Tunnels for a Site](https://altostrat.io/docs/api/en/wan-tunnels/list-tunnels-for-a-site-1.md): Retrieves a detailed list of all WAN tunnels configured for a specific site. - [List WAN tunnels across accessible sites](https://altostrat.io/docs/api/en/wan-tunnels/list-wan-tunnels-across-accessible-sites.md): Returns WAN tunnels across the sites available to the authenticated user. The portal uses this for live WAN health views. - [List WAN tunnels across accessible sites](https://altostrat.io/docs/api/en/wan-tunnels/list-wan-tunnels-across-accessible-sites-1.md): Returns WAN tunnels across the sites available to the authenticated user. The portal uses this endpoint for live WAN health views. - [Update Tunnel Priorities](https://altostrat.io/docs/api/en/wan-tunnels/update-tunnel-priorities.md): Re-orders the failover priority for all tunnels associated with a site. This is an atomic operation; you must provide a complete list of all tunnels and their desired new priorities. The lowest number represents the highest priority. - [Trigger a workflow via webhook](https://altostrat.io/docs/api/en/webhooks/trigger-a-workflow-via-webhook.md): A public endpoint to trigger a workflow that has a `webhook_trigger`. Authentication is handled by the unique, secret token in the URL path. The entire request body will be available in the workflow's context. - [Get workflow log statistics](https://altostrat.io/docs/api/en/workflow-logs/get-workflow-log-statistics.md): Returns aggregate counts for a workflow log stream. - [List recent workflow logs](https://altostrat.io/docs/api/en/workflow-logs/list-recent-workflow-logs.md): Returns recent workflow log entries across workflows available to the authenticated user. - [List workflow logs](https://altostrat.io/docs/api/en/workflow-logs/list-workflow-logs.md): Returns logs for workflow executions. You can filter by level, node, run, or date range. - [Execute a workflow](https://altostrat.io/docs/api/en/workflow-runs/execute-a-workflow.md): Manually triggers the execution of a workflow. The workflow will run asynchronously in the background. The response acknowledges that the execution has been accepted and provides the ID of the new workflow run. - [List workflow runs](https://altostrat.io/docs/api/en/workflow-runs/list-workflow-runs.md): Retrieves a paginated list of all past and current executions (runs) for a specific workflow, ordered by the most recent. - [Re-run a workflow](https://altostrat.io/docs/api/en/workflow-runs/re-run-a-workflow.md): Creates a new workflow run using the same initial trigger payload as a previous run. This is useful for re-trying a failed or completed execution with the original input data. - [Resume a failed workflow](https://altostrat.io/docs/api/en/workflow-runs/resume-a-failed-workflow.md): Resumes a failed workflow run from a specific, successfully completed node. A new workflow run is created, inheriting the context from the original run up to the specified node, and execution continues from there. - [Retrieve a workflow run](https://altostrat.io/docs/api/en/workflow-runs/retrieve-a-workflow-run.md): Retrieves the details of a single workflow run, including its status, trigger payload, error message (if any), and a complete, ordered log of every step that was executed. - [Create a new workflow](https://altostrat.io/docs/api/en/workflows/create-a-new-workflow.md): Creates a new workflow definition, including its nodes and edges that define the automation graph. A valid workflow must have exactly one trigger node. - [Delete a workflow](https://altostrat.io/docs/api/en/workflows/delete-a-workflow.md): Permanently deletes a workflow and all of its associated runs and logs. This action cannot be undone. A workflow cannot be deleted if it is being called by another workflow. - [Execute a synchronous workflow](https://altostrat.io/docs/api/en/workflows/execute-a-synchronous-workflow.md): Executes a workflow that contains a `sync_request_trigger` and immediately returns the result. The workflow must be designed for synchronous execution, meaning it cannot contain long-running tasks like delays or iterators. The final node must be a `text_transform` node configured as the response. - [List all workflows](https://altostrat.io/docs/api/en/workflows/list-all-workflows.md): Retrieves a list of all workflows belonging to your organization. This endpoint is useful for dashboard displays or for selecting a workflow to execute or edit. - [List triggerable workflows](https://altostrat.io/docs/api/en/workflows/list-triggerable-workflows.md): Returns active workflows that can be triggered by another workflow or selected as a subflow target. - [Retrieve a workflow](https://altostrat.io/docs/api/en/workflows/retrieve-a-workflow.md): Retrieves the complete details of a single workflow by its prefixed ID, including its full node and edge configuration. - [Update a workflow](https://altostrat.io/docs/api/en/workflows/update-a-workflow.md): Updates an existing workflow. You can update any property, including the name, description, active status, schedule, or the entire graph of nodes and edges. - [Validate a workflow definition](https://altostrat.io/docs/api/en/workflows/validate-a-workflow-definition.md): Validates a workflow graph before you create or update it. Use this to catch missing triggers, invalid node configuration, and graph errors. - [Add a member to a workspace](https://altostrat.io/docs/api/en/workspace-members/add-a-member-to-a-workspace.md): Adds a new user to a workspace with a specified role. Only workspace owners and admins can add new members. A workspace cannot have more than 100 members. - [List workspace members](https://altostrat.io/docs/api/en/workspace-members/list-workspace-members.md): Returns a list of users who are members of the specified workspace, including their roles. - [Remove a member from a workspace](https://altostrat.io/docs/api/en/workspace-members/remove-a-member-from-a-workspace.md): Removes a member from a workspace. A user can remove themselves, or an owner/admin can remove other members. The last owner of a workspace cannot be removed. - [Update a member's role](https://altostrat.io/docs/api/en/workspace-members/update-a-members-role.md): Updates the role of an existing member in a workspace. Role changes are subject to hierarchy rules; for example, an admin cannot promote another member to an owner. - [Archive a workspace](https://altostrat.io/docs/api/en/workspaces/archive-a-workspace.md): Archives a workspace, preventing any further modifications. A workspace cannot be archived if it contains organizations with active resource usage or billing accounts with active subscriptions. This is a soft-delete operation. Only workspace owners can perform this action. - [Create a workspace](https://altostrat.io/docs/api/en/workspaces/create-a-workspace.md): Creates a new workspace, which acts as a top-level container for your resources, users, and billing configurations. The user creating the workspace is automatically assigned the 'owner' role. - [List workspaces](https://altostrat.io/docs/api/en/workspaces/list-workspaces.md): Returns a list of workspaces the authenticated user is a member of. - [Retrieve a workspace](https://altostrat.io/docs/api/en/workspaces/retrieve-a-workspace.md): Retrieves the details of an existing workspace. You must be a member of the workspace to retrieve it. - [Update a workspace](https://altostrat.io/docs/api/en/workspaces/update-a-workspace.md): Updates the specified workspace by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Only workspace owners and admins can perform this action. - [Architecture and Scale](https://altostrat.io/docs/radius/en/architecture.md): Understand how ArcRadius uses a global RadSec data plane, management control plane, analytics plane, multi-region data stores, deterministic sharding, and streaming imports. - [CoA and PoD](https://altostrat.io/docs/radius/en/coa-and-pod.md): Configure Change of Authorization and Packet of Disconnect for RADIUS NAS devices, manual session disconnects, and quota-triggered disconnects. - [Folders and Users](https://altostrat.io/docs/radius/en/containers-and-users.md): Organize RADIUS users with folders, bulk actions, user profiles, credentials, status controls, sessions, logs, and metadata. - [Getting Started with RADIUS](https://altostrat.io/docs/radius/en/getting-started.md): Configure your first RADIUS device, group, user, and test authentication from the Altostrat Radius UI. - [Groups and Attributes](https://altostrat.io/docs/radius/en/groups-and-attributes.md): Use RADIUS groups to manage reusable check attributes, reply attributes, inherited policy, members, metadata, and quota-aware presence modes. - [RADIUS Overview](https://altostrat.io/docs/radius/en/introduction.md): Learn how the Altostrat Radius web UI organizes devices, users, groups, realms, attributes, live logs, and operational settings. - [Limits and Availability](https://altostrat.io/docs/radius/en/limits-and-availability.md): Review ArcRadius feature coverage, availability targets, retention, performance limits, migration limits, and default account limits. - [Live Monitoring and Logs](https://altostrat.io/docs/radius/en/live-monitoring.md): Use RADIUS Live View, log filters, user dashboards, device dashboards, metrics, sessions, and failure categories to operate authentication. - [NAS Devices](https://altostrat.io/docs/radius/en/nas-devices.md): Register and manage RADIUS clients, RadSec configuration, certificates, CoA and PoD settings, auto registration, device metrics, and NAS logs. - [Realms](https://altostrat.io/docs/radius/en/realms.md): Use RADIUS realms to match username suffixes and automatically apply group attributes to matching users. - [Settings, Labels, Metadata, and Shortcuts](https://altostrat.io/docs/radius/en/settings-and-shortcuts.md): Customize RADIUS labels, use metadata fields, and create global metadata shortcuts to external systems from the Radius UI. - [Supported Dictionaries](https://altostrat.io/docs/radius/en/supported-dictionaries.md): Review the RADIUS attribute dictionaries, vendors, operators, value types, and quota attributes surfaced by the Altostrat Radius UI. - [RADIUS Troubleshooting](https://altostrat.io/docs/radius/en/troubleshooting.md): Troubleshoot RADIUS rejects, bad passwords, missing attributes, suspended users, device setup issues, realms, CoA and PoD, RadSec, and missing logs. - [Api base instructions](https://altostrat.io/docs/scripts/api-base-instructions.md) - [Billing and Subscriptions](https://altostrat.io/docs/sdx/en/account/billing-and-subscriptions.md): Review billing accounts, subscriptions, license allocation, usage, and limits for your SDX workspace. - [Account & Billing](https://altostrat.io/docs/sdx/en/account/introduction.md): Understand the account structures that organize SDX workspaces, teams, users, roles, billing, subscriptions, and auditability. - [User and Team Management](https://altostrat.io/docs/sdx/en/account/user-and-team-management.md): Add users, organize teams, assign roles, and use notification-only users for alert and report recipients. - [Workspaces and Organizations](https://altostrat.io/docs/sdx/en/account/workspaces-and-organizations.md): Model your business or customer structure with workspaces, organizations, teams, and resource ownership. - [Generative AI](https://altostrat.io/docs/sdx/en/automation/generative-ai.md): Use AI-assisted features in Altostrat SDX for workflow text transforms, script drafting, diagnostics, and operational support. - [Automation and AI](https://altostrat.io/docs/sdx/en/automation/introduction.md): Use workflows, scheduled scripts, templates, and AI-assisted tools to automate Altostrat SDX operations. - [Script Management](https://altostrat.io/docs/sdx/en/automation/script-management.md): Create, test, authorize, schedule, and monitor RouterOS scripts across Altostrat SDX managed sites. - [Workflow Authorizations](https://altostrat.io/docs/sdx/en/automation/workflows/authorizations.md): Understand how workflow authorizations let SDX workflows perform actions on behalf of users. - [Build Workflows](https://altostrat.io/docs/sdx/en/automation/workflows/building-workflows.md): Design Altostrat SDX workflows with triggers, actions, conditions, variables, testing, and execution logs. - [Workflow Node Reference](https://altostrat.io/docs/sdx/en/automation/workflows/node-reference.md): A practical reference for the trigger, action, condition, and loop nodes available in Altostrat SDX workflows. - [AI Text Transform](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/ai-text-transform.md): Format text and data using AI prompts. - [API Call](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/altostrat-api-call.md): Make HTTP requests to Altostrat API endpoints. - [Attach Policy](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/altostrat-attach-policy.md): Attach a policy to a site. - [Detach Policy](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/altostrat-detach-policy.md): Remove a policy from a site. - [Get Resource Tags](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/altostrat-get-resource-tags.md): Retrieve tags associated with a resource (site). - [Get Site](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/altostrat-get-site.md): Retrieve detailed site information and configuration. - [Get WAN Tunnel](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/altostrat-get-wan.md): Retrieve detailed WAN tunnel information and status. - [MikroTik Script](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/altostrat-run-async-script.md): Run scripts or config changes on a site. - [MikroTik API](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/altostrat-run-sync-command.md): Run a real-time API command on a specific site. - [Set Resource Tags](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/altostrat-set-resource-tags.md): Add or update tag key-value pairs for a resource. - [Update WAN Priorities](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/altostrat-update-wan-priorities.md): Update WAN failover link priorities for a site. - [Filter Array](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/array-filter.md): Create a new array with only the items that match your conditions. - [Shorten Link](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/create-short-link.md): Create a short link from a long URL. - [CVE Scan Multiple IPs](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/cve-scan-multiple-ips.md): Initiate an immediate CVE scan for multiple IP addresses. - [Data Mapper](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/data-mapper-action.md): Create or modify objects and arrays by mapping data. - [Date Transform](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/date-transform-action.md): Modify dates, add/subtract time, or change formats. - [Ingest Metrics](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/ingest-metrics.md): Send custom metrics to Prometheus for monitoring and analysis. - [IPv4 Address Tool](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/ipv4-address.md): Analyze an IPv4 address or CIDR range. - [JSON Parser](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/json-parser.md): Parse JSON data and extract values. - [Markdown to PDF](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/markdown-pdf.md): Convert Markdown content to PDF format. - [Overview](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/overview.md): Reference for workflow action nodes, including action categories, typical use cases, and links to detailed per-action documentation. - [Send Notification](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/send-notification.md): Send notifications via email or WhatsApp. - [Send Email (SMTP)](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/smtp-action.md): Send an email via a custom SMTP server. - [SOAP Request](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/soap-action.md): Interact with legacy SOAP web services. - [SSH Command](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/ssh-action.md): Execute commands on a remote server via SSH. - [String Transform](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/string-transform.md): Perform a series of transformations on a string. - [Terminate](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/terminate-action.md): Stop the workflow with a 'Completed' or 'Failed' status. - [Text Transform](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/text-transform.md): Format text and data using custom templates. - [Trigger Another Workflow](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/trigger-workflow-action.md): Start another workflow from this one. - [Validate Data](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/validate.md): Validate an object or array using Laravel rules. - [Webhook API Call](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/webhook-api-call.md): Send HTTP requests to external APIs and webhook endpoints. - [WireGuard Key Generator](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/actions/wireguard-key-generator.md): Generate a new key pair or derive a public key. - [Array Condition](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/conditions/array-condition.md): Check conditions on arrays and their elements. - [Boolean Condition](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/conditions/boolean-condition.md): Check conditions on boolean values. - [Date Condition](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/conditions/date-condition.md): Check conditions on dates and times. - [Logical Group (AND/OR)](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/conditions/logical-group-condition.md): Combine multiple conditions with complex AND/OR logic. - [Number Condition](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/conditions/number-condition.md): Check conditions on numbers and numeric values. - [Overview](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/conditions/overview.md): Condition nodes branch workflow execution by evaluating expressions against the current context. - [Resource Has Tags](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/conditions/resource-has-tags-condition.md): Check if a resource has specific tags or any tags at all. - [String Condition](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/conditions/string-condition.md): Check conditions on strings and text. - [Switch](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/conditions/switch-condition.md): Create multiple branches based on different conditions. - [Loop / Iterator Node](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/loop-iterator/README.md): Reference for the Loop / Iterator node, including when to use it, how it processes arrays, and practices for reliable per-item execution. - [Overview](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/triggers/overview.md): Reference for workflow trigger nodes, including scheduling, event-driven triggers, and synchronous API-triggered execution. - [Scheduled Trigger](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/triggers/scheduled-trigger.md): Run this workflow on a recurring schedule. - [Site Added](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/triggers/site-added.md): Trigger this workflow when a new site is added. - [Site Offline](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/triggers/site-offline.md): Trigger when a site fails to check in with the management system for more than 5 minutes. - [Site Online](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/triggers/site-online.md): Trigger when a site comes back online and resumes sending heartbeats. - [Site Removed](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/triggers/site-removed.md): Trigger this workflow when a site is removed. - [API Trigger (Synchronous)](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/triggers/sync-request-trigger.md): Trigger this workflow via API call with synchronous execution. - [Manual Trigger](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/triggers/trigger.md): Start this workflow via an API call or the UI. - [WAN Interface Offline](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/triggers/wan-offline.md): Trigger when a WAN interface from a WAN failover goes offline. - [WAN Interface Online](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/triggers/wan-online.md): Trigger when a WAN interface from a WAN failover comes online. - [WAN Packet Loss](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/triggers/wan-packet-loss.md): Trigger when a WAN interface from a WAN failover experiences packet loss. - [WAN Packet Loss Resolved](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/triggers/wan-packet-loss-resolved.md): Trigger when a WAN interface from a WAN failover recovers from packet loss. - [Trigger by Another Workflow](https://altostrat.io/docs/sdx/en/automation/workflows/nodes/triggers/workflow-trigger.md): Call this workflow from another workflow. - [Workflow Triggers](https://altostrat.io/docs/sdx/en/automation/workflows/triggers-and-webhooks.md): Choose the right trigger for manual runs, schedules, API requests, site lifecycle events, WAN health events, and workflow chaining. - [Use The Workflow Vault](https://altostrat.io/docs/sdx/en/automation/workflows/using-the-vault.md): Store workflow secrets, generated API keys, and signing material without exposing sensitive values in workflow definitions. - [Configure Captive Portals](https://altostrat.io/docs/sdx/en/connectivity/captive-portals/configuration.md): Create captive portal auth integrations, instances, site assignments, and coupon workflows. - [Captive Portals](https://altostrat.io/docs/sdx/en/connectivity/captive-portals/introduction.md): Understand captive portal instances, OAuth2 identity providers, coupons, and guest sessions in Altostrat SDX. - [Connectivity and SD-WAN](https://altostrat.io/docs/sdx/en/connectivity/introduction.md): Plan and operate Altostrat SDX connectivity services, including WAN failover, managed VPN, and captive portals. - [VPN Instances and Peers](https://altostrat.io/docs/sdx/en/connectivity/managed-vpn/instances-and-peers.md): Create a managed VPN instance, add site and client peers, and make practical routing decisions. - [Managed VPN](https://altostrat.io/docs/sdx/en/connectivity/managed-vpn/introduction.md): Understand VPN instances, peers, protocols, and routing choices in Altostrat SDX. - [WAN Failover](https://altostrat.io/docs/sdx/en/connectivity/wan-failover.md): Configure and monitor prioritized WAN links for an Altostrat SDX managed site. - [Configuration Backups](https://altostrat.io/docs/sdx/en/fleet/configuration-backups.md): Request, review, compare, and use MikroTik configuration backups as the safer reference point for change planning and troubleshooting. - [Control Plane Policies](https://altostrat.io/docs/sdx/en/fleet/control-plane-policies.md): Use control plane policies to define which router management services are enabled and which source networks can reach them. - [Fleet Management](https://altostrat.io/docs/sdx/en/fleet/introduction.md): Manage MikroTik sites at scale with SDX sites, policies, remote access, backups, tags, notes, and operational metadata. - [Managing Sites and Devices](https://altostrat.io/docs/sdx/en/fleet/managing-sites-devices.md): Create, review, update, and retire SDX sites while understanding how heartbeats and asynchronous jobs affect site state. - [Metadata, Tags, and Site Files](https://altostrat.io/docs/sdx/en/fleet/metadata-and-tags.md): Use tags, metadata, notes, media, and documents to make your SDX fleet searchable, reportable, and automation-ready. - [Secure Remote Access](https://altostrat.io/docs/sdx/en/fleet/secure-remote-access.md): Use time-limited transient access and transient port forwarding to reach managed sites through the SDX management path. - [Core Concepts](https://altostrat.io/docs/sdx/en/getting-started/core-concepts.md): Learn the SDX terms you need before managing sites, policies, workflows, and monitoring. - [Introduction to Altostrat SDX](https://altostrat.io/docs/sdx/en/getting-started/introduction.md): Understand what Altostrat SDX does, how it fits around your MikroTik fleet, and where to start in the documentation. - [Operational Model](https://altostrat.io/docs/sdx/en/getting-started/operational-model.md): Understand how SDX uses heartbeats, queued jobs, live commands, faults, notifications, and reports to operate a MikroTik fleet. - [Onboard Your First Router](https://altostrat.io/docs/sdx/en/getting-started/quickstart-onboarding.md): Create your first SDX site, run the bootstrap command on RouterOS, and verify that the router is online. - [Dashboards and Metrics](https://altostrat.io/docs/sdx/en/monitoring/dashboards-and-metrics.md): Use SDX dashboards to inspect fleet health, site state, WAN behavior, inventory, and operational trends. - [Fault Logging](https://altostrat.io/docs/sdx/en/monitoring/fault-logging.md): Investigate active and resolved site, WAN, and service faults with timestamps, severity, type, cause, and duration. - [Monitoring & Analytics](https://altostrat.io/docs/sdx/en/monitoring/introduction.md): Understand how Altostrat SDX turns heartbeats, metrics, faults, reports, and notifications into an operating view of your fleet. - [Notifications](https://altostrat.io/docs/sdx/en/monitoring/notifications.md): Route operational events to the right responders with notification groups, topics, schedules, sites, and muting controls. - [Reporting](https://altostrat.io/docs/sdx/en/monitoring/reporting.md): Schedule SLA reports, choose business-hour or all-hour calculations, and share generated report artifacts. - [Best Practices](https://altostrat.io/docs/sdx/en/resources/best-practices.md): Operate Altostrat SDX safely across sites, policies, connectivity, automation, monitoring, and account administration. - [Glossary](https://altostrat.io/docs/sdx/en/resources/glossary.md): Definitions for common Altostrat SDX terms used across documentation, the portal, and operational workflows. - [Platform Resources](https://altostrat.io/docs/sdx/en/resources/introduction.md): Use Altostrat SDX platform references for endpoint planning, troubleshooting, glossary terms, and operational best practices. - [Management VPN](https://altostrat.io/docs/sdx/en/resources/management-vpn.md): Understand the SDX management VPN used for router management, monitoring, jobs, and transient access. - [Regional Servers](https://altostrat.io/docs/sdx/en/resources/regional-servers.md): Understand how SDX regional infrastructure relates to router management and when operators need to think about regions. - [Short Links](https://altostrat.io/docs/sdx/en/resources/short-links.md): Create temporary short links in workflows with configurable expiration. - [Troubleshooting](https://altostrat.io/docs/sdx/en/resources/troubleshooting.md): Follow practical troubleshooting paths for offline sites, management VPN issues, failed jobs, WAN failover, captive portals, and workflows. - [Trusted IPs and Endpoints](https://altostrat.io/docs/sdx/en/resources/trusted-ips.md): Plan firewall allowlists, control-plane trusted networks, and outbound SDX service access. - [Audit Logs](https://altostrat.io/docs/sdx/en/security/audit-logs.md): Search workspace activity to investigate changes, access, errors, and security-sensitive events. - [Security Essentials](https://altostrat.io/docs/sdx/en/security/bgp-threat-mitigation.md): Use continuously updated threat mitigation lists to reduce exposure to known-risk network destinations. - [DNS Content Filtering](https://altostrat.io/docs/sdx/en/security/dns-content-filtering.md): Create DNS policies that combine category filtering, SafeSearch enforcement, and domain allow or block lists. - [Security & Compliance](https://altostrat.io/docs/sdx/en/security/introduction.md): Understand the policy layers Altostrat SDX gives you for content control, threat mitigation, firewall rules, vulnerability scanning, and auditability. - [Security Groups](https://altostrat.io/docs/sdx/en/security/security-groups.md): Create reusable firewall policies with ordered rules, services, ports, CIDRs, prefix lists, and site assignments. - [Vulnerability Scanning](https://altostrat.io/docs/sdx/en/security/vulnerability-scanning.md): Schedule CVE scans, review affected hosts, and track remediation status across managed sites. - [AI Copilot](https://altostrat.io/docs/studio/en/ai-copilot.md): Use Copilot modes, approvals, context attachment, slash commands, streaming, and multi-agent delegation to work against real operational context safely. - [Agent and local runtime](https://altostrat.io/docs/studio/en/ai-safety/agent-and-local-runtime.md): The Electron + Go-sidecar architecture that runs SSH, packet capture, embeddings, and protocol I/O on your machine — what stays local, what crosses to the cloud, and the trust boundaries between the two processes. - [AI provider and data flow](https://altostrat.io/docs/studio/en/ai-safety/ai-provider-and-data-flow.md): Where Studio's AI inference actually happens, which models are used, what region they run in, how the prompt cache is structured, what gets redacted before it leaves your machine, and the strict boundary between local context and cloud inference. - [Audit and telemetry](https://altostrat.io/docs/studio/en/ai-safety/audit-and-telemetry.md): What Studio records about your work, what it sends to third parties, what's redacted from error reports, and how to disable optional telemetry. With the honest gap: per-decrypt audit logging is on the roadmap. - [Connectors and MCP safety](https://altostrat.io/docs/studio/en/ai-safety/connectors-and-mcp-safety.md): How third-party API credentials are stored, how connector and MCP tool calls are gated, what happens when an OAuth token rotates, and the realistic limits on what we can prevent a remote MCP server from doing. - [Human in the loop](https://altostrat.io/docs/studio/en/ai-safety/human-in-the-loop.md): How Studio classifies tool calls by risk, presents approvals the operator can read and act on, and lets you steer or stop a running agent in real time. The trust-level model, the approval gate, and the streaming surface that makes the autonomy visible. - [Identity and access](https://altostrat.io/docs/studio/en/ai-safety/identity-and-access.md): How Studio authenticates users, derives short-term AWS credentials, isolates organizations, and enforces resource-level access — with the boundary between Clerk (identity) and Cognito (AWS authorization) explained. - [Known limits and roadmap](https://altostrat.io/docs/studio/en/ai-safety/known-limits-and-roadmap.md): The honest list of what Studio's safety story does not cover yet, what's explicitly out of scope, and what's being worked on. Read this before making a procurement decision. - [AI safety in Studio](https://altostrat.io/docs/studio/en/ai-safety/overview.md): How Altostrat Studio runs AI against production networks safely — the architecture, the controls, the cryptography, and the honest limits. Written for the security engineer reviewing whether to authorize this in their environment. - [Supply chain and updates](https://altostrat.io/docs/studio/en/ai-safety/supply-chain-and-updates.md): How Studio gets from our source repo to your machine intact — code signing, notarization, the build pipeline, the update flow with SHA-512 verification, and where the release artifacts live. - [Threat model](https://altostrat.io/docs/studio/en/ai-safety/threat-model.md): What Studio is built to defend against, what it explicitly is not, the assumptions our controls depend on, and the boundaries between the components that hold those controls together. - [Vault and keys](https://altostrat.io/docs/studio/en/ai-safety/vault-and-keys.md): The cryptographic core of Studio: per-organization customer master keys in a FIPS 140-2 HSM, AES-256-GCM envelope encryption with additional authenticated data, automatic 30-day data-key rotation, and cryptographic shredding on organization deletion. - [Changelog](https://altostrat.io/docs/studio/en/changelog/overview.md): Weekly updates to Altostrat Studio — new features, improvements, and fixes. - [Connectors and MCP](https://altostrat.io/docs/studio/en/connectors-and-mcp.md): Extend Copilot with your own systems — named REST and SOAP connectors, and custom MCP servers that contribute tools to the Copilot catalog. - [Files and artifacts](https://altostrat.io/docs/studio/en/files-and-artifacts.md): Find the reports, tables, code, diagrams, and diffs Copilot produced in your conversations, and browse and edit remote files from an SSH session — all in one view. - [Hosts and credentials](https://altostrat.io/docs/studio/en/hosts-and-credentials.md): Build device inventory, attach multiple protocols per host, and reuse credentials through Keychain so you never type the same password twice. - [Install and sign in](https://altostrat.io/docs/studio/en/install-and-sign-in.md): Download Studio for macOS or Windows, sign in with your Altostrat account, and complete the first-run onboarding that tailors your workspace. - [Keyboard shortcuts](https://altostrat.io/docs/studio/en/keyboard-shortcuts.md): Workspace, tabs, search, terminal, diagrams, and editor shortcuts in one place. - [Memories and search](https://altostrat.io/docs/studio/en/memories-and-search.md): Save structured facts you or Copilot want to recall later, and find anything in the workspace with one search box. - [Network diagrams](https://altostrat.io/docs/studio/en/network-diagrams.md): Draw and edit network maps with Cisco and cloud service shape libraries, auto-layout, multi-page support, draw.io round-trip, and one-click generation from hosts or Copilot topology evidence. - [Procedures](https://altostrat.io/docs/studio/en/procedures.md): Promote a successful chat into a parameterized runbook — markdown with arguments, allowed tools, success criteria, and a controlled run loop. - [Security and privacy](https://altostrat.io/docs/studio/en/security-and-privacy.md): Where your data lives, what's encrypted before it leaves your machine, how approval gates guard changes, and what sign-out actually clears. - [Settings](https://altostrat.io/docs/studio/en/settings.md): Control how Studio looks, how Copilot thinks, how updates land, and what happens when you sign out. - [Shared sessions](https://altostrat.io/docs/studio/en/shared-sessions.md): Collaborate inside a terminal with owner, co-worker, and viewer roles, invite guests by link, escalate to voice and video without leaving Studio, and see team presence in real time. - [System requirements](https://altostrat.io/docs/studio/en/system-requirements.md): Desktop platforms, network reach, privileges, and usage limits you should know before rolling out Studio. - [Teams and organizations](https://altostrat.io/docs/studio/en/teams-and-organizations.md): How Studio scopes your work to an organization, how the org switcher works, what visibility means, and the roles your teammates can hold. - [Terminal](https://altostrat.io/docs/studio/en/terminal.md): Open network-aware terminal sessions with clickable IPs and interfaces, selection-to-Copilot actions, staged commands, live error detection, and full recording and replay. - [Tour the workspace](https://altostrat.io/docs/studio/en/tour-the-workspace.md): Learn the Studio shell: activity bar, primary sidebar, main canvas with tabs, AI Copilot panel, bottom panel, status bar, and the core layout shortcuts. - [Troubleshooting](https://altostrat.io/docs/studio/en/troubleshooting.md): Common symptoms in Studio and the first things to check when you see them. - [Capacity upgrade: 100 Mbps to 1 Gbps transit cutover](https://altostrat.io/docs/studio/en/use-cases/isp/capacity-upgrade.md): Plan, procure, and cut over a 10x capacity uplift on a regional transit link — LibreNMS growth data, quote approval, cross-connect, BGP session bring-up, graceful traffic shift, customer comms. - [CGNAT pool exhaustion: alert to expanded capacity](https://altostrat.io/docs/studio/en/use-cases/isp/cgnat-exhaustion.md): NetFlow flags CGNAT port-pool exhaustion on a regional aggregator. Add pool capacity, reduce per-subscriber port budget safely, notify abuse partners about the pool changes, and document the new IP plan. - [CPE bulk firmware rollout: advisory to verified updates](https://altostrat.io/docs/studio/en/use-cases/isp/cpe-firmware-rollout.md): A vendor advisory drops mid-week. Stage the firmware through the TR-069 ACS, plan a regional rollout with maintenance windows, notify subscribers, monitor reboot success, and roll back the failures. - [DDoS mitigation activation and customer comms](https://altostrat.io/docs/studio/en/use-cases/isp/ddos-mitigation.md): A NetFlow anomaly flags a volumetric attack on a hosted customer. Confirm in FastNetMon, activate upstream mitigation, advertise RTBH where appropriate, and keep the customer informed through the whole event. - [Fiber cut response: OTDR alarm to restored service](https://altostrat.io/docs/studio/en/use-cases/isp/fiber-cut-response.md): An OTDR fires a fibre-break alarm mid-morning. Identify the segment, dispatch a splicer to the GPS coordinates, notify affected subscribers by SMS, coordinate road access with the municipality, and track the repair to the restoration. - [New PON deployment: 64 subscribers from site approval to first login](https://altostrat.io/docs/studio/en/use-cases/isp/pon-deployment.md): Plan, order, configure, and activate a 64-subscriber GPON tree — OLT provisioning, splicer dispatch, subscriber provisioning in BSS and RADIUS, welcome emails, truck-rolls scheduled. - [Subscriber data-usage dispute: RADIUS evidence to credit note](https://altostrat.io/docs/studio/en/use-cases/isp/subscriber-data-dispute.md): A subscriber disputes their data-usage bill. Pull the RADIUS accounting records, cross-check NetFlow, present the evidence, make the right call, and issue a credit note cleanly. - [Upstream provider outage: bulk customer comms in one workflow](https://altostrat.io/docs/studio/en/use-cases/isp/upstream-outage.md): Multiple monitoring triggers light up. Confirm the outage is upstream, open a carrier ticket, update the IVR, bulk-SMS subscribers in the affected region, run a status page update, and keep a Slack war room alive. - [Cisco IOS-XE firmware upgrade across 12 sites with change approval](https://altostrat.io/docs/studio/en/use-cases/msp/cisco-firmware-multisite.md): Plan, approve, schedule, and execute a fleet firmware upgrade — Jira change request, Freshservice approval, Slack war room, staged maintenance windows, post-upgrade verification, CMDB sync. - [Compromised account: alert to containment to incident report](https://altostrat.io/docs/studio/en/use-cases/msp/compromised-account.md): A Microsoft Defender alert flags impossible-travel sign-ins for a customer admin account. Verify, contain across cloud and network, capture forensics, file the IR ticket, and brief the customer. - [Onboard a new MSP customer fleet](https://altostrat.io/docs/studio/en/use-cases/msp/customer-onboarding.md): Take a customer's CSV inventory and a contract handoff, and turn it into a discovered, monitored, backed-up, documented, and team-briefed managed environment within the day. - [End-of-life hardware refresh: vuln scan to install date](https://altostrat.io/docs/studio/en/use-cases/msp/eol-hardware-refresh.md): A vulnerability scan flags an EOL Catalyst 2960. Build the replacement BOM, request quotes from three vendors, win customer approval, schedule the install, and dispatch a field tech with the right gear. - [Weekly executive report for managed customers](https://altostrat.io/docs/studio/en/use-cases/msp/executive-weekly-report.md): Pull the week's uptime, ticket backlog, change activity, backup health, and security posture from the systems they live in, then deliver a customer-ready PDF and a Teams summary every Monday at 09:00. - [MFA enforcement rollout to a 200-user customer](https://altostrat.io/docs/studio/en/use-cases/msp/mfa-enforcement.md): Move a customer's 200 users from optional to enforced MFA — pull the user list, stage the conditional access policy, communicate by phase, watch enrolment rate, and close the compliance loop. - [Office 365 outage triage and bulk customer comms](https://altostrat.io/docs/studio/en/use-cases/msp/office365-outage-triage.md): A PRTG sensor flips red across multiple managed customers. Confirm the upstream nature of the outage, broadcast it once, and update every affected ticket without typing the same sentence forty times. - [Dell R720 disk failure: Kayako to RMA in one workspace](https://altostrat.io/docs/studio/en/use-cases/msp/r720-disk-failure.md): Triage a Kayako ticket, confirm a failed disk on a Dell PowerEdge R720 over iDRAC, file the warranty RMA with Dell ProSupport, and book datacenter access — without leaving Studio. - [Ransomware containment: alert to clean restore](https://altostrat.io/docs/studio/en/use-cases/msp/ransomware-containment.md): A SIEM detection fires on lateral movement and SMB encryption activity. Contain the blast radius across cloud and network in minutes, snapshot evidence, restore from clean backups, and run the customer through a calm executive briefing. - [WiFi deployment from survey to customer report](https://altostrat.io/docs/studio/en/use-cases/msp/wifi-deployment.md): Take an Ekahau predictive survey, provision the access points, validate coverage and throughput in the office, and deliver a before-and-after report the customer's office manager actually understands. - [Use cases](https://altostrat.io/docs/studio/en/use-cases/overview.md): Real workflows MSPs, ISPs, WISPs, and VoIP carriers run inside Studio — from a Kayako ticket to a closed customer comms loop, across terminal, ticketing, monitoring, server hardware, vendor RMA, and field dispatch. - [E911 address validation campaign across the customer base](https://altostrat.io/docs/studio/en/use-cases/voip/e911-validation.md): Pull every active DID, cross-reference E911 registered addresses with the address validation database, identify mismatches, ask subscribers to re-attest, and produce the regulator-ready compliance report. - [Voice DR failover drill: scheduled, executed, validated, reverted](https://altostrat.io/docs/studio/en/use-cases/voip/failover-drill.md): Run the quarterly disaster-recovery drill — fail the SBC and RADIUS to the secondary site, validate inbound and outbound voice, check 911 routing, fail back, and produce the compliance report. - [One-way audio complaint: ticket to fix in one session](https://altostrat.io/docs/studio/en/use-cases/voip/one-way-audio.md): A customer reports they can hear callers but callers can't hear them. Pull the call recording, run the SIP trace, identify RTP NAT asymmetry on the SBC, fix the firewall pinhole, validate with a test call, and update the customer. - [PSTN trunk provisioning for a new tenant](https://altostrat.io/docs/studio/en/use-cases/voip/pstn-trunk-provisioning.md): Sales hands over a new business customer. Reserve a DID block, configure the SBC trunk, provision in 3CX, validate inbound and outbound, and email the tenant their go-live details — all in one session. - [SIP trunk exhaustion: alarm to expanded capacity in one shift](https://altostrat.io/docs/studio/en/use-cases/voip/sip-trunk-exhaustion.md): Concurrent-call counters peak above the contracted limit. Confirm legitimate traffic, expand the trunk capacity with the carrier, push the SBC change, validate, and update billing — without dropping calls. - [STIR/SHAKEN spoofing complaint: trace, mitigate, escalate](https://altostrat.io/docs/studio/en/use-cases/voip/stir-shaken-spoofing.md): A subscriber complains they're being called by their own number. Pull the SIP trace, check SHAKEN attestation, identify the originating carrier, mitigate at the SBC, and file the formal complaint upstream. - [Microsoft Teams Direct Routing migration for an enterprise tenant](https://altostrat.io/docs/studio/en/use-cases/voip/teams-direct-routing.md): Migrate a 1,200-seat enterprise from a legacy PBX to Microsoft Teams Direct Routing — SBC provisioning, dial plan, DID porting, phased user migration, training, and legacy decom. - [Welcome to Studio](https://altostrat.io/docs/studio/en/welcome.md): Altostrat Studio is a network operations IDE for engineers who need terminal speed, documentation memory, team coordination, and the safety controls production networks demand. - [Why Studio](https://altostrat.io/docs/studio/en/why-studio.md): Studio is built so every session makes the next one faster. Device identity, conversation memory, procedures, and team knowledge compound against your network — and the controls that keep that data isolated are the same controls that make the accumulated value structurally yours. - [Workspace Billing Modes: Single vs Assigned vs Pooled Resource Allocation](https://altostrat.io/docs/workspaces/billing-modes.md): Complete guide to workspace billing modes including Single mode for unified billing, Assigned mode for isolated accounts, and Pooled mode for shared resources. Choose the right billing strategy for your business structure. - [Workspace Management: Complete Guide to Billing, Organizations & Multi-Tenant Architecture](https://altostrat.io/docs/workspaces/introduction.md): Complete guide to workspace architecture including billing accounts, organization hierarchies, member management, and billing modes. Learn how to structure enterprise-grade multi-tenant systems with Auth0 and Stripe integration. - [Workspace System Limits: Organization, Billing & Performance Constraints](https://altostrat.io/docs/workspaces/limitations.md): Complete reference for workspace system limitations including organization hierarchy limits, billing account restrictions, performance considerations, and scaling strategies for enterprise implementations. - [Business Structure Modeling: Franchise, Enterprise, MSP & Partner Network Examples](https://altostrat.io/docs/workspaces/modeling-your-business.md): Complete guide to modeling business structures with workspace billing modes and organization hierarchies. Real-world examples for franchises, multinational corporations, MSPs, channel partners, and traditional businesses with implementation steps. - [Organization Hierarchies: Multi-Level Structure Design with Usage Tracking & Limits](https://altostrat.io/docs/workspaces/organization-hierarchies.md): Complete guide to building organization hierarchies with up to 10 levels of nesting. Learn usage aggregation, limit enforcement, and best practices for modeling complex business structures including enterprises, franchises, and partner networks. - [Subscription Management & Invoicing: Resource Pooling, Billing Cycles & Payment Processing](https://altostrat.io/docs/workspaces/subscriptions-and-invoicing.md): Complete guide to workspace subscription management including resource pooling, trial subscriptions, payment methods, invoicing, and usage metering. Learn billing account limits and subscription lifecycle management. ## OpenAPI Specs - [workspaces](https://altostrat.io/docs/api/en/workspaces.yaml) - [workflows](https://altostrat.io/docs/api/en/workflows.yaml) - [wan-failover](https://altostrat.io/docs/api/en/wan-failover.yaml) - [utm-ips](https://altostrat.io/docs/api/en/utm-ips.yaml) - [security-groups](https://altostrat.io/docs/api/en/security-groups.yaml) - [search](https://altostrat.io/docs/api/en/search.yaml) - [scripts](https://altostrat.io/docs/api/en/scripts.yaml) - [schedules](https://altostrat.io/docs/api/en/schedules.yaml) - [reports](https://altostrat.io/docs/api/en/reports.yaml) - [radius](https://altostrat.io/docs/api/en/radius.yaml) - [notifications](https://altostrat.io/docs/api/en/notifications.yaml) - [monitoring-metrics](https://altostrat.io/docs/api/en/monitoring-metrics.yaml) - [mikrotik-oem-data](https://altostrat.io/docs/api/en/mikrotik-oem-data.yaml) - [mikrotik-api](https://altostrat.io/docs/api/en/mikrotik-api.yaml) - [metadata](https://altostrat.io/docs/api/en/metadata.yaml) - [managed-vpn](https://altostrat.io/docs/api/en/managed-vpn.yaml) - [faults](https://altostrat.io/docs/api/en/faults.yaml) - [cve-scans](https://altostrat.io/docs/api/en/cve-scans.yaml) - [control-plane](https://altostrat.io/docs/api/en/control-plane.yaml) - [captive-portal](https://altostrat.io/docs/api/en/captive-portal.yaml) - [backups](https://altostrat.io/docs/api/en/backups.yaml) - [authentication](https://altostrat.io/docs/api/en/authentication.yaml) - [audit-logs](https://altostrat.io/docs/api/en/audit-logs.yaml) - [api-keys](https://altostrat.io/docs/api/en/api-keys.yaml)