Main Site HUB Security Scorecard API 8.3 Create A New Grade Based Alerts

HUB

8.3 Create A New Grade Based Alerts

This API endpoint allows you to create a alert that is based on grade changes. You can check out the full specification for this endpoint here

Resource URI

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

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" or "drops"
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/grade \
                -H 'Accept: application/json' \
                -H 'Authorization: Token <Your API Key>' \
                -H 'Content-Type: application/json' \
                -H 'cache-control: no-cache' \
                -d '{ "change_direction": "drops", "score_types": ["overall", "network_security", "patching_cadence" ], "target": ["my_scorecard"]}'
        

Sample Response:


{
    "id": "fbd3bd00-c05d-11e9-a55a-f717a63628a6"
}