Code Block
composer require "creativestyle/magesuite-rest-api-logger" ^1.0.0

Admin setting

The module can be configured in Stores -> Configuration -> Advanced -> System

...

Rest API Payload Logger settings:

Field

Option

Comment

Rest API logging enabled

Yes/No

If set to "Yes" module will log REST API payloads into database.

Maximum Payload Length

Default: 65000

Payload Placeholders

Code Block
password:*******

New line separated list of placeholders. Example:
field_name1:placeholder1
field_name2:placeholder2

Rest Response logging enabled

Yes/No

If set to "Yes" module will log REST endpoint response into database.

Response Placeholders

New line separated list of placeholders. Example:
field_name1:placeholder1
field_name2:placeholder2

HTTP request methods to log

GET/POST/PUT/DELETE

Rest endpoint to log

New line separated list of endpoints which payloads will be logged to database.
Wildcard allowed, example: /rest/V1/order/*/invoice

Rest endpoint to skip

New line separated list of endpoints which payloads will be skipped from logging.
Wildcard allowed, example: /rest/V1/order/*/invoice

Logging retention period

How long (in days) logs should be kept

Log table optimization enabled

Yes/No

If set to 'Yes' then log table will be optimized after cleanup.

In System -> Data Transfer -> Rest Api Logger an admin user can found find logged API requests:

...

Backend

...