Endpoint
/api/v2/tenants/{tenantId}/resources/auditRecordings

Example:

Note:

  • Special characters in Query string
    • (+) indicates next field and must be URL encoded.
    • (:) indicates Equals. Example key : value
    • (,) Indicates Multiple values for a key (Ex: Priority:P0,P1)
    • Space characters must be URL encoded.
    • Date format must be yyyy-MM-ddTHH:mm:ssZ (GMT).
    • (+ or %2B) can be used in the above URL with queryString

Path Parameters
tenantId
string

Describes the client ID of the tenant

Query Parameters
pageNo
number

queried page

pageSize
number

size of the query objects

queryString
string

queryString

Responses

OK

descendingOrder
boolean

nextPage
boolean

nextPageNo
number

orderBy
string

pageNo
number

pageSize
number

previousPageNo
number

results
array

results.consoleProtocol
results.endTime
results.gatewayId
results.id
results.notes
results.playbackCodec
results.recStatus
results.resoruceId
results.startTime
results.ticketId
results.url
results.userId
totalPages
number

totalResults
number

{
  "descendingOrder": true,
  "nextPage": false,
  "orderBy": "id",
  "pageNo": 1,
  "pageSize": 100,
  "previousPageNo": 0,
  "results": [
    {
      "client": {
        "name": "ConsoleClient",
        "uniqueId": "client_22"
      },
      "consoleProtocol": "SSH",
      "endTime": "2020-08-27T15:00:23+0000",
      "gatewayId": "010ddd3c-1283-4462-861f-ht673f48de2d",
      "id": "150",
      "playbackCodec": "NRC",
      "recStatus": "Completed",
      "resoruceId": "ad05b24b-6e61-4101-8718-049ba5370b3a",
      "startTime": "2020-08-27T15:00:23+0000",
      "url": "https://app.opsramp.com/computer.do?action=launchPlayer\u0026recId=266",
      "userId": "USR0000002711"
    }
  ],
  "totalPages": 1,
  "totalResults": 1
}
{
  "descendingOrder": true,
  "nextPage": true,
  "nextPageNo": 11,
  "orderBy": "id",
  "pageNo": 10,
  "pageSize": 5,
  "previousPageNo": 9,
  "results": [
    {
      "client": {
        "name": "ConsoleClient",
        "uniqueId": "client_22"
      },
      "consoleProtocol": "SSH",
      "endTime": "2021-05-06T07:54:06+0000",
      "id": "699",
      "notes": "test",
      "playbackCodec": "HTML5",
      "recStatus": "Completed",
      "resoruceId": "ad05b24b-6e61-4101-8718-049ba5370b3a",
      "startTime": "2021-05-06T07:51:35+0000",
      "url": "https://app.opsramp.com/itop/webconsole/launchHtml5Player/Njk5",
      "userId": "USR000000003"
    },
    {
      "client": {
        "name": "ConsoleClient",
        "uniqueId": "client_22"
      },
      "consoleProtocol": "SSH",
      "endTime": "2021-05-06T07:50:34+0000",
      "id": "698",
      "notes": "test",
      "playbackCodec": "HTML5",
      "recStatus": "Completed",
      "resoruceId": "ad05b24b-6e61-4101-8718-049ba5370b3a",
      "startTime": "2021-05-06T07:25:36+0000",
      "url": "https://app.opsramp.com/itop/webconsole/launchHtml5Player/Njk4",
      "userId": "USR000000003"
    },
    {
      "client": {
        "name": "ConsoleClient",
        "uniqueId": "client_22"
      },
      "consoleProtocol": "SSH",
      "endTime": "2021-05-06T07:22:02+0000",
      "id": "697",
      "notes": "test",
      "playbackCodec": "HTML5",
      "recStatus": "Completed",
      "resoruceId": "ad05b24b-6e61-4101-8718-049ba5370b3a",
      "startTime": "2021-05-06T07:10:03+0000",
      "url": "https://app.opsramp.com/itop/webconsole/launchHtml5Player/Njk3",
      "userId": "USR000000003"
    },
    {
      "client": {
        "name": "ConsoleClient",
        "uniqueId": "client_22"
      },
      "consoleProtocol": "SSH",
      "endTime": "2021-05-06T07:09:37+0000",
      "id": "696",
      "notes": "test",
      "playbackCodec": "HTML5",
      "recStatus": "Completed",
      "resoruceId": "ad05b24b-6e61-4101-8718-049ba5370b3a",
      "startTime": "2021-05-06T07:08:59+0000",
      "url": "https://app.opsramp.com/itop/webconsole/launchHtml5Player/Njk2",
      "userId": "USR000000003"
    },
    {
      "client": {
        "name": "ConsoleClient",
        "uniqueId": "client_22"
      },
      "consoleProtocol": "SSH",
      "endTime": "2021-05-06T07:07:49+0000",
      "id": "695",
      "notes": "test",
      "playbackCodec": "HTML5",
      "recStatus": "Completed",
      "resoruceId": "ad05b24b-6e61-4101-8718-049ba5370b3a",
      "startTime": "2021-05-06T07:07:07+0000",
      "url": "https://app.opsramp.com/itop/webconsole/launchHtml5Player/Njk1",
      "userId": "USR000000003"
    }
  ],
  "totalPages": 137,
  "totalResults": 681
}
{
  "descendingOrder": true,
  "nextPage": false,
  "orderBy": "id",
  "pageNo": 1,
  "pageSize": 100,
  "previousPageNo": 0,
  "results": [
    {
      "client": {
        "name": "Demo",
        "uniqueId": "client_35"
      },
      "consoleProtocol": "SSH",
      "endTime": "2021-04-16T15:15:14+0000",
      "id": "450",
      "notes": "demo",
      "playbackCodec": "HTML5",
      "recStatus": "Completed",
      "resoruceId": "yx3z4e21-5e51-7101-3718-0d92a5376b0s",
      "startTime": "2021-04-16T15:14:43+0000",
      "url": "https://app.opsramp.com/itop/webconsole/launchHtml5Player/NjQ3",
      "userId": "USR000000021"
    }
  ],
  "totalPages": 1,
  "totalResults": 1
}
{
  "descendingOrder": true,
  "nextPage": false,
  "orderBy": "id",
  "pageNo": 1,
  "pageSize": 100,
  "previousPageNo": 0,
  "results": [
    {
      "consoleProtocol": "SSH",
      "endTime": "2021-05-21T08:26:32+0000",
      "id": "503",
      "notes": "test",
      "playbackCodec": "HTML5",
      "recStatus": "Completed",
      "resoruceId": "ad05b24b-6e61-4101-8718-049ba5370b3a",
      "startTime": "2021-05-21T08:25:57+0000",
      "url": "https://app.opsramp.com/itop/webconsole/launchHtml5Player/NzQz",
      "userId": "USR000000005"
    },
    {
      "consoleProtocol": "RDP",
      "endTime": "2021-05-21T08:11:19+0000",
      "gatewayId": "003cccd3-1283-4462-861f-de01a617ec4e",
      "id": "266",
      "notes": "test",
      "playbackCodec": "HTML5",
      "recStatus": "Completed",
      "resoruceId": "ad05b24b-6e61-4101-8718-049ba5370b3a",
      "startTime": "2021-05-21T08:10:48+0000",
      "ticketId": "INC0000000001",
      "url": "https://app.opsramp.com/itop/webconsole/launchHtml5Player/NzQy",
      "userId": "USR000000005"
    }
  ],
  "totalPages": 1,
  "totalResults": 2
}
{
  "descendingOrder": true,
  "nextPage": true,
  "nextPageNo": 2,
  "orderBy": "id",
  "pageNo": 1,
  "pageSize": 5,
  "previousPageNo": 0,
  "results": [
    {
      "consoleProtocol": "SSH",
      "endTime": "2021-05-21T08:26:32+0000",
      "id": "743",
      "notes": "test",
      "playbackCodec": "HTML5",
      "recStatus": "Completed",
      "resoruceId": "ad05b24b-6e61-4101-8718-049ba5370b3a",
      "startTime": "2021-05-21T08:25:57+0000",
      "url": "https://app.opsramp.com/itop/webconsole/launchHtml5Player/NzQz",
      "userId": "USR000000003"
    },
    {
      "consoleProtocol": "RDP",
      "endTime": "2021-05-21T08:11:19+0000",
      "gatewayId": "003cccd3-1283-4462-861f-de01a617ec4e",
      "id": "742",
      "notes": "test RDP",
      "playbackCodec": "HTML5",
      "recStatus": "Completed",
      "resoruceId": "ad05b24b-6e61-4101-8718-049ba5370b3a",
      "startTime": "2021-05-21T08:10:48+0000",
      "ticketId": "INC0000000001",
      "url": "https://app.opsramp.com/itop/webconsole/launchHtml5Player/NzQy",
      "userId": "USR000000003"
    },
    {
      "consoleProtocol": "SSH",
      "endTime": "2021-05-18T14:46:12+0000",
      "id": "741",
      "notes": "test",
      "playbackCodec": "NRC",
      "recStatus": "Completed",
      "resoruceId": "ad05b24b-6e61-4101-8718-049ba5370b3a",
      "startTime": "2021-05-18T14:45:51+0000",
      "url": "https://app.opsramp.com/computer.do?action=launchPlayer\u0026recId=741",
      "userId": "USR000000003"
    },
    {
      "consoleProtocol": "RDP",
      "endTime": "2021-05-18T14:01:17+0000",
      "gatewayId": "003cccd3-1283-4462-861f-de01a617ec4e",
      "id": "740",
      "notes": "ops test",
      "playbackCodec": "HTML5",
      "recStatus": "Completed",
      "resoruceId": "ad05b24b-6e61-4101-8718-049ba5370b3a",
      "startTime": "2021-05-18T13:59:32+0000",
      "url": "https://app.opsramp.com/itop/webconsole/launchHtml5Player/NzQw",
      "userId": "USR000000003"
    },
    {
      "consoleProtocol": "SSH",
      "endTime": "2021-05-18T14:01:14+0000",
      "id": "739",
      "notes": "test",
      "playbackCodec": "HTML5",
      "recStatus": "Completed",
      "resoruceId": "ad05b24b-6e61-4101-8718-049ba5370b3a",
      "startTime": "2021-05-18T13:55:05+0000",
      "ticketId": "INC0000000001",
      "url": "https://app.opsramp.com/itop/webconsole/launchHtml5Player/NzM5",
      "userId": "USR000000003"
    }
  ],
  "totalPages": 130,
  "totalResults": 650
}
{
  "descendingOrder": true,
  "nextPage": false,
  "orderBy": "id",
  "pageNo": 1,
  "pageSize": 100,
  "previousPageNo": 0,
  "results": [
    {
      "consoleProtocol": "SSH",
      "endTime": "2020-12-18T10:35:57+0000",
      "id": "311",
      "notes": "browser consoles test",
      "playbackCodec": "HTML5",
      "recStatus": "Completed",
      "resoruceId": "ad05b24b-6e61-4101-8718-049ba5370b3a",
      "startTime": "2020-12-18T10:32:10+0000",
      "ticketId": "INC0000000001",
      "url": "https://app.opsramp.com/itop/webconsole/launchHtml5Player/MzEx",
      "userId": "USR000000003"
    }
  ],
  "totalPages": 1,
  "totalResults": 1
}