[data-reveal]{opacity:1!important;transform:none!important}
FAQ
API

FAQ

Answers to common questions about the API console.

The console shows no traffic

The console counts the routes of its scope only, Own routes by default. If your routes come from a module, switch the scope to Module routes or All routes in the API settings. Requests sent from the Tester and the DMS's own calls are never counted.

The 30D comparison is unavailable

Statistics are kept 90 days by default. With 30 days, the 30D period has no period before it to compare with: pick 60 or 90 days.

The cURL snippets point to the wrong host

They use the DMS apiBaseUrl. Set it to the URL clients reach your API at. See Public API origin.

The module refuses to start with "invalid configuration"

A configured value is one the API settings page would refuse. The error lists each one; see the bounds in Configuration.

Tester calls are rejected as Tester calls on another instance

Behind several instances, set the same testerSourceSecret on each, so every instance accepts the Tester tokens the others sign.

A route reads "Auth unknown"

No guard was found before or on its handler, and no 401 was seen. A check made inside the handler does not show. Use the DMS auth decorators, or add your middleware's name to authMiddlewareCallbacks.

Upgrading from 0.1

The stored data of earlier versions is not migrated.

This upgrade discards monitoring history. Back up or export any records you need before dropping tables, and confirm that you are targeting the dms-api schema, not an application's tables.

Drop the request_log, routes_statistics and migrations tables of the dms-api schema when upgrading; the module creates them again. The API settings return the error-rate thresholds as ratios (0.05), and the api.get-api-health action returns failingRoutes instead of routesWithErrors24h.