- 3 minutes to read

Install Nodinite Log API

The Nodinite Log API is the REST endpoint that receives Log Events from Log Agents, the Pickup Service, and your own code. It ships with the Nodinite Core Services, so you never install it on its own: you describe the environment in the Nodinite Portal, download one ZIP, and run the generated CLI package. The full procedure is Install Nodinite v7; this page lists what matters for the Log API.

Before you start, review the Log API Prerequisites (SQL Server rights, firewall).

What You Set for the Log API in the Portal

Setting Where in the Portal Notes
Server that hosts the Core Services Step 4: Servers › Selected server One server per environment hosts the Log API with the other Core Services
Log API port Step 4: Servers › Core platform services The Log API is its own IIS web site on this port. Log Agents and the Pickup Service use it in the base URL https://{host}:{port}/LogAPI/
Service account (identity) Step 4: Servers › Core platform services Same account for all Services, or a separate account for the Log API. The Log API connects to SQL Server as this account. Defaults come from Step 2: Auth › Service Account Defaults
TLS host name and certificate Step 4: Servers › Core host Configuration The FQDN, and the certificate subject the installer uses to find the certificate for the HTTPS binding
Authentication mode Step 2: Auth › Auth Mode Windows authentication or OAuth 2.0 / OIDC for the environment
Enable Authentication and Audiences (OAuth 2.0 only) Step 2: Auth › Log API Off by default: the Log API accepts Log Events anonymously. When checked, every call needs a bearer token; see Protect the Log API with OAuth 2.0 and Entra ID
SQL Server and connection string Step 3: Infrastructure The Log API writes to the Configuration Database and the active Log Database

Check the ports in Step 6: Review and Download › Allocated ports before you download the ZIP.

What the CLI Does for the Log API

When you run the generated package (validate, dry-run, then deploy-environment) in an elevated PowerShell 7 prompt, the CLI:

  • Creates or updates the Log API IIS web site and application pool, with the port, identity, and HTTPS binding from the Portal.
  • Writes the Log API settings, including the authentication values, from the generated configuration. Don't edit them by hand; change them in the Portal and redeploy.
  • Deploys the Configuration Database that the Log API reads its settings from.

Verify the Log API

  1. In IIS Manager, check that the Log API web site is started.
  2. Open Scalar at https://{host}:{port}/scalar, for example https://nodinite.contoso.com:40002/scalar. It lists the Information and LogEvent operations.
  3. Send a test Log Event to https://{host}:{port}/LogAPI/api/LogEvent/Validate. A 200 or 400 response means the Log API is running; 400 only means the test payload is invalid. A 401 means Enable Authentication is on and the call has no valid token.
  4. Point a Log Agent or the Pickup Service at the base URL https://{host}:{port}/LogAPI/, and confirm that its Log Events show up in a Log View.

For the URL formats and code samples, see Log using REST. If the installation itself fails, see the CLI troubleshooting section.

Note

Nodinite v6 is no longer supported. To move an existing v6 installation, follow Updating from v6 to v7.

Next Steps