# Altostrat Documentation ## Docs - [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. - [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 recent faults (Legacy)](https://altostrat.io/docs/api/en/analytics/get-recent-faults-legacy.md): Retrieves a list of recent faults. This endpoint provides a specific view of network health: it returns all currently unresolved faults, plus any faults that were resolved within the last 10 minutes. **Note:** This is a legacy endpoint maintained for backward compatibility. For more flexible querying, we recommend using the primary `GET /faults` endpoint with the appropriate filters. - [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. - [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. Results are returned in reverse chronological order (most recent first) by default. - [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. - [Compare Two Backups](https://altostrat.io/docs/api/en/backups/compare-two-backups.md): Generates a unified diff between two backup files for a site, showing the precise configuration changes. This is invaluable for auditing changes and understanding network evolution. - [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. - [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. - [Fetch Latest Backups in Bulk](https://altostrat.io/docs/api/en/bulk-operations/fetch-latest-backups-in-bulk.md): Efficiently retrieves the latest backup content for a list of up to 50 sites. This is optimized for AI agents and automation systems that need to gather configurations for multiple sites in a single request. The endpoint validates access for each site individually and returns a per-site status. - [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. - [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 a Job](https://altostrat.io/docs/api/en/data-migration/delete-a-job.md): Deletes a migration job record and its associated result files. This does not revert any data that was imported. - [Get a Signed Upload URL](https://altostrat.io/docs/api/en/data-migration/get-a-signed-upload-url.md): Requests a pre-signed URL for uploading a CSV file to a secure, temporary location. The returned URL should be used to perform a `PUT` request with the file content. - [Get CSV File Preview](https://altostrat.io/docs/api/en/data-migration/get-csv-file-preview.md): After uploading a CSV file, use this endpoint to get a preview of its content, detected columns, and total line count. This helps verify the file format and structure before starting an import. - [Get Importable Columns](https://altostrat.io/docs/api/en/data-migration/get-importable-columns.md): Retrieves the available columns and their requirements for a specific import type (users, groups, or nas). Also provides a link to download an example CSV file. - [Get Job Status](https://altostrat.io/docs/api/en/data-migration/get-job-status.md): Retrieves the current status and progress of a specific migration job. - [List Migration Jobs](https://altostrat.io/docs/api/en/data-migration/list-migration-jobs.md): Retrieves a paginated list of all past and current migration jobs. - [Start a Dry Run](https://altostrat.io/docs/api/en/data-migration/start-a-dry-run.md): Initiates a dry run of the import process. This validates the entire file against your mapping and settings without making any changes to your data. It returns an asynchronous job that you can monitor for results, including any potential errors. - [Start an Import](https://altostrat.io/docs/api/en/data-migration/start-an-import.md): Initiates the full import process. This will create or update resources based on the CSV file, mapping, and settings. It returns an asynchronous job that you can monitor for progress and final results. - [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 to pinpoint the exact information you need. - [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. - [Create a Group](https://altostrat.io/docs/api/en/groups/create-a-group.md): Creates a new user group. Groups are used to apply a common set of RADIUS attributes to multiple users. - [Delete a Group](https://altostrat.io/docs/api/en/groups/delete-a-group.md): Schedules a group for deletion. The deletion is processed asynchronously. The group will become immediately unavailable via the API. - [List Groups](https://altostrat.io/docs/api/en/groups/list-groups.md): Retrieves a paginated list of all RADIUS groups in your workspace. - [Retrieve a Group](https://altostrat.io/docs/api/en/groups/retrieve-a-group.md): Retrieves the details of a specific group by its unique ID. - [Update a Group](https://altostrat.io/docs/api/en/groups/update-a-group.md): Updates the specified group by setting the values of the parameters passed. Any parameters not provided will be left unchanged. - [Health Check](https://altostrat.io/docs/api/en/health/health-check.md): Provides a simple health check of the MCP server, returning its status, version, and supported capabilities. This endpoint can be used for monitoring and service discovery. - [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. - [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. - [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 Introduction](https://altostrat.io/docs/api/en/introduction.md): Welcome to the Altostrat SDX API. Learn about our core concepts, authentication, and how to make your first API call to start automating your network. - [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). - [Execute Synchronous Command](https://altostrat.io/docs/api/en/live-commands/execute-synchronous-command.md): Executes a read-only MikroTik RouterOS API command synchronously on a specific site. This provides a direct, real-time interface to the device. For fetching static configuration, using the Backups API is often faster. Write operations are strictly forbidden. - [List Logs for a NAS Device](https://altostrat.io/docs/api/en/logs/list-logs-for-a-nas-device.md): Retrieves a paginated list of API logs for a specific NAS device, showing the RADIUS requests it has made to the service. Logs are available for a limited time. - [List Logs for a User](https://altostrat.io/docs/api/en/logs/list-logs-for-a-user.md): Retrieves a paginated list of API logs related to a specific user, such as authentication attempts. Logs are available for a limited time. - [MCP JSON-RPC Endpoint](https://altostrat.io/docs/api/en/mcp--core-protocol/mcp-json-rpc-endpoint.md): This is the single endpoint for all Model Context Protocol (MCP) interactions, which follow the JSON-RPC 2.0 specification. The specific action to be performed is determined by the `method` property within the JSON request body. The `params` object structure varies depending on the method being called. Below are the supported methods: ### Lifecycle - `initialize`: Establishes a connection and negotiates protocol versions. - `ping`: A simple method to check if the connection is alive. ### Tools - `tools/list`: Retrieves a list of available tools that an AI agent can execute. - `tools/call`: Executes a specific tool with the provided arguments. ### Resources - `resources/list`: Retrieves a list of available knowledge resources. - `resources/read`: Reads the content of a specific resource. ### Prompts - `prompts/list`: Retrieves a list of available, pre-defined prompts. - `prompts/get`: Retrieves the full message structure for a specific prompt, populated with arguments. - [Add a User to a Group](https://altostrat.io/docs/api/en/memberships/add-a-user-to-a-group.md): Adds a user to a group, applying the group's policies to that user. - [List Group Members](https://altostrat.io/docs/api/en/memberships/list-group-members.md): Retrieves a paginated list of all users who are members of a specific group. - [List User's Groups](https://altostrat.io/docs/api/en/memberships/list-users-groups.md): Retrieves a paginated list of all groups that a specific user is a member of. - [Remove a User from a Group](https://altostrat.io/docs/api/en/memberships/remove-a-user-from-a-group.md): Removes a user from a group. The user will no longer inherit policies from this group. - [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 a NAS Device](https://altostrat.io/docs/api/en/nas-devices/create-a-nas-device.md): Registers a new NAS device with the RADIUS service. A shared secret and RadSec client certificates will be automatically generated. - [Delete a NAS Device](https://altostrat.io/docs/api/en/nas-devices/delete-a-nas-device.md): Permanently deletes a NAS device. This will also revoke its client certificate. Any authentication requests from this device will be rejected. - [List NAS Devices](https://altostrat.io/docs/api/en/nas-devices/list-nas-devices.md): Retrieves a paginated list of all Network Access Server (NAS) devices registered in your workspace. - [Retrieve a NAS Device](https://altostrat.io/docs/api/en/nas-devices/retrieve-a-nas-device.md): Retrieves the details of a specific NAS device, including its configuration and client certificate information. The private key is not returned for security reasons. - [Update a NAS Device](https://altostrat.io/docs/api/en/nas-devices/update-a-nas-device.md): Updates the description, type, or metadata of a NAS device. The NAS identifier (IP/hostname) cannot be changed. - [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): Retrieves high-level statistics for your workspace, including the total count of users, groups, and NAS devices. This provides a quick overview of your RADIUS environment. - [List Available RADIUS Attributes](https://altostrat.io/docs/api/en/platform/list-available-radius-attributes.md): Retrieves a comprehensive list of all supported RADIUS attributes, their data types, allowed operators, and vendor information. This is essential for building UIs for user and group policy management. - [Apply policy to sites](https://altostrat.io/docs/api/en/policies/apply-policy-to-sites.md): Assigns or reassigns a list of sites to this policy. This is the primary way to apply a new set of firewall rules to one or more devices. - [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. - [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. - [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 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. Available actions: - `site.upgrade`: Triggers a software upgrade on the device. - `site.clear_firewall`: Clears the device's firewall rules. - `site.reboot`: Reboots the device. - `site.recreate_management_filter`: Re-applies the Altostrat management firewall rules. - `site.recreate_tunnel`: Tears down and rebuilds the secure tunnel to the platform. - `site.resend_api_user`: Pushes the current API user credentials to the device again. - [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. - [List users for a site](https://altostrat.io/docs/api/en/site-users/list-users-for-a-site.md): Retrieves a paginated list of users who have connected through the captive portal at 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. - [Get Site Metadata](https://altostrat.io/docs/api/en/sites/get-site-metadata.md): Retrieves freeform metadata associated with a specific site. This can include the router's assigned name, configured timezone, custom banner messages, notes, or other user-defined tags. - [Get Site Metrics](https://altostrat.io/docs/api/en/sites/get-site-metrics.md): Retrieves uptime and downtime metrics for a specific site over the past 24 hours, based on heartbeat signals received by the Altostrat platform. - [Get Site OEM Information](https://altostrat.io/docs/api/en/sites/get-site-oem-information.md): Retrieves detailed Original Equipment Manufacturer (OEM) information for a specific deployed MikroTik router. This includes hardware specifications, serial numbers, CPU, RAM, and RouterOS license level. - [List All Sites](https://altostrat.io/docs/api/en/sites/list-all-sites.md): Retrieves a simplified list of all sites (MikroTik routers) managed within the organization. This endpoint is optimized for performance and is ideal for populating user interfaces or obtaining site IDs for use in other API calls. - [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 allowed per request. - [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. - [Attach a Tag to a Group](https://altostrat.io/docs/api/en/tagging/attach-a-tag-to-a-group.md): Associates an existing tag with a specific group. - [Attach a Tag to a User](https://altostrat.io/docs/api/en/tagging/attach-a-tag-to-a-user.md): Associates an existing tag with a specific user. - [Detach a Tag from a Group](https://altostrat.io/docs/api/en/tagging/detach-a-tag-from-a-group.md): Removes the association between a tag and a group. - [Detach a Tag from a User](https://altostrat.io/docs/api/en/tagging/detach-a-tag-from-a-user.md): Removes the association between a tag and a user. - [List Groups by Tag](https://altostrat.io/docs/api/en/tagging/list-groups-by-tag.md): Retrieves a paginated list of all groups that have a specific tag applied. - [List Users by Tag](https://altostrat.io/docs/api/en/tagging/list-users-by-tag.md): Retrieves a paginated list of all users that have a specific tag applied. - [Create a Tag](https://altostrat.io/docs/api/en/tags/create-a-tag.md): Creates a new tag for organizing users and groups. - [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. - [Delete a Tag](https://altostrat.io/docs/api/en/tags/delete-a-tag.md): Permanently deletes a tag. This also removes the tag from any users or groups it was applied to. - [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. - [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 Tags](https://altostrat.io/docs/api/en/tags/list-tags.md): Retrieves a paginated list of all tags defined in your workspace. - [Retrieve a Tag](https://altostrat.io/docs/api/en/tags/retrieve-a-tag.md): Retrieves the details of a specific tag by its unique ID. - [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](https://altostrat.io/docs/api/en/tags/update-a-tag.md): Updates the specified tag's name or color. - [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. - [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. - [Create a User](https://altostrat.io/docs/api/en/users/create-a-user.md): Creates a new RADIUS user with specified credentials, attributes, and group memberships. A unique ID for the user will be generated and returned upon successful creation. - [Delete a User](https://altostrat.io/docs/api/en/users/delete-a-user.md): Permanently deletes a user and all of their associated data, including group memberships and RADIUS attributes. This action cannot be undone. - [List Users](https://altostrat.io/docs/api/en/users/list-users.md): Retrieves a paginated list of all RADIUS users in your workspace. You can control the number of results per page and navigate through pages using the cursor. - [Retrieve a User](https://altostrat.io/docs/api/en/users/retrieve-a-user.md): Retrieves the details of a specific RADIUS user by their unique ID. - [Update a User](https://altostrat.io/docs/api/en/users/update-a-user.md): Updates the specified user by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This operation can be used to change a user's status, metadata, attributes, or group memberships. - [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. Note: This endpoint uses POST to allow for querying multiple MAC addresses in the request body, which is more robust and secure than a lengthy GET URL. - [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 number of data points. - [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, you must use a `PUT` request to `/v1/failover/{site_id}/tunnels/{tunnel_id}` to configure its 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. - [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. - [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. - [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. - [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. - [Billing and Subscriptions](https://altostrat.io/docs/sdx/en/account/billing-and-subscriptions.md): A complete guide to managing your subscriptions, payment methods, and invoices, and understanding how resource pooling and usage metering work in Altostrat SDX. - [Account & Billing](https://altostrat.io/docs/sdx/en/account/introduction.md): Learn how to build the foundational structure of your Altostrat environment, including managing organizations, workspaces, billing, and user access. - [User and Team Management](https://altostrat.io/docs/sdx/en/account/user-and-team-management.md): Learn how to manage access control in Altostrat SDX by organizing users into teams and assigning roles to grant permissions to your network resources. - [Workspaces and Organizations](https://altostrat.io/docs/sdx/en/account/workspaces-and-organizations.md): Learn how to model your business with Altostrat's hierarchical structure, using Organizations, Workspaces, and Teams to manage billing, resources, and access control. - [Generative AI](https://altostrat.io/docs/sdx/en/automation/generative-ai.md): Meet your AI Co-pilot. Learn how to leverage our agentic AI to automate complex network tasks, from diagnostics to configuration, using natural language. - [Automation & AI Overview](https://altostrat.io/docs/sdx/en/automation/introduction.md): An overview of Altostrat's automation suite. Learn how to orchestrate tasks with the visual Workflow engine, deploy changes with Script Management, and leverage our agentic AI Co-pilot. - [Script Management & Orchestration](https://altostrat.io/docs/sdx/en/automation/script-management.md): Centrally manage, test, authorize, and execute MikroTik RouterOS scripts across your fleet with built-in safety checks, reusable templates, and AI-powered generation. - [Building Workflows: Actions and Conditions](https://altostrat.io/docs/sdx/en/automation/workflows/building-workflows.md): A complete guide to the building blocks of automation. Learn how to use actions to perform tasks and conditions to create intelligent, branching logic. - [Workflow Triggers and Webhooks](https://altostrat.io/docs/sdx/en/automation/workflows/triggers-and-webhooks.md): Learn how to start your automations with a complete guide to all available workflow triggers, including schedules, webhooks, manual execution, and platform events. - [Using the Vault for Secrets](https://altostrat.io/docs/sdx/en/automation/workflows/using-the-vault.md): Learn how to securely store, manage, and use sensitive credentials like API keys and tokens in your workflows with the Altostrat Vault. - [Configuring a Captive Portal](https://altostrat.io/docs/sdx/en/connectivity/captive-portals/configuration.md): A step-by-step guide to creating and customizing your captive portal, including setting up Auth Integrations (IDPs), choosing a strategy, and applying it to a site. - [Introduction to Captive Portals](https://altostrat.io/docs/sdx/en/connectivity/captive-portals/introduction.md): Understand how to create branded, secure guest Wi-Fi experiences with Altostrat's Captive Portal service, using OAuth2 or coupon-based authentication. - [Connectivity & SD-WAN](https://altostrat.io/docs/sdx/en/connectivity/introduction.md): An overview of Altostrat's cloud-managed tools for building resilient, secure, and flexible network fabrics, including WAN Failover, Managed VPN, and Captive Portals. - [Configuring a Managed VPN](https://altostrat.io/docs/sdx/en/connectivity/managed-vpn/instances-and-peers.md): A step-by-step guide to creating a VPN Instance, configuring advanced settings, adding Site Peers for site-to-site connectivity, and adding Client Peers for secure remote user access. - [Introduction to Managed VPN](https://altostrat.io/docs/sdx/en/connectivity/managed-vpn/introduction.md): Understand the core concepts of Altostrat's Managed VPN service, including Instances and Peers, for building secure site-to-site and remote user networks. - [WAN Failover](https://altostrat.io/docs/sdx/en/connectivity/wan-failover.md): Configure multiple internet connections on your MikroTik router to ensure continuous, uninterrupted network connectivity. - [Configuration Backups](https://altostrat.io/docs/sdx/en/fleet/configuration-backups.md): Automate, manage, compare, and restore MikroTik configurations to ensure network integrity and enable rapid recovery from a secure, versioned history. - [Control Plane Policies](https://altostrat.io/docs/sdx/en/fleet/control-plane-policies.md): Define, enforce, and asynchronously deploy consistent firewall rules for management services like WinBox, SSH, and API across your entire MikroTik fleet. - [Introduction](https://altostrat.io/docs/sdx/en/fleet/introduction.md): Learn the core principles of managing your MikroTik fleet at scale with Altostrat SDX, from centralized control and policy enforcement to secure remote access. - [Managing Sites and Devices](https://altostrat.io/docs/sdx/en/fleet/managing-sites-devices.md): Learn how to create, edit, and delete sites, and understand the asynchronous lifecycle between a logical site and the physical MikroTik device it contains. - [Metadata, Tags, and Site Files](https://altostrat.io/docs/sdx/en/fleet/metadata-and-tags.md): Learn how to enrich your fleet with structured tags for classification, custom metadata for specific data, and file attachments for documentation. - [Secure Remote Access](https://altostrat.io/docs/sdx/en/fleet/secure-remote-access.md): Securely access any MikroTik device using the Management VPN and time-limited Transient Access credentials, without exposing ports or configuring complex firewall rules. - [Core Concepts](https://altostrat.io/docs/sdx/en/getting-started/core-concepts.md): Understand the fundamental building blocks of the Altostrat SDX platform, including Sites, Policies, the Management VPN, Automation, and your Account Hierarchy. - [Introduction to Altostrat SDX](https://altostrat.io/docs/sdx/en/getting-started/introduction.md): Altostrat SDX is a software-defined networking platform designed to unlock the full potential of your MikroTik hardware, transforming distributed networks into a centrally managed, secure, and automated fabric. - [Onboard Your First Router](https://altostrat.io/docs/sdx/en/getting-started/quickstart-onboarding.md): Follow this step-by-step guide to connect your prepared MikroTik router to the Altostrat SDX platform and bring it online in minutes. - [Dashboards & Real-time Metrics](https://altostrat.io/docs/sdx/en/monitoring/dashboards-and-metrics.md): Utilize our dashboards to view real-time metrics for device health, interface statistics, and WAN performance. - [Fault Logging & Event Management](https://altostrat.io/docs/sdx/en/monitoring/fault-logging.md): Learn how to monitor, filter, and manage network incidents using the Fault Log, your central record for all operational events like outages and service degradation. - [Monitoring & Analytics](https://altostrat.io/docs/sdx/en/monitoring/introduction.md): An overview of Altostrat's monitoring suite, from real-time dashboards and proactive fault logging to automated SLA reporting and intelligent notifications. - [Configuring Notifications](https://altostrat.io/docs/sdx/en/monitoring/notifications.md): Learn how to configure proactive alerts for critical network events, such as outages and security issues, using customizable Notification Groups. - [SLA & Performance Reporting](https://altostrat.io/docs/sdx/en/monitoring/reporting.md): Learn how to schedule, generate, and analyze automated SLA reports to track network uptime, ensure compliance, and gain data-driven insights into your fleet's performance. - [Management VPN](https://altostrat.io/docs/sdx/en/resources/management-vpn.md): How MikroTik devices connect securely to Altostrat for real-time monitoring and management. - [Regional Servers](https://altostrat.io/docs/sdx/en/resources/regional-servers.md): A reference guide to Altostrat's official IP addresses and domains, essential for configuring your firewalls to allow access to our management services. - [Short Links](https://altostrat.io/docs/sdx/en/resources/short-links.md): An overview of Altostrat's secure URL shortening service (altostr.at), including security, expiration, and rate limiting. - [Trusted IPs & Service Endpoints](https://altostrat.io/docs/sdx/en/resources/trusted-ips.md): A list of Altostrat's service IP addresses and domains for configuring firewall rules. - [Audit Logs & Compliance Reporting](https://altostrat.io/docs/sdx/en/security/audit-logs.md): Track, search, and review all user and system activity across your Altostrat workspace for security, compliance, and troubleshooting. - [BGP Threat Mitigation](https://altostrat.io/docs/sdx/en/security/bgp-threat-mitigation.md): Automatically block traffic to and from known malicious IP addresses by subscribing your routers to curated, real-time threat intelligence feeds. - [DNS Content Filtering](https://altostrat.io/docs/sdx/en/security/dns-content-filtering.md): Manage and restrict access to undesirable web content across your network using centralized DNS-based policies. - [Security & Compliance](https://altostrat.io/docs/sdx/en/security/introduction.md): An overview of Altostrat's layered security model, from proactive threat intelligence and stateful firewalls to continuous vulnerability scanning and comprehensive auditing. - [Security Groups and Firewalls](https://altostrat.io/docs/sdx/en/security/security-groups.md): Learn how to create and manage centralized, stateful firewall policies using Security Groups and reusable Prefix Lists to protect your network sites. - [Vulnerability Scanning (CVE)](https://altostrat.io/docs/sdx/en/security/vulnerability-scanning.md): Continuously scan your devices for known vulnerabilities (CVEs) and get actionable recommendations for remediation.