Log API
The Nodinite Log API is the REST entry point for every Log Event that reaches Nodinite. Nodinite Log Agents use it, the Pickup Log Events Service Logging Agent uses it, and your own code can use it too, from any platform: Node.js, .NET, Java, Python, PowerShell, or anything that can post JSON over REST. The Log API stores the events in the Log Databases, where the Logging Service processes them and business users find them through role-based Log Views.
- ✅ One REST endpoint for Log Events from all platforms
- ✅ Single Log Events or batches, with a validate-only operation
- ✅ Optional OAuth 2.0 protection, set in the Nodinite Portal
- ✅ Built-in Scalar and Swagger API references
Understanding the Log API Architecture
Senders post Log Events to the Log API (blue), which stores them in the active Log Database (green). The Logging Service (orange) then processes them.
Key Components
| Component | Role |
|---|---|
| Log API | ASP.NET Core web application, hosted as its own IIS web site and port. Receives Log Events over REST and stores them. Part of the Core Services |
| Log Agents and the Pickup Service | Send Log Events to the Log API base URL https://{host}:{port}/LogAPI/. They keep their events and retry while the Log API is unavailable |
| Configuration Database | Holds the System Parameters the Log API reads |
| Log Databases | Hold the stored Log Events and messages |
| Logging Service | Processes what the Log API stores: Message Types, Search Fields, retention, and cleanup |
Installation and Settings
The Log API is installed, updated, and removed with the Core Services; see Install Log API, Update Log API, and Uninstall Log API. You set its values in the Nodinite Portal, never by hand in IIS or settings files:
| Setting | Portal step |
|---|---|
| Port and service account | Step 4: Servers › Core platform services |
| TLS host name and certificate | Step 4: Servers › Core host Configuration |
| Enable Authentication and Audiences (OAuth 2.0) | Step 2: Auth › Log API |
By default the Log API accepts Log Events anonymously. To require a bearer token, follow Protect the Log API with OAuth 2.0 and Entra ID. Review the Prerequisites (SQL Server rights, firewall) before you install.
System Parameters Read by the Log API
| System Parameter | Purpose |
|---|---|
| SqlServer | Which SQL Server, Linked Server, or Azure SQL hosts the Nodinite databases |
The Log API reads only this one. The parameters that change what happens to your Log Events after they are stored are read by the Logging Service; see the next section. How to change a value: Manage System Parameters.
What Happens After the Log API Accepts an Event
The Log API stores the event as unprocessed. The Logging Service then determines the Message Type, extracts Search Fields, and applies retention; the full pipeline is in What happens after you log an event. These pages tell you what you can control:
- JSON Log Event – the fields to send; always set
OriginalMessageTypeName, or the event gets no searchable business data - Context Options – reserved context keys that change how an event is processed
- Repository Binding – build the Repository Model from your Log Events, with AllowRepositoryAutomapping
- ContextPropertiesFilters – remove context properties, such as passwords, before they are stored
- MessageProcessingMaxBodySize – the largest message body the Logging Service processes
- MissingEventsDays – how long unprocessed Log Events without a Message Type are kept
- Message Types and Search Fields – how business data is extracted, for Log Views, Non-Events Monitoring, and BPM
Log from Your Own Code
To post Log Events from a script, service, or application, start with Log using REST. It shows how to find the base URL of your environment's Log API (for example https://nodinite.contoso.com:40002/LogAPI/), how to call a protected Log API, and gives samples in PowerShell, curl, C#, Python, and Node.js. For volume, or when your application must not depend on Nodinite being available, use Asynchronous Logging with the Pickup Service.
Tip
The Log API is for writing Log Events. To automate other tasks, such as maintaining the Repository Model or reading monitoring data, use the deterministic Web API. To ask natural-language questions about your integration landscape from an AI tool, use the MCP Endpoint.
The WCF endpoints of Nodinite v6 are not available in v7; see Log using WCF for what to use instead.
Scalar and Swagger Support
The Log API comes with two interactive API references at the root of its web site: Scalar at https://{host}:{port}/scalar and Swagger at https://{host}:{port}/swagger. Both list every operation and model, and let you send test requests. Scalar also generates code snippets for many languages. Swagger may be removed in a future version, so prefer Scalar.
Scalar groups the Log API operations into Information and LogEvent, and lets you download the OpenAPI document.
Swagger lists the Log API operations: post a Log Event or a batch, validate them, and read the valid Endpoint Types, Endpoint Directions, and Event Directions.
Frequently Asked Questions
Find answers to common questions and troubleshooting tips in the Troubleshooting guide for the Nodinite Log API.
Note
Nodinite v6 is no longer supported. To move an existing v6 installation, follow Updating from v6 to v7.
Next Steps
- Log using REST
- Protect the Log API with OAuth 2.0 and Entra ID
- Log Events transferred by the Nodinite Pickup Log Events Service Logging Agent
- Prerequisites
- Install Log API
- Self-service for the business using Nodinite Log Views
Related Topics
- Log Event
- Asynchronous Logging
- Log Agents
- Logging Service
- Log Databases
- Message Types - Critical for Search Field extraction
- Search Fields - Extracted using Message Types
- Non-Events Monitoring - Analyzes Log View data
- Business Process Modeling (BPM) - Tracks end-to-end processes
- Hardening
- Log API Scenarios
- System Parameters