Replay

Quick Navigation

POST pbsm/replay

Creates a new replay session for a specified session token. The session token can be discovered using the Sessions endpoints.

None

Content-Type: application/json

{
    id: string, // Session Token from query to <base>/Sessions endpoint
    record_key: string, // RecordKey from query to <base>/Sessions endpoint
    protocol: string, // When session Type is 0 this should be RDP or for type 1 SSH
    headless: boolean // Must be set to true
}

Content-Type: application/json

{
    id: string, // ReplayID for this replay session
    token: string, // ReplayID for this replay session
    ticket: string, // Ticket value used internally
}
  • 200 – Request successful.
  • 403 – Access forbidden. Response body contains a message or status code indicating the reason for this forbidden access:
  • 404 – Not found. The requested replay session was not found on the server

For more information, please see Common Response Codes.

GET pbsm/replay/{replayId}

Displays the replay session details.

ReplayID: ID of the replay session returned from POST pbsm/replay.

  • jpeg=(scale): Requests a jpeg image of the current RDP replay session scaled in size by the given scale.
  • png=(scale): Requests a png image of the current RDP replay session scaled in size by the given scale.
  • screen=1: Requests a text representation of the current SSH session.

None

Content-Type: application/json

{
    tstamp: int, // Start time of the session in seconds
    end: int, // End time of the session in seconds
    offset: int, // Current offset of replay session in ms
    next: int, // Offset of next activity of replay session in ms
    speed: int, // Speed of replay session as a %
    eof: boolean, // Set to true when the end of the replay has been reached
    duration: int // Duration in ms of the replay session
}
  • 200 – Request successful.
  • 403 – Access forbidden. Response body contains a message or status code indicating the reason for this forbidden access
  • 404 – Not found. The requested replay session was not found on the server

For more information, please see Common Response Codes.

PUT pbsm/replay/{replayId}

Controls the replay session status.

ReplayID: ID of the replay session returned from POST pbsm/replay

None

{
    speed: int, // Sets the replay speed of this session as a %
    offset: int, // Sets the offset of the replay cursor for this session in ms
    next: int // Requests the next changed frame based on the given % change
}

Content-Type: application/json

{
    tstamp: int, // Start time of the session in seconds
    end: int, // End time of the session in seconds
    offset: int, // Current offset of replay session in ms
    next: int, // Offset of next activity of replay session in ms
    speed: int, // Speed of replay session as a %
    eof: boolean, // Set to true when the end of the replay has been reached
    duration: int // Duration in ms of the replay session
}
  • 200 – Request successful.
  • 403 – Access forbidden. Response body contains a message or status code indicating the reason for this forbidden access:
  • 404 – Not found. The requested replay session was not found on the server

For more information, please see Common Response Codes.

DELETE pbsm/replay/{replayId}

Terminates the replay session.

ReplayID: ID of the replay session returned from POST pbsm/replay

None

None

  • 200 – Request successful.
  • 403 – Access forbidden. Response body contains a message or status code indicating the reason for this forbidden access:
  • 404 – Not found. The requested replay session was not found on the server

For more information, please see Common Response Codes.