List Scorecards

GET 
/api/v1/scorecards

List Scorecards

Request

Query Parameters

showDrafts boolean
page int32required

Default value: 0

Page number to return, 0-indexed. Default 0.

pageSize int32required

Default value: 250

Number of results to return per page, between 1 and 1000. Default 250.

Responses

200

OK

application/json

Schema

Schema

page int32required

Current page number, 0-indexed

scorecards

object[]

required

Array [

description string

Human-readable description of the Scorecard

evaluation

object

Evaluation window for how often the Scorecard is run

window int64

Number of hours between Scorecard evaluations. If the evaluation window is not set, the Scorecard is evaluated every 4 hours

exemptions

object

required

Exemptions settings for the Scorecard

autoApprove booleanrequired

This will enable auto-approving of Scorecard rule exemptions. If not set, it defaults to false.

enabled booleanrequired

This will enable Scorecard rule exemptions. If not set, it defaults to true.

filter

object

groups

object

Entity groups to include or exclude

exclude string[]

include string[]

query string

CQL expression to apply as a filter

types

object

Entity types (e.g. SERVICE, DOMAIN, TEAM) to include or exclude

exclude string[]

include string[]

isDraft booleanrequired

Whether or not the Scorecard is in draft

lastUpdated date-timerequired

Time the Scorecard was last updated, which includes setting the next evaluation time

levels

object[]

List of levels associated with the Scorecard

Array [

level

object

name stringrequired

Name of the level

number int32required

Rank of the level where 1 is the highest

]

name stringrequired

Human-readable name

notifications

object

required

Notification settings for the Scorecard

enabled booleanrequired

Whether this Scorecard should be included in notifications. If not set, it defaults to true for non-draft Scorecards and to false for draft Scorecards

scoreDropNotificationsEnabled booleanrequired

Whether to notify when an entities' score drops after a Scorecard evaluation. If not set, it defaults to false

rules

object[]

required

List of rules that are evaluated each time the Scorecard is evaluated

Array [

description string

effectiveFrom date-time

Date when the rule starts being evaluated

expression stringrequired

CQL representation of the rule

failureMessage string

filter

object

groups

object

Entity groups to include or exclude

exclude string[]

include string[]

query string

CQL expression to apply as a filter

types

object

Entity types (e.g. SERVICE, DOMAIN, TEAM) to include or exclude

exclude string[]

include string[]

identifier string

Unique identifier of the rule

levelName string

Name of the level this rule is associated with, if applicable

title string

weight number

Numerical weight of the rule. When using levels, this defaults to 1

]

tag stringrequired

Unique identifier, found in the UI

]

total int32required

Total number of results

totalPages int32required

Total number of pages

Example (from schema)

{
  "page": 0,
  "scorecards": [
    {
      "description": "string",
      "evaluation": {
        "window": 4
      },
      "exemptions": {
        "autoApprove": false,
        "enabled": true
      },
      "filter": {
        "groups": {
          "exclude": [
            "string"
          ],
          "include": [
            "string"
          ]
        },
        "query": "string",
        "types": {
          "exclude": [
            "string"
          ],
          "include": [
            "string"
          ]
        }
      },
      "isDraft": true,
      "lastUpdated": "2024-07-29T15:51:28.071Z",
      "levels": [
        {
          "level": {
            "name": "Bronze",
            "number": 0
          }
        }
      ],
      "name": "Production Readiness Scorecard",
      "notifications": {
        "enabled": true,
        "scoreDropNotificationsEnabled": true
      },
      "rules": [
        {
          "description": "This rule is very important because you must pass it",
          "effectiveFrom": "2024-01-01T00:00:00Z",
          "expression": "custom(\"key\") = \"value\"",
          "failureMessage": "To fix this rule, visit [our internal doc][docs.cortex.io]",
          "filter": {
            "groups": {
              "exclude": [
                "string"
              ],
              "include": [
                "string"
              ]
            },
            "query": "string",
            "types": {
              "exclude": [
                "string"
              ],
              "include": [
                "string"
              ]
            }
          },
          "identifier": "96db03f1-2529-3fc3-9f13-7fb4dd28f427",
          "levelName": "string",
          "title": "Key value must be correct",
          "weight": 0
        }
      ],
      "tag": "production-readiness-scorecard"
    }
  ],
  "total": 0,
  "totalPages": 0
}

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

Response Headers

• Retry-After

  integer

  The number of seconds until the rate limiting resets.

application/problem+json

Schema

Schema

detail string
instance uri-reference
retryAfter int32

The number of seconds until the rate limiting resets.

status int32required

Possible values: >= 100 and <= 599, [429]

title stringrequired
type uri-referencerequired

Example (from schema)

{
  "detail": "string",
  "instance": "string",
  "retryAfter": 0,
  "status": 429,
  "title": "string",
  "type": "string"
}

Loading...