IRPCLogin.KeepAlive
Vault API / core session session idempotent
Tells the server that the session is still in use, so that it does not expire.
| Service | Login and sessions MFiles.IRPCLogin |
|---|---|
| gRPC method | /MFiles.IRPCLogin/KeepAlive |
| HTTP (mf-http-grpc) | POST /grpc/v1/keep-alive |
| Request | KeepAliveRequest |
| Response | KeepAliveResponse |
| Book and level | Vault API, core |
| Kind | session |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | yes |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
Call it at least every session_data.keep_alive_interval_in_seconds seconds (half the server's
session timeout; 450 seconds with the default 15-minute timeout). Only this call resets the idle
timer; other calls do not. When the timeout elapses, the session expires.
KeepAlive fails with UNAUTHENTICATED when the session has expired or was logged out. Then log
in again with LogIn.
Request: KeepAliveRequest
No fields.
Response: KeepAliveResponse
No fields.
Related methods
- LogIn -- Authenticates the caller and opens a session to a vault, or to the server when the vault GUID is all zeros.