ActivityProxy - Cloud Security API

{"type":"model","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/9d37d008417d562ab46d4b67547a68457ce288d2/cba65c33-1da3-3556-a885-2c67eb61196b","info":{"title":"Cisco Umbrella 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":"Provider Deployment Status"},{"name":"Provider Requests by Hour"},{"name":"Provider Requests by Timerange"},{"name":"Provider Requests by Organization"},{"name":"Provider Requests by Category"},{"name":"Provider Requests by Destination"},{"name":"Provider Category Requests by Organization"},{"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.umbrella.com/{basePath}","variables":{"basePath":{"default":"reports/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"client credential flow","flows":{"clientCredentials":{"tokenUrl":"https://api.umbrella.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","reports.customers:read":"Read reports for the customers"}}}}}},"spec":{"type":"object","description":"The activity of the proxy.","properties":{"externalip":{"type":"string","description":"The external IP for the entry."},"internalip":{"type":"string","description":"The internal IP for the entry."},"policycategories":{"type":"array","description":"The list of policy 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/policycategories"},"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"},"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"},"allapplications":{"type":"array","description":"The list of applications for the entry.","items":{"type":"object","description":"The information about the application.","properties":{"id":{"type":"number","description":"The ID of the application."},"label":{"type":"string","description":"The descriptive label for the application."},"type":{"type":"string","description":"The type of the application: NBAR or AVC.","enum":["NBAR","AVC"],"example":"AVC"},"category":{"type":"object","description":"The category of the application.","properties":{"id":{"type":"number","description":"The ID of the application category."},"label":{"type":"string","description":"The label of the application category."}}}},"example":{"id":1,"label":"malware","type":"AVC","category":{"id":2,"label":"Education"}},"$$ref":"#/components/schemas/Application"},"$$ref":"#/components/schemas/allapplications"},"allowedapplications":{"type":"array","description":"The list of allowed applications for the entry.","items":{"type":"object","description":"The information about the application.","properties":{"id":{"type":"number","description":"The ID of the application."},"label":{"type":"string","description":"The descriptive label for the application."},"type":{"type":"string","description":"The type of the application: NBAR or AVC.","enum":["NBAR","AVC"],"example":"AVC"},"category":{"type":"object","description":"The category of the application.","properties":{"id":{"type":"number","description":"The ID of the application category."},"label":{"type":"string","description":"The label of the application category."}}}},"example":{"id":1,"label":"malware","type":"AVC","category":{"id":2,"label":"Education"}},"$$ref":"#/components/schemas/Application"}},"blockedapplications":{"type":"array","description":"The list of blocked applications for the entry.","items":{"type":"object","description":"The information about the application.","properties":{"id":{"type":"number","description":"The ID of the application."},"label":{"type":"string","description":"The descriptive label for the application."},"type":{"type":"string","description":"The type of the application: NBAR or AVC.","enum":["NBAR","AVC"],"example":"AVC"},"category":{"type":"object","description":"The category of the application.","properties":{"id":{"type":"number","description":"The ID of the application category."},"label":{"type":"string","description":"The label of the application category."}}}},"example":{"id":1,"label":"malware","type":"AVC","category":{"id":2,"label":"Education"}},"$$ref":"#/components/schemas/Application"}},"responsefilename":{"type":"string","description":"The response filename for the entry."},"blockedfiletype":{"type":"string","description":"The blocked file type for the entry."},"bundleid":{"type":"number","description":"The ID of the bundle type."},"amp":{"type":"object","description":"The properties of the AMP disposition and score for the malware.","properties":{"score":{"type":"number","description":"The AMP score."},"disposition":{"type":"string","description":"The AMP disposition."},"malware":{"type":"string","description":"The AMP malware."}},"required":["disposition","malware","score"],"$$ref":"#/components/schemas/CiscoAMP"},"type":{"type":"string","description":"The type of the request. A proxy request is always of type 'proxy'."},"tenantcontrols":{"type":"boolean","description":"Specifies whether the request is part of a tenant control policy."},"port":{"type":"number","description":"The port used to make the request.","nullable":true},"antivirusthreats":{"type":"object","description":"The information about the antivirus threats.","properties":{"puas":{"type":"array","description":"The list of potentially unwanted applications.","items":{"type":"object"}},"viruses":{"type":"array","description":"The list of viruses.","items":{"type":"string"}},"others":{"type":"array","description":"The list of other antivirus threats.","items":{"type":"object"}}},"required":["others","puas","viruses"],"$$ref":"#/components/schemas/AntivirusThreats"},"policy":{"type":"object","description":"The properties of the rules in the policy.","required":["destinationlistids","ruleid","rulesetid","timebasedrule"],"properties":{"timebasedrule":{"type":"boolean","description":"Specify whether the policy triggered a time-of-day rule."},"destinationlistids":{"type":"array","description":"The list of destination lists that the rules triggered.","items":{"type":"number"}},"ruleid":{"type":"number","description":"The ID of the rule in the policy.","nullable":true},"rulesetid":{"type":"number","description":"The ID of the ruleset in the policy.","nullable":true}},"$$ref":"#/components/schemas/Policy"},"requestmethod":{"type":"string","description":"The HTTP request method.","example":"GET"},"responsesize":{"type":"number","description":"The response size in bytes."},"requestsize":{"type":"number","description":"The response size in bytes."},"statuscode":{"type":"number","description":"The HTTP status code (`200` or `201`).","enum":[200,201],"example":200},"useragent":{"type":"string","description":"The name of the browser that made the request."},"referer":{"type":"string","description":"The referring domain or URL."},"warnstatus":{"type":"string","description":"The warning status."},"sha256":{"type":"string","description":"The hex digest of the response content."},"isolated":{"type":"object","description":"The properties of the isolated file.","properties":{"state":{"type":"string","description":"The state of the isolated file."},"fileaction":{"type":"string","description":"The action taken for the file."}},"required":["state","fileaction"],"example":{"state":"not-isolated","fileaction":""},"$$ref":"#/components/schemas/Isolated"},"datalossprevention":{"type":"object","description":"The information about the Data Loss Prevention state.","properties":{"state":{"type":"string","description":"Indicates the status of the DLP. The state is either `blocked` or the empty string (` `).","enum":["blocked",""]}},"required":["state"],"example":{"state":"blocked"},"$$ref":"#/components/schemas/DataLossPreventionState"},"securityoverridden":{"type":"boolean","description":"Specifies whether security overrides are configured."},"contenttype":{"type":"string","description":"The type of web content, typically text/html.","example":"text/html"},"forwardingmethod":{"type":"string","description":"The request method (GET, POST, HEAD, etc.)","example":"GET"},"httperrors":{"type":"array","items":{"type":"object","description":"The properties of the HTTP error.","properties":{"type":{"type":"string","description":"The type of the error, either `CertificateError` or `TLSError`.","enum":["CertificateError","TLSError"]},"code":{"type":"number","description":"The HTTP error code."},"reason":{"type":"string","description":"The name of the error."},"attributes":{"type":"object","description":"The properties of the additional information for the error."}},"$$ref":"#/components/schemas/HttpError"},"description":"Certificate & TLS Errors"},"threats":{"type":"array","items":{"type":"object","description":"The information about the threat.","properties":{"label":{"type":"string","description":"The descriptive label for the threat name."},"type":{"type":"string","description":"The type of the threat."}},"$$ref":"#/components/schemas/Threat"}},"egress":{"type":"object","description":"The information about the egress IP.","properties":{"ip":{"type":"string","description":"The egress IP."},"type":{"type":"string","description":"The type of the egress IP.","example":"shared"}},"required":["ip","type"],"example":{"ip":"155.190.3.8","type":"shared"},"$$ref":"#/components/schemas/Egress"},"datacenter":{"type":"object","description":"The information about the data center.","properties":{"id":{"type":"string","description":"The unique ID for the data center."},"label":{"type":"string","description":"The name of the data center."}},"required":["id","label"],"example":{"id":"LAX","label":"Los Angeles, US"},"$$ref":"#/components/schemas/DataCenter"},"date":{"type":"string","description":"The date from the timestamp based on the timezone parameter.","example":"2020-07-12","$$ref":"#/components/schemas/Date"},"time":{"type":"string","description":"The time in 24-hour format based on the timezone parameter.","example":"12:34","$$ref":"#/components/schemas/Time"},"destinationip":{"type":"string","description":"The destination IP for the entry.","example":"12.10.10.10","$$ref":"#/components/schemas/DestinationIp"},"url":{"type":"string","description":"The URL that was requested."}},"required":["allapplications","allowedapplications","amp","antivirusthreats","blockedapplications","blockedfiletype","bundleid","categories","contenttype","datacenter","datalossprevention","date","destinationip","egress","externalip","forwardingmethod","httperrors","identities","internalip","isolated","policy","policycategories","port","referer","requestsize","responsefilename","responsesize","securityoverridden","sha256","statuscode","tenantcontrols","threats","time","timestamp","type","url","useragent","verdict","warnstatus"],"example":{"destinationip":"","externalip":"32.4.91.7","responsesize":3329530,"allapplications":[{"id":1313,"label":"Netflix","category":{"id":47,"label":"Media"}}],"date":"2022-02-18","datalossprevention":{"state":""},"antivirusthreats":{"puas":[],"viruses":[],"others":[]},"internalip":"192.168.1.43","referer":"","contenttype":"","tenantcontrols":false,"securityoverridden":false,"useragent":"","time":"23:29:42","amp":{"disposition":"","score":0,"malware":""},"policycategories":[],"type":"proxy","requestsize":1996,"port":443,"policy":{"ruleid":0,"rulesetid":0,"destinationlistids":[],"timebasedrule":false},"forwardingmethod":"","categories":[{"id":17,"type":"content","label":"Movies","integration":false,"deprecated":true}],"isolated":{"state":"not-isolated","fileaction":""},"statuscode":200,"egress":{"ip":"155.190.3.8","type":"shared"},"blockedfiletype":"","url":"https://ipv4-lax2-ix.1.oca.anothervideo.net","verdict":"allowed","responsefilename":"","warnstatus":"","sha256":"","timestamp":1645226982000,"blockedapplications":[],"allowedapplications":[],"identities":[{"id":1,"type":{"id":34,"type":"anyconnect","label":"Anyconnect Roaming Client"},"label":"Vincent's Macbook","deleted":false}],"datacenter":{"label":"Atlanta, US","id":"ATL"},"threats":[],"httperrors":[],"bundleid":3},"$$ref":"#/components/schemas/ActivityProxy","title":"ActivityProxy"}}