This is an automated email from the ASF dual-hosted git repository.
sk0x50 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/ignite-3.git
The following commit(s) were added to refs/heads/main by this push:
new 28a0c29f7e1 IGNITE-28056 REST API events (#7700)
28a0c29f7e1 is described below
commit 28a0c29f7e188a06038a6a521841ef09c773fe2b
Author: jinxxxoid <[email protected]>
AuthorDate: Fri Apr 3 13:08:46 2026 +0400
IGNITE-28056 REST API events (#7700)
---
docs/docs/develop/work-with-data/events-list.md | 24 ++++++++++++++++++++++++
1 file changed, 24 insertions(+)
diff --git a/docs/docs/develop/work-with-data/events-list.md
b/docs/docs/develop/work-with-data/events-list.md
index 2cdb76ef683..608055911eb 100644
--- a/docs/docs/develop/work-with-data/events-list.md
+++ b/docs/docs/develop/work-with-data/events-list.md
@@ -109,3 +109,27 @@ Each task event has the following fields:
| taskId | ID of a map reduce task. |
| targetNode | Name of the node where a task is executed. |
| clientAddress | **Optional** A socket address of a thin client that
submitted a task. |
+
+## REST API Events
+
+These events are fired on REST API calls and can be used for audit purposes.
+
+| Event Type | Description |
+|---------------------------|-------------------------------------------------|
+| REST_API_REQUEST_STARTED | Triggered when a REST API request is received. |
+| REST_API_REQUEST_FINISHED | Triggered when a REST API request is completed. |
+
+### REST API Event Structure
+
+The user identity is available in the standard event `user`
[field](developers-guide/events/overview#event-structure). Each REST API event
also has the following fields:
+
+| Field Name | Description |
+|------------|-------------|
+| method | HTTP method of the request (e.g., `GET`, `POST`). |
+| endpoint | API endpoint path (e.g., `/management/v1/license`). |
+| requestId | Unique identifier of the request. |
+| nodeName | Name of the node that received the request.
+| message | Error message. Applicable only to `REST_API_REQUEST_FINISHED`
events. |
+| timestamp | ISO-8601 timestamp of when the request was received.
+| status | HTTP response status code. Applicable only to
`REST_API_REQUEST_FINISHED` events. |
+| durationMs | Request duration in milliseconds. Applicable only to
`REST_API_REQUEST_FINISHED` events. |
\ No newline at end of file