SEsecurityscorecard
custom scorecards

Create a custom scorecard

Changed on

Create a custom scorecard

post/custom-scorecards

Request

  • Base URL
    https://api.securityscorecard.io
  • URL
    https://api.securityscorecard.io/custom-scorecards
  • Auth
    API key in header Authorization

Request body

namestring required

name of the custom scorecard

descriptionstring

description of the custom scorecard

managed_bystring

specify edit access levels of private (me only), team, or company

share_withstring

specify who can access this scorecard, if company wide or public to anyone in the platform

visibility_levelstring

specify who can see this scorecard, if private, company or public in the platform

team_idstring

unique identifier of the team that manages a custom scorecard

sourcesstring[] required

Source Scorecards list

Example request

{
  "name": "custom scorecard name",
  "description": "custom scorecard description",
  "managed_by": "private",
  "team_id": "eac3f898-4a47-41bf-9a6d-fa3cb5bd4762",
  "sources": [
    "['5f5e1b1b4b1f4b0001b1f4b0', 'cisco.com']"
  ],
  "filters": {
    "includes": [
      {
        "include": [
          {
            "condition": "is",
            "ip": [
              "['1.1.1.1', '192.168.0.1']"
            ],
            "domain": [
              "['example.com', 'example.org']"
            ],
            "country": [
              "['US', 'CA']"
            ],
            "footprint_tags": [
              "['eac3f898-4a47-41bf-9a6d-fa3cb5bd4762']"
            ],
            "associated_assets": [
              "['includes_domain', 'includes_ip']"
            ]
          }
        ]
      }
    ],
    "excludes": [
      {
        "condition": "is",
        "ip": [
          "['1.1.1.1', '192.168.0.1']"
        ],
        "domain": [
          "['example.com', 'example.org']"
        ],
        "country": [
          "['US', 'CA']"
        ],
        "footprint_tags": [
          "['eac3f898-4a47-41bf-9a6d-fa3cb5bd4762']"
        ],
        "associated_assets": [
          "['includes_domain', 'includes_ip']"
        ]
      }
    ],
    "issues": {
      "include": [
        "['api_key_exposed', 'age_exposed']"
      ],
      "exclude": [
        "['api_key_exposed', 'age_exposed']"
      ]
    }
  }
}

Response

Custom Scorecard

idstring required

custom scorecard id

uuidstring required

uuid to identify custom scorecard, same to id

namestring required

name of the custom scorecard

descriptionstring

description of the custom scorecard

managed_bystring

specify edit access levels of private (me only), team, or company

share_withstring

specify who can access this scorecard, if company wide or public to anyone in the platform

visibility_levelstring

specify who can see this scorecard, if private, company or public in the platform

owned_bystring

specify who owns the custom scorecard, only when managedBy value is private

is_entityboolean
customer_idstring required

the organization id of the user who created the custom scorecard

createdstring date-time required

created date

created_bystring required

user who created the object

updated_atstring date-time

created date

updated_bystring

user who updated the object

versionnumber required

Version number of Recipe field

sourcesstring[] required

Source Scorecards list

Example response

{
  "id": "aea7dae2-370f-4279-a458-4c7cb9661778",
  "uuid": "aea7dae2-370f-4279-a458-4c7cb9661778",
  "name": "custom scorecard name",
  "description": "custom scorecard description",
  "managed_by": "private",
  "share_with": "company",
  "owned_by": "user@example.com",
  "is_entity": true,
  "customer_id": "aea7dae2-370f-4279-a458-4c7cb9661778",
  "base": [
    {
      "domain": "securityscorecard.com",
      "name": "SecurityScorecard",
      "grade": "A",
      "score": 100
    }
  ],
  "filter": {
    "ips": [
      "['1.22.33.44']"
    ],
    "domains": [
      "['example.org']"
    ],
    "countries": [
      "['US']"
    ]
  },
  "bulk": [
    {
      "ips": [
        "['1.1.1.1']"
      ],
      "domains": [
        "['example.org']"
      ]
    }
  ],
  "created": "2020-01-01T00:00:00.000Z",
  "created_by": "user@example.com",
  "updated_at": "2020-01-01T00:00:00.000Z",
  "updated_by": "user@example.com",
  "version": 3,
  "sources": [
    "['5f5e1b1b4b1f4b0001b1f4b0', 'cisco.com']"
  ],
  "filters": {
    "includes": [
      {
        "include": [
          {
            "condition": "is",
            "ip": [
              "['1.1.1.1', '192.168.0.1']"
            ],
            "domain": [
              "['example.com', 'example.org']"
            ],
            "country": [
              "['US', 'CA']"
            ],
            "footprint_tags": [
              "['eac3f898-4a47-41bf-9a6d-fa3cb5bd4762']"
            ],
            "associated_assets": [
              "['includes_domain', 'includes_ip']"
            ]
          }
        ]
      }
    ],
    "excludes": [
      {
        "condition": "is",
        "ip": [
          "['1.1.1.1', '192.168.0.1']"
        ],
        "domain": [
          "['example.com', 'example.org']"
        ],
        "country": [
          "['US', 'CA']"
        ],
        "footprint_tags": [
          "['eac3f898-4a47-41bf-9a6d-fa3cb5bd4762']"
        ],
        "associated_assets": [
          "['includes_domain', 'includes_ip']"
        ]
      }
    ],
    "issues": {
      "include": [
        "['api_key_exposed', 'age_exposed']"
      ],
      "exclude": [
        "['api_key_exposed', 'age_exposed']"
      ]
    }
  }
}

Changes

  • b465b4846039Revision changes
    • breaking

      request property /// was restricted to a list of enum values

    • breaking

      request property ///// was restricted to a list of enum values

    • breaking

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

    • breaking

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

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      added the new includes_all enum value to the /// response property for the response status

    • warning

      added the new includes_all enum value to the ///// response property for the response status

    • warning

      added the new is enum value to the /// response property for the response status

    • warning

      added the new is enum value to the ///// response property for the response status

    • warning

      added the new is not enum value to the /// response property for the response status

    • warning

      added the new is not enum value to the ///// response property for the response status

    • warning

      added the new not enum value to the /// response property for the response status

    • warning

      added the new not enum value to the ///// response property for the response status

    • info

      added the new includes_all enum value to the request property ///

    • info

      added the new includes_all enum value to the request property /////

    • info

      added the new is enum value to the request property ///

    • info

      added the new is enum value to the request property /////

    • info

      added the new is not enum value to the request property ///

    • info

      added the new is not enum value to the request property /////

    • info

      added the new not enum value to the request property ///

    • info

      added the new not enum value to the request property /////

    • 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

    • info

      the response's property pattern was changed from ^\d{4}-\d{2}-\d{2}[ T]\d{2}:\d{2}:\d{2}\.{0,1}\d*Z$ to ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$ for the status

    • info

      the response's property pattern was changed from ^[\da-z-]{16,}$ to ^[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}$ for the status

    • info

      the response's property pattern was changed from ^\d{4}-\d{2}-\d{2}[ T]\d{2}:\d{2}:\d{2}\.{0,1}\d*Z$ to ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$ for the status

    • info

      the response's property pattern was changed from ^[\da-z-]{16,}$ to ^[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}$ for the status