System
Retrieves a list of users based on the provided parameters like limit, offset, and status.
Limit of users per request
10
Offset to start fetching the list
0
Whether to count the total number of users
false
Filter users based on their status
Bearer token for authentication.
Successfully retrieved the user list
GET /backend/api/auth/userlist HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
Successfully retrieved the user list
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully got all user list</message>
</object>
This endpoint is used to enable or disable the maintenance mode.
Bearer token for authentication.
Set mode: 0 to disable maintenance mode, 1 to enable maintenance mode.
0
The ID of the setting to update
2
Successfully updated the maintenance mode
Bad Request - Invalid input parameters
PUT /backend/api/settings/maintainance HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 17
"mode=0&id=2"
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Maintainance mode updated successfully</message>
</object>
This endpoint is used to retrieve a list of audit logs with pagination and optional filters.
The number of items to skip (used for pagination)
0
The number of items to return (used for pagination)
20
Keyword to filter the results by
Filter the audit logs by the module
Filter the audit logs by the user who performed the action
Bearer token for authentication.
Successfully retrieved audit log list
Bad Request - Invalid input parameters
GET /backend/api/auditlog/auditLog-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully got a audit log list</message>
</object>
This endpoint is used to retrieve a list of modules involved in audit logs.
Bearer token for authentication.
Successfully retrieved module log list
Bad Request - Invalid request or input
GET /backend/api/auditlog/module-list HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully got a module log list</message>
</object>
This endpoint allows the deletion of audit logs between the given fromDate
and toDate
.
Bearer token for authentication.
The starting date for the range of audit logs to delete
2024-1-1
The ending date for the range of audit logs to delete
2024-1-1
Successfully deleted the audit logs within the specified date range
Bad Request - Invalid input or date format
POST /backend/api/auditlog/delete-auditlog HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 43
"fromDate='2024-1-1'&toDate='2024-1-1'"
<?xml version="1.0"?>
<object>
<status>1</status>
<message>Successfully deleted audit logs</message>
</object>
Last updated