docs(endpointprotector): fix API endpoint names and document backgrou…#917
Open
MRoscaNetwrix wants to merge 4 commits into
Open
docs(endpointprotector): fix API endpoint names and document backgrou…#917MRoscaNetwrix wants to merge 4 commits into
MRoscaNetwrix wants to merge 4 commits into
Conversation
…nd export process - Corrected four wrong endpoint names in API Logs docs: /device-control-logs → /device-control /content-filtering-logs → /content-aware-protection /easylock-alert-logs → /easy-lock /data-rest-alerts → /ediscovery - Added Export List section to Reports and Analysis explaining background export processing, queue behavior, banner messages, and export retention (addresses ADO #414334) - Fixed pre-existing Vale warnings in reports.md Generated with AI Co-Authored-By: Claude Code <ai@netwrix.com>
bturlea
reviewed
May 14, 2026
| | `department_id` | `olog.department_id` | Department ID | | ||
|
|
||
| **GET /device-control-logs/(id)** | ||
| **GET /device-control/(id)** |
Contributor
There was a problem hiding this comment.
This endpoint is not available anymore. This needs to be removed:
GET /device-control/(id)
Returns a single device control log entry by ID with the same fields as the list endpoint.
| ::: | ||
|
|
||
| **GET /content-filtering-logs/(id)** | ||
| **GET /content-aware-protection/(id)** |
Contributor
There was a problem hiding this comment.
same as above. Needs to be removed.
Contributor
There was a problem hiding this comment.
this part with: Alert Statuses, needs to be removed.
There is no Alert Statuses endpoint.
Contributor
There was a problem hiding this comment.
this endpoint needs to be removed: GET /system-alerts
The valid one that should be remaining is this one: GET /system-alert-logs
| | `start_date` | string | Return records on or after this date | | ||
| | `end_date` | string | Return records on or before this date | | ||
| | `machine_name` | string | Filter by machine name (partial match) | | ||
| | `client_name` | string | Filter by client name (partial match) | |
Contributor
There was a problem hiding this comment.
Missing Filter Parameter: use_last_partition. And this is true for all the other endpoints:
Contributor
There was a problem hiding this comment.
Remove all this section: List supported endpoints (discovery)**
Contributor
There was a problem hiding this comment.
there is no API-Key and it is with -H "Authorization: Bearer ${TOKEN}" \
| @@ -86,7 +86,7 @@ If your Endpoint Protector server uses a self-signed certificate, add `-k` to th | |||
| ```bash | |||
| curl -s \ | |||
| -H "X-Api-Key: YOUR_API_KEY" \ | |||
Contributor
There was a problem hiding this comment.
remove: "X-Api-Key: YOUR_API_KEY and replace with H "Authorization: Bearer ${TOKEN}"
| - `client_name` (partial match) | ||
|
|
||
| **GET /device-control-logs/(id)** | ||
| **GET /device-control/(id)** |
Contributor
There was a problem hiding this comment.
remove the /id endpoint completely.
Contributor
There was a problem hiding this comment.
what is the point of having the 2nd file? If we want to have 2 files, than all the comments that are for the previous file should apply here.
…gs REST API docs - Replace API key auth with JWT auth (POST /login → Bearer token) - Remove endpoints that don't exist: event-logs, alert-statuses, system-alerts, mobile-management-alerts, mobile-management-alert-logs, auth-logs, easylock-send-alert-logs, scim-logs/(id), device-control/(id), content-aware-protection/(id) - Change eDiscovery from single-item GET /ediscovery/(id) to list GET /ediscovery with correct filters and response fields from EDiscoveryController - Fix EasyLock: correct date field (timestamp), filters, and response fields from EasyLockController - Add use_last_partition parameter to Device Control, Content-Aware Protection, eDiscovery, and EasyLock endpoints - Update all curl examples to use Authorization: Bearer token - Update database tables reference to match actual endpoints Generated with AI Co-Authored-By: Claude Code <ai@netwrix.com>
Corrections verified against PDF spec (API_SPECIFICATION 11.pdf) and
all controller source files:
- Fix login URL: /api/logs/login -> /api/login (separate from logs base)
- Fix 401 error message to match ApiAuth.php exact string
- Fix Device Control and Content-Aware Protection date field: eventtime -> timestamp
- Fix Device Control response fields to match DeviceControlController output columns
- Fix Content-Aware Protection response fields to match ContentFilteringController output columns
- Fix Admin Actions response fields: user_id/username flat fields -> user {id, username}
object plus before_desc/after_desc (which ARE included, not excluded)
- Add legacy list response format and legacy simple format to Response Format section
(Device Control, CAP, eDiscovery, EasyLock use legacy; Admin Actions uses simple)
- Remove Mobile Management section (no controller or route exists)
- Remove GET /content-filtering-alerts/(id) (no route registered)
- Remove Export Logs section (no route or controller exists)
- Fix CORS: Access-Control-Allow-Origin is not wildcard (restricted to configured origins)
- Fix CORS methods: GET, OPTIONS -> GET, POST, OPTIONS (POST needed for /login)
- Add use_last_partition accepted values: true, 1, yes, on (case-insensitive)
- Add POST /login public-endpoint note and error response table
- Add more usage examples: EasyLock, eDiscovery, delta sync, date range
Generated with AI
Co-Authored-By: Claude Code <ai@netwrix.com>
- Fix 405 description: remove "only GET is supported" (POST /login exists) - Add SCIM Logs to standard list format description (uses ApiResponse::paginated) - Fix rate limit headers: not sent on every response, only authenticated requests Generated with AI Co-Authored-By: Claude Code <ai@netwrix.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
…nd export process
Generated with AI