Configuration

Probe API is a BETA feature, not yet available to all accounts.

The Birch Probe supports a local RESTful API to allow for third-party devices to control Birch routes across the system. The API uses existing (or purpose built) Access Control Lists to limit what sources and destinations are exposed to the API. Additionally, you can use multiple APIs with different username and passwords to filter sources and destinations as needed for different third-party devices.

Prerequisites

• Prior to configuring a new API, an Access Control List must first be defined.

API Configuration

Any Administrator can configure a new Birch Probe API. Navigate to the Settings -> Probe API settings.

To add a new API, click Add API.

Create a Name for the API and select the Access List that this API will use to filter the sources and destinations within Birch. The Username and Password are generated automatically. Click Submit to create the new API.

When creating a new API, the Birch Probe will need to be manually restarted from the Probe settings.

The Birch Probe API uses HTTP Basic Authentication for all HTTP Requests. The username and password will be generated automatically when the API is created and cannot be changed.

Once the API is created, you can click on the Auth User or Auth Password to copy these values to your clipboard. You can also view the values by Editing the API. The number of destinations and sources from your ACL are shown for reference.