Osprey API reference

Reference edition 1.4.5. Match this reference to your installed release. The OpenAPI file covers 20 observation operations; the pages below describe the broader API.

• Osprey REST API Reference
  • Using the API
  • Authentication
    • Cookie Strategy
    • Roles
    • API Key Authentication
    • Read-only API Keys
    • Refresh Token Rotation
    • Rate Limiting
    • Body Size Limit
    • Input Validation
  • API Capabilities
  • Pagination
  • Public Endpoints (no authentication)
    • Health Check
    • Version
    • Prometheus Metrics
    • Login
    • MFA Step-Up
    • MFA Enroll-at-Login (mandatory MFA, no session yet)
    • MFA Enrollment (authenticated)
    • SCIM 2.0 Provisioning
    • Refresh Token
    • List Sign-In Providers
    • SAML 2.0 Sign-In Flow
    • OIDC Sign-In Flow
  • Authenticated Endpoints (admin, engineer, or operator)
    • Usage Summary
    • Auth Management
    • Hierarchy (Read)
    • Global Search
    • Topology (Read)
    • Topology Events (Read)
    • Routes & Interfaces (Read)
    • Traffic (Read)
    • Collectors (Read)
    • WebSocket (Authenticated)
    • SSH Sessions
    • Alerts
    • Incidents
    • Layouts
    • Settings
  • Privileged Endpoints
    • Hierarchy (Write)
    • Collectors (Write)
    • User Management
    • API Keys
    • Identity Providers (SSO)
    • Alert Rules (Write)
    • Notification Channels
    • SNMP Targets
    • SNMP Credential Profiles
    • IP Conflict Diagnostics
    • Reports
    • SNMP Target Summary (Non-Admin)
    • Admin Layout Operations
    • Device Management (Admin)
    • Link Management (Admin)
    • System Settings (Admin)
    • Maintenance Windows (Admin)
    • Sessions (Admin)
    • Audit Log (Admin)
    • Application Logs (Admin)
    • Backup & Restore (Admin)
    • Icon Packs
    • DNS Tools (Admin)
    • License
    • SRLG Groups (Shared Risk Link Groups)
    • MPLS-TE Tunnels
    • MPLS L3VPNs
    • MPLS L2VPN Pseudowires (VPWS / VPLS)
    • EVPN (E-LAN, EVPN-VPWS)
    • Simulation (Engineering Mode)
    • Advanced Reports
    • Dependency report
    • Dependency impact report
    • BGP churn shapes
    • BGP security report
    • Import ROA data
    • ROA summary
    • BGP selection funnel
    • Traffic History
    • L2 Discovery (LLDP/CDP)
  • BMP Targets & BGP
    • List BMP targets
    • Create BMP target
    • Get BMP target
    • Update BMP target
    • Delete BMP target
    • Toggle BMP target
    • BGP-LS
    • List BGP-LS peers
    • Create BGP-LS peer
    • Update, toggle or delete a BGP-LS peer
    • List BGP-LS objects
    • List BGP peers
    • BGP peer impact summary
    • List BGP routes
    • BGP RIB paths
    • BGP history scenario
    • BGP history bins
    • BGP history candidates
    • BGP history AS graph
    • BGP history AS flows
    • BGP history AS detail
    • BGP history half-life
    • BGP history blind spots
    • BGP peer statistics history
    • BGP summary
    • BGP ASBR mapping
  • Error Responses
    • Error Codes
    • HTTP Status Codes
  • CORS
  • Versioning
  • Implementation Notes
    • Nil Slices
    • Timestamps
    • UUIDs
    • JSONB Fields
    • Router ID CIDR Suffix
  • Device SRv6 observations
  • Logical local repair analysis
    • BGP-LS SR-policy observations (2026-09-09)
    • SR-policy node associations (application-only)