R12.1 Project Publication-2025Dec23

Set up the API Server

Create a Cisco SNTC API Server:

  1. Pre-requisites
  2. Create a Cisco SNTC API Server Connection 

Pre-requisites

Application Version

Application Version
NetBrain

IEv10.1 and above

Network Connectivity

ClientServerPorts
NetBrain Front Server

Cisco SNTC API

  • https://id.cisco.com
  • https://apix.cisco.com

TCP Port 443

User Account and Privileges

Application User Account Required Role Assignment(s)
NetBrain Required Domain Admin
Cisco SNTC API Required
  • Bug API (List the required API service names)
  • EOX V5 API
  • Product Info API
  • Serial Number to Information
  • Software Suggestion API
  • Service Order Return API (List the required API service names)
  • Case API

Create a Cisco SNTC API Server Connection

  1. Using a web browser, login to the NetBrain Desktop UI using the System Admin credentials.
    • http(s)://<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: “Cisco SNTC”
      Information Note: The server name cannot be changed
    • Description: Cisco SNTC API server 
    • API Source Type: "Cisco SNTC API Adapter v3" 
    • Endpoint: https://apix.cisco.com 
    • Username: Cisco SNTC API account's username 
    • Password: Cisco SNTC API password 
    • Front Server/Front Server Group: Select FS/FSG which would have reachability to Cisco SNTC API endpoints
  5. Click Managed Devices: 0 to assign Cisco SNTC covered devices to this API Server.
    • Click + Device.
    • Select "Device Type" radio button.
    • Select All Cisco 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 Cisco SNTC API configured.
Test Results
 Screenshots
Successful Connection  

Error Scenario: The entered credentials are incorrect.

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

 

Error Scenario: Cisco SNTC API endpoint is unreachable.

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

  
Built-in Cisco SNTC Integration Schedule Cisco Support Information Plugin