{"type":"api","title":"Get list of closed or historical Remote Sessions","meta":{"id":"/apps/pubhub/media/sea-api/7c15e51e49c0ffa2ba78927684d875bb631dffa7/d5f79626-4df3-3cd0-aec3-6ecc5b860dd3","swagger":"2.0","info":{"description":"Deals with Remote Sessions, Access Management (Access Control Groups), and System Management (Network Devices and Assets) APIs","license":{"name":"Licensing is primarily subscription based.","url":"https://www.cisco.com"},"termsOfService":"http://swagger.io/terms/","title":"Secure Equipment Access (SEA) Management APIs","version":"1.0.0"},"host":"us.ciscoiot.com","basePath":"/nbapi/sramgmt/ext","schemes":["https"],"securityDefinitions":{"access_token":{"in":"header","name":"x-access-token","type":"apiKey"},"bearer_token":{"in":"header","name":"Authorization","type":"apiKey"}},"security":[{"access_token":[]},{"bearer_token":[]}],"x-parser-conf":{"apiKeyGenerator":{"$remoteModule":"./config/apikey.js"},"labelConfig":{"endpoint":"summary"}}},"spec":{"description":"Get list of closed or historical Remote Sessions\u003cbr /\u003eOne of the below roles is needed to invoke this API\u003cbr /\u003e- SEA System Admin\u003cbr /\u003e- SEA Access Admin","operationId":"get_session_history","parameters":[{"format":"uuid","in":"header","name":"x-tenant-id","required":true,"type":"string"},{"description":"The number of pages to skip before starting to collect the result set. Default: 1","in":"query","name":"page","required":false,"type":"integer"},{"description":"The numbers of items to return on a page. Default: 500","in":"query","name":"size","required":false,"type":"integer"},{"description":"Available (multiple) options: [username, gateway_name, device_name, connection_name, connection_protocol]","in":"query","name":"filter","required":false,"type":"string"},{"description":"Available (multiple) options: [time_begin, time_end]","in":"query","name":"compare_filter","required":false,"type":"string"},{"in":"query","name":"search","required":false,"type":"string"},{"description":"Available options: [username, gateway name, device name, connection name, connection type, bytes total]","in":"query","name":"sort_by","required":false,"type":"string"},{"description":"Available options: [ASC, DESC] Default: ASC","in":"query","name":"sort_dir","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Successful operation. Session History received.","schema":{"properties":{"object_type":{"type":"string"},"results":{"items":{"properties":{"bytes_total":{"type":"long"},"closed_by_admin":{"type":"boolean"},"connection_details":{"type":"string"},"connection_name":{"type":"string"},"connection_protocol":{"type":"string"},"device_host":{"type":"string"},"device_name":{"type":"string"},"duration":{"type":"integer"},"gateway_identifier":{"type":"string"},"gateway_model":{"type":"string"},"gateway_name":{"type":"string"},"guac_encoding_status":{"type":"string"},"guac_recording_exists":{"type":"boolean"},"guac_recording_name":{"type":"string"},"guacd_connection_id":{"type":"string"},"location":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"latitude":{"type":"float"},"longitude":{"type":"float"},"region":{"type":"string"}},"type":"object","$$ref":"#/definitions/response_common_location"},"recorded":{"type":"boolean"},"recorded_guac":{"type":"boolean"},"recorded_screen":{"type":"boolean"},"recording_deleted":{"type":"boolean"},"screen_monitoring_download_url":{"type":"string"},"screen_monitoring_id":{"format":"UUID","type":"string"},"screen_monitoring_playback_url":{"type":"string"},"screen_monitoring_recording_password":{"type":"string"},"session_id":{"format":"UUID","type":"string"},"tenant_id":{"format":"UUID","type":"string"},"time_begin":{"format":"timestamp","type":"string"},"time_end":{"format":"timestamp","type":"string"},"username":{"type":"string"}},"type":"object","$$ref":"#/definitions/response_common_session_history"},"type":"array"},"page":{"type":"integer","description":"Current page to display","default":1,"example":1},"page_links":{"type":"object","description":"Page links to navigate pages","example":null},"size":{"type":"integer","description":"The numbers of records to return","default":500,"example":500},"total_count":{"type":"integer","description":"Total count of records retrieved by query","example":95},"total_pages":{"type":"integer","description":"Total count of records retrieved by query","example":19}},"type":"object","$$ref":"#/definitions/response_get_session_history_list"}},"400":{"description":"Invalid input","schema":{"properties":{"debug_message":{"items":{"type":"string"},"type":"array"},"error_code":{"type":"string"},"message":{"type":"string"}},"type":"object","$$ref":"#/definitions/response_error"}},"401":{"description":"Bad request","schema":{"example":"Authentication Token is invalid","type":"string"}},"403":{"description":"Forbidden","schema":{"example":"Permission denied to access the resource","type":"string"}},"500":{"description":"Internal server error","schema":{"example":"Could not connect to server","type":"string"}}},"summary":"Get list of closed or historical Remote Sessions","tags":["Remote Sessions"],"__originalOperationId":"get_session_history","security":[{"access_token":[]},{"bearer_token":[]}],"method":"get","path":"/session_history"}}