Scores Information

Get Score Summary for Scorecards

Securityx-api-key

Request

query Parameters

entity_identifier

required

string

Identifier for entity to get the scores for score card

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to.

Responses

200

Example response

get/v1/scores/summary

Request samples

curl
Java
Go

Response samples

application/json

{"scorecards_summary": [{"scorecard_name": "string",
"timestamp": 0,
"score": 0,
"checks_statuses": [{"reason": "string",
"identifier": "string",
"name": "string",
"custom": true,
"status": "PASS",
"weight": 0
}
],
"description": "string",
"scorecard_identifier": "string",
"recalibrate_info": {"start_time": 0,
"started_by": {"uuid": "string",
"name": "string",
"email": "string"
}
}
}
]
}

Get Scores for Scorecards

Securityx-api-key

Request

query Parameters

entity_identifier

required

string

Identifier for entity to get the scores for score card

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to.

Responses

200

Response for scorecards score

get/v1/scores

Request samples

curl
Java
Go

Response samples

application/json

{"scorecard_scores": [{"score": 0,
"description": "string",
"scorecard_name": "string"
}
],
"overall_score": 0
}

Get Aggregated Scores for backstage entities

Securityx-api-key

Request

header Parameters

Harness-Account

string

Identifier field of the account the resource is scoped to.

Request Body schema: application/json

kind required	string
type	string
owners	Array of strings
tags	Array of strings
lifecycle	Array of strings

Responses

200

Response for all the entity scores

post/v1/scores/aggregate

Request samples

Payload
curl
Java
Go

application/json

{"kind": "string",
"type": "string",
"owners": ["string"
],
"tags": ["string"
],
"lifecycle": ["string"
]
}

Response samples

application/json

[{"entity": {"name": "string",
"title": "string",
"kind": "string",
"namespace": "string",
"scores": [{"score": 0,
"description": "string",
"scorecard_name": "string"
}
]
}
}
]

➔ Next to dashboards