Main Site HUB Security Scorecard API 8.7 Create A New Score Based Alerts

HUB

8.7 Create A New Score Based Alerts

Create A New Score Based Alerts

This API endpoint allows you to create an alert that is based on score changes. 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])
Change Direction Y The direction of the change you want to monitor: "rises_above" or "drops_below"
Threshold Y The score threshold. Ex: 70
Score Types Y What type of score to monitor, it could be one of the following values:

  • overall
  • any_factor_score

Or the factor scores to monitor

  • network_security
  • dns_health
  • patching_cadence
  • endpoint_security
  • ip_reputation
  • application_security
  • cubit_score
  • hacker_chatter
  • leaked_information
  • social_engineering
Target Y

What do you want to monitor with this alert setting, it could be one of the following values:

  • my_scorecard
  • any_followed_company
  • portfolio ids

Sample Code:


            curl -X POST \
                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' \
                -d '{"change_direction": "drops_below", "threshold": 70, "score_types": ["overall", "network_security", "patching_cadence" ], "target": ["my_scorecard"]}'
        

Sample Response:


{
    "id": "a3e9d750-c062-11e9-ac1b-9b935c6e7ffa"
}