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

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

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

api

{
    "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-01-25",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-01-26",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-01-27",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-01-28",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-01-29",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-01-30",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-01-31",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-02-01",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-02-02",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-02-03",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-02-04",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-02-05",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-02-06",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-02-07",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-02-08",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-02-09",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-02-10",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-02-11",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-02-12",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-02-13",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-02-14",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-02-15",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-02-16",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-02-17",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-02-18",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-02-19",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-02-20",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-02-21",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-02-22",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-02-23",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-02-24",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-02-25",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-02-26",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-02-27",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-02-28",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-03-01",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-03-02",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-03-03",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-03-04",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-03-05",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-03-06",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-03-07",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-03-08",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-03-09",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-03-10",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-03-11",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-03-12",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-03-13",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-03-14",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-03-15",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-03-16",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-03-17",
            "target_count": 0,
            "issue_count": 0,
            "risk_score": 0,
            "port_count": 0
        },
        {
            "date": "2022-03-18",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        },
        {
            "date": "2022-03-19",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        },
        {
            "date": "2022-03-20",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        },
        {
            "date": "2022-03-21",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        },
        {
            "date": "2022-03-22",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        },
        {
            "date": "2022-03-23",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        },
        {
            "date": "2022-03-24",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        },
        {
            "date": "2022-03-25",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        },
        {
            "date": "2022-03-26",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        },
        {
            "date": "2022-03-27",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        },
        {
            "date": "2022-03-28",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        },
        {
            "date": "2022-03-29",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        },
        {
            "date": "2022-03-30",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        },
        {
            "date": "2022-03-31",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        },
        {
            "date": "2022-04-01",
            "target_count": 1,
            "issue_count": 1,
            "risk_score": 275,
            "port_count": 3
        },
        {
            "date": "2022-04-02",
            "target_count": 1,
            "issue_count": 1,
            "risk_score": 275,
            "port_count": 3
        },
        {
            "date": "2022-04-03",
            "target_count": 1,
            "issue_count": 1,
            "risk_score": 275,
            "port_count": 3
        },
        {
            "date": "2022-04-04",
            "target_count": 1,
            "issue_count": 1,
            "risk_score": 275,
            "port_count": 3
        },
        {
            "date": "2022-04-05",
            "target_count": 1,
            "issue_count": 1,
            "risk_score": 275,
            "port_count": 3
        },
        {
            "date": "2022-04-06",
            "target_count": 1,
            "issue_count": 1,
            "risk_score": 275,
            "port_count": 3
        },
        {
            "date": "2022-04-07",
            "target_count": 1,
            "issue_count": 1,
            "risk_score": 275,
            "port_count": 3
        },
        {
            "date": "2022-04-08",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        },
        {
            "date": "2022-04-09",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        },
        {
            "date": "2022-04-10",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        },
        {
            "date": "2022-04-11",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        },
        {
            "date": "2022-04-12",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        },
        {
            "date": "2022-04-13",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        },
        {
            "date": "2022-04-14",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        },
        {
            "date": "2022-04-15",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        },
        {
            "date": "2022-04-16",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        },
        {
            "date": "2022-04-17",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        },
        {
            "date": "2022-04-18",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        },
        {
            "date": "2022-04-19",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        },
        {
            "date": "2022-04-20",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        },
        {
            "date": "2022-04-21",
            "target_count": 1,
            "issue_count": 3,
            "risk_score": 1000,
            "port_count": 4
        },
        {
            "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

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

Last updated