Close Session
This endpoint closes an existing session and returns the session ID. A valid session ID must be provided to close the session.
Parameters
Required parameter to specify the session ID. The session ID of the session to be closed. This field is mandatory.
Response
The unique identifier for the closed session.
An optional error message if something goes wrong during session closure.
Error Responses
Invalid request. This error is returned when the session ID is not provided.
Internal server error. This error is returned when the server encounters an unexpected condition.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
If True, the session will not be closed after the operation is completed.
Whether to include a screenshot in the response.
The ID of the session. A new session is created when not provided.
Session timeout in minutes. Cannot exceed the global timeout.
0 < x < 30Response
Session creation time
Session duration
Last access time
The ID of the session (created or existing). Use this ID to interact with the session for the next operation.
Session status
active, closed, error, timed_out Session timeout in minutes. Will timeout if now() > last access time + timeout_minutes
Error message if the operation failed to complete