Get Tunnel Global Error Events - Cloud Security API

{"type":"api","title":"Get Tunnel Global Error Events","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/9d37d008417d562ab46d4b67547a68457ce288d2/6de27b83-cd76-3f18-9e4a-e121ea0a8b86","info":{"title":"Cisco Umbrella Network Tunnels API","description":"Manage the network tunnels in the organization.","version":"2.0.0","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Data Center"},{"name":"Organization Tunnel"},{"name":"Debugging"},{"name":"Umbrella"}],"x-parser-conf":{"overview":{"markdownPath":"reference/deployments/network-tunnels-overview.md","uri":"umbrella-api-reference-network-tunnels-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.umbrella.com/{basePath}","variables":{"basePath":{"default":"deployments/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"client credential flow","flows":{"clientCredentials":{"tokenUrl":"https://api.umbrella.com/auth/v2/token","scopes":{"deployments.tunnels:write":"Write deployments tunnels","deployments.tunnels:read":"Read deployments tunnels","deployments.datacenters:read":"Read deployments datacenters"}}}}}},"spec":{"tags":["Debugging","Umbrella"],"summary":"Get Tunnel Global Error Events","operationId":"getTunnelGlobalErrorEvents","security":[{"oauthFlow":["deployments.tunnels:read"]}],"description":"Get the recent global error events.","parameters":[{"in":"path","name":"id","description":"The ID of the tunnel.","required":true,"schema":{"type":"integer"}},{"in":"path","name":"ip","description":"The source IPv4 address of the tunnel.","required":true,"schema":{"type":"string"}},{"in":"query","name":"hour","description":"Retrieve events that occur in the last number of hours.","required":false,"schema":{"type":"integer","minimum":1,"maximum":168}},{"in":"query","name":"limit","description":"Retrieve up to this number of events.","required":false,"schema":{"type":"integer","minimum":1,"maximum":500}},{"in":"query","name":"cursor","description":"Return events from the cursor where `0` points to the latest event.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"The tunnel global error metadata and event records.","properties":{"meta":{"description":"The tunnel global error metadata.","type":"object","properties":{"records":{"type":"integer","readOnly":true,"description":"The number of records returned for the global error events.","example":100},"cursor":{"type":"string","readOnly":true,"description":"The unique cursor identifier conducted from the IP address,\ntimestamp, and event ID for a global error event.","example":"MTIyLjE5OS4xLjMxLDE1NjExNjc4NDAsMU15cm5MR3RzZ1dzNnBBTk1MMkJDOHRhME9Q"}}},"data":{"type":"array","items":{"type":"object","description":"The tunnel global error event.","properties":{"time":{"type":"string","readOnly":true,"format":"date-time","description":"The date and time when the error event was generated (UTC time, with milliseconds).","example":"2018-06-13T16:07:07.222Z"},"eventId":{"type":"string","readOnly":true,"description":"The unique event ID.","example":"1Ip3mRXguys9u4mIwfQXj63KwqL"},"type":{"type":"string","readOnly":true,"description":"The event Type:\n* SSEN - StrongSwan-based Error Notify Events\n* OTHER - others/future\n","enum":["SSEN","OTHER"],"default":"SSEN","example":"SSEN"},"code":{"type":"string","readOnly":true,"description":"The type-specific error codes:\n* LOCAL_AUTH_FAILED - creating local authentication data failed\n* PEER_AUTH_FAILED - peer authentication failed\n* PARSE_ERROR_HEADER - parsing IKE header failed\n* PARSE_ERROR_BODY - parsing IKE message failed\n* RETRANSMIT_SEND_TIMEOUT - IKE message retransmission timed out\n* HALF_OPEN_TIMEOUT - IKE SA timed out before it could be established\n* PROPOSAL_MISMATCH_IKE - received IKE SA proposals mismatch\n* PROPOSAL_MISMATCH_CHILD - received CHILD SA proposals mismatch\n* TS_MISMATCH - received traffic selectors mismatch\n* INSTALL_CHILD_SA_FAILED - installing IPsec SA failed\n* INSTALL_CHILD_POLICY_FAILED - installing IPsec policy failed\n* UNIQUE_REPLACE - replaced old IKE SA due to uniqueness policy\n* UNIQUE_KEEP - keep existing in favor of rejected new IKE SA due to uniqueness policy\n* VIP_FAILURE - virtual IP failure\n* AUTHORIZATION_FAILED - an authorization plugin prevented establishment of an IKE SA\n* RETRANSMIT_SEND - IKE message retransmission\n\nFor additional information, see https://datatracker.ietf.org/doc/html/rfc7296.\n","enum":["LOCAL_AUTH_FAILED","PEER_AUTH_FAILED","PARSE_ERROR_HEADER","PARSE_ERROR_BODY","RETRANSMIT_SEND_TIMEOUT","HALF_OPEN_TIMEOUT","PROPOSAL_MISMATCH_IKE","PROPOSAL_MISMATCH_CHILD","TS_MISMATCH","INSTALL_CHILD_SA_FAILED","INSTALL_CHILD_POLICY_FAILED","UNIQUE_REPLACE","UNIQUE_KEEP","VIP_FAILURE","AUTHORIZATION_FAILED","RETRANSMIT_SEND"],"example":"PEER_AUTH_FAILED"},"reason":{"type":"string","readOnly":true,"description":"The description of the error.","example":"peer authentication failed"},"peerIp":{"type":"string","readOnly":true,"description":"The optional peer IP (if available).","example":"11.11.11.11"},"peerPort":{"type":"string","readOnly":true,"description":"The optional peer port (if available).","example":"4500"}}}}}}}}}},"400":{"description":"Bad Request","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","minProperties":3,"required":["statusCode","error","txId"],"properties":{"statusCode":{"type":"integer","example":400,"description":"HTTP status code"},"error":{"type":"string","example":"Validation Error","description":"a brief description of the error"},"txId":{"type":"string","example":"86e189a6-0124-47d3-a32c-25ff3f07deaf","description":"a unique hex number that can be used for debugging"},"validationErrors":{"type":"object","properties":{"someProperty":{"type":"string","example":"must not be empty","description":"the name of the property failing validation."}}}}}}},"$$ref":"#/components/responses/BadRequest"},"401":{"description":"Unauthorized","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","minProperties":3,"required":["statusCode","error","txId"],"properties":{"statusCode":{"type":"integer","example":401,"description":"HTTP status code"},"error":{"type":"string","example":"Unauthorized","description":"A brief description of the error"},"txId":{"type":"string","example":"86e189a6-0124-47d3-a32c-25ff3f07deaf","description":"a unique hex number that can be used for debugging"}}}}},"$$ref":"#/components/responses/Unauthorized"},"403":{"description":"Forbidden","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","minProperties":1,"required":["message"],"properties":{"statusCode":{"type":"integer","example":403,"description":"HTTP status code"},"message":{"type":"string","example":"SIG is not enabled, please check with Cisco Support.\nYou have reached the maximum number of network tunnels for this organization.\nTo increase the limit, contact your administrator.\n","description":"Error message explaining the reason for failure"}}}}},"$$ref":"#/components/responses/Forbidden"},"404":{"description":"Not Found","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","minProperties":3,"required":["statusCode","error","txId"],"properties":{"statusCode":{"type":"integer","example":404,"description":"HTTP status code"},"error":{"type":"string","example":"Not Found","description":"A brief description of the error"},"txId":{"type":"string","example":"86e189a6-0124-47d3-a32c-25ff3f07deaf","description":"a unique hex number that can be used for debugging"}}}}},"$$ref":"#/components/responses/NotFound"},"500":{"description":"Internal Server Error","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","minProperties":3,"required":["statusCode","error","txId"],"properties":{"statusCode":{"type":"integer","example":500,"description":"HTTP status code"},"error":{"type":"string","example":"Internal Server Error","description":"a brief description of the error"},"txId":{"type":"string","example":"86e189a6-0124-47d3-a32c-25ff3f07deaf","description":"a unique hex number that can be used for debugging"}}}}},"$$ref":"#/components/responses/ServerError"}},"__originalOperationId":"getTunnelGlobalErrorEvents","method":"get","path":"/tunnels/{id}/globalEvents/sourceIp/{ip}"}}