List Information for Applications - Cloud Security API

{"type":"api","title":"List Information for Applications","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/d2a1854d5c0ed9069a7f0bc54a9b813f3075ddc9/29468fdf-90c8-34ef-bf3f-a1b0fc9fc185","info":{"title":"Cisco Umbrella App Discovery API","description":"The App Discovery API provides an overall view of application and protocol activity in your environment\nand the potential risk indicated by this network traffic.","version":"2.0.1","contact":{"name":"Cloud Security Developer Community"}},"tags":[{"name":"Applications"},{"name":"Application Categories"},{"name":"Protocols"},{"name":"Identities"},{"name":"Umbrella"}],"x-parser-conf":{"overview":{"markdownPath":"reference/reports/app-discovery-overview.md","uri":"umbrella-api-reference-app-discovery-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.appDiscovery:write":"Write reports app discovery","reports.appDiscovery:read":"Read reports app discovery"}}}}}},"spec":{"tags":["Applications","Umbrella"],"description":"List the information about the applications.","operationId":"getApplicationsInfo","summary":"List Information for Applications","parameters":[{"in":"query","name":"sources","schema":{"type":"array","items":{"type":"string","enum":["dns","swg","cdfw"]}},"style":"form","explode":false,"description":"Specify the types of log source to filter the collection.\nValid values are: `dns`, `swg`, `cdfw`.","example":["cdfw"],"$$ref":"#/components/parameters/sources"},{"in":"query","name":"identity","schema":{"type":"integer"},"description":"Specify the entity ID to filter the collection.","example":12355,"$$ref":"#/components/parameters/identity"},{"in":"query","name":"labels","schema":{"type":"array","items":{"type":"string","description":"The application label. Valid values are: `unreviewed`, `approved`, `notApproved`, `underAudit`.","enum":["unreviewed","approved","notApproved","underAudit"],"example":"approved","$$ref":"#/components/schemas/Label"}},"style":"form","explode":false,"description":"Specify the types of application classification to filter the collection.\nValid values are: `unreviewed`, `approved`, `notApproved`, `underAudit`.","example":["approved"],"$$ref":"#/components/parameters/labels"},{"in":"query","name":"controllable","schema":{"type":"string","enum":["all","advanced"]},"description":"Specify the type of controllable applications to filter the collection.\nValid values are: `all`, `advanced`.","example":"advanced","$$ref":"#/components/parameters/controllable"},{"in":"query","name":"weightedRisk","schema":{"type":"array","items":{"type":"string","description":"The risk the app poses to the environment.","enum":["veryLow","low","medium","high","veryHigh"],"example":"low","$$ref":"#/components/schemas/WeightedRisk"}},"style":"form","explode":false,"description":"Specify the list of application weighted risk to filter the collection.\nValid values are: `veryLow`, `low`, `medium`, `high`, `veryHigh`.","example":["low"],"$$ref":"#/components/parameters/weightedRisk"},{"in":"query","name":"categories","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"description":"Specify the list of application category to filter the collection.","example":["Security"],"$$ref":"#/components/parameters/categories"},{"in":"query","name":"appTypes","schema":{"type":"array","items":{"type":"string","description":"The type of the app.","enum":["saas","paas","iaas"],"example":"saas","$$ref":"#/components/schemas/AppType"},"example":["saas","paas","iaas"]},"style":"form","explode":false,"description":"Specify the types of application to filter the collection.\nValid values are: `saas`, `paas`, and `iaas`.","example":["paas"],"$$ref":"#/components/parameters/appTypes"},{"in":"query","name":"date","schema":{"type":"string","format":"date"},"description":"Specify a date to search for data within a twenty-four hour time period.\nIf you do not provide a date, the last 90 days period is used to query the collection.","example":"2022-01-01","$$ref":"#/components/parameters/date"},{"in":"query","name":"limit","schema":{"type":"integer","minimum":1,"maximum":100},"description":"The maximum number of items to return in the collection.","$$ref":"#/components/parameters/limit"},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"The number of items to skip before starting to collect the result set.","$$ref":"#/components/parameters/offset"},{"in":"query","name":"sort","schema":{"type":"string","enum":["firstDetected","lastDetected","weightedRisk","name","vendor","identities","dnsRequests","firewallEvents","blockedDnsRequests","traffic","inboundWebTraffic","ruleStatus","scannable","totalEvents","labels"]},"description":"Specify the name of a field to sort the information for the applications.","$$ref":"#/components/parameters/applicationsInfoSort"},{"in":"query","name":"order","schema":{"type":"string","enum":["asc","desc"]},"description":"Specify the order to sort the collection. Valid values are: `asc` (ascending)\nor `desc` (descending).","example":"asc","$$ref":"#/components/parameters/order"},{"in":"query","name":"label_timestamp","schema":{"type":"string","format":"date-time"},"example":"2022-01-01T00:00:00.000Z","description":"Filter the result set on the date and time (ISO 8601 timestamp) when the label was updated.","$$ref":"#/components/parameters/label_timestamp"},{"in":"query","name":"app_ids","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"description":"The IDs of the applications to use when filtering the collection.","example":["1356"],"$$ref":"#/components/parameters/app_ids"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"The properties of the information for the applications.","properties":{"items":{"type":"array","description":"The list of information about the applications.","items":{"type":"object","description":"The properties of the app.","required":["id","name","description","label","weightedRisk","category","appType","url","vendor","identitiesCount","sources","firstDetected","lastDetected"],"properties":{"id":{"type":"string","description":"The ID of the app.","example":"eaqYExba"},"name":{"type":"string","description":"The name of the app.","example":"Umbrella"},"description":{"type":"string","description":"The description of the app.","example":"Offers threat intelligence solutions."},"label":{"type":"string","description":"The application label. Valid values are: `unreviewed`, `approved`, `notApproved`, `underAudit`.","enum":["unreviewed","approved","notApproved","underAudit"],"example":"approved","$$ref":"#/components/schemas/Label"},"weightedRisk":{"type":"string","description":"The risk the app poses to the environment.","enum":["veryLow","low","medium","high","veryHigh"],"example":"low","$$ref":"#/components/schemas/WeightedRisk"},"category":{"type":"string","description":"The category applied to the app.","example":"Security"},"appType":{"type":"string","description":"The type of the app.","enum":["saas","paas","iaas"],"example":"saas","$$ref":"#/components/schemas/AppType"},"url":{"type":"string","description":"The URL of the app.","example":"https://umbrella.cisco.com/products/umbrella-investigate"},"vendor":{"type":"string","description":"The vendor that owns the app.","example":"Cisco"},"identitiesCount":{"type":"integer","description":"The number of identities.","example":5},"sources":{"type":"array","description":"The list of app sources where the sources are DNS, Web (Secure Web Gateway), and cloud-delivered firewall (CDFW) traffic events.\nThe list can contain one or more of the source types.","items":{"anyOf":[{"type":"object","description":"The properties of the app's DNS requests.","properties":{"name":{"type":"string","description":"The type of traffic associated with the source.","enum":["dns"],"example":"dns"},"requests":{"type":"integer","description":"The number of DNS requests for this app.","example":100},"blockedRequests":{"type":"integer","description":"The number of DNS requests blocked, which is based on the policy configurations.","example":50}},"example":{"name":"dns","requests":100,"blockedRequests":35},"$$ref":"#/components/schemas/DnsSource"},{"type":"object","description":"The properties of the app's web requests.","properties":{"name":{"type":"string","description":"The type of traffic associated with the source.","enum":["swg"],"example":"swg"},"totalTraffic":{"type":"integer","description":"The total number of bytes inbound and outbound for this app in your environment.","example":150},"bytesIn":{"type":"integer","description":"The number of bytes received (inbound).","example":50},"bytesOut":{"type":"integer","description":"The number of bytes sent (outbound).","example":100},"blockedBytesOut":{"type":"integer","description":"The number of bytes of outbound traffic that are blocked.","example":90}},"example":{"name":"swg","totalTraffic":200,"bytesIn":100,"bytesOut":100,"blockedBytesOut":49},"$$ref":"#/components/schemas/SwgSource"},{"type":"object","description":"The properties of the app's requests that are managed by the cloud-delivered firewall (CDFW).","properties":{"name":{"type":"string","description":"The type of traffic associated with the source.","enum":["cdfw"],"example":"cdfw"},"events":{"type":"integer","description":"The number of CDFW L7 events for this app.","example":100},"blockedEvents":{"type":"integer","description":"The number of CDFW L7 events that are blocked.","example":50}},"example":{"name":"cdfw","events":50,"blockedEvents":25},"$$ref":"#/components/schemas/CdfwSource"}]},"example":[{"name":"cdfw","events":50,"blockedEvents":25}],"$$ref":"#/components/schemas/Sources"},"firstDetected":{"type":"string","format":"date-time","description":"The date and time (ISO 8601 timestamp) when the app was first detected.","example":"2022-01-01T00:00:00.000Z"},"lastDetected":{"type":"string","description":"The date and time (ISO 8601 timestamp) when the app was last detected.","format":"date-time","example":"2022-01-01T00:00:00.000Z"}},"example":{"id":"eaqYExba","name":"Umbrella","description":"The properties of the app.","label":"unreviewed","weightedRisk":"low","category":"Security","appType":"saas","url":"https://umbrella.cisco.com/products/umbrella-investigate","vendor":"Cisco Systems","identitiesCount":25,"sources":[{"name":"dns","requests":100,"blockedRequests":100}],"firstDetected":"2022-01-01T00:00:00.000Z","lastDetected":"2022-01-01T00:00:00.000Z"},"$$ref":"#/components/schemas/ApplicationObject"}},"currentPage":{"type":"integer","description":"The index of the current page in the collection.","example":1},"totalPages":{"type":"integer","description":"The total number of pages in the collection.","example":100},"itemsCount":{"type":"integer","description":"The number of items in the collection.","example":10}},"example":{"items":[{"id":"0JdbV4dy","name":"Twitter","label":"unreviewed","weightedRisk":"low","category":"Social Networking","appType":"saas","sources":[{"name":"cdfw","events":0,"blockedEvents":0},{"name":"swg","totalTraffic":0,"bytesIn":0,"bytesOut":0,"blockedBytesOut":0},{"name":"dns","requests":3,"blockedRequests":0}],"firstDetected":"2025-01-01T00:00:00.000Z","lastDetected":"2025-01-01T00:00:00.000Z","description":"Online social networking service that enables users to send\nand read short messages called tweets.","url":"https://twitter.com","vendor":"Twitter","identitiesCount":1}],"currentPage":1,"totalPages":126,"itemsCount":251},"$$ref":"#/components/schemas/ApplicationListWithInfo"},"example":{"items":[{"id":"0JdbV4dy","name":"Twitter","label":"unreviewed","weightedRisk":"low","category":"Social Networking","appType":"saas","sources":[{"name":"cdfw","events":0,"blockedEvents":0},{"name":"swg","totalTraffic":0,"bytesIn":0,"bytesOut":0,"blockedBytesOut":0},{"name":"dns","requests":3,"blockedRequests":0}],"firstDetected":"2022-01-01T00:00:00.000Z","lastDetected":"2022-01-01T00:00:00.000Z","description":"Online social networking service that enables users to send\nand read short messages called tweets.","url":"https://twitter.com","vendor":"Twitter","identitiesCount":1}],"currentPage":1,"totalPages":126,"itemsCount":251}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","description":"The error message returned in the response.","properties":{"message":{"type":"string"}},"$$ref":"#/components/schemas/Error"}}},"$$ref":"#/components/responses/InvalidRequest"},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"type":"object","description":"The error message returned in the response.","properties":{"message":{"type":"string"}},"$$ref":"#/components/schemas/Error"}}},"$$ref":"#/components/responses/Unauthorized"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","description":"The error message returned in the response.","properties":{"message":{"type":"string"}},"$$ref":"#/components/schemas/Error"}}},"$$ref":"#/components/responses/Forbidden"},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","description":"The error message returned in the response.","properties":{"message":{"type":"string"}},"$$ref":"#/components/schemas/Error"}}},"$$ref":"#/components/responses/NotFound"},"500":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","description":"The error message returned in the response.","properties":{"message":{"type":"string"}},"$$ref":"#/components/schemas/Error"}}},"$$ref":"#/components/responses/ServerError"}},"__originalOperationId":"getApplicationsInfo","method":"get","path":"/appDiscovery/applications/info"}}