Get log settings

Request

This endpoint retrieves the log settings for a specific point of sale device.

Path

pointOfSaleIdinteger, (int64)required

The unique system identifier for the point of sale device.

Example:123456789

curl -i -X GET \
  https://api-services.pxp.io/api/v1/point-of-sales/123456789/log-settings

Responses

Successfully retrieved the log settings.

Bodyapplication/json

verboseLoggingEnabledboolean

Indicates whether verbose logging is enabled for the point of sale device. When enabled, more detailed logs are generated, which can be useful for debugging and troubleshooting.

Example:true

maximumLogSizeinteger, (int32)

The maximum size of the log file in bytes. Once the log file reaches this size, older log entries may be removed or archived to prevent exceeding the size limit.

Example:10485760

logFileCleanUpDaysinteger, (int32)

The number of days after which log files are cleaned up or archived. This helps manage storage by removing or archiving logs that are older than the specified number of days.

Example:30

Response

{
  "verboseLoggingEnabled": true,
  "maximumLogSize": 10485760,
  "logFileCleanUpDays": 30
}

Get log settings

Request

Path

Responses

Was this helpful?