- 3 minutes to read

ProductArtifactsPath - System Parameter

The ProductArtifactsPath System Parameter lists where each Nodinite Core Services component runs: its name, address, and API key. The Web API uses it to find and call the Logging Service and the Monitoring Service, and the Logging Service reads it too.

Warning

The installer sets this value. Don't edit it unless Nodinite Support asks you to; a wrong address or key breaks the communication between the Web API and the services.

At a Glance

Property Value
Key ProductArtifactsPath
Data type json
Default Set by the installer
Read by Web API / Logging Service
Takes effect Within about 15 seconds; no restart needed
Status ✅ Active (installer-managed)
Since Nodinite 4

How It Works

Each Nodinite environment runs its Core Services as separate IIS web sites, each on its own port. You set the host names and ports for the environment in the Nodinite Portal (Servers step), and the installer writes the resulting addresses into ProductArtifactsPath. When the Web API calls the Logging Service or the Monitoring Service, it looks up the address and the XApiKey here.

Value Format

A JSON array with one object per component:

Property Type Meaning
Name string Component name: WebClient, WebAPI, LogAPI, LoggingService, or MonitoringService
URI string HTTP or HTTPS address of the component
XApiKey string API key for service-to-service calls; set for the Logging Service and Monitoring Service, empty for the others. Generated during installation 
[
    {"Name":"WebClient","URI":"http://localhost:40000/WebClient","XApiKey":""},
    {"Name":"WebAPI","URI":"http://localhost:40001/WebAPI","XApiKey":""},
    {"Name":"LogAPI","URI":"http://localhost:40002/LogAPI","XApiKey":""},
    {"Name":"LoggingService","URI":"http://localhost:40004/Service/Logging/","XApiKey":"1234d170-1921-48d6-abcf-c93ff2888344"},
    {"Name":"MonitoringService","URI":"http://localhost:40003/Service/Monitoring/","XApiKey":"1234d170-1921-48d6-abcf-c93ff2888344"}
]

Example from a demo environment with Windows Authentication and without HTTPS; the ports and API keys are examples only. Use HTTPS in production.

Important

These URIs are for internal use. To call the Web API from your own scripts, use the root of its web site, for example https://nodinite.contoso.com:40001/api/Users/whoami. A path such as /WebAPI/api/... returns 404. See Manage the Web API.

Choosing a Value

  • Let the installer manage it. If host names or ports change, for example after hardening with HTTPS, update the environment in the Portal and run the update, or ask Nodinite Support.
  • Treat the API keys as secrets. The XApiKey values give access to the Logging Service and Monitoring Service.

Next Steps

Note

Nodinite v6 and its Install and Update Tool are no longer supported.