mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
3bd9920e38
* docs: Continue to reorganize things Make landing pages for /Installation, /API, etc. Split API out into multiple docs Properly use multi-level navigation Add lower nav buttons (tops are bug so disable for now) Add logo for fanciness Refine index page a bit * Improve API TOC layout * Couple of fixes. * Fix API/API-Docs, assumed it was at the right url.
1.1 KiB
1.1 KiB
source: API/Routing.md
list_bgp
List the current BGP sessions.
Route: /api/v0/bgp
Input:
- hostname = Either the devices hostname or id. OR
- asn = The ASN you would like to filter by
Example:
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/bgp
Output:
{
"status": "ok",
"err-msg": "",
"count": 0,
"bgp_sessions": [
]
}
list_ipsec
List the current IPSec tunnels which are active.
Route: /api/v0/routing/ipsec/data/:hostname
- hostname can be either the device hostname or id
Input:
Example:
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/routing/ipsec/data/localhost
Output:
{
"status": "ok",
"err-msg": "",
"count": 0,
"ipsec": [
"tunnel_id": "1",
"device_id": "1",
"peer_port": "0",
"peer_addr": "127.0.0.1",
"local_addr": "127.0.0.2",
"local_port": "0",
"tunnel_name": "",
"tunnel_status": "active"
]
}
Please note, this will only show active VPN sessions not all configured.