Activity list for a preset - Cisco Cyber Vision 5.3 API

{"type":"api","title":"Activity list for a preset","meta":{"id":"/apps/pubhub/media/cyber-vision-5-3/e889ca86e22c7a47e33bc1438ffdba51f3384493/262737b2-b3c2-32cd-b07b-fdbdcd23918f","info":{"description":"RESTful API to manage the resources of Cisco Cyber Vision centers.","title":"Cisco Cyber Vision center v3 API.","version":"3.0.0-5.3.0"},"security":[{"token":[]}],"tags":[{"description":"Routes to configure the Active Discovery mode.","name":"ActiveDiscovery"},{"description":"Activities are an aggregation of flows between components.","name":"Activities"},{"description":"In monitor mode, these routes allow to retrieve and review differences between the actual network activity and the baseline description.","name":"BaselineDifferences"},{"description":"A baseline is used for monitor mode. They represent a snapshot of the network.","name":"Baselines"},{"description":"Components are logical nodes of the network.","name":"Components"},{"description":"Routes to manage network organization.","name":"CustomNetwork"},{"description":"Routes to manage custom properties that can be added to components or groups.","name":"CustomProperties"},{"description":"Routes to retrieve statistics and dashboard information. ","name":"Dashboard"},{"description":"Routes to retrieve information about the sensor deployment tokens.","name":"Deployments"},{"description":"A Device is a physical device that host a software that communicates on the network","name":"Devices"},{"description":"Routes to retrieve about external communications.","name":"ExternalCommunication"},{"description":"Flows represent a network interaction between two components.","name":"Flows"},{"description":"Routes to retrieve information about the global credentials.","name":"GlobalCredentials"},{"description":"Routes to get a graphical representation of the components, activities, etc.","name":"Graph"},{"description":"Groups are a logical way to organize components.","name":"Groups"},{"description":"Various routes to get more information about a center.","name":"Misc"},{"description":"Routes to access the application parameters such as security options and allow to manage custom parameters.","name":"Parameters"},{"description":"Routes to retrieve information about pcap files replayed.","name":"PcapReplays"},{"description":"Presets are a way to filter data and prepare visualizations.","name":"Presets"},{"description":"Preset Based Reports","name":"Reports"},{"description":"Routes to access the configuration of the risk scores.","name":"RiskScores"},{"description":"Routes to browse sensor folders.","name":"SensorExplorer"},{"description":"Routes to retrieve information about the enrolled sensors.","name":"Sensors"},{"description":"Routes to retrieve information about the sensor templates.","name":"SensorTemplates"},{"description":"Tags are meaningful labels applied to components and activities to describe network behaviors and device properties.","name":"Tags"},{"description":"Vulnerabilities are known security threats that could allow an attacker to gain unauthorized privileges.","name":"Vulnerabilities"}],"x-parser-conf":{"overview":{"markdownPath":"reference/overview.md"}},"swagger":"2.0","basePath":"/api/3.0/","schemes":["https"],"securityDefinitions":{"token":{"description":"API token created in the Cyber Vision administration UI","type":"apiKey","name":"x-token-id","in":"header"}}},"spec":{"description":"Warning: this endpoint is cached. This means that the returned data is not necessarily the latest. So, be careful when using this endpoint with live data endpoints. The cache is automatically updated, but can also be updated at will thanks to POST /presets/{preset_id}/refreshData.\n","tags":["Activities"],"summary":"Activity list for a preset.","operationId":"getActivityListForPreset","parameters":[{"type":"string","description":"preset id (uuid)","name":"preset_id","in":"path","required":true},{"enum":["json","csv"],"type":"string","description":"expected format of the returned data. If not specified, json will be used.","name":"format","in":"query"},{"type":"integer","description":"pagination - the page number","name":"page","in":"query"},{"type":"integer","description":"pagination - the number of items per page","name":"size","in":"query"},{"type":"integer","description":"start of the period to query, in ms since January 1, 1970 UTC","name":"from","in":"query"},{"type":"integer","description":"end of the period to query, in ms since January 1, 1970 UTC","name":"to","in":"query"},{"type":"string","description":"the fields to sort. Example: field1,field2:DESC","name":"sort","in":"query"},{"type":"string","description":"the language used to improve the sorting","name":"Accept-Language","in":"header"},{"type":"string","description":"the filter. Example: field1:val,field2:abc","name":"filter","in":"query"}],"responses":{"200":{"description":"object successful","schema":{"type":"array","items":{"type":"object","properties":{"bytesCount":{"type":"integer","format":"int64","x-go-name":"BytesCount"},"differences":{"type":"array","items":{"type":"object","properties":{"detection":{"type":"integer","format":"int64","x-go-name":"DetectionTime"},"id":{"description":"A UUID is a 128 bit (16 byte) Universal Unique IDentifier as defined in RFC\n4122.","type":"array","items":{"type":"integer","format":"uint8"},"x-go-package":"code.google.com/p/go-uuid/uuid","$$ref":"#/definitions/UUID"},"key":{"type":"string","x-go-name":"Key"},"oldValue":{"type":"string","x-go-name":"OldValue"},"type":{"type":"string","x-go-name":"Type"},"value":{"type":"string","x-go-name":"Value"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/Difference"},"x-go-name":"Differences"},"direction":{"type":"string","x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/TrafficDirection"},"eventsCount":{"type":"integer","format":"int64","x-go-name":"EventsCount"},"firstActivity":{"type":"integer","format":"int64","x-go-name":"CreationTime"},"flowCount":{"type":"integer","format":"int64","x-go-name":"FlowCount"},"id":{"type":"string","x-go-name":"Id"},"lastActivity":{"type":"integer","format":"int64","x-go-name":"LastActivity"},"left":{"x-go-name":"Left"},"newVariableAccess":{"type":"integer","format":"int64","x-go-name":"NewVariableAccess"},"packetsCount":{"type":"integer","format":"int64","x-go-name":"PacketsCount"},"right":{"x-go-name":"Right"},"status":{"type":"string","x-go-name":"Status"},"tags":{"type":"array","items":{"type":"object","properties":{"category":{"description":"Category json representation","type":"object","properties":{"id":{"type":"string","x-go-name":"Id"},"label":{"type":"string","x-go-name":"Label"},"priority_order":{"type":"integer","format":"int64","x-go-name":"PriorityOrder"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/Category"},"id":{"type":"string","x-go-name":"Id"},"important":{"type":"boolean","x-go-name":"Important"},"label":{"type":"string","x-go-name":"Label"},"type":{"type":"string","x-go-name":"Type"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/Tag"},"x-go-name":"Tags"},"variables":{"type":"array","items":{"type":"object","properties":{"accessBy":{"type":"string","x-go-name":"AccessBy"},"accessType":{"type":"string","x-go-name":"AccessTypes"},"extraField":{"description":"ExtraField json representation","type":"object","properties":{"id":{"type":"string","x-go-name":"Id"},"label":{"type":"string","x-go-name":"Label"},"value":{"type":"string","x-go-name":"Value"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/ExtraField"},"firstAccess":{"type":"string","format":"date-time","x-go-name":"FirstAccess"},"id":{"type":"string","x-go-name":"Id"},"label":{"type":"string","x-go-name":"Label"},"lastAccess":{"type":"string","format":"date-time","x-go-name":"LastAccess"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/VariableActivityMonitor"},"x-go-name":"Variables"},"variablesCount":{"type":"integer","format":"int64","x-go-name":"VariablesCount"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/ActivityBetweenEndpoints"}}},"400":{"description":"bad request (parameters in wrong format)"},"401":{"description":"incorrect token"},"404":{"description":"unknown preset"},"default":{"description":"unexpected error"}},"__originalOperationId":"getActivityListForPreset","consumes":["application/json"],"produces":["application/json"],"security":[{"token":[]}],"method":"get","path":"/presets/{preset_id}/visualisations/activity-list"}}