API Configuration

Owned by Enterprise IT
May 29, 2024
5 min read


Overview

To discover multiple type of devices, SummitAI now offers API based discovery. Based on the API configuration, the Servers, Networks, Links, Printers, and Laptop devices in the organization can be identified or define to establish connection with the configured APIs. It identifies or supports all the devices wherever an APIs is required.

Using API configuration, you can:

  • Establish connection with the API.
  • Manage Repository of templates.
  • Append API based discovery.
  • Sending Notification.
  • Maintaining Logs and reports.

User Persona – Administrator

Business Benefits

  • Identifying devices that are un-operational.
  • Better data related to troubleshooting, by checking the logs of devices that are inactive.
  • Sending email notifications for devices that are inactive.

Creating API Configuration

An API Configuration enables to you to create API configuration using which you can discover multiple devices.

To create an API Configuration:

  1. Navigate to Admin > Discovery & Monitoring > API Configuration.
    An API Configuration screen appears.

Figure - API Configuration

3. Select the configured Tenant name from the list.

4. Enter the required details. For more information about the fields on the API Configuration page see, Field         Description.

5. Click Submit.

Field Description

Field Description
TenantSelect the Tenant’s name configured in the Tenant page. For more information, see Configuration Tenant. 
API Configuration List

The list of previously configured API appears in the list. You can search the specific API by entering the name in the Search API Configurations field. On selecting the API name the details of the API appears on the API CONFIG DETAILS section.

Note: Select the Include Inactive check box to include the inactive API in the API Configuration List.

API CONFIG DETAILS
API Config NameEnter the API config name while creating a new API or the previously configured API config name appears on selection from API Configuration List. This is a mandatory field.
EnvironmentSelect the environment name from the list. This is a mandatory field.
ModuleSelect the module name from the list. This is a mandatory field.
ActiveSelect the check box to make the API Config Details active. This check box is enabled, by default.
API DETAILS
API NAMEEnter the API name for the API configuration. You can configure multiple APIs for an API configuration.
Method

Select the standard API method from the list. The options are:

  • GET – To fetch the information.
  • POST – To create a new entry.
  • PUT - To update the information.
API Timeout (In seconds)Type in the API Timeout value (in millisecond). Based on the entered timeframe the API is timed out.
Params
KeySpecify the key.
Value Key

Select the value of the key. The field contains the following values:

  • Static
  • API
APISelect previously configured API name from the list. 
API ElementSelect an API element name configured for the selected API appears in the list.
ValueSpecify the value. This field is enabled if the Value Type is selected as ‘Static’.
Description

Type in a brief description about the parameter.

Action

Click to add the specified parameters.

Authentication
Authentication Type

Select the pre-defined authentication values of the list. The listed values are:

  1. No Authentication
  2. API Key - Specify the API key details.

   3. Bearer Token - Specify the token.

   4. Basic - Specify the credentials for the authentication.

    5. OAuth 2.0 - Enter the required auth details.

Headers
KeySpecify the key.
Value Key

Select the value of the key. The field contains the following values:

  • Static
  • API
API Select previously configured API name from the list. 
API ElementSelect the API element name. The API element configured for the selected API appears in the list.
ValueSpecify the value. This field is enabled if the Value Type is selected as ‘Static’.
DescriptionType in a brief description about the headers.
Action

Click to add the specified parameters.

Body
Request TypeSelect the Request Type from the list. Based on Request Type, the actions occur.
Response
Status

The standard HTTP status codes are displayed to indicate whether the API request is executed successfully or not. Following are the standards response codes:

  • Successful Responses (200-299)
  • Client Errors (400-499)
  • Server Errors (500-599)
DescriptionThe description of the API response appears.

Modifying API Configuration

You are enables to edit the API Configuration based on the requirements.

To modify API configuration:

  1. Navigate to Admin > Discovery & Monitoring > API Configuration. 
    The API Configuration screen appears.
  2. Select the configured Tenant name from the list.
  3. Click the configured API from API Configuration List. 
    The detail of configured API appears in the API detail sections.
  4. Clickto edit the previously configured API. 
    The configured details appear.

5. Edit the required fields and click SUBMIT to update the modified details.


The different icons and buttons that are available in the API Configuration screen are explained in the following table:

Click To...

edit the configured API.

delete the configured API.

add the configured parameters to the list.

save the configured API configuration.

cancel the configured API.

test the configured API URL. Click TEST to view the result in Response tab.