webMethods API Gateway¶
About¶
IBM webMethods API Gateway is a comprehensive solution for managing, securing, and monitoring APIs across their full lifecycle.
Product Details¶
Vendor URL: webMethods API Gateway
Product Type: Web API Gateway
Product Tier: Tier III
Integration Method: WEBHOOK
Parser Details¶
Log Format: JSON
Expected Normalization Rate: 100%
Data Label: WEBMETHODS_API_GATEWAY
UDM Fields (list of all UDM fields leveraged in the Parser):
| Log File Field | UDM Field |
|---|---|
| apiVersion | metadata.product_version |
| apiName | principal.resource.resource_subtype |
| applicationIp | principal.ip |
| applicationName | principal.application |
| httpMethod | network.http.method |
| responseCode | network.http.response_code |
| sourceGatewayNode | intermediary.ip |
| correlationID | additional.fields |
| operationName | additional.fields |
| errorDesc | security_result.description |
| sessionID | network.session_id |
| nativeURL | target.url |
| requestHeaders.Host | target.hostname |
| requestHeaders.X-Forwarded-Proto | network.application_protocol |
| responseHeaders.Connection | target.resource.attribute.labels |
| responseHeaders.Content-Security-Policy | target.resource.attribute.labels |
| responseHeaders.Content-Type | target.resource.attribute.labels |
| requestHeaders.Content-Type | principal.resource.attribute.labels |
| requestHeaders.Accept | principal.resource.attribute.labels |
| responseHeaders.Date | target.resource.attribute.labels |
| responseHeaders.Referrer-Policy | target.resource.attribute.labels |
| responseHeaders.Strict-Transport-Security | target.resource.attribute.labels |
| responseHeaders.x-frame-options | target.resource.attribute.labels |
| requestHeaders.Content-Length | principal.resource.attribute.labels |
| responseHeaders.Server | target.resource.attribute.labels |
| externalCalls.0.callDuration | network.session_duration.seconds |
| requestHeaders.user-agent | network.http.user_agent |
| requestHeaders.X-Forwarded-For | intermediary.ip |
| status | security_result.action |
| errorOrigin | about.labels |
| totalDataSize | about.labels |
| totalTime | about.labels |
| isCallbackRequest | about.labels |
Product Event Types¶
| Event | UDM Event Classification |
|---|---|
| TRANSACTIONAL | NETWORK_HTTP |
Log Sample¶
{"apiId":"7b4b3520-93b3-4503-b78e-24538440d53b","apiName":"EBX-API","apiVersion":"1.0","applicationId":"2bcde554-dd35-3456-9088-cdff13456677","applicationIp":"10.10.10.10","applicationName":"Digital Customer Profile Service","cachedResponse":"Not-Cached","correlationID":"APIGW:abcdefgh-855f-4079-8167-ebacc6216a76:123456","creationDate":1751971019467,"customFields":{},"errorOrigin":"NATIVE","eventType":"Transactional","externalCalls":[{"callDuration":9,"callEndTime":1751971019478,"callStartTime":1751971019469,"externalCallType":"NATIVE_SERVICE_CALL","externalURL":"https://backend-dcp.example.com/profiles/user123","responseCode":"404"}],"httpMethod":"put","isCallbackRequest":false,"messageType":null,"nativeHttpMethod":"PUT","nativeRequestHeaders":{"Accept":"application/json","Content-Length":"245","Via":"1.1 google","X-Cloud-Trace-Context":"c14dc44c8860c3137678e100ee4826b4/14417651021624123456","X-Forwarded-For":"10.10.10.10, 10.30.30.30","X-Forwarded-Proto":"https","accept-encoding":"gzip","content-type":"application/json; charset=utf-8","user-agent":"okhttp/5.0.0","x-ebx-auth":"EBX IjxwM663RUmoxjsY-q5e67D3"},"nativeRequestPayload":"","nativeResponseHeaders":{"Connection":"keep-alive","Content-Language":"en-US","Content-Security-Policy":"default-src 'self'; font-src * data: *.sample.co.uk; img-src * data: *.sample.co.uk; script-src * 'unsafe-inline' 'unsafe-eval'; style-src * 'unsafe-inline';","Content-Type":"application/json;charset=UTF-8","Date":"Tue, 08 Jul 2025 10:36:59 GMT","Referrer-Policy":"strict-origin","Server":"nginx","Strict-Transport-Security":"max-age=31536000; includeSubDomains","Transfer-Encoding":"chunked","X-Content-Type-Options":"nosniff","x-frame-options":"SAMEORIGIN"},"nativeResponsePayload":"","nativeURL":"https://backend-dcp.example.com/profiles/user123","operationName":"/data/v1/{dataspace}/{dataset}/root/Customer/{primaryKey}","origin":null,"packageId":null,"packageName":null,"planId":null,"planName":null,"providerTime":9,"queryParameters":{},"reqPayload":"","requestHeaders":{"Accept":"application/json","Connection":"Keep-Alive","Content-Length":"245","Host":"abc-prd.co.uk","Via":"1.1 google","X-Cloud-Trace-Context":"c14dc44c8860c3137678e100ee4826b4/14417651021624600132","X-Forwarded-For":"10.10.10.10, 10.30.30.30","X-Forwarded-Proto":"https","accept-encoding":"gzip","authorization":"**************","content-type":"application/json; charset=utf-8","user-agent":"okhttp/5.0.0","x-ebx-auth":"EBX AbcdefghIh-abc1234"},"resPayload":"","responseCode":"404","responseHeaders":{"Connection":"keep-alive","Content-Language":"en-US","Content-Security-Policy":"default-src 'self'; font-src * data: *.sample.co.uk; img-src * data: *.sample.co.uk; script-src * 'unsafe-inline' 'unsafe-eval'; style-src * 'unsafe-inline';","Content-Type":"application/json;charset=UTF-8","Date":"Tue, 08 Jul 2025 10:36:59 GMT","Referrer-Policy":"strict-origin","Server":"nginx","Strict-Transport-Security":"max-age=31536000; includeSubDomains","Transfer-Encoding":"chunked","X-Content-Type-Options":"nosniff","x-frame-options":"SAMEORIGIN"},"sourceGateway":"APIGateway","sourceGatewayDetails":null,"sourceGatewayNode":"10.20.30.40","status":"FAILURE","totalDataSize":430,"totalTime":12}
Sample Parsing¶
metadata.event_type = "NETWORK_HTTP"
metadata.vendor_name = "IBM"
metadata.product_name = "webMethods API Gateway"
metadata.product_version = "1.0"
principal.ip = "10.10.10.10"
principal.application = "Digital Customer Profile Service"
principal.resource.resource_subtype = "EBX-API"
target.hostname = "abc-prd.co.uk"
target.url= "https://backend-dcp.example.com/profiles/user123"
intermediary.ip = "10.20.30.40" "10.30.30.30"
security_result.action = BLOCK
network.session_duration.seconds = 9
network.application_protocol = HTTPS
network.http.method = "put"
network.http.user_agent = "okhttp/5.0.0"
network.http.response_code = 404