{"type":"api","title":"List Applications","meta":{"id":"/apps/pubhub/media/Meraki-Dashboard-API-v1-Documentation/426c8f7edc2cc0036fbe8fd4ce0d3ec2eda7fa14/de857a95-32cb-3f3c-8d64-0bf8514993f9","info":{"title":"Meraki Integrated API for Secure Connect","description":"The Cisco Meraki Integrated API for Secure Connect is a modern REST API based on the OpenAPI specification.\n ---\n\n [API Documentation](https://meraki.io/api)\n\n [Meraki Homepage](https://www.meraki.com)\n","version":"1.8.0","contact":{"name":"Meraki Developer Community","url":"https://meraki.io/community"}},"security":[{"meraki_api_key":[]},{"bearerAuth":[]}],"tags":[{"name":"Reports"},{"name":"Activity"},{"name":"Top Categories"},{"name":"Organization Requests by Timerange and Category"},{"name":"Total Requests"},{"name":"Summary"},{"name":"Applications"},{"name":"Deployments"},{"name":"Data Center"},{"name":"Network Devices"},{"name":"Organization Tunnel"},{"name":"Policy"},{"name":"Firewall Applications"},{"name":"Policies"},{"name":"Destination Lists"},{"name":"Destinations"}],"x-parser-conf":{"theme":"meraki","expand":2,"exampleAsDefault":true,"groupBy":{"$remoteModule":"config/group_api_tag.js"}},"openapi":"3.0.0","servers":[{"url":"https://api.meraki.com/{basePath}","variables":{"basePath":{"default":"api/secureConnect/v1"}}}],"securitySchemes":{"meraki_api_key":{"type":"apiKey","name":"X-Cisco-Meraki-API-Key","in":"header"},"bearerAuth":{"type":"apiKey","name":"Authorization","in":"header"}}},"spec":{"tags":["Reports","Applications"],"summary":"List Applications","description":"List all discovered applications.","operationId":"getApplicationsAppDiscovery","parameters":[{"name":"organizationId","in":"path","description":"Organization ID associated with this resource.","required":true,"schema":{"type":"integer"}},{"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"]},{"in":"query","name":"identity","schema":{"type":"integer"},"description":"Specify the entity ID to filter the collection.","example":12355},{"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"}},"style":"form","explode":false,"description":"Specify the types of application classification to filter the collection.\nValid values are: `unreviewed`, `approved`, `notApproved`, `underAudit`.","example":["approved"]},{"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"},{"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"}},"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"]},{"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"]},{"in":"query","name":"appTypes","schema":{"type":"array","items":{"type":"string","description":"The type of the app.","enum":["saas","paas","iaas"],"example":"saas"},"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"]},{"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"},{"in":"query","name":"limit","schema":{"type":"integer","minimum":1,"maximum":100},"description":"The maximum number of items to return in the collection."},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"The number of items to skip before starting to collect the result set."},{"in":"query","name":"sort","schema":{"type":"string","enum":["firstDetected","lastDetected","weightedRisk","name"]},"description":"Specify the name of a field to sort the applications.","example":"firstDetected"},{"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"},{"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 time when the label was updated."}],"security":[{"meraki_api_key":[]}],"responses":{"200":{"description":"OK","headers":{"Link":{"schema":{"type":"string"},"description":"Links to related resources, in the format defined by\n[RFC 5988](https://tools.ietf.org/html/rfc5988#section-5).\nIf there is a next page, this header includes a link with relation type\n`next` to the next page."}},"content":{"application/json":{"schema":{"type":"object","description":"The object that contains the list of application properties.","properties":{"items":{"type":"array","description":"The list of application properties.","items":{"type":"object","required":["id","name","label","weightedRisk","category","appType","sources","firstDetected","lastDetected"],"description":"The list of properties about the discovered apps.","properties":{"id":{"type":"string","description":"The ID of the app.","example":"eaqYExba"},"name":{"type":"string","description":"The name of the app.","example":"Umbrella"},"label":{"type":"string","description":"The application label. Valid values are: `unreviewed`, `approved`, `notApproved`, `underAudit`.","enum":["unreviewed","approved","notApproved","underAudit"],"example":"approved"},"weightedRisk":{"type":"string","description":"The risk the app poses to the environment.","enum":["veryLow","low","medium","high","veryHigh"],"example":"low"},"category":{"type":"string","description":"The category of the app.","example":"Security"},"appType":{"type":"string","description":"The type of the app.","enum":["saas","paas","iaas"],"example":"saas"},"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 by Umbrella, based on policy configurations.","example":50}},"example":{"name":"dns","requests":100,"blockedRequests":35}},{"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}},{"type":"object","description":"The properties of the app's requests that are managed by the Umbrella 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}}]},"example":[{"name":"cdfw","events":50,"blockedEvents":25}]},"firstDetected":{"type":"string","description":"The date when the app was first detected.","format":"date-time","example":"2022-01-01T00:00:00.000Z"},"lastDetected":{"type":"string","description":"The date when the app was last detected.","format":"date-time","example":"2022-01-01T00:00:00.000Z"}},"example":{"id":"ea890ya","name":"Umbrella","label":"approved","weightedRisk":"low","category":"Security","appType":"saas","sources":[{"name":"dns","requests":100,"blockedRequests":100}],"firstDetected":"2022-01-01T00:00:00.000Z","lastDetected":"2022-01-01T00:00:00.000Z"}}}},"example":{"items":[{"id":"ea890yb","name":"Umbrella","label":"unreviewed","weightedRisk":"low","category":"Security","appType":"saas","sources":[{"name":"dns","requests":100,"blockedRequests":100}],"firstDetected":"2022-01-01T00:00:00.000Z","lastDetected":"2022-01-01T00:00:00.000Z"}]}},"example":{"items":[{"id":"1234ay7","name":"Umbrella","label":"approved","weightedRisk":"low","category":"Security","appType":"saas","sources":[{"name":"cdfw","events":50,"blockedEvents":25},{"name":"dns","events":35,"blockedRequests":14},{"name":"swg","totalTraffic":150,"bytesIn":50,"bytesOut":100,"blockedBytesOut":15}],"firstDetected":"2022-01-01T00:00:00.000Z","lastDetected":"2022-01-01T00:00:00.000Z"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"Validation Error","type":"object","properties":{"statusCode":{"type":"integer","example":400,"description":"HTTP status code"},"error":{"type":"string","example":"Validation Error","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"},"validationErrors":{"type":"object","properties":{"someProperty":{"type":"string","example":"must not be empty","description":"the name of the property failing validation."}}}}}}}},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"description":"Unauthorized- The authorization header is missing or the token is unauthorized","type":"object","properties":{"statusCode":{"type":"integer","example":401,"description":"HTTP status code"},"error":{"type":"string","example":"Unauthorized","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"description":"Forbidden- The token is invalid","type":"object","properties":{"statusCode":{"type":"integer","example":403,"description":"HTTP status code"},"error":{"type":"string","example":"Forbidden, Invalid authentication credentials","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}}}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","description":"The error message returned in the response.","properties":{"message":{"type":"string"}}}}}}},"__originalOperationId":"getApplicationsAppDiscovery","method":"get","path":"/organizations/{organizationId}/reports/appDiscovery/applications"}}