Skip to content
GitmoapAPIBeta
Shipcatalog
PATCH/catalog/scorecards/{scorecard_id}

Amend a scorecard

update_scorecard
  • catalog:manage
    A token needs the catalog:manage scope: Declare, edit and delete catalog servicesGranted by write_api.Every operation this scope unlocks
  • Audited · mutation

    x-gitmoap-audit: {"kind":"audited","arg":"mutation"}

Changes only the fields you send, and results are recomputed against the new rubric shortly afterwards. Send the version you last read to have the change refused if someone else amended the scorecard since. Maintainers and above may amend it, but arming or disarming its campaign needs an Owner; arming starts the campaign's item count afresh.

Parameters

Path
  • scorecard_idScorecardId (string · uuid)The scorecard's id

Request body

application/json
  • applies_toServiceSelector or nulloptional
    • The ServiceSelector schema
    • annotationsobjectoptionalAnnotations a service must carry, as key–value pairs. Every entry must match; a service with extra annotations still matches.
    • kindsarray of ServiceKind: one of service | library | website | job | datastore | api | ml_model | otheroptional
    • lifecyclesarray of ServiceLifecycle: one of experimental | production | deprecated | retiredoptional
  • campaign_activeboolean or nulloptionalSwitches the campaign on or off. Unlike every other field here, changing it requires the Owner role, because switching it on can file work items across every covered service.
  • campaign_max_itemsinteger · int32 or nulloptional0–∞
  • checksarray of ScorecardCheck or nulloptional
    • The ScorecardCheck schema
    • keyCheckKey (string)The built-in check's key for a derived check; your own name for the check otherwise.
    • ruleCheckRule
    • configobjectoptionalThe check's own parameters, such as {"days": 90} for released_within. An unknown parameter is refused with a 400 rather than ignored.
    • creates_work_itembooleanoptionalWhether a failure opens a work item in the owning group's backlog. Off by default, and it takes effect only while the scorecard's campaign is active.
  • descriptionstring or nulloptional
  • enabledboolean or nulloptional
  • levelsarray of ScorecardLevel or nulloptional
  • namestring or nulloptional
  • slugScorecardSlug (string) or nulloptional
  • versioninteger · int64 or nulloptionalThe version you last read. When given and the scorecard has changed since, the update is refused with a 409.
Request body exampleSynthesized example
{}

Responses

200The amended scorecardapplication/json
  • applies_toServiceSelector
    • The ServiceSelector schema
    • annotationsobjectoptionalAnnotations a service must carry, as key–value pairs. Every entry must match; a service with extra annotations still matches.
    • kindsarray of ServiceKind: one of service | library | website | job | datastore | api | ml_model | otheroptional
    • lifecyclesarray of ServiceLifecycle: one of experimental | production | deprecated | retiredoptional
  • campaign_activebooleanWhether the scorecard's campaign is on. Checks that open work items on failure do so only while it is.
  • campaign_enforcedbooleanWhether the platform acts on campaign_active. Always true.
  • campaign_item_countinteger · int320–∞How many work items the campaign has filed since it was last switched on. Read-only.
  • campaign_max_itemsinteger · int320–∞How many work items the campaign may file each time it is switched on. The count starts from zero every time campaign_active is turned on.
  • checksarray of ScorecardCheck
    • The ScorecardCheck schema
    • keyCheckKey (string)The built-in check's key for a derived check; your own name for the check otherwise.
    • ruleCheckRule
    • configobjectoptionalThe check's own parameters, such as {"days": 90} for released_within. An unknown parameter is refused with a 400 rather than ignored.
    • creates_work_itembooleanoptionalWhether a failure opens a work item in the owning group's backlog. Off by default, and it takes effect only while the scorecard's campaign is active.
  • created_atstring
  • enabledboolean
  • namestring
  • scopeScopeRefThe owning scope — a group or a repository.
  • scorecard_idScorecardId (string · uuid)
  • slugScorecardSlug (string)
  • updated_atstring
  • versioninteger · int64The scorecard's revision, incremented on every change. Send it with an update to have the update refused with a 409 if someone changed the scorecard since you read it.
  • created_byActorSummary or nulloptional
  • descriptionstring or nulloptional
  • levelsarray of ScorecardLeveloptional
200 exampleSynthesized example
{
"applies_to": {
"annotations": {},
"kinds": [
"service",
"service"
],
"lifecycles": [
"experimental"
]
},
"campaign_active": false,
"campaign_enforced": false,
"campaign_item_count": 3,
"campaign_max_items": 34,
"checks": [
{
"key": "key-8bce",
"rule": {
"type": "derived"
}
}
],
"created_at": "2026-10-09T00:23:49Z",
"enabled": true,
"name": "payments-api",
"scope": {
"group": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69"
},
"scorecard_id": "217b158a-84d1-491a-94a4-6c19ec5c6824",
"slug": "slug-3454",
"updated_at": "2026-10-17T08:43:16Z",
"version": 85,
"created_by": {
"email": "lin@acme.example",
"id": "id-5e26",
"username": "lin",
"avatar_url": "https://gitmoap.example/acme/d8879381"
},
"description": "Renders each region as density contours of its operations.",
"levels": [
{
"name": "payments-api",
"required_check_keys": []
}
]
}
400Validation error, or a level requiring a check the amendment removedapplication/json
Error codes
  • BAD_REQUESTThe request is malformed: a parameter or a body field is not a well-formed value of its type
  • INVALID_BINDINGThe criterion binding is not well-formed
  • RESERVED_CHECK_KEYThe key names a check the platform implements; a check you report needs a key of its own
  • UNKNOWN_CHECKThe key names no check the platform implements
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
400 exampleSynthesized example
{
"error": {
"code": "code-4a95",
"message": "Label every synthesized example"
}
}
401Unauthenticated — no credential, or an invalid oneapplication/json
Error codes
  • UNAUTHORIZEDNo credential was sent, or the one sent is invalid, expired or revoked
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
401 exampleSynthesized example
{
"error": {
"code": "code-173f",
"message": "Draw the region map from operation density"
}
}
403Insufficient standing, or Owner required to change the campaign switchapplication/json
Error codes
  • FORBIDDENYou are signed in but may not do this here; reason names the permission or the rule that refused it
  • INSUFFICIENT_SCOPEThe access token lacks the scope this operation needs; required_scope names it
  • PERMISSION_REQUIREDYou need a permission you do not hold here; the message names it
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
403 exampleSynthesized example
{
"error": {
"code": "code-d2d7",
"message": "Stream pipeline status into the run header"
}
}
404No such scorecard, or it is not visibleapplication/json
Error codes
  • NOT_FOUNDThe resource does not exist — or exists and you cannot see it: a private resource you have no access to answers exactly as an absent one does
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
404 exampleSynthesized example
{
"error": {
"code": "code-7611",
"message": "Stream pipeline status into the run header"
}
}
409The scorecard was modified by someone elseapplication/json
Error codes
  • CONFLICTThe request conflicts with the resource's current state; reason says how
  • LEGAL_ACCEPTANCE_REQUIREDAccept the current Terms of Service before changing anything; reading stays open
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
409 exampleSynthesized example
{
"error": {
"code": "code-4aa1",
"message": "Draw the region map from operation density"
}
}

CLI

gitmoap catalog update-scorecard

  • --scorecard-ididThe scorecard's id
  • --applies-tojsonoptional
  • --campaign-activeflagoptionalSwitches the campaign on or off. Unlike every other field here, changing it requires the Owner role, because switching it on can file work items across every covered service.
  • --campaign-max-itemsnumberoptional
  • --checksjsonoptional
  • --descriptionstringoptional
  • --enabledflagoptional
  • --levelsjsonoptional
  • --namestringoptional
  • --slugstringoptional
  • --versionnumberoptionalThe `version` you last read. When given and the scorecard has changed since, the update is refused with a `409`.

Used in these guides