{"type":"api","title":"Flow list of a component","meta":{"id":"/apps/pubhub/media/cisco-cyber-vision/c0cd14e5fea40ab3226a4b108db61ca3f0980faf/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"},"security":[{"token":[]}],"tags":[{"description":"Activities are an aggregation of flows between components.","name":"Activities"},{"description":"A baseline is used for monitor mode. They represent a snapshot of the network.","name":"Baselines"},{"description":"In monitor mode, these routes allow to retrieve and review differences between the actual network activity and the baseline description.","name":"BaselineDifferences"},{"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":"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 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 retrieve information about the enrolled sensors.","name":"Sensors"},{"description":"Routes to browse sensor folders.","name":"SensorExplorer"},{"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"},{"description":"Routes to configure the Active Discovery mode.","name":"ActiveDiscovery"},{"description":"Routes to retrieve information about the global credentials.","name":"GlobalCredentials"}],"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":"Flow list of a component.","tags":["Components"],"summary":"Flow list of a component.","operationId":"getComponentFlowList","parameters":[{"type":"string","description":"component id (uuid)","name":"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":"list successful","schema":{"type":"array","items":{"description":"JSON flow representation","type":"object","properties":{"bytesCount":{"type":"integer","format":"uint64","x-go-name":"BytesCount"},"direction":{"type":"string","x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/TrafficDirection"},"dstPort":{"type":"integer","format":"int64","x-go-name":"DstPort"},"firstActivity":{"type":"integer","format":"int64","x-go-name":"FirstActivity"},"id":{"type":"string","x-go-name":"Id"},"lastActivity":{"type":"integer","format":"int64","x-go-name":"LastActivity"},"left":{"description":"JSON FlowEndpoint representation","type":"object","properties":{"customLabel":{"type":"string","x-go-name":"CustomLabel"},"group":{"description":"Group item json representation","type":"object","properties":{"centerID":{"type":"string","x-go-name":"CenterID"},"color":{"type":"string","x-go-name":"Color"},"comments":{"type":"string","x-go-name":"Comments"},"criticalness":{"type":"integer","format":"int64","x-go-name":"Criticalness"},"description":{"type":"string","x-go-name":"Description"},"groupIds":{"type":"array","items":{"type":"string"},"x-go-name":"GroupIds"},"id":{"type":"string","x-go-name":"Id"},"label":{"type":"string","x-go-name":"Label"},"locked":{"type":"boolean","x-go-name":"Locked"},"parentId":{"type":"string","x-go-name":"ParentId"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/Group"},"icon":{"type":"string","x-go-name":"Icon"},"id":{"type":"string","x-go-name":"Id"},"label":{"type":"string","x-go-name":"Label"},"originalLabel":{"type":"string","x-go-name":"OriginalLabel"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/FlowEndpoint"},"packetsCount":{"type":"integer","format":"uint64","x-go-name":"PacketsCount"},"protocol":{"type":"string","x-go-name":"Protocol"},"right":{"description":"JSON FlowEndpoint representation","type":"object","properties":{"customLabel":{"type":"string","x-go-name":"CustomLabel"},"group":{"description":"Group item json representation","type":"object","properties":{"centerID":{"type":"string","x-go-name":"CenterID"},"color":{"type":"string","x-go-name":"Color"},"comments":{"type":"string","x-go-name":"Comments"},"criticalness":{"type":"integer","format":"int64","x-go-name":"Criticalness"},"description":{"type":"string","x-go-name":"Description"},"groupIds":{"type":"array","items":{"type":"string"},"x-go-name":"GroupIds"},"id":{"type":"string","x-go-name":"Id"},"label":{"type":"string","x-go-name":"Label"},"locked":{"type":"boolean","x-go-name":"Locked"},"parentId":{"type":"string","x-go-name":"ParentId"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/Group"},"icon":{"type":"string","x-go-name":"Icon"},"id":{"type":"string","x-go-name":"Id"},"label":{"type":"string","x-go-name":"Label"},"originalLabel":{"type":"string","x-go-name":"OriginalLabel"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/FlowEndpoint"},"srcPort":{"type":"integer","format":"int64","x-go-name":"SrcPort"},"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"}},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/Flow"},"x-go-package":"cv-gitlab.cisco.com/sentryo-labs/ccv-go/backend/serialization/v3","$$ref":"#/definitions/Flows"}},"400":{"description":"invalid parameter"},"401":{"description":"incorrect token"},"404":{"description":"component not found"},"default":{"description":"unexpected error"}},"__originalOperationId":"getComponentFlowList","consumes":["application/json"],"produces":["application/json"],"security":[{"token":[]}],"method":"get","path":"/components/{id}/flows"}}