Create a custom scorecard

post https://api.securityscorecard.io/custom-scorecards

time	status	user agent
Retrieving recent requests…

Loading…

Response

Response body

object

uuid

required

custom scorecard id

uuid

required

uuid to identify custom scorecard

name

string

required

name of the custom scorecard

description

string

description of the custom scorecard

managed_by

string

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

share_with

string

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

visibility_level

string

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

team_id

string

unique identifier of the team that manages a custom scorecard

owned_by

string

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

is_entity

boolean

has_write_permissions

boolean

The user has permissions to modify the custom scorecard

customer_id

string

required

the organization id of the user who created the custom scorecard

base

array of objects

required

collection of parent scorecards whose digital footprints were filtered in order to create a custom scorecard

base*

object

domain

string

domain of the custom scorecard

name

string

name of the custom scorecard

grade

string

grade of the custom scorecard

score

integer

score of the custom scorecard

filter

object

required

base footprint filters that make up a custom scorecard

ips

array of strings

required

collection of footprint ip filters

ips*

domains

array of strings

required

collection of footprint domain filters

domains*

countries

array of strings

collection of footprint country filters

countries

filter_toggle_setting

string

filter toggle setting

bulk

array of objects

optional footprint filters loaded in bulk from a file (CSV)

bulk

object

filename

string

required

name of the file used to load this bulk

excludes

boolean

true to exclude assets matching bulk filters (defaults to false, meaning, to include)

ips

array of strings

collection of footprint ip filters

ips

domains

array of strings

collection of footprint domain filters

domains

created

date-time

required

created date

created_by

string

required

user who created the custom scorecard

updated_at

date-time

updated date

updated_by

string

user who last updated the custom scorecard

grade

string

grade of the custom scorecard

score

number

score of the custom scorecard

provisional

boolean

true if a custom scorecard was scored by Fast Score

version

number

required

Version number of Recipe field

sources

array of strings

required

Source Scorecards list

sources*

filters

object

required

includes

array of objects

list of include filters to include

includes

object

index

number

index of the filter

include

array of objects

list of footprint filters to include

include

object

index

number

index of the filter

condition

string

condition to apply to the filter

array of strings

list of footprint ips filters to add

domain

array of strings

list of footprint domains filters to add

domain

country

array of strings

list of footprint countries filters to add

country

footprint_tags

array of strings

list of footprint tags filters to add

footprint_tags

associated_assets

array of strings

condition to apply to the filter

associated_assets

excludes

array of objects

list of footprint filters to exclude

excludes

object

index

number

index of the filter

condition

string

condition to apply to the filter

array of strings

list of footprint ips filters to add

domain

array of strings

list of footprint domains filters to add

domain

country

array of strings

list of footprint countries filters to add

country

footprint_tags

array of strings

list of footprint tags filters to add

footprint_tags

associated_assets

array of strings

condition to apply to the filter

associated_assets

issues

object

list of issues to filter

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.securityscorecard.io/custom-scorecards \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200response for creating a custom scorecard