R12 Publication-2025July16

Set up API Server

Create a ThousandEyes API Server:

  1. Pre-requisites
  2. Create ThousandEyes API Server Connection 

Pre-requisites

Application Version

Application Version
NetBrain IEv8.0 and above

Network Connectivity

Client Server Ports
NetBrain Front Server ThousandEyes Cloud

NetBrain > ThousandEyes Cloud API TCP 443

 

User Account and Privileges

Application User Account Required Role Assignment(s)
NetBrain Required System Admin
ThousandEyes cloud Required Client

Create ThousandEyes API Server Connection

Information Note: If the environment has been deployed with multiple Front Servers, repeat this section for each of the Front Servers.
  1. Using a web browser, login to the NetBrain Desktop UI using the System Admin credentials.
    • http://<NetBrain Web Server IP>
  2. Navigate to the NetBrain API Server Manager.
    • Domain Management > API Server Manager
  3. In the API Server Manager screen, click Add.
  4. Complete the Add API Server dialog screen as follows:
    • Server Name: ThousandEyes API Server <Front Server>
    • Description: ThousandEyes
    • API Source Type: " ThousandEyes API Adapter"
    • Endpoint: ThousandEyes cloud endpoint (ex "https://api.thousandeyes.com")
    • Username: ThousandEyes API account's username
    • Password: ThousandEyes API password
    • Front Server/Front Server Group: Select FS/FSG which would have reachability to ThousandEyes Cloud API endpoint
  5. Click Managed Devices: 0 to assign ThousandEyes covered devices to this API Server.
    • Click + Device.
    • Select "Device Type" radio button.
    • Select All Device Types.
    • Click ">>", then click OK two times to save the device assignment.
  6. Click Test to initiate a connectivity test between the NetBrain front server and the ThousandEyes Cloud API configured.
Test Results
Screenshots
Successful Connection  

Error Scenario: The entered credentials are incorrect.

Possible Resolution: Confirm credentials specified in the ThousandEyes API Adaptor configuration and retry.

 

Error Scenario: ThousandEyes cloud endpoint is unreachable.

Possible Resolution: Confirm that the NetBrain Front Server(s) can reach the ThousandEyes API endpoint using 3rd party tools (Ping, Traceroute, Wireshark). Or confirm your endpoint is inserted correctly.