> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Bigleaf API

> Read Bigleaf SD-WAN site, circuit, router and switch status, risks with the recommended action, and each site's circuits, ISP bandwidth, WAN and LAN settings. Read-only

An agent with this tool answers a Bigleaf alert or an outage ticket from the client's Bigleaf data: is the site or circuit still down, since when, which ISP circuit it is, and what Bigleaf recommends. With no ticket, it reads every site.

> [!NOTE]
>
> Automatically enabled when you configure Bigleaf permissions in your agent workflow. No manual toggle needed.

## What It Does

* Find the client's sites from the [Organization Mapping](https://docs.neoagent.io/integrations/bigleaf/overview.md#your-clients-sites-are-mapped-automatically). A client with several locations has one site per location
* Read a site's status (healthy, circuit issues, offline, provisioning) and each circuit's (up, normal, degraded, down)
* Read each router's and high-availability switch's status and role
* Read the risks Bigleaf raised for a site, with their level, when each started and was last seen, and the recommended action
* Read a site's circuits with their type, ISP bandwidth, usage setting and WAN addressing, its LAN networks, routers and points of presence
* Read the Bigleaf companies and Cloud Connect users the token reaches

The agent calls Bigleaf through the [Vendor API](https://docs.neoagent.io/agents/tools/vendor-api.md) tool, with `bigleaf` as the vendor id. [Sandbox](https://docs.neoagent.io/agents/tools/built-in/sandbox.md) scripts can call Bigleaf too, under the same permissions.

## Permission Groups

| Group | Access levels | What it covers |
| - | - | - |
| **Site Status and Risks** | Disabled, Read Only | Site status, circuit status, router and switch status, and risks |
| **Site Configuration** | Disabled, Read Only | The site list and each site's service, circuits, LAN networks, routers and points of presence |
| **Companies and Users** | Disabled, Read Only | Bigleaf companies, Cloud Connect users, the token's own user, and Bigleaf's API version |

## Access Profiles

> [accordion] Read Only
>
> Every group Read Only. Bigleaf's API has no write, so this is the only preset.

## On a ticket

On a ticket, every call names one of the sites mapped to the ticket's company, and the site, company and user lists are not sent. With no ticket company (a chat, or a scheduled agent with no ticket), the agent reads every site.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.