IRPCEventsAdmin.ClearEvents
Administration API / specialized admin session
Deletes all events of the vault.
| Service | Event administration MFiles.IRPCEventsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCEventsAdmin/ClearEvents |
| HTTP (mf-http-grpc) | POST /grpc/v1/clear-events |
| Request | ClearEventsRequest |
| Response | ClearEventsResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Destructive. Removes the whole event log; export it first if you need it (GetEventsRange).
- Runs in the background: the server first creates the pending notifications, then deletes the events. The call returns after about five seconds, possibly before the log is empty.
- Requires a vault session and the vault right
manage_events. Refused in vaults with the advanced event log features; use DeleteEventsRange there.
Request: ClearEventsRequest
No fields.
Response: ClearEventsResponse
No fields.
Related methods
- GetEventsRange -- Gets events by ID range and filters, oldest or newest first, with an optional maximum count.
- DeleteEventsRange -- Deletes the events whose IDs are in the given range.