Skip to main content

Help

REST API

The TowerOps REST API provides programmatic access to your monitoring data. All endpoints are under /api/v1/ and require a valid API token carrying the scope the endpoint needs.

Available Endpoints

  • Devices: List, view, create, update, and delete monitored devices
  • Alerts: Query active and historical alerts, acknowledge, and resolve
  • Sites: Manage sites and their device assignments
  • Agents: List, create, and revoke remote pollers
  • Checks: Manage HTTP, TCP, DNS, and ping service checks
  • Check Results: Query per-device check results, metrics, and interfaces
  • Organization Settings: Read and update the organization's SNMP and MikroTik defaults
  • Members & Invitations: Manage organization membership and pending invitations
  • Integrations: Configure and test vendor integrations
  • On-call Schedules: Schedules with their layers, members, and overrides
  • Escalation Policies: Rules and their notification targets
  • Maintenance Windows: Create and manage planned maintenance

    announce_on_status_page defaults to false; set true to opt in. Finite windows publicly announce their public title and end time on mapped status components, mark them as maintenance, and restore their status when the window ends; the internal window name is never published. Set public_title to choose the label customers see. Windows with no mapped components make no public changes.

  • RF Coverage: Coverage predictions, recompute, and KMZ export
  • Webhook Endpoints: Manage outbound webhook subscriptions, deliveries, and replays
  • Activity Feed: Recent events and changes across the organization

Quick Example

# create a token in Account Settings → API tab
curl -H "Authorization: Bearer YOUR_TOKEN" \
  https://staging.towerops.net/api/v1/devices

Every successful response wraps its payload in an {"data": ...} envelope, and paginated collections add a meta object carrying the page count and the next-page cursor. Failures answer an error object instead. Results are scoped to the organization associated with your API token.

Full reference: REST API Documentation → complete endpoint reference with request/response examples.