R12 Publication-2025July16

Set up an API Server

Create a BMC Remedy API Server:

  1. Pre-requisites
  2. Create BMC Remedy API Server Connection

Pre-requisites

Application Version

ApplicationVersion
BMC RemedyRemedy ITSM 9.1.04 (or newer)

Network Connectivity

ClientServerProtocol
NetBrain Front ServerBMC Remedy EndpointHTTP/HTTPS

User Account and Privileges

ApplicationUser AccountRequired Role Assignment(s)
NetBrainRequiredSystem Admin
BMC RemedyRequiredGuest (or higher)

Create BMC Remedy 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 > The Start Menu > API Server Manager
  3. In the API Server Manager screen, click Add.
  4. Complete the Add API Server dialog screen as follows:
    • Server Name: BMC Remedy API Server <Front Server>
    • Description: BMC Remedy
    • API Source Type: " BMC Remedy API Adapter"
    • Endpoint: BMC Remedy instance endpoint (ex "https://192.168.28.253:8008")
    • Username: BMC Remedy account's username
    • Password: BMC Remedy password
    • Front Server/Front Server Group: Select FS/FSG which would have reachability to BMC Remedy instance endpoint
  5. Click Managed Devices: 0 to assign BMC Remedy Search enabled devices to this API Server.
    • Click + Device.
    • Select the "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 BMC Remedy instance configured.
    Test ResultsScreenshots
    Successful Connection

    Error Scenario: The entered credentials are incorrect.

    Possible Resolution: Confirm credentials specified in the BMC Remedy API Server configuration and retry.

    Error Scenario: BMC Remedy endpoint is unreachable.

    Possible Resolution: Confirm that the NetBrain Front Server(s) can reach the BMC Remedy Server on Port 8008 via HTTPs