Skip to main content

Delete a Session

This command deletes an existing session.

Authorizations: All

Request

deleteSession sessionId

Parameters

ParameterDescription/Values

sessionId

The ID of a HMP session

Result

Success

OK

Error

ErrorDescription
ERROR|010003|Expected 1 parameter(s). 
Got Y parameter(s)
Calling deleteSession requires 1 parameter.
ERROR|010001|'Y' is not a uuid
The sessionId provided must be a UUID.
ERROR|040006|Session not found
The 'session' with UUID 'sessionId' was not found.
ERROR|060003|Recording currently in progress
The session is being recorded. All recordings for this session must be stopped before it can be removed.
ERROR|070000|Internal Server Error
Database returned an error while removing session. Please see calypso.log for details.

Example

The following example deletes a session entitled “Test Session1”. The system returns OK.

deleteSession "Test Session1"
OK

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.