Altostrat Networks

# Altostrat Documentation

## Docs

- [null](https://altostrat.io/docs/CLAUDE.md)
- [null](https://altostrat.io/docs/README.md)
- [Get Device Change Events](https://altostrat.io/docs/api-reference/arp/devices/get-device-change-events.md): Retrieves the change event history for a specific device.
- [Get Device Details](https://altostrat.io/docs/api-reference/arp/devices/get-device-details.md): Retrieves details for a specific device by its MAC address.
- [Get Device IP History](https://altostrat.io/docs/api-reference/arp/devices/get-device-ip-history.md): Retrieves the IP address history for a specific device.
- [List Devices](https://altostrat.io/docs/api-reference/arp/devices/list-devices.md): Retrieves a list of network devices belonging to the authenticated customer, with filtering and pagination.
- [Update Device Alias](https://altostrat.io/docs/api-reference/arp/devices/update-device-alias.md): Updates the alias for a specific device.
- [Asynchronous job execution](https://altostrat.io/docs/api-reference/developers/asynchronous-api/asynchronous-job-execution.md): Queues a job to run scripts or config changes on the router without waiting for real-time response.
- [Retrieve a list of jobs for a router](https://altostrat.io/docs/api-reference/developers/asynchronous-api/retrieve-a-list-of-jobs-for-a-router.md): Fetch asynchronous job history or status for a specified router.
- [Retrieve router faults](https://altostrat.io/docs/api-reference/developers/health/retrieve-router-faults.md): Gets the last 100 faults for the specified router, newest first.
- [Retrieve router metrics](https://altostrat.io/docs/api-reference/developers/health/retrieve-router-metrics.md): Provides uptime/downtime metrics for the past 24 hours based on heartbeats.
- [Create a transient port forward](https://altostrat.io/docs/api-reference/developers/port-forwards/create-a-transient-port-forward.md): Establish a temporary TCP forward over the management tunnel for behind-NAT access.
- [Delete a transient port forward](https://altostrat.io/docs/api-reference/developers/port-forwards/delete-a-transient-port-forward.md): Revokes a port forward before it naturally expires.
- [Retrieve a specific port forward](https://altostrat.io/docs/api-reference/developers/port-forwards/retrieve-a-specific-port-forward.md): Returns the details for one transient port forward by ID.
- [Retrieve active transient port forwards](https://altostrat.io/docs/api-reference/developers/port-forwards/retrieve-active-transient-port-forwards.md): List all active port forwards for a given router.
- [Retrieve a list of routers](https://altostrat.io/docs/api-reference/developers/sites/retrieve-a-list-of-routers.md): Returns a list of MikroTik routers belonging to the team associated with the bearer token.
- [Retrieve OEM information](https://altostrat.io/docs/api-reference/developers/sites/retrieve-oem-information.md): Provides manufacturer data (model, CPU, OS license, etc.) for a given router.
- [Retrieve router metadata](https://altostrat.io/docs/api-reference/developers/sites/retrieve-router-metadata.md): Gets freeform metadata (like name, timezone, banner, etc.) for a specific router.
- [Synchronous MikroTik command execution](https://altostrat.io/docs/api-reference/developers/synchronous-api/synchronous-mikrotik-command-execution.md): Real-time RouterOS commands for read or quick ops (not recommended for major config changes).
- [Adopt Device](https://altostrat.io/docs/api-reference/spa/async/bootstrap-&-adoption/adopt-device.md): Endpoint called by the device during bootstrapping to finalize adoption. It receives device information (heartbeat data), creates or finds the site record, and returns the final adoption script including the scheduler setup. Requires `Heartbeat` and `RunbookToken` middleware. Accepts `x-ros-debug` header.
- [Get Bootstrap Script](https://altostrat.io/docs/api-reference/spa/async/bootstrap-&-adoption/get-bootstrap-script.md): Retrieves the initial bootstrap script for a device based on a runbook token. The device fetches this script to start the adoption process. Requires a valid runbook token middleware (`RunbookToken`). Accepts `x-ros-debug` header for verbose/non-minified script.
- [Notify Scheduler Deletion](https://altostrat.io/docs/api-reference/spa/async/bootstrap-&-adoption/notify-scheduler-deletion.md): Endpoint called by a device's scheduler *after* it successfully deletes the Altostrat polling scheduler (typically when the site itself is being deleted/decommissioned). Requires `SiteAuth` and validates signature. Marks the site's deletion as fully completed.
- [Receive Heartbeat & Get Job](https://altostrat.io/docs/api-reference/spa/async/heartbeat/receive-heartbeat-&-get-job.md): Endpoint called periodically by the managed device (via scheduler). Sends device status (heartbeat) and receives the next pending job script, if any. Requires `SiteAuth` middleware (device-specific Bearer token).
- [Get Customer Site IDs (Internal Lite)](https://altostrat.io/docs/api-reference/spa/async/internal/get-customer-site-ids-internal-lite.md): Retrieves only the UUIDs of sites for a specific customer ID. Requires internal API token authentication.
- [Get Customer Sites (Internal)](https://altostrat.io/docs/api-reference/spa/async/internal/get-customer-sites-internal.md): Retrieves a list of sites for a specific customer ID. Requires internal API token authentication.
- [Get Online Site IDs (Internal)](https://altostrat.io/docs/api-reference/spa/async/internal/get-online-site-ids-internal.md): Retrieves a list of UUIDs for all sites currently marked as having a pulse (online). Intended for internal use.
- [Get Site Counts for Multiple Customers (Internal)](https://altostrat.io/docs/api-reference/spa/async/internal/get-site-counts-for-multiple-customers-internal.md): Retrieves the count of sites for each customer ID provided in the request body. Requires internal API token authentication.
- [Create Site Job](https://altostrat.io/docs/api-reference/spa/async/jobs/create-site-job.md): Creates a new job (command/script) for a specific site. Requires `job:create` permission and user ownership of the site. Uses headers for job metadata.
- [Delete Site Job](https://altostrat.io/docs/api-reference/spa/async/jobs/delete-site-job.md): Deletes a *pending* job (one that has not started execution). Requires `job:delete` permission and user ownership.
- [Get Job Details](https://altostrat.io/docs/api-reference/spa/async/jobs/get-job-details.md): Retrieves details for a specific job associated with a site. Requires `job:view` permission and user ownership of the site/job.
- [List Site Jobs](https://altostrat.io/docs/api-reference/spa/async/jobs/list-site-jobs.md): Retrieves a list of jobs associated with a specific site. Requires `job:view` permission and user ownership of the site.
- [Update Job Status (from Device)](https://altostrat.io/docs/api-reference/spa/async/jobs/update-job-status-from-device.md): Endpoint called by the device (using a signed URL provided in the job script) to update the status of a job (busy, done, fail). Uses `ValidateSignature` and `SubstituteBindings` middleware.
- [Get Runbook Details](https://altostrat.io/docs/api-reference/spa/async/runbooks/get-runbook-details.md): Retrieves details for a specific Runbook, including its bootstrap command. Requires user authentication and authorization (user must own the runbook).
- [SFTP User Authentication](https://altostrat.io/docs/api-reference/spa/async/sftp-auth/sftp-user-authentication.md): Called by the AWS SFTP Gateway to authenticate a user attempting to log in. Validates the provided password (cached temporarily) against the username (site UUID) and returns an IAM role and S3 policy if valid.
- [Delete Site](https://altostrat.io/docs/api-reference/spa/async/sites/delete-site.md): Marks a site for deletion. The actual deletion and resource cleanup happen asynchronously. Requires `site:delete` permission and user ownership. Accepts `X-Force-Delete: true` header for immediate forceful deletion (use with caution).
- [Get Recent Sites](https://altostrat.io/docs/api-reference/spa/async/sites/get-recent-sites.md): Retrieves a list of the 5 most recently accessed sites by the authenticated user. Requires user authentication.
- [Get Site Details](https://altostrat.io/docs/api-reference/spa/async/sites/get-site-details.md): Retrieves detailed information for a specific site. Records the access as a "recent site" for the user. Requires `site:view` permission and user ownership.
- [Get Site Hourly Uptime Stats](https://altostrat.io/docs/api-reference/spa/async/sites/get-site-hourly-uptime-stats.md): Retrieves hourly uptime/downtime percentage statistics for the last 24 hours for a specific site. Requires user authentication and ownership.
- [Get Site Version Info](https://altostrat.io/docs/api-reference/spa/async/sites/get-site-version-info.md): Retrieves basic version information for a specific site.
- [List User's Sites](https://altostrat.io/docs/api-reference/spa/async/sites/list-users-sites.md): Retrieves a list of all sites associated with the authenticated user. Requires `site:view` permission.
- [List User's Sites (Minimal)](https://altostrat.io/docs/api-reference/spa/async/sites/list-users-sites-minimal.md): Retrieves a minimal list of sites (ID, name, pulse status, basic info) associated with the authenticated user. Optimized for dropdowns or quick lists. Requires `site:view` permission.
- [Manually Create Site (Internal/Admin)](https://altostrat.io/docs/api-reference/spa/async/sites/manually-create-site-internaladmin.md): Allows manual creation of a site record, bypassing the usual adoption flow. Intended for internal tooling or administrative purposes. Requires appropriate permissions (likely admin/internal).
- [Update Site Details](https://altostrat.io/docs/api-reference/spa/async/sites/update-site-details.md): Updates mutable details of a specific site (e.g., name, address, location, timezone). Requires `site:update` permission and user ownership.
- [List backups for a site](https://altostrat.io/docs/api-reference/spa/backups/site-backups/list-backups-for-a-site.md): Retrieves an array of available RouterOS backups for the specified site. Requires `backup:view` scope.
- [Request a new backup for a site](https://altostrat.io/docs/api-reference/spa/backups/site-backups/request-a-new-backup-for-a-site.md): Enqueues a backup request for the specified site. Requires `backup:create` scope.
- [Retrieve a specific backup file](https://altostrat.io/docs/api-reference/spa/backups/site-backups/retrieve-a-specific-backup-file.md): Shows the contents of the specified backup file. By default returns JSON with parsed metadata. If header `X-Download` is set, it downloads raw data. If `x-highlight` is set, highlights syntax. If `x-view` is set, returns raw text in `text/plain`. Requires `backup:view` scope.
- [Retrieve subnets from latest backup](https://altostrat.io/docs/api-reference/spa/backups/site-backups/retrieve-subnets-from-latest-backup.md): Parses the most recent backup for the specified site, returning discovered local subnets. Requires `backup:view` scope.
- [Show diff between two backup files](https://altostrat.io/docs/api-reference/spa/backups/site-backups/show-diff-between-two-backup-files.md): Returns a unified diff between two backup files. By default returns the diff as `text/plain`. If `X-Download` header is set, you can download it as a file. If `x-highlight` is set, it highlights the diff in a textual format. Requires `backup:view` scope.
- [Assign BGP Policy to Site](https://altostrat.io/docs/api-reference/spa/bgp-dns-filter/bgp-policy/assign-bgp-policy-to-site.md): Assigns or updates the BGP/DNR policy for a specific site tunnel. Creates the tunnel record if it doesn't exist.
- [Create BGP Policy](https://altostrat.io/docs/api-reference/spa/bgp-dns-filter/bgp-policy/create-bgp-policy.md): Creates a new BGP/DNR policy.
- [Delete BGP Policy](https://altostrat.io/docs/api-reference/spa/bgp-dns-filter/bgp-policy/delete-bgp-policy.md): Deletes a BGP/DNR policy. Fails if the policy is currently attached to any sites.
- [Get BGP Policy Details](https://altostrat.io/docs/api-reference/spa/bgp-dns-filter/bgp-policy/get-bgp-policy-details.md): Retrieves details of a specific BGP/DNR policy by its UUID.
- [List BGP Policies](https://altostrat.io/docs/api-reference/spa/bgp-dns-filter/bgp-policy/list-bgp-policies.md): Retrieves all BGP/DNR policies for the authenticated customer.
- [List BGP/DNR Lists](https://altostrat.io/docs/api-reference/spa/bgp-dns-filter/bgp-policy/list-bgpdnr-lists.md): Retrieves a list of available BGP/DNR feed lists.
- [Remove BGP Policy from Site](https://altostrat.io/docs/api-reference/spa/bgp-dns-filter/bgp-policy/remove-bgp-policy-from-site.md): Removes the BGP/DNR policy assignment from a specific site tunnel. Deletes the tunnel record if no DNS policy remains.
- [Update BGP Policy](https://altostrat.io/docs/api-reference/spa/bgp-dns-filter/bgp-policy/update-bgp-policy.md): Updates an existing BGP/DNR policy.
- [List Categories and Top Applications](https://altostrat.io/docs/api-reference/spa/bgp-dns-filter/categories-&-applications/list-categories-and-top-applications.md): Retrieves a list of content categories, each including its top applications sorted by domain count.
- [List Safe Search Options](https://altostrat.io/docs/api-reference/spa/bgp-dns-filter/categories-&-applications/list-safe-search-options.md): Retrieves a list of available safe search services and their configuration options.
- [Assign DNS Policy to Site](https://altostrat.io/docs/api-reference/spa/bgp-dns-filter/dns-policy/assign-dns-policy-to-site.md): Assigns or updates the DNS policy for a specific site tunnel. Creates the tunnel record if it doesn't exist.
- [Create DNS Policy](https://altostrat.io/docs/api-reference/spa/bgp-dns-filter/dns-policy/create-dns-policy.md): Creates a new DNS content filtering policy.
- [Delete DNS Policy](https://altostrat.io/docs/api-reference/spa/bgp-dns-filter/dns-policy/delete-dns-policy.md): Deletes a DNS policy. Fails if the policy is currently attached to any sites.
- [Get DNS Policy Details](https://altostrat.io/docs/api-reference/spa/bgp-dns-filter/dns-policy/get-dns-policy-details.md): Retrieves details of a specific DNS policy by its UUID.
- [List DNS Policies](https://altostrat.io/docs/api-reference/spa/bgp-dns-filter/dns-policy/list-dns-policies.md): Retrieves all DNS content filtering policies for the authenticated customer.
- [Remove DNS Policy from Site](https://altostrat.io/docs/api-reference/spa/bgp-dns-filter/dns-policy/remove-dns-policy-from-site.md): Removes the DNS policy assignment from a specific site tunnel. Deletes the tunnel record if no BGP policy remains.
- [Update DNS Policy](https://altostrat.io/docs/api-reference/spa/bgp-dns-filter/dns-policy/update-dns-policy.md): Updates an existing DNS content filtering policy.
- [Handle DNR Subscription Webhook](https://altostrat.io/docs/api-reference/spa/bgp-dns-filter/internal-hooks/handle-dnr-subscription-webhook.md): Endpoint to receive DNR (BGP) subscription lifecycle events (create, terminate). Requires valid signature.
- [Handle DNS Subscription Webhook](https://altostrat.io/docs/api-reference/spa/bgp-dns-filter/internal-hooks/handle-dns-subscription-webhook.md): Endpoint to receive DNS subscription lifecycle events (create, terminate). Requires valid signature.
- [Get Application Blackhole IPs](https://altostrat.io/docs/api-reference/spa/bgp-dns-filter/ip-lists/get-application-blackhole-ips.md): Retrieves a list of applications and their assigned blackhole IP addresses used for DNS filtering. Requires internal API token.
- [Get DNR Blackhole IP Ranges](https://altostrat.io/docs/api-reference/spa/bgp-dns-filter/ip-lists/get-dnr-blackhole-ip-ranges.md): Retrieves a map of DNR list names to their active blackhole IP ranges (integer format). Requires internal API token.
- [Get Service Counts for All Customers](https://altostrat.io/docs/api-reference/spa/bgp-dns-filter/tunnels-&-sites/get-service-counts-for-all-customers.md): Retrieves a summary count of DNS and DNR subscriptions per customer. Requires internal API token.
- [Get Service Details for a Customer](https://altostrat.io/docs/api-reference/spa/bgp-dns-filter/tunnels-&-sites/get-service-details-for-a-customer.md): Retrieves detailed service information (DNS/DNR subscriptions) for all tunnels belonging to a specific customer. Requires internal API token.
- [Get Tunnel/Site Details](https://altostrat.io/docs/api-reference/spa/bgp-dns-filter/tunnels-&-sites/get-tunnelsite-details.md): Retrieves details for a specific tunnel/site by its Site ID.
- [List All Tunnels/Sites](https://altostrat.io/docs/api-reference/spa/bgp-dns-filter/tunnels-&-sites/list-all-tunnelssites.md): Retrieves a list of all tunnels/sites associated with the authenticated customer.
- [List Sites with BGP/DNR Service](https://altostrat.io/docs/api-reference/spa/bgp-dns-filter/tunnels-&-sites/list-sites-with-bgpdnr-service.md): Retrieves a list of site IDs for the authenticated customer that have the BGP/DNR service enabled.
- [List Sites with DNS Service](https://altostrat.io/docs/api-reference/spa/bgp-dns-filter/tunnels-&-sites/list-sites-with-dns-service.md): Retrieves a list of site IDs for the authenticated customer that have the DNS filtering service enabled.
- [Create a new Auth Integration](https://altostrat.io/docs/api-reference/spa/captive-portal/idp-integrations/create-a-new-auth-integration.md)
- [Delete a specific Auth Integration](https://altostrat.io/docs/api-reference/spa/captive-portal/idp-integrations/delete-a-specific-auth-integration.md)
- [List all IDP Integrations](https://altostrat.io/docs/api-reference/spa/captive-portal/idp-integrations/list-all-idp-integrations.md)
- [Partially update a specific Auth Integration](https://altostrat.io/docs/api-reference/spa/captive-portal/idp-integrations/partially-update-a-specific-auth-integration.md)
- [Replace a specific Auth Integration](https://altostrat.io/docs/api-reference/spa/captive-portal/idp-integrations/replace-a-specific-auth-integration.md)
- [Retrieve a specific Auth Integration](https://altostrat.io/docs/api-reference/spa/captive-portal/idp-integrations/retrieve-a-specific-auth-integration.md)
- [Create a new captive portal Instance](https://altostrat.io/docs/api-reference/spa/captive-portal/instances/create-a-new-captive-portal-instance.md)
- [Delete a specific captive portal Instance](https://altostrat.io/docs/api-reference/spa/captive-portal/instances/delete-a-specific-captive-portal-instance.md)
- [List all captive portal Instances](https://altostrat.io/docs/api-reference/spa/captive-portal/instances/list-all-captive-portal-instances.md)
- [Partially update a specific captive portal Instance](https://altostrat.io/docs/api-reference/spa/captive-portal/instances/partially-update-a-specific-captive-portal-instance.md)
- [Replace a specific captive portal Instance](https://altostrat.io/docs/api-reference/spa/captive-portal/instances/replace-a-specific-captive-portal-instance.md)
- [Retrieve a specific captive portal Instance](https://altostrat.io/docs/api-reference/spa/captive-portal/instances/retrieve-a-specific-captive-portal-instance.md)
- [Upload an image (logo or icon) for a specific Instance](https://altostrat.io/docs/api-reference/spa/captive-portal/instances/upload-an-image-logo-or-icon-for-a-specific-instance.md)
- [Create a new walled garden entry for a site](https://altostrat.io/docs/api-reference/spa/captive-portal/walled-garden/create-a-new-walled-garden-entry-for-a-site.md)
- [Delete a specific walled garden entry under a site](https://altostrat.io/docs/api-reference/spa/captive-portal/walled-garden/delete-a-specific-walled-garden-entry-under-a-site.md)
- [List all walled garden entries for a specific site](https://altostrat.io/docs/api-reference/spa/captive-portal/walled-garden/list-all-walled-garden-entries-for-a-specific-site.md)
- [Partially update a specific walled garden entry under a site](https://altostrat.io/docs/api-reference/spa/captive-portal/walled-garden/partially-update-a-specific-walled-garden-entry-under-a-site.md)
- [Replace a specific walled garden entry under a site](https://altostrat.io/docs/api-reference/spa/captive-portal/walled-garden/replace-a-specific-walled-garden-entry-under-a-site.md)
- [Retrieve a specific walled garden entry under a site](https://altostrat.io/docs/api-reference/spa/captive-portal/walled-garden/retrieve-a-specific-walled-garden-entry-under-a-site.md)
- [Server check-in for a site](https://altostrat.io/docs/api-reference/spa/cpf/checkin/server-check-in-for-a-site.md): Called by a server to claim or update itself as the active server for a particular site (via the tunnel username).
- [Create (rotate) new credentials](https://altostrat.io/docs/api-reference/spa/cpf/credentials/create-rotate-new-credentials.md): Generates a new username/password pair for the site, deletes any older credentials. Requires `apicredentials:create` scope.