Files
librenms-librenms/doc/API/Routing.md

68 lines
1.1 KiB
Markdown
Raw Normal View History

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
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/bgp
```
Output:
```json
{
"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
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/routing/ipsec/data/localhost
```
Output:
```json
{
"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.