Altostrat Networks's 458-line llms.txt shows what thorough AI preparation looks like

# 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.
- [Attach Tag to Container](https://altostrat.io/docs/api/en/account-containers/attach-tag-to-container.md)
- [Create Container](https://altostrat.io/docs/api/en/account-containers/create-container.md)
- [Delete Container](https://altostrat.io/docs/api/en/account-containers/delete-container.md): Deletes a container. The container must be empty (no child containers or accounts).
- [Detach Tag from Container](https://altostrat.io/docs/api/en/account-containers/detach-tag-from-container.md)
- [Get Container](https://altostrat.io/docs/api/en/account-containers/get-container.md)
- [List Containers](https://altostrat.io/docs/api/en/account-containers/list-containers.md): Retrieve a list of account containers. Can be filtered by parent or level for tree traversal. Includes a separate list of pinned containers.
- [Move Container](https://altostrat.io/docs/api/en/account-containers/move-container.md): Initiates an asynchronous job to move a container (and its entire subtree) to a new parent.
- [Pin Container](https://altostrat.io/docs/api/en/account-containers/pin-container.md): Pins a container to the user's dashboard/sidebar for quick access.
- [Transfer Users](https://altostrat.io/docs/api/en/account-containers/transfer-users.md): Bulk transfer all users from this container to another container.
- [Unpin Container](https://altostrat.io/docs/api/en/account-containers/unpin-container.md): Removes a container from the user's pinned list.
- [Update Container](https://altostrat.io/docs/api/en/account-containers/update-container.md)
- [Attach Tag to Account](https://altostrat.io/docs/api/en/accounts/attach-tag-to-account.md)
- [Create an Account](https://altostrat.io/docs/api/en/accounts/create-an-account.md)
- [Delete an Account](https://altostrat.io/docs/api/en/accounts/delete-an-account.md)
- [Detach Tag from Account](https://altostrat.io/docs/api/en/accounts/detach-tag-from-account.md)
- [List Account Groups](https://altostrat.io/docs/api/en/accounts/list-account-groups.md)
- [List Accounts](https://altostrat.io/docs/api/en/accounts/list-accounts.md)
- [Move Account](https://altostrat.io/docs/api/en/accounts/move-account.md): Move an account to a different container.
- [Retrieve an Account](https://altostrat.io/docs/api/en/accounts/retrieve-an-account.md)
- [Update an Account](https://altostrat.io/docs/api/en/accounts/update-an-account.md)
- [Generate Script from Prompt](https://altostrat.io/docs/api/en/ai-script-generation/generate-script-from-prompt.md): Submits a natural language prompt to the AI engine to generate a MikroTik RouterOS script. The response includes the generated script content, a flag indicating if the script is potentially destructive, and any errors or warnings from the AI.
- [Get 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.
- [Download Client CA](https://altostrat.io/docs/api/en/certificates/download-client-ca.md)
- [Download NAS Certificate](https://altostrat.io/docs/api/en/certificates/download-nas-certificate.md)
- [Download NAS Private Key](https://altostrat.io/docs/api/en/certificates/download-nas-private-key.md)
- [Add a comment to a fault](https://altostrat.io/docs/api/en/comments/add-a-comment-to-a-fault.md): Adds a new comment to an existing fault. Comments are useful for tracking troubleshooting steps, adding context, or communicating with team members about an incident.
- [Get Raw README Content](https://altostrat.io/docs/api/en/community-scripts/get-raw-readme-content.md): Downloads the raw, plain-text markdown content of a community script's README file, if one exists.
- [Get Raw Script Content](https://altostrat.io/docs/api/en/community-scripts/get-raw-script-content.md): Downloads the raw, plain-text content of a community script, suitable for direct use or inspection.
- [List Community Scripts](https://altostrat.io/docs/api/en/community-scripts/list-community-scripts.md): Retrieves a paginated list of scripts from the public community repository. This is a valuable resource for finding pre-built solutions for common MikroTik tasks.
- [Retrieve a Community Script](https://altostrat.io/docs/api/en/community-scripts/retrieve-a-community-script.md): Fetches detailed information about a specific community script, including its content, description, and metadata about the author and source repository.
- [Submit a Community Script](https://altostrat.io/docs/api/en/community-scripts/submit-a-community-script.md): Submits a new script to the community repository by providing a URL to a raw `.rsc` file on GitHub. The system will then fetch the script content and associated repository metadata.
- [Create a coupon schedule](https://altostrat.io/docs/api/en/coupon-schedules/create-a-coupon-schedule.md): Creates a new schedule to automatically generate coupons on a recurring basis (daily, weekly, or monthly).
- [Delete a coupon schedule](https://altostrat.io/docs/api/en/coupon-schedules/delete-a-coupon-schedule.md): Permanently deletes a coupon schedule. This will not delete coupons that have already been generated by the schedule.
- [Generate a signed coupon URL](https://altostrat.io/docs/api/en/coupon-schedules/generate-a-signed-coupon-url.md): Creates a temporary, signed URL that can be used to retrieve the list of valid coupons generated by a specific schedule. This is useful for distributing coupons to third-party systems without exposing API keys. The URL is valid for 24 hours.
- [List coupon schedules](https://altostrat.io/docs/api/en/coupon-schedules/list-coupon-schedules.md): Retrieves a list of all coupon generation schedules for a specific captive portal instance.
- [Retrieve a coupon schedule](https://altostrat.io/docs/api/en/coupon-schedules/retrieve-a-coupon-schedule.md): Retrieves the details of a specific coupon schedule by its ID.
- [Run a coupon schedule now](https://altostrat.io/docs/api/en/coupon-schedules/run-a-coupon-schedule-now.md): Manually triggers a coupon schedule to generate a new batch of coupons immediately, outside of its normal recurrence.
- [Update a coupon schedule](https://altostrat.io/docs/api/en/coupon-schedules/update-a-coupon-schedule.md): Updates the configuration of an existing coupon schedule.
- [Create coupons](https://altostrat.io/docs/api/en/coupons/create-coupons.md): Generates a batch of one-time use coupons for a specified captive portal instance.
- [List valid coupons for an instance](https://altostrat.io/docs/api/en/coupons/list-valid-coupons-for-an-instance.md): Retrieves a list of all valid (unredeemed and not expired) coupons for a specific captive portal instance.
- [Get Data Transferred Volume](https://altostrat.io/docs/api/en/dashboard/get-data-transferred-volume.md): Retrieves the total volume of data transferred (in bytes) across specified sites, aggregated into time buckets. Use this endpoint to analyze data consumption and usage patterns.
- [Get Network Throughput](https://altostrat.io/docs/api/en/dashboard/get-network-throughput.md): Retrieves time-series data representing the average network throughput (in bits per second) across specified sites over a given time window. Use this endpoint to visualize traffic rates for dashboards and reports.
- [Delete Job](https://altostrat.io/docs/api/en/data-migration/delete-job.md)
- [Download Example CSV](https://altostrat.io/docs/api/en/data-migration/download-example-csv.md): Download a template CSV file for bulk import.
- [Get Columns](https://altostrat.io/docs/api/en/data-migration/get-columns.md)
- [Get Job Status](https://altostrat.io/docs/api/en/data-migration/get-job-status.md)
- [Get Upload URL](https://altostrat.io/docs/api/en/data-migration/get-upload-url.md)
- [List Jobs](https://altostrat.io/docs/api/en/data-migration/list-jobs.md)
- [Preview File](https://altostrat.io/docs/api/en/data-migration/preview-file.md)
- [Start Dry Run](https://altostrat.io/docs/api/en/data-migration/start-dry-run.md)
- [Start Import](https://altostrat.io/docs/api/en/data-migration/start-import.md)
- [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.