Get recordings

This method returns the details of recordings of PSM, PSM for SSH, or OPM sessions.

URL

  • Make sure there are no spaces in the URL.

  • The following characters are not supported in URL values: + & %

  • If the URL includes a dot (.), add a forward slash (/) at the end of the URL. For example: api/Safes/MySafe/Members/user@cyber.com/

 

 

 
https://<IIS_Server_Ip>/PasswordVault/API/recordings/{recordingId}/

The following values can be added in the URL. None of them are mandatory.

Parameter

Limit

Type

Integer

Description

Determines the number of recordings that are returned in the list.

The maximum value is defined in the MaxRecords property in Options à Privileged Session Management à General Setting à Search Properties.

Valid values

A positive value greater than 0

Default

25

Parameter

Sort

Type

String

Description

The sort can be done by each property on the recording file:

■ RiskScore
■ FileName
■ SafeName
■ FolderName
■ PSMVaultUserName
■ FromIP
■ RemoteMachine
■ Client
■ Protocol
■ AccountUserName
■ AccountAddress
■ AccountPlatformID
■ PSMStartTime
■ TicketID

The sort can be in ascending or descending order. To sort in descending order, specify "-" (dash) before the recording property by which to sort.

Default

Descending according to StartTime

Parameter

Offset

Type

Integer

Description

Determines which recording results will be returned, according to a specific place in the returned list. This value defines the recording's place in the list and how many results will be skipped.

Valid values

A positive value greater than 0

Default

0

Parameter

Search

Type

String

Description

Returns recordings that are filtered by properties that contain the specified search text.

Parameter

Safe

Type

String

Description

Returns recordings from a specific Safe.

Parameter

FromTime

Type

Integer

Description

Returns recordings from a specific date.

Parameter

ToTime

Type

Integer

Description

Returns recordings before a specific date.

Parameter

Activities

Type

String

Description

Returns recordings with specific activities.

Resource information

HTTP method

GET

Content type

application/json

Header parameter

Parameter

Description

Authorization

The token that identifies the session, encoded in BASE 64. See Authentication.

Type: String

Mandatory: Yes

Default value: None

Body parameters

None

Result

  
"Recordings": [
{
"SessionID": "<the session id>",
"SessionGuid": "<the session guide>",
"SafeName": "<the safe name>",
"FolderName": "<the folder name>",
"FileName": "<the file name>",
"Start": <the start date in unix time>,
"End": <the end date in unix time>,
"Duration": <the duration in seconds>,
"User": "<the use name>",
"RemoteMachine": "<the remote machine>",
"ProtectionDate": <the protection date in unix time>,
"ProtectedBy": "<the protected by user name>",
"ProtectionEnabled": <indication if the protection is enable>,
"AccountUsername": "<the account user name>",
"AccountPlatformID": "<the account platform ID>",
"AccountAddress": "<the account address>",
"PIMSuCommand": "<the PIMSU command>",
"PIMSuCWD": "<the PIMSU current working directory>",
"ConnectionComponentID": "<the connection component ID>",
"TicketID": "<the ticket ID>",
"FromIP": "<The IP address where the account was used>",
"Protocol": "<The protocol where the account was used>",
"Client": "<the client where the account was used>",
"RiskScore": <the risk score>,
"Severity": "<the savirity>",
"RecordingFiles": [
{
"FileName": "<The recording file name>",
"RecordingType": "<The recording type>",
"LastReviewBy": "<The recording reviewer username>",
"LastReviewDate": "<The review date in unix time>",
"FileSize": "<The recording file size in bytes>",
"CompressedFileSize": "<The recording compressed file size in bytes>",
"Format": ""<The recording format>""
},
...
]
"IncidentDetails": {
"Incident": {
"Id": "<The incident id>",
"Url": "<The incident URL in PTA>",
"Score": <The incident score>,
"Name": "<The incident description>",
"StartDate": <The incident start date in unix time>
},
"Sessions": [
{
"Id": "<The session id>",
"Score": <The session score>,
"Severity": "<The session severity>",
"Commands": [
{
"Value": "<The command>",
"Offset": "<The command offset>",
"Score": <The command scort>,
"Severity": "<The command severity>"
},
...
]
},
...
]
},
...
]

Return codes

For a complete list of return codes, see Return Codes.