Skip to main content

Create or update Scorecard

POST 

/api/v1/scorecards/descriptor

Create or update a Scorecard using the descriptor YAML. The operation is determined by the existence of a Scorecard with the same tag as passed in the descriptor.

Request

Query Parameters

    dryRun boolean

    When true, this endpoint only validates the descriptor contents and returns any errors or warnings.

Body

Raw text of the YAML
See an example of a yaml file for scorecards here

    any

Responses

Created Scorecard

Schema
    scorecard objectrequired
    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.

    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 objectrequired

    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.

    rules object[]required

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

  • Array [
  • description string
    expression stringrequired

    CQL representation of the rule

    failureMessage string
    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

Loading...