Security

The Security endpoint provides methods for viewing various security related metrics over time, such as your risk score.

Display your current risk score.

GET https://api.halosecurity.com/api/v1/security/risk-score.json

200: OK

{
    "request": {
        "target_count": 1,
        "sort": "1"
    },
    "risk_score": 1000
}

Display trends of your risk score, target, port, and issue counts over time.

GET https://api.halosecurity.com/api/v1/security/trend.json

api

200: OK

{
    "request": {
        "target_count": 1,
        "sort": "1"
    },
    "days": [
        {
            "date": "2022-01-22",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-01-23",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-01-24",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-04-22",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        }
}

Display a list of platforms that were detected.

GET https://api.halosecurity.com/api/v1/security/platform-list.json

200: OK

{
    "request": {
        "target_count": 1,
        "sort": "1"
    },
    "pagination": {
        "total": 1,
        "start": 0,
        "limit": 100
    },
    "list": [
        {
            "target_count": 1,
            "platform_id": 29,
            "platform_display": "AWS CloudFront"
        }
    ]
}