This version is still in development and is not considered stable yet. For the latest stable version, please use Spring Boot 3.3.2! |
Sessions (sessions
)
The sessions
endpoint provides information about the application’s HTTP sessions that are managed by Spring Session.
Retrieving Sessions
To retrieve the sessions, make a GET
request to /actuator/sessions
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/sessions?username=alice' -i -X GET
The preceding examples retrieves all of the sessions for the user whose username is alice
.
The resulting response is similar to the following:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 789
{
"sessions" : [ {
"id" : "cae3d0b6-46b0-47c6-be24-59293f73a08e",
"attributeNames" : [ ],
"creationTime" : "2024-07-18T17:05:54.533856262Z",
"lastAccessedTime" : "2024-07-18T19:05:42.533857003Z",
"maxInactiveInterval" : 1800,
"expired" : false
}, {
"id" : "4db5efcc-99cb-4d05-a52c-b49acfbb7ea9",
"attributeNames" : [ ],
"creationTime" : "2024-07-18T14:05:54.533849018Z",
"lastAccessedTime" : "2024-07-18T19:05:17.533852885Z",
"maxInactiveInterval" : 1800,
"expired" : false
}, {
"id" : "eb67103d-e20f-4398-8424-f7e9faa39135",
"attributeNames" : [ ],
"creationTime" : "2024-07-18T07:05:54.513086672Z",
"lastAccessedTime" : "2024-07-18T19:05:09.513092704Z",
"maxInactiveInterval" : 1800,
"expired" : false
} ]
}
Query Parameters
The endpoint uses query parameters to limit the sessions that it returns. The following table shows the single required query parameter:
Parameter | Description |
---|---|
|
Name of the user. |
Response Structure
The response contains details of the matching sessions. The following table describes the structure of the response:
Path | Type | Description |
---|---|---|
|
|
Sessions for the given username. |
|
|
ID of the session. |
|
|
Names of the attributes stored in the session. |
|
|
Timestamp of when the session was created. |
|
|
Timestamp of when the session was last accessed. |
|
|
Maximum permitted period of inactivity, in seconds, before the session will expire. |
|
|
Whether the session has expired. |
Retrieving a Single Session
To retrieve a single session, make a GET
request to /actuator/sessions/{id}
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/sessions/4db5efcc-99cb-4d05-a52c-b49acfbb7ea9' -i -X GET
The preceding example retrieves the session with the id
of 4db5efcc-99cb-4d05-a52c-b49acfbb7ea9
.
The resulting response is similar to the following:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 208
{"id":"4db5efcc-99cb-4d05-a52c-b49acfbb7ea9","attributeNames":[],"creationTime":"2024-07-18T14:05:54.533849018Z","lastAccessedTime":"2024-07-18T19:05:17.533852885Z","maxInactiveInterval":1800,"expired":false}
Response Structure
The response contains details of the requested session. The following table describes the structure of the response:
Path | Type | Description |
---|---|---|
|
|
ID of the session. |
|
|
Names of the attributes stored in the session. |
|
|
Timestamp of when the session was created. |
|
|
Timestamp of when the session was last accessed. |
|
|
Maximum permitted period of inactivity, in seconds, before the session will expire. |
|
|
Whether the session has expired. |
Deleting a Session
To delete a session, make a DELETE
request to /actuator/sessions/{id}
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/sessions/4db5efcc-99cb-4d05-a52c-b49acfbb7ea9' -i -X DELETE
The preceding example deletes the session with the id
of 4db5efcc-99cb-4d05-a52c-b49acfbb7ea9
.