Web API FAQ and Troubleshooting guide
Discover answers to common questions and solutions for the Nodinite Web API. This guide helps systems integration experts and potential customers quickly resolve issues and understand the unique benefits of the Web API within Core Services.
✅ Comprehensive FAQ for the Web API
✅ Details on Scalar and Swagger support and discoverability
✅ Direct links to help resources and expert support
The Nodinite Web API is part of Core Services and relies on several dependencies, as described in the Prerequisites user guide. This page provides troubleshooting tips and highlights key features to help you maximize your integration experience.

Animated walkthrough: a script calls the Web API in Windows Authentication mode. Without credentials the answer is 401 Unauthorized; with -UseDefaultCredentials the Web API answers with the caller's user. See Why does my script get 401 Unauthorized?
Does the Web API support Swagger?
Yes. Add /swagger to the Web API base URL, for example https://nodinite.contoso.com:40001/swagger, to open Swagger. It lists every REST operation with its request and response models, and lets you send test requests with Try it out and Execute.

Swagger shows the curl command, the request URL, and the response body for each test request.
Note
Swagger may be removed in a future version of the Web API. Use Scalar for new work.
What is Scalar?
Scalar is the modern, interactive API reference that comes with the Nodinite v7 Web API, next to Swagger. Add /scalar to the Web API base URL, for example https://nodinite.contoso.com:40001/scalar. Besides browsing operations and sending test requests, Scalar generates code snippets in many languages, such as C# HttpClient, PowerShell, Python, and curl. The snippets don't include authentication; add it as described in Manage the Web API.

Scalar groups the operations by area and generates a snippet for the selected language.
Why does /swagger, /scalar, or an API call return 404?
Check the base URL. In Nodinite v7, each environment's Web API is its own IIS web site with its own port, such as https://nodinite.contoso.com:40001. The port is set for each environment in the Nodinite Portal, in the Servers step. Add /scalar or /swagger directly after the port, not after a path. See Find the base URL.
The same applies to API calls: use https://nodinite.contoso.com:40001/api/Users/whoami. A path between the port and /api/, such as /WebAPI/api/Users/whoami, returns 404 Not Found with an empty body, so a browser shows a blank page. Without credentials, a wrong path answers 401 Unauthorized first, because sign-in is checked before the route.

Animated walkthrough: /WebAPI/api/Users/whoami gets 404 Not Found, /api/Users/whoami right after the port answers, and /scalar opens the API reference, also right after the port.
What protocols are supported?
For a detailed overview of supported protocols and security best practices, see the Hardening guide.
Is there a Help page?
Yes. The interactive API references are the help pages for the Nodinite v7 Web API. Open Scalar at <webapi-base-url>/scalar or Swagger at <webapi-base-url>/swagger to browse the operations, their parameters, and response models. See What is Scalar?.
How do I call the Web API from a script or pipeline?
It depends on the authentication mode of your environment. In OpenID Connect / OAuth 2.0 mode, register a client app and send an access token, as described in Call the Web API with OAuth 2.0 Client Credentials. In Windows Authentication mode, run the script as a Windows account with access in Nodinite, as described in Call the Web API with Windows Authentication. For an overview, see Manage the Web API.
Why does my script get 401 Unauthorized?
In Windows Authentication mode, make the script send its Windows credentials. The Web API answers 401 with WWW-Authenticate: Negotiate until the client authenticates, and PowerShell sends the current account only when you ask it to:
Invoke-RestMethod -Uri https://nodinite.contoso.com:40001/api/Users/whoami -UseDefaultCredentials
Use -Credential for another account, and curl --negotiate -u : with curl. Call the https:// address: over plain http://, PowerShell 7 refuses to send Windows credentials unless you add -AllowUnencryptedAuthentication. The account must be a Nodinite User, or a member of a registered Windows AD Group, with a Role.
In OAuth 2.0 mode, check that the token was requested with the scope <api-app-id-uri>/.default of the Nodinite Web API, and that it has not expired. Tokens last about an hour. In Windows Authentication mode, check that the account is a domain account and that the SPN matches the URL when you use Kerberos. See the troubleshooting tables in the OAuth 2.0 and Windows Authentication guides.
Why does my client get a response but no data?
The caller is authenticated but has no Nodinite Role with access to the data. Call api/Users/whoami to see which Roles the caller has. In OAuth 2.0 mode, check that the Claim value matches the app role value exactly and that its Policy is added to a Role, then request a new token. Changes can take up to about an hour to apply to a client that is already connected.
What happened to the MaintenanceMode System Parameter?
It was removed in Nodinite 7.12, so a script that still calls PUT api/SystemParameters/MaintenanceMode must drop that call; see MaintenanceMode. To plan downtime and mute alerts, use Maintenance Mode in User Notifications. To pause the Logging Service and the Monitoring Service, use Stop on the Log Databases page, or call PUT api/Status/Service/{loggingservice|monitoringservice}/Maintenance?enableMaintenance=true (Administrators); see System Parameters in Manage the Web API.
Why does a System Parameter change through the Web API break a feature?
PUT api/SystemParameters/{key} validates many keys and answers 400 Bad Request with the reason, saving nothing: the true/false switches (such as AllowExport, AllowRepair, AllowResubmit, UseContracts), the whole-number settings with their lowest values (such as the DaysToKeep… defaults and the cleanup intervals), LogDatabaseRecovery (SIMPLE or FULL), ResendWebhookSettings, SharedFilePolicy, ArticleSecurityPolicy, LogEventsPerDayThresholds, and AI. CustomerName and ProductKey are refused, and an unknown key answers 404 Not Found. Other keys are saved as sent, so for their json values call POST api/SystemParameters/{key}/ValidateJson first, then save.
No restart is needed after a fix, but when it takes effect depends on who reads the parameter: the Web API within about 15 seconds, other services on a longer cache (the Logging Service up to 5 or 15 minutes, the Web Client up to an hour for a few view settings). Each parameter page states its timing. See Manage System Parameters.
Why does the Web API reject my OAuth token although sign-in to the Web Client works?
The token must be issued for the Web API audience. Compare the aud claim in the token with the Web API Audiences value set in the Portal, in the Auth step, Web API, and see Call the Web API with OAuth 2.0 Client Credentials.
Should I use the Web API or the MCP Endpoint?
Use the Web API when the result must be repeatable: scripts, CI/CD pipelines, integrations, and reports. It is deterministic, so the same request returns the same result. Use the MCP Endpoint when you want to ask natural-language questions about your integration landscape from an AI tool such as VS Code or Claude Desktop. See Web API or MCP Endpoint?, MCP Endpoint External Access, and AI in Nodinite.
Contact our support
If you have questions or encounter issues with the Web API, contact our expert team. Read more on the Support page.