Set Up API Server

Note: Before setting up your API server, read NetBrain Requirements for API Server Setup first.

Follow these steps to set up a NetBrain API server:

1. Click in your NetBrain desktop and select API Server Manager from the dropdown menu.
   
   
2. Click + Add API Server to initiate the addition of a new API server.
   
   

• Server Name: a unique name.
• Description: an optional field to describe this server.
• API Source Type: select Microsoft Azure.
• Access Method: select Managed Identity.
• Public Service: Include or Exclude
  
• Endpoint (Client/VM ID): copy/paste the VM ID value from the JSON format data in Azure Virtual Machine (VM) portal.

• Directory (Tenant) ID: copy/paste the Tenant ID.

• Front Server/Front Server Group: select one front server VM with managed identity to access Azure.
• Management Identity Client ID/Object ID/Resource ID: In the Advanced settings, you can specify which VM management identity will be used for NetBrain IE discovery.
   
  • If the VM is configured with only a system-assigned identity or if the VM has only one user-assigned identity configured, no additional configuration is required.
  • If both identity types are configured and you prefer to use the user-assigned identity (note: Azure defaults to the system-assigned identity). To override the default system-assigned identity and use a user-assigned identity, you must explicitly define the management identity using one of the following parameters:Client ID, Object ID, and Resource ID.
    
    
  • Find the management Client ID, Object ID(PrincipalId) or Resource ID from Json view of Azure Portal.
  

3. Click Test to verify that this API server works.

Once the API server is successfully verified and saved, you can proceed to Discover Azure Resources.