{
  "opencollection": "1.0.0",
  "info": {
    "name": "Secret Server Rest Activations SecretSessions API",
    "version": "11.7.2"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "SecretSessions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get the SSH proxy session data",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/recorded-sessions/ssh-session",
            "params": [
              {
                "name": "auditSecretId",
                "value": "",
                "type": "query",
                "description": "Either the secret session ID or the secret audit record ID or secret session key must be passed"
              },
              {
                "name": "byteLimit",
                "value": "",
                "type": "query",
                "description": "Amout of data in bytes to return"
              },
              {
                "name": "filterType",
                "value": "",
                "type": "query",
                "description": "Filter by server, client, or both"
              },
              {
                "name": "searchTerm",
                "value": "",
                "type": "query",
                "description": "Search term to filter"
              },
              {
                "name": "secretSessionId",
                "value": "",
                "type": "query",
                "description": "Either the secret session ID, the secret audit record ID, secret session key, or the session GUID must be passed"
              },
              {
                "name": "secretSessionKey",
                "value": "",
                "type": "query",
                "description": "Either the secret session ID, the secret audit record ID, secret session key, or the session GUID must be passed"
              },
              {
                "name": "sessionGuid",
                "value": "",
                "type": "query",
                "description": "This can be the secret session key or the launcher guid Either the secret session ID, the secret audit record ID, secret session key, or the session GUID must be passed"
              }
            ]
          },
          "docs": "Get the SSH proxy session data"
        },
        {
          "info": {
            "name": "Get the SSH proxy session data as an attached file",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/recorded-sessions/ssh-session-file",
            "params": [
              {
                "name": "auditSecretId",
                "value": "",
                "type": "query",
                "description": "Either the secret session ID or the secret audit record ID or secret session key must be passed"
              },
              {
                "name": "filterType",
                "value": "",
                "type": "query",
                "description": "Filter by server, client, or both"
              },
              {
                "name": "searchTerm",
                "value": "",
                "type": "query",
                "description": "Search term to filter"
              },
              {
                "name": "secretSessionId",
                "value": "",
                "type": "query",
                "description": "Either the secret session ID, the secret audit record ID, secret session key, or the session GUID must be passed"
              },
              {
                "name": "secretSessionKey",
                "value": "",
                "type": "query",
                "description": "Either the secret session ID, the secret audit record ID, secret session key, or the session GUID must be passed"
              },
              {
                "name": "sessionGuid",
                "value": "",
                "type": "query",
                "description": "This can be the secret session key or the launcher guid Either the secret session ID, the secret audit record ID, secret session key, or the session GUID must be passed"
              }
            ]
          },
          "docs": "Get the SSH proxy session data as an attached file"
        },
        {
          "info": {
            "name": "Get a summary of the secret session data",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/secret-sessions/:id/summary",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "id"
              }
            ]
          },
          "docs": "Get a summary of the secret session data"
        },
        {
          "info": {
            "name": "Search Recorded Sessions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/recorded-sessions",
            "params": [
              {
                "name": "filter.active",
                "value": "",
                "type": "query",
                "description": "Filter by active or inactive status"
              },
              {
                "name": "filter.dateRange",
                "value": "",
                "type": "query",
                "description": "Return sessions within a certain number of days"
              },
              {
                "name": "filter.endDate",
                "value": "",
                "type": "query",
                "description": "EndDate"
              },
              {
                "name": "filter.endTime",
                "value": "",
                "type": "query",
                "description": "EndTime"
              },
              {
                "name": "filter.excludedApplications",
                "value": "",
                "type": "query",
                "description": "Exclude particular Applications from search"
              },
              {
                "name": "filter.folderId",
                "value": "",
                "type": "query",
                "description": "Filter by folder"
              },
              {
                "name": "filter.groupIds",
                "value": "",
                "type": "query",
                "description": "Return sessions for specific groups"
              },
              {
                "name": "filter.hasError",
                "value": "",
                "type": "query",
                "description": "Filter to only records with errors"
              },
              {
                "name": "filter.includeNonSecretServerSessions",
                "value": "",
                "type": "query",
                "description": "IncludeNonSecretServerSessions"
              },
              {
                "name": "filter.includeOnlyLaunchedSuccessfully",
                "value": "",
                "type": "query",
                "description": "Return only sessions that launched successfully"
              },
              {
                "name": "filter.includeRestricted",
                "value": "",
                "type": "query",
                "description": "Whether to include restricted secret sessions"
              },
              {
                "name": "filter.includeSubFolders",
                "value": "",
                "type": "query",
                "description": "Whether to include subfolders in a folder search"
              },
              {
                "name": "filter.launcherTypeId",
                "value": "",
                "type": "query",
                "description": "Filter by launcher type"
              },
              {
                "name": "filter.searchText",
                "value": "",
                "type": "query",
                "description": "Search text"
              },
              {
                "name": "filter.searchTypes",
                "value": "",
                "type": "query",
                "description": "Specifies the sources of information you want to search across, can be many of (SecretItems, Username, Hostname, Domain, RdpKeystroke, RdpApplication, ProxyClient)"
              },
              {
                "name": "filter.secretIds",
                "value": "",
                "type": "query",
                "description": "Return sessions for specific secrets"
              },
              {
                "name": "filter.siteId",
                "value": "",
                "type": "query",
                "description": "SiteId"
              },
              {
                "name": "filter.startDate",
                "value": "",
                "type": "query",
                "description": "StartDate"
              },
              {
                "name": "filter.startTime",
                "value": "",
                "type": "query",
                "description": "StartTime"
              },
              {
                "name": "filter.userIds",
                "value": "",
                "type": "query",
                "description": "Return sessions for specific users"
              },
              {
                "name": "skip",
                "value": "",
                "type": "query",
                "description": "Number of records to skip before taking results"
              },
              {
                "name": "sortBy[0].direction",
                "value": "",
                "type": "query",
                "description": "Sort direction"
              },
              {
                "name": "sortBy[0].name",
                "value": "",
                "type": "query",
                "description": "Sort field name"
              },
              {
                "name": "sortBy[0].priority",
                "value": "",
                "type": "query",
                "description": "Priority index. Sorts with lower values are executed earlier"
              },
              {
                "name": "take",
                "value": "",
                "type": "query",
                "description": "Maximum number of records to include in results"
              }
            ]
          },
          "docs": "Search, filter, sort, and page recorded sessions"
        },
        {
          "info": {
            "name": "Get Recorded Session",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/recorded-sessions/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Recorded session ID"
              }
            ]
          },
          "docs": "Get a single recorded session by ID"
        },
        {
          "info": {
            "name": "Recorded Session Summary",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/recorded-sessions/:id/summary",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Recorded session ID"
              }
            ]
          },
          "docs": "Get the summary for a recorded session"
        },
        {
          "info": {
            "name": "Recorded Session Points of Interest",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/recorded-sessions/:id/points-of-interest",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Recorded session ID"
              },
              {
                "name": "filter.searchText",
                "value": "",
                "type": "query",
                "description": "Search text"
              },
              {
                "name": "skip",
                "value": "",
                "type": "query",
                "description": "Number of records to skip before taking results"
              },
              {
                "name": "sortBy[0].direction",
                "value": "",
                "type": "query",
                "description": "Sort direction"
              },
              {
                "name": "sortBy[0].name",
                "value": "",
                "type": "query",
                "description": "Sort field name"
              },
              {
                "name": "sortBy[0].priority",
                "value": "",
                "type": "query",
                "description": "Priority index. Sorts with lower values are executed earlier"
              },
              {
                "name": "take",
                "value": "",
                "type": "query",
                "description": "Maximum number of records to include in results"
              }
            ]
          },
          "docs": "Get the points of interest for a recorded session"
        },
        {
          "info": {
            "name": "Recorded Session Points of Interest Summary",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/recorded-sessions/:id/points-of-interest-summary",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Recorded session ID"
              },
              {
                "name": "filter.searchText",
                "value": "",
                "type": "query",
                "description": "Search text"
              },
              {
                "name": "skip",
                "value": "",
                "type": "query",
                "description": "Number of records to skip before taking results"
              },
              {
                "name": "sortBy[0].direction",
                "value": "",
                "type": "query",
                "description": "Sort direction"
              },
              {
                "name": "sortBy[0].name",
                "value": "",
                "type": "query",
                "description": "Sort field name"
              },
              {
                "name": "sortBy[0].priority",
                "value": "",
                "type": "query",
                "description": "Priority index. Sorts with lower values are executed earlier"
              },
              {
                "name": "take",
                "value": "",
                "type": "query",
                "description": "Maximum number of records to include in results"
              }
            ]
          },
          "docs": "Get the points of interest summary for a recorded session"
        },
        {
          "info": {
            "name": "Get Recorded Session Video Stream",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/recorded-sessions/:id/session-recordings/:fileName",
            "params": [
              {
                "name": "fileName",
                "value": "",
                "type": "path",
                "description": "fileName"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Recorded session ID"
              }
            ]
          },
          "docs": "Get the video stream for a recorded session"
        },
        {
          "info": {
            "name": "Get Recorded Session Video Stream by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/recorded-sessions/:id/session-recordings",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Recorded session ID"
              }
            ]
          },
          "docs": "Get the video stream for a recorded session by ID"
        },
        {
          "info": {
            "name": "Get Session Image By the Session Key",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/recorded-sessions/session-image-by-key/:secretSessionKey/:imageId?",
            "params": [
              {
                "name": "imageId",
                "value": "",
                "type": "query",
                "description": "imageId"
              },
              {
                "name": "secretSessionKey",
                "value": "",
                "type": "path",
                "description": "secretSessionKey"
              }
            ]
          },
          "docs": "Get Session Image By the Session Key"
        },
        {
          "info": {
            "name": "Get Session Image By the Launcher Session Guid",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/recorded-sessions/session-image-by-launcher-guid/:launcherGuid/:imageId?",
            "params": [
              {
                "name": "imageId",
                "value": "",
                "type": "query",
                "description": "imageId"
              },
              {
                "name": "launcherGuid",
                "value": "",
                "type": "path",
                "description": "launcherGuid"
              }
            ]
          },
          "docs": "Get Session Image By the Launcher Session Guid"
        },
        {
          "info": {
            "name": "Get Session Image",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/recorded-sessions/session-image/:secretSessionId/:imageId?",
            "params": [
              {
                "name": "imageId",
                "value": "",
                "type": "query",
                "description": "imageId"
              },
              {
                "name": "secretSessionId",
                "value": "",
                "type": "path",
                "description": "secretSessionId"
              }
            ]
          },
          "docs": "Get Session Image"
        },
        {
          "info": {
            "name": "Get Session Frames",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/recorded-sessions/session-frames/:secretSessionId/:topImageIdRecovered",
            "params": [
              {
                "name": "secretSessionId",
                "value": "",
                "type": "path",
                "description": "secretSessionId"
              },
              {
                "name": "topImageIdRecovered",
                "value": "",
                "type": "path",
                "description": "topImageIdRecovered"
              }
            ]
          },
          "docs": "Get Session Frames"
        },
        {
          "info": {
            "name": "Request Immediate Session Processing",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/SecretServer/api/v1/recorded-sessions/:id/request-processing",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Recorded session ID"
              }
            ]
          },
          "docs": "Issues a request for the immediate processing of a session video"
        }
      ]
    }
  ],
  "bundled": true
}