PingIntelligence

API Key Forensics REST API

The API Key forensics API provides forensics information for a API Key during a specified period. Information provided includes attack types, metrics, and anomaly details.

Method: GET

URL: /v4/abs?later_date=<>T<hh:mm>&earlier_date=<>T<hh:mm> &api_key=<api_key>

Header Value

Access Key

x-abs-ak

<string>

Secret Key

x-abs-sk

<string>

Sample response

{
    "company": "ping identity",
    "name": "api_abs_api_key",
    "description": "This report contains a summary and detailed information on metrics, attacks and anomalies for the specified api key across all APIs.",
    "earlier_date": "Sat Jan 12 13:30:00:000 2019",
    "later_date": "Tue Dec 31 18:00:00:000 2019",
    "summary": {
        "total_requests": 2621,
        "total_attacks": 1,
        "total_anomalies": 1
    },
    "details": {
        "metrics": {
            "api_key": "finite_api_key",
            "total_requests": 2621,
            "ip_list": [
                {
                    "ip": "192.168.2.2",
                    "total_requests": 457,
                    "devices": {
                        "UNKNOWN": 457
                    },
                    "methods": {
                        "GET": 457
                    },
                    "urls": {
                        "/atm_app/getzipcode": 457
                    },
                    "apis": {
                        "atm_app": 457
                    }
                },
                {
                    "ip": "192.168.2.1",
                    "total_requests": 560,
                    "devices": {
                        "UNKNOWN": 560
                    },
                    "methods": {
                        "GET": 560
                    },
                    "urls": {
                        "/atm_app/getzipcode": 560
                    },
                    "apis": {
                        "atm_app": 560
                    }
                },
                {
                    "ip": "192.168.2.3",
                    "total_requests": 404,
                    "devices": {
                        "UNKNOWN": 404
                    },
                    "methods": {
                        "GET": 404
                    },
                    "urls": {
                        "/atm_app/getzipcode": 404
                    },
                    "apis": {
                        "atm_app": 404
                    }
                },
                {
                    "ip": "192.168.2.5",
                    "total_requests": 1200,
                    "devices": {
                        "UNKNOWN": 1200
                    },
                    "methods": {
                        "GET": 1200
                    },
                    "urls": {
                        "/atm_app/getzipcode": 1200
                    },
                    "apis": {
                        "atm_app": 1200
                    }
                }
            ]
        },
        "attack_types": {
            "Stolen API Key Attack- Per API Key": [
                "all"
            ]
        },
        "anomaly_types": {
            "Stolen API Key Attack- Per API Key": [
                "all"
            ]
        }
    }
}