Get Summaries Rule Intrusion - Cloud Security Gov

{"type":"api","title":"Get Summaries Rule Intrusion","meta":{"id":"/apps/pubhub/media/cloud-security-gov/9ead083ce611c254ac9201d1e76003bd3d4b4b6b/d1093732-2fd9-3760-ac85-83910c4b7111","info":{"title":"Cisco Secure Access for Government Reporting API","description":"The Reporting API provides the data to generate the Secure Access reports.","version":"2.0.1","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Activity"},{"name":"Top Identities"},{"name":"Identity Distribution"},{"name":"Top Resources"},{"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"},{"name":"Remote Access"},{"name":"Private Resource"},{"name":"Requests Resource Connector"},{"name":"Requests Summary Resource Connector Groups"},{"name":"Resource Connectors"},{"name":"Rules Activity"},{"name":"Unique Resources"},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/reports/reporting-overview.md","uri":"secure-access-api-reference-reporting-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.secureaccessfed.cisco.com/{basePath}","variables":{"basePath":{"default":"reports/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"client credential flow","flows":{"clientCredentials":{"tokenUrl":"https://api.secureaccessfed.cisco.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.privateResources:read":"Read reports for the private resources"}}}}}},"spec":{"summary":"Get Summaries Rule Intrusion","operationId":"getSummariesByRuleIntrusion","tags":["Summaries by Rule","Secure Access"],"description":"List the summaries by rule for the intrusion type.\n\n**Access Scope:** Reports \u003e Summaries by rule \u003e Read-Only","security":[{"oauthFlow":["reports.summariesByRule:read"]}],"parameters":[{"name":"from","in":"query","description":"A timestamp or relative time string (for example: '-1days').\nFilter for data that appears after this time.","required":true,"schema":{"type":"string"},"example":"1639146300000","$$ref":"#/components/parameters/fromParam"},{"name":"to","in":"query","description":"A timestamp or relative time string (for example: 'now').\nFilter for data that appears before this time.","required":true,"schema":{"type":"string"},"example":"1640010300000","$$ref":"#/components/parameters/toParam"},{"name":"offset","in":"query","description":"A number that represents an index in the collection.","schema":{"type":"number","default":0},"example":0,"$$ref":"#/components/parameters/offsetParam"},{"name":"limit","in":"query","description":"The maximum number of records to return from the collection.","required":true,"schema":{"type":"number","default":100},"example":100,"$$ref":"#/components/parameters/limitParam"},{"name":"signatures","in":"query","description":"The signature or comma-separated list of \u003csignatureid\u003e-\u003cgeneratorid\u003e signatures.","schema":{"type":"string"},"example":"1-2,1-4","$$ref":"#/components/parameters/signaturesParam"},{"name":"signaturelistids","in":"query","description":"The signature ID or comma-separated list of signature list IDs.","schema":{"type":"string"},"example":"1,2","$$ref":"#/components/parameters/signatureListIdsParam"},{"name":"ipsprofile","in":"query","description":"An IPS profile string or comma-delimited list of IPS profile string.","schema":{"type":"string"},"example":"config,profile","$$ref":"#/components/parameters/ipsProfileParam"},{"name":"ip","in":"query","description":"An IP address.","schema":{"type":"string"},"example":"10.10.10.10","$$ref":"#/components/parameters/ipParam"},{"name":"identityids","in":"query","description":"An identity ID or comma-delimited list of identity IDs.","schema":{"type":"string"},"example":"1,2,3","$$ref":"#/components/parameters/identityIdsParam"},{"name":"identitytypes","in":"query","description":"An identity type or comma-delimited list of identity types.","schema":{"type":"string"},"example":"network,roaming","$$ref":"#/components/parameters/identityTypesParam"},{"name":"intrusionaction","in":"query","description":"An action or list of comma-separated intrusion actions. Valid values are: `would_block`, `blocked`, and `detected`.","schema":{"type":"string"},"example":"detected,would_block","$$ref":"#/components/parameters/intrusionActionParam"},{"name":"ports","in":"query","description":"A port number or comma-delimited list of port numbers.","schema":{"type":"string"},"example":"7351,80","$$ref":"#/components/parameters/portsParam"},{"name":"filternoisydomains","in":"query","description":"Filter out domains that generate a lot of insignificant traffic (noise).","schema":{"type":"boolean"},"example":true,"$$ref":"#/components/parameters/filterNoisyDomainsParam"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","description":"The summary information about the signature lists.","properties":{"signaturelist":{"type":"object","description":"The properties of the signature list.","properties":{"id":{"type":"number","description":"The unique ID assigned to a default or custom signature list."}},"required":["id"],"example":{"id":1112},"$$ref":"#/components/schemas/SignatureList"},"signatures":{"type":"array","description":"The list of information about the signatures.","items":{"type":"object","properties":{"generatorid":{"type":"number","description":"The generator ID of the signature."},"id":{"type":"number","description":"The ID of the signature."},"lasteventat":{"type":"number","description":"The date and time in milliseconds of the last event."},"counts":{"type":"object","properties":{"blocked":{"type":"number","description":"The number of blocked signatures."},"detected":{"type":"number","description":"The number of detected signatures."},"wouldblock":{"type":"number","description":"The number of signatures to block."}},"required":["blocked","detected","wouldblock"]}}}},"rule":{"type":"object","description":"The properties of the rule parameter.","properties":{"id":{"type":"number","description":"The ID of the ruleset for the signature.","example":47}},"$$ref":"#/components/schemas/RuleParam"}},"example":{"signaturelist":{"id":1111},"signatures":[{"counts":{"blocked":0,"detected":1,"wouldblock":0},"generatorid":1,"lasteventat":1594557262000,"id":47829}],"rule":{"id":47}},"$$ref":"#/components/schemas/SignatureListSummary"}},"meta":{"type":"object","description":"The properties of the metadata.","example":{},"$$ref":"#/components/schemas/Meta"}},"required":["data","meta"]},"example":{"data":[{"signaturelist":{"id":1111},"signatures":[{"counts":{"blocked":0,"detected":1,"wouldblock":0},"generatorid":1,"lasteventat":1594557262000,"id":47829}],"rule":{"id":47}}],"meta":{}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Bad Request"}}}},"$$ref":"#/components/responses/400Error"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Unauthorized"}}}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Forbidden"}}}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Not Found"}}}},"$$ref":"#/components/responses/404Error"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Internal Server Error"}}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"getSummariesByRuleIntrusion","method":"get","path":"/summaries-by-rule/intrusion"}}