Main Site HUB Security Scorecard API 8.6 Get A List of All Your Score Based Alerts

HUB

8.6 Get A List of All Your Score Based Alerts

Get A List of All Your Score Based Alerts

This API endpoint allows you to get a list of all your current score based alerts. You can check out the full specification for this endpoint here

Resource URI

/users/by-username/{username}/alerts/score

Parameters:

Name Required Description
Username Y The username of a user (ex: [email protected])

Sample Code:


            curl -X GET \
                https://api.securityscorecard.io/users/by-username/[email protected]/alerts/score \
                -H 'Accept: application/json' \
                -H 'Authorization: Token <Your API Key>' \
                -H 'Content-Type: application/json' \
                -H 'cache-control: no-cache'
        

Sample Response:


{
    "entries": [
        {
            "change_direction": "drops_below",
            "created_at": "2019-04-09T21:10:19.555Z",
            "id": "e1619f30-5b0b-11e9-a557-7b9551821617",
            "score_types": [
                "network_security"
            ],
            "target": [
                "any_followed_company"
            ],
            "threshold": 99,
            "updated_at": "2019-04-09T21:10:19.555Z"
        },
        {
            "change_direction": "rises_above",
            "created_at": "2019-04-22T22:43:43.399Z",
            "id": "14e71b70-6550-11e9-9792-fdf3636c72f0",
            "score_types": [
                "dns_health"
            ],
            "target": [
                "my_scorecard"
            ],
            "threshold": 75,
            "updated_at": "2019-04-22T22:43:43.399Z"
        },
        {
            "change_direction": "rises_above",
            "created_at": "2019-04-30T16:38:15.509Z",
            "id": "5a2aa050-6b66-11e9-b64b-e947bc0f95a6",
            "score_types": [
                "overall"
            ],
            "target": [
                "my_scorecard"
            ],
            "threshold": 90,
            "updated_at": "2019-04-30T16:38:15.509Z"
        }
    ]
}