SEsecurityscorecard
action plans

Create new overall score improvement plan

Changed on

Create new overall score improvement plan

post/plans/overall-score-improvement

Request

  • Base URL
    https://api.securityscorecard.io
  • URL
    https://api.securityscorecard.io/plans/overall-score-improvement
  • Auth
    API key in header Authorization

Request body

namestring

action plan name

descriptionstring

description

due_datestring date-time

due date

guestsstring[]

list of emails of guest users

Example request

{
  "name": "Example action plan",
  "description": "Example description",
  "due_date": "2020-01-01T00:00:00.000Z",
  "scorecard": "example.com",
  "target": {
    "overall_score": 95
  }
}

Response

created action plan id

idstring

action plan identifier

Example response

{
  "id": "aea7dae2-370f-4279-a458-4c7cb9661778"
}

Changes

  • b465b4846039Revision changes
    • breaking

      request body became required

    • breaking

      added the pattern ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$ to the request property

    • breaking

      the / request property type changed from number to integer

    • breaking

      the response property became optional for the status

    • breaking

      the response's property format changed from uuid to no format for status

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property / became optional

    • info

      media type application/json; charset=utf-8 was changed to application/json for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      the response's property pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ was added for the status