Configure Agent-Based API

API Config Name

Enter AgentBase Discovery Sync, this indicates the configuration is used to synchronize discovery data from agent-based sources into the system.

API Group Name

Select Others, the API is categorized under a general/default group, meaning it is not grouped under any specific predefined category.

Configured For

Select Inbound, shows that this API is used to receive data into the application (data is pulled from tables into the system).

Domain

Select Domain, specifies the domain to which the API configuration belongs. This helps segregate configurations across different organizational domains.

Sub-Domain

Select Sub-Domain, further categorizes the API under a specific sub-domain within the selected domain for finer classification.

Department

Select Department, identifies the department responsible for or associated with the API configuration. This is useful for ownership and access control.

Active

Enable Active, the API configuration is currently active and available for use in schedulers or integrations.

Icon

Upload an Icon, a visual identifier is optionally added.

API Name

Specifies the name of the API used to retrieve device details from the tables. In this use case, it represents the API responsible for fetching table data into the system.

API Timeout (in seconds)

Defines the maximum time the system waits for a response when calling the agent-based API. For discovery sync, this ensures the data retrieval process does not hang indefinitely if the agent does not respond.

API Type

Indicates that the API is Internal, meaning it is used within the application ecosystem to process and sync table data rather than connecting to an external third-party service.

Response Type

Specifies the expected structure of the API response. In this case, Array indicates that multiple device records are returned from the table in a list format.

List the Response Attributes with Hierarchy

When enabled, the device data from the table (which may include nested attributes like hardware details) is displayed in a hierarchical structure. This is useful for mapping complex discovery data.

Method

Used to configure how the system authenticates API requests when retrieving table data. Ensures secure communication between the system and the agent endpoint.

URL

Specifies the endpoint used to fetch device data from the table. In this use case, it represents the internal API endpoint that retrieves static or discovered device data (hardware tables) for further processing in discovery. The URL is instance-specific and must be configured based on the environment (for example, tenant URL), ensuring the scheduler can successfully call the API and pull table data.

Authentication

Defines the authentication mechanism used. In this case, API Key is used to authorize requests for accessing table data.

Params

Allows defining query parameters required to filter or control the data fetched from the tables (example: device type, timestamp, or batch details if applicable).

Headers

Used to configure request headers required for the agent API, such as authentication headers or content type.

Body

Used to pass additional input data if the API requires it. In this scenario (table data retrieval), it is typically minimal or not used depending on API design.

Response

Used to view and map the response fields returned from the agent API to the system’s discovery or hardware tables for further processing.

Authentication Type

Specifies the authentication mechanism used to access the API. In this use case, API Key is selected to securely authenticate requests made to fetch agent-based discovery data.

Key

Defines the header name used to pass the authentication credential in the API request. In this scenario, X-API-KEY is used to send the API key as part of the request header.

Value

Represents the actual API key required to authorize access to the API endpoint. This value ensures that only authenticated requests can retrieve table data from the system.