v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Scorecards

Update an existing scorecard rule

Updates an existing rule.

put/api/v2/scorecard/rules/{rule_id}

Path parameters

rule_idstring required

The ID of the rule.

Request body

Example request

{
  "data": {
    "attributes": {
      "enabled": true,
      "level": 2,
      "name": "Team Defined",
      "scope_query": "kind:service",
      "scorecard_name": "Deployments automated via Deployment Trains"
    },
    "type": "rule"
  }
}

Response

Rule updated successfully

Example response

{
  "data": {
    "attributes": {
      "enabled": true,
      "level": 2,
      "name": "Team Defined",
      "scope_query": "kind:service",
      "scorecard_name": "Deployments automated via Deployment Trains"
    },
    "id": "q8MQxk8TCqrHnWkx",
    "relationships": {
      "scorecard": {
        "data": {
          "id": "q8MQxk8TCqrHnWkp",
          "type": "scorecard"
        }
      }
    },
    "type": "rule"
  }
}