Osprey API reference

Reference edition 1.4.3. Match this reference to your installed release. The OpenAPI file covers eight 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
• 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
• GET /api/v1/reports/dependencies
• POST /api/v1/reports/dependency-impact
• `GET /bgp/history/churn-shapes`
• GET /api/v1/reports/bgp-security
• POST /api/v1/bgp/roa/import
• GET /api/v1/bgp/roa/summary
• GET /api/v1/bgp/selection-funnel
• Traffic History
• L2 Discovery (LLDP/CDP)
• BMP Targets & BGP
• `GET /bgp/targets`
• `POST /bgp/targets`
• `GET /bgp/targets/{id}`
• `PUT /bgp/targets/{id}`
• `DELETE /bgp/targets/{id}`
• `PUT /bgp/targets/{id}/toggle`
• BGP-LS
• `GET /bgpls/peers`
• `POST /bgpls/peers`
• `PUT /bgpls/peers/{id}` / `PUT /bgpls/peers/{id}/toggle` / `DELETE /bgpls/peers/{id}`
• `GET /bgpls/objects`
• `GET /bgp/peers`
• `GET /bgp/peers/{peerID}/impact-summary`
• `GET /bgp/routes`
• `GET /bgp/rib-paths`
• `GET /bgp/history/scenario`
• `GET /bgp/history/bins`
• `GET /bgp/history/candidates`
• `GET /bgp/history/as-graph`
• `GET /bgp/history/as-flows`
• `GET /bgp/history/as-detail`
• `GET /bgp/history/half-life`
• `GET /bgp/history/blind-spots`
• `GET /bgp/peers/stat-history`
• `GET /bgp/summary`
• `GET /bgp/asbr-mapping`
• Error Responses
• Error Codes
• HTTP Status Codes
• CORS
• Versioning
• Implementation Notes
• Nil Slices
• Timestamps
• UUIDs
• JSONB Fields
• Router ID CIDR Suffix