{"type":"api","title":"Get Network Tunnel Logs","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/7bfc3311cf6d1f4e83a0b8e234580d3aecf0352d/d1093732-2fd9-3760-ac85-83910c4b7111","info":{"title":"Cisco Secure Access 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":"Network Tunnels"},{"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.sse.cisco.com/{basePath}","variables":{"basePath":{"default":"reports/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"client credential flow","flows":{"clientCredentials":{"tokenUrl":"https://api.sse.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":{"tags":["Network Tunnels","Secure Access"],"summary":"Get Network Tunnel Logs","description":"List the events for the network tunnels deployed in the organization.\n\n**Access Scope:** Reports \u003e Granular Events \u003e Read-Only","operationId":"getTunnelEvents","security":[{"oauthFlow":["reports.granularEvents: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":"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":"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":"order","in":"query","description":"A string that describes how to order the results: ascending (`asc`) or descending (`desc`).","schema":{"type":"string","enum":["asc","desc"]},"example":"desc","$$ref":"#/components/parameters/orderParam"},{"name":"timezone","in":"query","description":"Display the timestamp of the traffic events in the specified timezone.\nFor the timezone, provide a continent and city separated by an url-encoded forward slash ('/'), for example: timezone='ASIA%2fCALCUTTA'.","schema":{"type":"string"},"example":"ASIA%2fCALCUTTA","$$ref":"#/components/parameters/timezoneParam"},{"name":"servicename","in":"query","schema":{"type":"string"},"description":"A comma-separated list of service type used to filter the collection.","example":"BGP,IKE","$$ref":"#/components/parameters/servicenameParam"},{"name":"networkTunnelLevel","in":"query","schema":{"type":"string"},"description":"A comma-separated list of log levels used to filter the collection of network tunnel logs.","example":"INFO,WARNING","$$ref":"#/components/parameters/networkTunnelLevelParam"},{"name":"networktunnelgrouplabel","in":"query","schema":{"type":"string"},"description":"A comma-separated list of network tunnel group labels used to filter the collection.","example":"vpn-two,tunnel one","$$ref":"#/components/parameters/networktunnelgrouplabelParam"},{"name":"datacenterip","in":"query","schema":{"type":"string"},"description":"A comma-separated list of data center IP addresses.","example":"10.0.0.1,192.168.1.1","$$ref":"#/components/parameters/datacenteripParam"},{"name":"message","in":"query","schema":{"type":"string"},"description":"A comma-separated list of event messages.","example":"message one,message two","$$ref":"#/components/parameters/messageParam"},{"name":"region","in":"query","schema":{"type":"string"},"description":"A comma-separated list of AWS or Azure regions where the system deployed the network tunnel groups.","example":"us-west-2,eu-central-1","$$ref":"#/components/parameters/regionParam"},{"name":"searchtext","in":"query","schema":{"type":"string"},"description":"A comma-separated list of text used to search the collection.","example":"vpn,tunnel","$$ref":"#/components/parameters/searchtextParam"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"The properties of the events for the network tunnels deployed in the organization.","properties":{"data":{"type":"array","description":"The list of events for the network tunnels.","items":{"type":"object","description":"The properties of the event for the network tunnel.","properties":{"timestamp":{"type":"number","description":"The timestamp represented in seconds.","example":1594557263,"$$ref":"#/components/schemas/TimestampInSeconds"},"umbrellaOrgId":{"type":"integer","description":"The unique identifier of the organization.","readOnly":true,"example":123556,"$$ref":"#/components/schemas/organizationId"},"networkTunnelGroupId":{"type":"integer","description":"The unique identifier of the network tunnel group.","readOnly":true,"example":456123789,"$$ref":"#/components/schemas/networkTunnelGroupId"},"originId":{"type":"integer","description":"The unique identifier of the network device that established the IPsec tunnel.","example":101,"$$ref":"#/components/schemas/originId"},"originType":{"type":"integer","description":"The numeric type that identifies the origin.","example":1,"$$ref":"#/components/schemas/originType"},"tunnelId":{"type":"integer","description":"The unique identifier of the network tunnel.","example":456,"$$ref":"#/components/schemas/networkTunnel"},"serviceName":{"type":"string","description":"The label of the tunnel service.","enum":["BGP","IKE","ORCH","UNDEFINED"],"$$ref":"#/components/schemas/serviceName"},"level":{"type":"string","enum":["INFO","WARNING","ERROR"],"description":"The severity level of the event.","example":"INFO","$$ref":"#/components/schemas/level"},"message":{"type":"string","description":"The message for the event.","example":"BGP session established with peer 192.168.1.1","$$ref":"#/components/schemas/tunnelEventMessage"},"region":{"type":"string","description":"The name of the region that the system uses to obtain the primary and secondary data centers for the Hubs.","example":"us-east-1","$$ref":"#/components/schemas/region"},"datacenterIp":{"type":"string","description":"The comma-separated list of IP addresses of the data centers where the system deployed the hub.","readOnly":true,"example":"54.145.27.13,10.0.0.2","$$ref":"#/components/schemas/datacenterIp"},"datacenter":{"type":"string","description":"The canonical name of the data center where the system deployed the hub.","readOnly":true,"example":"AWS-US-WEST-2","$$ref":"#/components/schemas/datacenterName"},"ikeAuthId":{"type":"string","description":"The unique identifier of the IKE session for the network tunnel.","example":"auth123","$$ref":"#/components/schemas/ikeAuthId"},"ikeCustomerAddress":{"type":"string","description":"The IP address used by the end user for the IKE session.","example":"203.0.113.1","$$ref":"#/components/schemas/ikeCustomerAddress"},"ikeCustomerPort":{"type":"integer","description":"The port used by the end user for the IKE session.","example":4500,"$$ref":"#/components/schemas/ikeCustomerPort"},"ikeSpi":{"type":"string","description":"","example":"spi456","$$ref":"#/components/schemas/ikeSpi"},"bgpPeerIp":{"type":"string","description":"The CIDR netmask used to limit the customer peers that can talk to the headend BGP.","example":"10.0.0.0/8","$$ref":"#/components/schemas/bgpPeerIp"},"networkTunnelGroupLabel":{"type":"string","description":"The name of the network tunnel group.\nA Network Tunnel Group name is a sequence of 1–50 characters, which does not contain any special characters other than spaces and hyphens.","example":"New York Branch Tunnels","$$ref":"#/components/schemas/networkTunnelGroupLabel"},"deviceType":{"type":"string","description":"The type of the device.","example":"ROUTER","$$ref":"#/components/schemas/deviceType"},"hubId":{"type":"string","readOnly":true,"description":"The unique identifier of the hub.","example":"987654321a","$$ref":"#/components/schemas/hubId"},"hubIsPrimary":{"type":"boolean","description":"Specifies whether the hub is a primary data center.","readOnly":true,"example":true,"$$ref":"#/components/schemas/isPrimary"}},"example":{"timestamp":1726502400,"umbrellaOrgId":123456,"networkTunnelGroupId":789,"originId":101,"originType":1,"tunnelId":456,"serviceName":"BGP","level":"INFO","message":"BGP session established with peer 192.168.1.1","region":"us-west-2","datacenterIp":"10.0.0.1, 10.0.0.2","datacenter":"AWS-US-WEST-2","ikeAuthId":"a123456","ikeCustomerAddress":"203.0.113.1","ikeCustomerPort":4500,"ikeSpi":"spi456","bgpPeerIp":"192.168.1.1","networkTunnelGroupLabel":"network tunnel group one","deviceType":"ROUTER","hubId":"hub789","hubIsPrimary":true},"$$ref":"#/components/schemas/NetworkTunnelEvent"}},"meta":{"type":"object","description":"The properties of the metadata.","example":{},"$$ref":"#/components/schemas/Meta"}},"required":["data","meta"]},"example":{"data":[{"timestamp":1726502400,"umbrellaOrgId":123456,"networkTunnelGroupId":789,"originId":101,"originType":1,"tunnelId":456,"serviceName":"BGP","level":"INFO","message":"BGP session established with peer 192.168.1.1","region":"us-west-2","datacenterIp":"10.0.0.1, 10.0.0.2","datacenter":"AWS-US-WEST-2","ikeAuthId":"a123456","ikeCustomerAddress":"203.0.113.1","ikeCustomerPort":4500,"ikeSpi":"spi456","bgpPeerIp":"192.168.1.1","networkTunnelGroupLabel":"network tunnel group one","deviceType":"ROUTER","hubId":"hub789","hubIsPrimary":true}],"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":"getTunnelEvents","method":"get","path":"/networkTunnelLogs"}}