{"type":"model","meta":{"id":"/apps/pubhub/media/cloud-security-gov/9ead083ce611c254ac9201d1e76003bd3d4b4b6b/afd656c6-fbb7-361d-909e-7dd25ff9b7a2","info":{"title":"Cisco Umbrella for Government Reporting API","description":"The Reporting API provides the data to generate the Umbrella reports.","version":"2.0.0","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Activity"},{"name":"Top Identities"},{"name":"Identity Distribution"},{"name":"Top Destinations"},{"name":"Top Categories"},{"name":"Top Event Types"},{"name":"Top DNS Query Types"},{"name":"Organization Requests by Hour"},{"name":"Organization Requests by Timerange"},{"name":"Organization Requests by Hour and Category"},{"name":"Organization Requests by Timerange and Category"},{"name":"Deployment Status"},{"name":"Bandwidth by Hour"},{"name":"Bandwidth by Timerange"},{"name":"Top Files"},{"name":"Total Requests"},{"name":"Top Threats"},{"name":"Top Threat Types"},{"name":"Utility"},{"name":"Top IPs"},{"name":"Summary"},{"name":"Summaries by Category"},{"name":"Summaries by Destination"},{"name":"Summaries by Rule (Intrusion)"},{"name":"Umbrella"}],"x-parser-conf":{"overview":{"markdownPath":"reference/reports/reporting-overview.md","uri":"umbrella-api-reference-reporting-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.umbrellagov.com/{basePath}","variables":{"basePath":{"default":"reports/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"client credential flow","flows":{"clientCredentials":{"tokenUrl":"https://api.umbrellagov.com/auth/v2/token","scopes":{"reports.granularEvents:read":"Read reports granular events","reports.utilities:read":"Read reports utilities","reports.aggregations:read":"Read reports aggregations","reports.summariesByRule:read":"Read reports for the summaries of the rule"}}}}}},"spec":{"type":"object","description":"The information about the firewall activity.","properties":{"date":{"type":"string","description":"The date from the timestamp based on the timezone parameter.","example":"2020-07-12","$$ref":"#/components/schemas/Date"},"destinationip":{"type":"string","description":"The destination IP for the entry.","example":"12.10.10.10","$$ref":"#/components/schemas/DestinationIp"},"sourceip":{"type":"string","description":"The source IP for the entry.","example":"10.11.10.10","$$ref":"#/components/schemas/SourceIp"},"sourceport":{"type":"number","description":"The source port for the entry.","example":3000,"$$ref":"#/components/schemas/SourcePort"},"destinationport":{"type":"number","description":"The destination port for entry.","example":89,"$$ref":"#/components/schemas/DestinationPort"},"categories":{"type":"array","description":"The list of categories.","items":{"type":"object","description":"The properties of the category.","properties":{"id":{"type":"number","description":"The ID of the category."},"label":{"type":"string","description":"The descriptive label for the category."},"type":{"type":"string","description":"The type of the category."},"integration":{"type":"boolean","description":"Specifies whether the category is an integration.","example":true},"deprecated":{"type":"boolean","description":"Specifies whether the category is a legacy category.","example":true}},"$$ref":"#/components/schemas/Category"},"$$ref":"#/components/schemas/categories"},"verdict":{"type":"string","description":"The verdict for the entry.","enum":["allowed","blocked"],"example":"allowed","$$ref":"#/components/schemas/verdict"},"time":{"type":"string","description":"The time in 24-hour format based on the timezone parameter.","example":"12:34","$$ref":"#/components/schemas/Time"},"timestamp":{"type":"number","description":"The timestamp represented in milliseconds.","example":1594557263000,"$$ref":"#/components/schemas/Timestamp"},"identities":{"type":"array","description":"The list of identities for the entry.","items":{"type":"object","description":"The information about the identity.","properties":{"id":{"type":"number","description":"The ID of the identity."},"label":{"type":"string","description":"The descriptive label for the identity."},"type":{"type":"object","description":"The information about the identity including the type.","properties":{"id":{"type":"number","description":"The ID of the origin type for the identity."},"label":{"type":"string","description":"The label of the origin type for the identity."},"type":{"type":"string","description":"The name of the origin type for the identity."}},"$$ref":"#/components/schemas/IdentityType"},"deleted":{"type":"boolean","description":"Indicates whether the identity was deleted.","example":true}},"required":["id","label","type","deleted"],"example":{"id":1,"label":"Catch Rate Testing System","type":{"id":21,"label":"Sites","type":"site"},"deleted":false},"$$ref":"#/components/schemas/Identity"},"$$ref":"#/components/schemas/identities"},"protocol":{"type":"object","description":"The properties of the protocol.","properties":{"id":{"type":"number","description":"The ID of protocol."},"label":{"type":"string","description":"The name of the protocol."}},"required":["id","label"],"$$ref":"#/components/schemas/Protocol"},"rule":{"type":"object","description":"The properties of the firewall rule.","properties":{"id":{"type":"number","description":"The ID of the rule."},"label":{"type":"string","description":"The name of the rule."},"privateapplicationgroup":{"type":"object","description":"The private application group.","properties":{"id":{"nullable":true,"type":"number","description":"The ID of application group."},"label":{"nullable":true,"type":"string","description":"The name of the application group."}},"$$ref":"#/components/schemas/PrivateApplicationGroup"}},"required":["id","label"],"$$ref":"#/components/schemas/Rule"},"type":{"type":"string","description":"The type of the request. A firewall request always has type firewall.","example":"firewall"},"allapplications":{"type":"array","description":"A list of firewall applications","items":{"type":"object","description":"The information about the applications managed by the firewall.","properties":{"id":{"type":"number","description":"The ID of the application or protocol."},"label":{"type":"string","description":"The descriptive label for the application or protocol."},"app":{"type":"string","description":"The information about the app type.","example":"IT Service Management (string) - application/protocol type"}},"$$ref":"#/components/schemas/FirewallApplication"}},"applicationprotocols":{"type":"array","description":"A list of firewall application protocols.","items":{"type":"object","description":"The information about the applications managed by the firewall.","properties":{"id":{"type":"number","description":"The ID of the application or protocol."},"label":{"type":"string","description":"The descriptive label for the application or protocol."},"app":{"type":"string","description":"The information about the app type.","example":"IT Service Management (string) - application/protocol type"}},"$$ref":"#/components/schemas/FirewallApplication"}},"direction":{"type":"string","description":"The direction of the packet. It is destined either towards the internet or to the customer's network."},"packetsize":{"type":"number","description":"The size of the packet that was received."}},"required":["allapplications","applicationprotocols","date","destinationip","destinationport","direction","identities","packetsize","protocol","rule","sourceip","sourceport","time","timestamp","type","verdict"],"example":{"date":"","destinationip":"52.8.160.247","sourceip":"192.168.0.1","sourceport":0,"destinationport":0,"direction":"toward","categories":[{"id":66,"label":"Malware","type":"security","integration":true}],"verdict":"allowed","time":"12:34","timestamp":1548311506000,"packetsize":32,"identities":[{"id":1,"label":"Catch Rate Testing System","type":{"id":21,"label":"Sites","type":"site"},"deleted":false}],"protocol":{"id":17,"label":"UDP"},"rule":{"id":1,"label":"Default Rule"},"type":"firewall","allapplications":[{"id":72,"label":"dns IT Service Management","app":""}],"applicationprotocols":[{"id":72,"label":"dns IT Service Management","app":""}]},"$$ref":"#/components/schemas/ActivityFirewall","title":"ActivityFirewall"}}