API Configurations

NDR Core's main functionality is to retrieve data over an API and display it. To achieve this, you need to create a configuration that defines how to access your data.

NDR Core provides multiple API implementations. If your desired API is not in the list, you can write your own implementation.

Configuration Fields

• API Type - Select the API implementation to use (MongoDB, Nodegoat, NDR Core, or custom).
• Configuration Name - A computer-readable identifier for this configuration. Must be unique, contain no special characters or spaces. Used internally and in form naming.
• Configuration Label - A human-readable display name shown in the administration interface and to end users when selecting search configurations.
• Connection URL - The complete URL endpoint for the API connection. Format varies by API type (see individual API documentation for examples).
• Authentication (optional) - Some APIs require authentication credentials:
  • Username - For basic authentication
  • Password - For basic authentication
  • Authentication Key - For token/key-based authentication
• Page Size - Number of results returned per API request.
• Search ID Field - The field name that uniquely identifies each result entry.
• Description - Internal notes about this configuration. Not displayed to end users.

See also: API Implementations for connection URL formats and examples for each API type.