Start/notes.ini Parameters/DEBUG_REST_API

DEBUG_REST_API

🛠️
Parameter: DEBUG_REST_API
Short description: Enables debug output for the Domino REST API ("Project Keep" / DRAPI) – logs JSON endpoints, token validation, and runtime errors.

Profile

Parameter
DEBUG_REST_API
Category
Logging / Debug
Component
Server
Available since
12.0
Supported versions
12.0, 14.0, 14.5, 14.5.1
GUI equivalent
notes.ini only (no GUI)
Possible values
0 = off (default), 1 = basic, 2 = verbose, 3 = trace (incl. payloads)

Description

The Domino REST API (originally Project Keep, internally also DRAPI) provides JSON/OpenAPI endpoints for CRUD operations on NSF databases, authentication via OAuth/OIDC, and mail/calendar functions. DEBUG_REST_API turns on detailed tracing of this API – incoming HTTP requests, endpoint routing, token validation, NSF operations, and responses.
Ideal for topics such as REST call returns 401/403/500, token is not accepted, endpoint not found, performance problems with individual calls, unexpected response schema.

Example configuration

DEBUG_REST_API=2
Debug_Outfile=/local/notesdata/IBM_TECHNICAL_SUPPORT/restapi_debug.log

Notes & pitfalls

  • Level 3 logs complete request/response payloads – sensitive, enable only temporarily.
  • Takes effect immediately via set config DEBUG_REST_API=...; a restart of the restapi task is not strictly required.
  • Entries appear in console.log and in Debug_Outfile.
  • Complementary to DEBUG_OIDC, DEBUG_HTTPINOUT, DEBUG_NAMELOOKUP.
  • For token issues, check the IdP catalog and OAuth configuration.