When true, also delete historical check results on rule change. Current results are always deleted. Defaults to false.
Available options:
true,
false
Body
application/json
A check definition. Supports three types based on fields provided: rule-based (include rule field), manual (set type to manual), or external (omit both rule and type).
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Spotify for Backstage","colors":{"primary":"#34baa2","light":"#9af0e1","dark":"#91eeda"},"logo":{"light":"https://mintcdn.com/spotify-89f50c35/24doFeqc-xIrJKxF/static/logo/light.svg?fit=max\u0026auto=format\u0026n=24doFeqc-xIrJKxF\u0026q=85\u0026s=e7c3376851f302fc6d1308df15deb771","dark":"https://mintcdn.com/spotify-89f50c35/24doFeqc-xIrJKxF/static/logo/dark.svg?fit=max\u0026auto=format\u0026n=24doFeqc-xIrJKxF\u0026q=85\u0026s=a4e4bd6c0b855fc5959169face3701e1","href":"/"},"favicon":"https://mintcdn.com/spotify-89f50c35/6C5KyJhdlFRgXnE0/static/favicon.ico?fit=max\u0026auto=format\u0026n=6C5KyJhdlFRgXnE0\u0026q=85\u0026s=78c7096e52c0a4493c1d4b76355d22d9","api":{"playground":{"display":"simple"}},"appearance":{"default":"dark"},"navbar":{"links":[{"href":"https://backstage.spotify.com/contact-us/try-portal/","label":"Try Spotify Portal"}],"primary":{"type":"button","label":"Log in","href":"https://backstage.spotify.com/login/"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/showcase/spotify-r\u0026d","x":"https://twitter.com/spotifyeng","youtube":"https://www.youtube.com/@SpotifyRnD","instagram":"https://www.instagram.com/lifeatspotify","facebook":"https://www.facebook.com/spotify"},"links":[{"header":"Learn More","items":[{"label":"Go to backstage.spotify.com","href":"https://backstage.spotify.com"},{"label":"Explore the demo","href":"https://demo.backstage.io/catalog"},{"label":"Partner interest form","href":"https://backstage.spotify.com/interested-in-partnering"}]},{"header":"News \u0026 Updates","items":[{"label":"Read our blog","href":"https://backstage.spotify.com/blog"},{"label":"Subscribe to newsletter","href":"https://spoti.fi/backstagenewsletter"},{"label":"Portal system status","href":"https://status.spotifyportal.com"}]},{"header":"Community","items":[{"label":"Join the community","href":"https://github.com/backstage/community"},{"label":"Get Backstage Certified","href":"https://www.cncf.io/training/certification/cba"}]},{"header":"Legal","items":[{"label":"Security","href":"https://backstage.spotify.com/security"},{"label":"Privacy Policy","href":"https://backstage.spotify.com/spotify-for-backstage-terms/privacy-policy"},{"label":"Cookies","href":"https://www.spotify.com/legal/cookies-policy"},{"label":"Terms of Service","href":"https://backstage.spotify.com/terms-of-service"},{"label":"Trademark Usage","href":"https://www.linuxfoundation.org/legal/trademark-usage"}]}]},"seo":{"metatags":{"canonical":"https://backstage.spotify.com/docs"}},"fonts":{"heading":{"family":"Circular Sp","source":"https://mintlify-assets.b-cdn.net/fonts/CircularSpTitle-Bold.woff2","format":"woff2"},"body":{"family":"Circular Sp","source":"https://mintlify-assets.b-cdn.net/fonts/CircularSp-Book.woff2","format":"woff2"}},"styling":{"codeblocks":{"theme":{"light":"github-light","dark":"dracula"}},"latex":false},"integrations":{"gtm":{"tagId":"GTM-58S6R55"},"telemetry":{"enabled":false}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"global":{"anchors":[{"anchor":"Contact us","icon":"headset","href":"https://backstage.spotify.com/contact-us/talk-to-us/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"spotify-89f50c35","hasAudioNarration":false,"actualSubdomain":"spotify-89f50c35","customDomains":["backstage.spotify.com"],"gitSource":{"type":"github","owner":"backstage-external","repo":"spotify-for-backstage-docs","deployBranch":"main","contentDirectory":"public","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af5c8c1bb452cd0b1db62ad","clientVersion":"0.0.4117","searchFilterCounts":[{"language":"default","tag":"Portal","count":140},{"language":"default","tag":"Plugins","count":111},{"language":"default","tag":"Soundcheck","count":88},{"language":"default","tag":"Portal Features \u0026 Plugins","count":88},{"language":"default","tag":"API Reference","count":45},{"language":"default","tag":"Integrations","count":35},{"language":"default","tag":"Guides","count":34},{"language":"default","tag":"Core Concepts","count":31},{"language":"default","tag":"Checks","count":19},{"language":"default","tag":"Fact Collectors","count":16}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"backstage-support@spotify.com","showHelpButton":true}},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"body{--font-jetbrains-mono:\n 'JetBrains Mono', SF Mono, SFMono-Regular, Menlo, Monaco, Cascadia Mono,\n Segoe UI Mono, Roboto Mono, Oxygen Mono, Ubuntu Monospace, Source Code Pro,\n Fira Mono, Droid Sans Mono, Consolas, Courier New, monospace}#topbar-cta-button svg path{stroke:#000000}#topbar-cta-button span{color:#000000}#content:has(.video-overlay){isolation:auto}.landing-page-card{transition:all 0.3s cubic-bezier(0.4, 0, 0.2, 1);backdrop-filter:blur(12px);border-width:2px;background-color:rgb(255 255 255)}.landing-page-card:is(.dark *){background-color:rgb(255 255 255 / 0.1)}.landing-page-card:hover{transform:translateY(-0.25rem)}.landing-page-card [data-component-part=\"card-icon\"],.landing-page-card [data-component-part=\"card-icon\"]>img{width:48px;height:48px}.landing-page-card h2{font-size:1.5rem;margin-bottom:1rem;font-weight:600}"}],"page":{"pagePath":"plugins/soundcheck/api-reference/checks/update-a-check","slug":"/plugins/soundcheck/api-reference/checks/update-a-check","pageMetadata":{"title":"Update a check","description":"Update a check by id. Supports three check types based on the fields provided:\n- **Rule-based** (default): include a `rule` field with fact conditions. Soundcheck evaluates these automatically.\n- **Manual**: set `type: \"manual\"`. Results are entered by humans via the Soundcheck UI.\n- **External**: omit both `rule` and `type`. An external system pushes results via POST /results.\n","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml put /checks/{checkId}","href":"/plugins/soundcheck/api-reference/checks/update-a-check","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Update a check by id. Supports three check types based on the fields provided:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Rule-based\"\n }), \" (default): include a \", _jsx(_components.code, {\n children: \"rule\"\n }), \" field with fact conditions. Soundcheck evaluates these automatically.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Manual\"\n }), \": set \", _jsx(_components.code, {\n children: \"type: \\\"manual\\\"\"\n }), \". Results are entered by humans via the Soundcheck UI.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"External\"\n }), \": omit both \", _jsx(_components.code, {\n children: \"rule\"\n }), \" and \", _jsx(_components.code, {\n children: \"type\"\n }), \". An external system pushes results via POST /results.\"]\n }), \"\\n\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"github-light","dark":"dracula"}},"config":{},"pageMetadata":{"title":"Update a check","description":"Update a check by id. Supports three check types based on the fields provided:\n- **Rule-based** (default): include a `rule` field with fact conditions. Soundcheck evaluates these automatically.\n- **Manual**: set `type: \"manual\"`. Results are entered by humans via the Soundcheck UI.\n- **External**: omit both `rule` and `type`. An external system pushes results via POST /results.\n","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml put /checks/{checkId}","href":"/plugins/soundcheck/api-reference/checks/update-a-check","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"updateCheck","summary":"Update a check","tags":["Checks"],"description":"Update a check by id. Supports three check types based on the fields provided:\n- **Rule-based** (default): include a `rule` field with fact conditions. Soundcheck evaluates these automatically.\n- **Manual**: set `type: \"manual\"`. Results are entered by humans via the Soundcheck UI.\n- **External**: omit both `rule` and `type`. An external system pushes results via POST /results.\n","parameters":["254c22d7-7d89-4fa6-94c5-fd56d8954974","bba73a18-4a71-4fc8-99fd-95f3fd03a91a"],"requestBody":"c5c74f2e-b6c7-4fa3-98d9-78100103b88d","responses":{"200":"51101b89-e798-45d1-b2b9-a16b5150a332","400":"6c4d8d11-deb0-47f6-a434-ef13dc601c07","403":"562b0368-116b-44ac-8761-a3225ccfc744"},"method":"put","type":"path","servers":["59925ce5-6164-44b8-9168-9b125b464937"],"security":[],"path":"/checks/{checkId}","baseUrlOptions":["https://backstage.example.com/api/soundcheck"],"title":"Update a check","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"254c22d7-7d89-4fa6-94c5-fd56d8954974":{"name":"checkId","in":"path","description":"The ID of the check","required":true,"schema":{"type":"string","isRequired":true,"description":"The ID of the check","uniqueKey":"","typeLabel":"string"}},"bba73a18-4a71-4fc8-99fd-95f3fd03a91a":{"name":"deleteHistory","in":"query","description":"When true, also delete historical check results on rule change. Current results are always deleted. Defaults to false.","required":false,"schema":{"type":"string","enum":["true","false"],"default":"false","isRequired":false,"description":"When true, also delete historical check results on rule change. Current results are always deleted. Defaults to false.","uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"A check definition. Supports three types based on fields provided: rule-based (include rule field), manual (set type to manual), or external (omit both rule and type).\n","type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"ownerEntityRef":{"type":"string","uniqueKey":"ownerEntityRef","typeLabel":"string"},"name":{"type":"string","minLength":1,"maxLength":100,"uniqueKey":"name","typeLabel":"string"},"description":{"type":"string","uniqueKey":"description","typeLabel":"string"},"filter":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"filter.oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"filter.oneOf.0.additionalProperties.oneOf.1.items.[INDEX]","typeLabel":"string"},"uniqueKey":"filter.oneOf.0.additionalProperties.oneOf.1","typeLabel":"string[]"}],"uniqueKey":"filter.oneOf.0.additionalProperties","typeLabel":"string | string[]"},"uniqueKey":"filter.oneOf.0","typeLabel":"object"},{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"filter.oneOf.1.items.[INDEX].additionalProperties.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"filter.oneOf.1.items.[INDEX].additionalProperties.oneOf.1.items.[INDEX]","typeLabel":"string"},"uniqueKey":"filter.oneOf.1.items.[INDEX].additionalProperties.oneOf.1","typeLabel":"string[]"}],"uniqueKey":"filter.oneOf.1.items.[INDEX].additionalProperties","typeLabel":"string | string[]"},"uniqueKey":"filter.oneOf.1.items.[INDEX]","typeLabel":"object"},"uniqueKey":"filter.oneOf.1","typeLabel":"object[]"}],"uniqueKey":"filter","typeLabel":"object | object[]"},"filterQuery":{"description":"Advanced filter predicate with logical operators ($all, $any, $not) and value matchers ($exists, $in, $contains, $hasPrefix).","type":"object","additionalProperties":true,"uniqueKey":"filterQuery","typeLabel":"object"},"exclude":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"exclude.oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"exclude.oneOf.0.additionalProperties.oneOf.1.items.[INDEX]","typeLabel":"string"},"uniqueKey":"exclude.oneOf.0.additionalProperties.oneOf.1","typeLabel":"string[]"}],"uniqueKey":"exclude.oneOf.0.additionalProperties","typeLabel":"string | string[]"},"uniqueKey":"exclude.oneOf.0","typeLabel":"object"},{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"exclude.oneOf.1.items.[INDEX].additionalProperties.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"exclude.oneOf.1.items.[INDEX].additionalProperties.oneOf.1.items.[INDEX]","typeLabel":"string"},"uniqueKey":"exclude.oneOf.1.items.[INDEX].additionalProperties.oneOf.1","typeLabel":"string[]"}],"uniqueKey":"exclude.oneOf.1.items.[INDEX].additionalProperties","typeLabel":"string | string[]"},"uniqueKey":"exclude.oneOf.1.items.[INDEX]","typeLabel":"object"},"uniqueKey":"exclude.oneOf.1","typeLabel":"object[]"}],"uniqueKey":"exclude","typeLabel":"object | object[]"},"rule":{"description":"Fact checker rule (required for rule-based checks, omit for manual/external)","type":"object","uniqueKey":"rule","typeLabel":"object"},"applicable":{"description":"Applicability condition","type":"object","uniqueKey":"applicable","typeLabel":"object"},"type":{"description":"Check type. Set to 'manual' for manual checks, 'default' or omit for rule-based checks.","type":"string","enum":["default","manual"],"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"warning":{"type":"boolean","uniqueKey":"warning","typeLabel":"boolean"},"passedMessage":{"type":"string","minLength":1,"uniqueKey":"passedMessage","typeLabel":"string"},"failedMessage":{"type":"string","minLength":1,"uniqueKey":"failedMessage","typeLabel":"string"},"notApplicableMessage":{"type":"string","minLength":1,"uniqueKey":"notApplicableMessage","typeLabel":"string"},"pathResolver":{"type":"string","uniqueKey":"pathResolver","typeLabel":"string"},"skillEntityRef":{"type":"string","uniqueKey":"skillEntityRef","typeLabel":"string"}},"required":["id"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","ownerEntityRef":"\u003cstring>","name":"\u003cstring>","description":"\u003cstring>","filter":{},"filterQuery":{},"exclude":{},"rule":{},"applicable":{},"warning":true,"passedMessage":"\u003cstring>","failedMessage":"\u003cstring>","notApplicableMessage":"\u003cstring>","pathResolver":"\u003cstring>","skillEntityRef":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"51101b89-e798-45d1-b2b9-a16b5150a332":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"check":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"check.id","typeLabel":"string"},"ownerEntityRef":{"type":"string","uniqueKey":"check.ownerEntityRef","typeLabel":"string"},"name":{"type":"string","minLength":1,"maxLength":100,"uniqueKey":"check.name","typeLabel":"string"},"description":{"type":"string","uniqueKey":"check.description","typeLabel":"string"},"filter":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"check.filter.oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"check.filter.oneOf.0.additionalProperties.oneOf.1.items.[INDEX]","typeLabel":"string"},"uniqueKey":"check.filter.oneOf.0.additionalProperties.oneOf.1","typeLabel":"string[]"}],"uniqueKey":"check.filter.oneOf.0.additionalProperties","typeLabel":"string | string[]"},"uniqueKey":"check.filter.oneOf.0","typeLabel":"object"},{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"check.filter.oneOf.1.items.[INDEX].additionalProperties.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"check.filter.oneOf.1.items.[INDEX].additionalProperties.oneOf.1.items.[INDEX]","typeLabel":"string"},"uniqueKey":"check.filter.oneOf.1.items.[INDEX].additionalProperties.oneOf.1","typeLabel":"string[]"}],"uniqueKey":"check.filter.oneOf.1.items.[INDEX].additionalProperties","typeLabel":"string | string[]"},"uniqueKey":"check.filter.oneOf.1.items.[INDEX]","typeLabel":"object"},"uniqueKey":"check.filter.oneOf.1","typeLabel":"object[]"}],"uniqueKey":"check.filter","typeLabel":"object | object[]"},"filterQuery":{"description":"Advanced filter predicate with logical operators ($all, $any, $not) and value matchers ($exists, $in, $contains, $hasPrefix).","type":"object","additionalProperties":true,"uniqueKey":"check.filterQuery","typeLabel":"object"},"exclude":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"check.exclude.oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"check.exclude.oneOf.0.additionalProperties.oneOf.1.items.[INDEX]","typeLabel":"string"},"uniqueKey":"check.exclude.oneOf.0.additionalProperties.oneOf.1","typeLabel":"string[]"}],"uniqueKey":"check.exclude.oneOf.0.additionalProperties","typeLabel":"string | string[]"},"uniqueKey":"check.exclude.oneOf.0","typeLabel":"object"},{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"check.exclude.oneOf.1.items.[INDEX].additionalProperties.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"check.exclude.oneOf.1.items.[INDEX].additionalProperties.oneOf.1.items.[INDEX]","typeLabel":"string"},"uniqueKey":"check.exclude.oneOf.1.items.[INDEX].additionalProperties.oneOf.1","typeLabel":"string[]"}],"uniqueKey":"check.exclude.oneOf.1.items.[INDEX].additionalProperties","typeLabel":"string | string[]"},"uniqueKey":"check.exclude.oneOf.1.items.[INDEX]","typeLabel":"object"},"uniqueKey":"check.exclude.oneOf.1","typeLabel":"object[]"}],"uniqueKey":"check.exclude","typeLabel":"object | object[]"},"skillEntityRef":{"type":"string","uniqueKey":"check.skillEntityRef","typeLabel":"string"}},"required":["id"],"additionalProperties":false,"isRequired":true,"uniqueKey":"check","typeLabel":"object"}},"required":["check"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"check":{"id":"\u003cstring>","ownerEntityRef":"\u003cstring>","name":"\u003cstring>","description":"\u003cstring>","filter":{},"filterQuery":{},"exclude":{},"skillEntityRef":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"6c4d8d11-deb0-47f6-a434-ef13dc601c07":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"error.name","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["name","message"],"additionalProperties":true,"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"response":{"type":"object","properties":{"statusCode":{"type":"integer","isRequired":true,"uniqueKey":"response.statusCode","typeLabel":"integer"}},"required":["statusCode"],"additionalProperties":false,"isRequired":true,"uniqueKey":"response","typeLabel":"object"},"request":{"type":"object","properties":{"method":{"type":"string","isRequired":true,"uniqueKey":"request.method","typeLabel":"string"},"url":{"type":"string","isRequired":true,"uniqueKey":"request.url","typeLabel":"string"}},"required":["method","url"],"additionalProperties":false,"uniqueKey":"request","typeLabel":"object"}},"required":["error","response"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"name":"\u003cstring>","message":"\u003cstring>"},"response":{"statusCode":123},"request":{"method":"\u003cstring>","url":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"562b0368-116b-44ac-8761-a3225ccfc744":{"description":"No permission to update check or check not found","content":{"text/plain":{"schema":{"type":"string","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"\u003cstring>"}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"59925ce5-6164-44b8-9168-9b125b464937":{"url":"https://backstage.example.com/api/soundcheck"}}},"originalFileLocation":"plugins/soundcheck/openapi.yaml"},"subdomain":"spotify-89f50c35","siteName":"Spotify for Backstage","title":"Update a check - Spotify for Backstage","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-21T14:16:41.721Z","originalFileLocation":"plugins/soundcheck/api-reference/checks/update-a-check.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Update a check by id. Supports three check types based on the fields provided: - Rule-based (default): include a rule field with fact conditions. Soundcheck evaluates these automatically. - Manual: set type: \u0026quot;manual\u0026quot;. Results are entered by humans via the Soundcheck UI. - External: omit both rule and type. An external system pushes results via POST /results.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Spotify for Backstage\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/spotify-89f50c35/R_8z5ScClO7v3nRq/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/spotify-89f50c35/R_8z5ScClO7v3nRq/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/spotify-89f50c35/R_8z5ScClO7v3nRq/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/spotify-89f50c35/R_8z5ScClO7v3nRq/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/spotify-89f50c35/R_8z5ScClO7v3nRq/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/spotify-89f50c35/R_8z5ScClO7v3nRq/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/spotify-89f50c35/R_8z5ScClO7v3nRq/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/spotify-89f50c35/R_8z5ScClO7v3nRq/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/spotify-89f50c35/R_8z5ScClO7v3nRq/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update a check - Spotify for Backstage\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update a check by id. Supports three check types based on the fields provided: - Rule-based (default): include a rule field with fact conditions. Soundcheck evaluates these automatically. - Manual: set type: \u0026quot;manual\u0026quot;. Results are entered by humans via the Soundcheck UI. - External: omit both rule and type. An external system pushes results via POST /results.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Spotify for Backstage\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checks/update-a-check\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://spotify-89f50c35.mintlify.site/docs/_mintlify/api/og/v2?division=Checks\u0026amp;title=Update+a+check\u0026amp;description=Update+a+check+by+id.+Supports+three+check+types+based+on+the+fields+provided%3A%0A-+**Rule-based**+%28default%29%3A+include+a+%60rule%60+field+with+fact+conditions.+Soundche\u0026amp;theme=a6f41037062b0a3b3eab7f14\u0026amp;signature=d1ca5800681d2dd581f0b7b53cb2de2e7776e5449b3872322be787255476e051\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update a check - Spotify for Backstage\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update a check by id. Supports three check types based on the fields provided: - Rule-based (default): include a rule field with fact conditions. Soundcheck evaluates these automatically. - Manual: set type: \u0026quot;manual\u0026quot;. Results are entered by humans via the Soundcheck UI. - External: omit both rule and type. An external system pushes results via POST /results.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://spotify-89f50c35.mintlify.site/docs/_mintlify/api/og/v2?division=Checks\u0026amp;title=Update+a+check\u0026amp;description=Update+a+check+by+id.+Supports+three+check+types+based+on+the+fields+provided%3A%0A-+**Rule-based**+%28default%29%3A+include+a+%60rule%60+field+with+fact+conditions.+Soundche\u0026amp;theme=a6f41037062b0a3b3eab7f14\u0026amp;signature=d1ca5800681d2dd581f0b7b53cb2de2e7776e5449b3872322be787255476e051\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/spotify-89f50c35/R_8z5ScClO7v3nRq/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Spotify for Backstage\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#34baa2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checks/update-a-check\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/plugins/soundcheck/api-reference/checks/update-a-check.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://backstage.spotify.com/#organization\",\"name\":\"Spotify for Backstage\",\"url\":\"https://backstage.spotify.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/spotify-89f50c35/24doFeqc-xIrJKxF/static/logo/light.svg?fit=max\u0026auto=format\u0026n=24doFeqc-xIrJKxF\u0026q=85\u0026s=e7c3376851f302fc6d1308df15deb771\"}},{\"@type\":\"WebSite\",\"@id\":\"https://backstage.spotify.com/docs#website\",\"name\":\"Spotify for Backstage\",\"url\":\"https://backstage.spotify.com/docs\",\"publisher\":{\"@id\":\"https://backstage.spotify.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checks/update-a-check#webpage\",\"url\":\"https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checks/update-a-check\",\"name\":\"Update a check\",\"description\":\"Update a check by id. Supports three check types based on the fields provided: - Rule-based (default): include a rule field with fact conditions. Soundcheck evaluates these automatically. - Manual: set type: \\\"manual\\\". Results are entered by humans via the Soundcheck UI. - External: omit both rule and type. An external system pushes results via POST /results.\",\"dateModified\":\"2026-10-21T14:16:41.721Z\",\"isPartOf\":{\"@id\":\"https://backstage.spotify.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checks/update-a-check#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checks/update-a-check#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Soundcheck\",\"item\":\"https://backstage.spotify.com/docs/plugins/soundcheck\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Reference\",\"item\":\"https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/campaigns/get-campaigns\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Checks\",\"item\":\"https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checks/get-checks\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Update a check\",\"item\":\"https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checks/update-a-check\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checks/update-a-check#apireference\",\"headline\":\"Update a check\",\"name\":\"Update a check\",\"description\":\"Update a check by id. Supports three check types based on the fields provided: - Rule-based (default): include a rule field with fact conditions. Soundcheck evaluates these automatically. - Manual: set type: \\\"manual\\\". Results are entered by humans via the Soundcheck UI. - External: omit both rule and type. An external system pushes results via POST /results.\",\"url\":\"https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checks/update-a-check\",\"mainEntityOfPage\":{\"@id\":\"https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checks/update-a-check#webpage\"},\"dateModified\":\"2026-10-21T14:16:41.721Z\",\"publisher\":{\"@id\":\"https://backstage.spotify.com/#organization\"},\"isPartOf\":{\"@id\":\"https://backstage.spotify.com/docs#website\"}}]}\u003c/script>","agentPointerHref":"/docs/plugins/soundcheck/api-reference/checks/update-a-check.md","siteName":"Spotify for Backstage","nav":{"global":{"anchors":[{"anchor":"Contact us","icon":"headset","href":"https://backstage.spotify.com/contact-us/talk-to-us/"}]},"tabs":[{"tab":"Portal","pages":[{"title":"Portal","href":"/portal"}]},{"tab":"Plugins","pages":[{"title":"Spotify Plugins for Backstage","href":"/plugins"},{"group":"Getting Started","root":{"title":"Getting Started Guide","sidebarTitle":"Getting started with Plugins for Backstage","href":"/plugins/getting-started/index"},"pages":[{"title":"AWS Marketplace","sidebarTitle":"Buy Plugins on AWS Marketplace","href":"/plugins/getting-started/aws-marketplace"}]},{"group":"Soundcheck","root":{"title":"Soundcheck","sidebarTitle":"Overview","href":"/plugins/soundcheck/index"},"pages":[{"title":"Installation \u0026 Setup","href":"/plugins/soundcheck/setup-and-installation"},{"group":"Core Concepts","root":{"title":"Core Concepts","href":"/plugins/soundcheck/core-concepts/index"},"pages":[{"group":"Checks","root":{"title":"Checks","sidebarTitle":"Overview","href":"/plugins/soundcheck/core-concepts/checks/index"},"pages":[{"title":"Manual Checks","href":"/plugins/soundcheck/core-concepts/checks/manual-checks"},{"title":"Multi-Fact Checks","sidebarTitle":"Multi-Fact Checks","href":"/plugins/soundcheck/core-concepts/checks/multi-fact-checks"},{"title":"Check Exemptions","sidebarTitle":"Check Exemptions","href":"/plugins/soundcheck/core-concepts/checks/check-exemptions"}]},{"title":"Tracks","href":"/plugins/soundcheck/core-concepts/tracks"},{"title":"Campaigns","href":"/plugins/soundcheck/core-concepts/campaigns"},{"title":"Filters","href":"/plugins/soundcheck/core-concepts/filters"},{"title":"Check Results","href":"/plugins/soundcheck/core-concepts/checkResults"},{"group":"Fact Collectors","root":{"title":"Fact Collectors","sidebarTitle":"Overview","href":"/plugins/soundcheck/core-concepts/fact-collectors/index"},"pages":[{"group":"Integrations","pages":[{"title":"Azure DevOps","href":"/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/azure"},{"title":"BigQuery","sidebarTitle":"BigQuery","href":"/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/bigquery"},{"title":"Catalog","sidebarTitle":"Catalog","href":"/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/catalog"},{"title":"Datadog","href":"/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/datadog"},{"title":"Data Registry","sidebarTitle":"Data Registry (Portal)","href":"/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/data-registry"},{"title":"GitHub","href":"/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/github"},{"title":"GitLab","href":"/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/gitlab"},{"title":"HTTP","sidebarTitle":"HTTP","href":"/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/http"},{"title":"Jira","sidebarTitle":"Jira","href":"/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/jira"},{"title":"Kubernetes","href":"/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/kubernetes"},{"title":"NewRelic","href":"/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/newrelic"},{"title":"PagerDuty","href":"/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/pagerduty"},{"title":"Source Control Management","href":"/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/scm"},{"title":"SonarQube","href":"/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/sonarqube"},{"title":"Soundcheck","href":"/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/soundcheck"},{"title":"Tech Insights","href":"/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/techinsights"}]}]},{"title":"Check Insights Page Overview","sidebarTitle":"Check Insights","href":"/plugins/soundcheck/core-concepts/check-insights"},{"title":"Track Insights Page Overview","sidebarTitle":"Track Insights","href":"/plugins/soundcheck/core-concepts/track-insights"},{"title":"Campaign Insights Page Overview","sidebarTitle":"Campaign Insights","href":"/plugins/soundcheck/core-concepts/campaign-insights"},{"title":"Tech Insights","sidebarTitle":"Tech Insights","href":"/plugins/soundcheck/core-concepts/tech-insights"},{"title":"Events","href":"/plugins/soundcheck/core-concepts/events"},{"title":"Notifications","href":"/plugins/soundcheck/core-concepts/notifications"}]},{"group":"Using Soundcheck","pages":[{"title":"Entity Card","href":"/plugins/soundcheck/soundcheck-elements/soundcheck-entity-card"},{"title":"Entity Tab","href":"/plugins/soundcheck/soundcheck-elements/soundcheck-entity-tab"}]},{"group":"Tutorials","pages":[{"title":"Creating a Custom Third-Party Integration","href":"/plugins/soundcheck/tutorials/custom-fact-collector"},{"title":"Creating a Custom No-Code UI for a Third-Party Integration","href":"/plugins/soundcheck/tutorials/custom-fact-collector-ncui"},{"title":"Start Measuring Catalog Maturity in 1 hour with the SCM Compliance Track","href":"/plugins/soundcheck/tutorials/start-measuring-catalog-maturity"},{"title":"Climb the maturity ladder with the Recommended Source Control Track","href":"/plugins/soundcheck/tutorials/climb-the-maturity-ladder-with-the-recommended-source-control-track"},{"title":"Start to enable your experts to manage maturity progress","href":"/plugins/soundcheck/tutorials/start-to-enable-your-experts-to-manage-maturity-progress"}]},{"group":"API Reference","pages":[{"group":"Campaigns","pages":[{"title":"Get campaigns","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml get /campaigns","href":"/plugins/soundcheck/api-reference/campaigns/get-campaigns"},{"title":"Create campaigns","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml post /campaigns","href":"/plugins/soundcheck/api-reference/campaigns/create-campaigns"},{"title":"Get campaign entities","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml post /campaigns/entities","href":"/plugins/soundcheck/api-reference/campaigns/get-campaign-entities"},{"title":"Get a campaign","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml get /campaigns/{campaignId}","href":"/plugins/soundcheck/api-reference/campaigns/get-a-campaign"},{"title":"Update a campaign","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml put /campaigns/{campaignId}","href":"/plugins/soundcheck/api-reference/campaigns/update-a-campaign"},{"title":"Delete a campaign","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml delete /campaigns/{campaignId}","href":"/plugins/soundcheck/api-reference/campaigns/delete-a-campaign"}]},{"group":"Certification","pages":[{"title":"Get certifications for an entity","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml get /certifications","href":"/plugins/soundcheck/api-reference/certification/get-certifications-for-an-entity"},{"title":"Certify world","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml post /certify_world","href":"/plugins/soundcheck/api-reference/certification/certify-world"}]},{"group":"Checks","pages":[{"title":"Get checks","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml get /checks","href":"/plugins/soundcheck/api-reference/checks/get-checks"},{"title":"Create checks","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml post /checks","href":"/plugins/soundcheck/api-reference/checks/create-checks"},{"title":"Get check entities","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml post /checks/entities","href":"/plugins/soundcheck/api-reference/checks/get-check-entities"},{"title":"Execute checks","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml post /checks/execute","href":"/plugins/soundcheck/api-reference/checks/execute-checks"},{"title":"Get exemptions","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml get /checks/exemptions","href":"/plugins/soundcheck/api-reference/checks/get-exemptions"},{"title":"Create an exemption","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml post /checks/exemptions","href":"/plugins/soundcheck/api-reference/checks/create-an-exemption"},{"title":"Revoke an exemption","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml post /checks/exemptions/revoke","href":"/plugins/soundcheck/api-reference/checks/revoke-an-exemption"},{"title":"Restore a revoked exemption","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml post /checks/exemptions/restore","href":"/plugins/soundcheck/api-reference/checks/restore-a-revoked-exemption"},{"title":"Get revoked exemptions","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml get /checks/exemptions/revoked","href":"/plugins/soundcheck/api-reference/checks/get-revoked-exemptions"},{"title":"Get a check","description":"Get a single check by id.","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml get /checks/{checkId}","href":"/plugins/soundcheck/api-reference/checks/get-a-check"},{"title":"Update a check","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml put /checks/{checkId}","href":"/plugins/soundcheck/api-reference/checks/update-a-check"},{"title":"Delete a check","description":"Delete a check by id.","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml delete /checks/{checkId}","href":"/plugins/soundcheck/api-reference/checks/delete-a-check"},{"title":"Get the aggregate status of a check","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml get /checks/{checkId}/status","href":"/plugins/soundcheck/api-reference/checks/get-the-aggregate-status-of-a-check"},{"title":"Get the aggregate status of a check","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml post /checks/{checkId}/status","href":"/plugins/soundcheck/api-reference/checks/get-the-aggregate-status-of-a-check-1"},{"title":"Get the status history of a check","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml get /checks/{checkId}/status-history","href":"/plugins/soundcheck/api-reference/checks/get-the-status-history-of-a-check"},{"title":"Get the status history of a check","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml post /checks/{checkId}/status-history","href":"/plugins/soundcheck/api-reference/checks/get-the-status-history-of-a-check-1"}]},{"group":"FactCollectors","pages":[{"title":"List fact collectors","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml get /fact-collectors","href":"/plugins/soundcheck/api-reference/factcollectors/list-fact-collectors"},{"title":"Create fact collectors","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml post /fact-collectors","href":"/plugins/soundcheck/api-reference/factcollectors/create-fact-collectors"},{"title":"Get a fact collector","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml get /fact-collectors/{collectorId}","href":"/plugins/soundcheck/api-reference/factcollectors/get-a-fact-collector"},{"title":"Update a fact collector","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml put /fact-collectors/{collectorId}","href":"/plugins/soundcheck/api-reference/factcollectors/update-a-fact-collector"},{"title":"Delete a fact collector","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml delete /fact-collectors/{collectorId}","href":"/plugins/soundcheck/api-reference/factcollectors/delete-a-fact-collector"}]},{"group":"Facts","pages":[{"title":"Submit facts","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml post /facts","href":"/plugins/soundcheck/api-reference/facts/submit-facts"},{"title":"Trigger on-demand fact collection","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml post /facts/collect","href":"/plugins/soundcheck/api-reference/facts/trigger-on-demand-fact-collection"}]},{"group":"CheckResults","pages":[{"title":"Get check results","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml get /results","href":"/plugins/soundcheck/api-reference/checkresults/get-check-results"},{"title":"Submit check results","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml post /results","href":"/plugins/soundcheck/api-reference/checkresults/submit-check-results"},{"title":"Delete check results","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml delete /results","href":"/plugins/soundcheck/api-reference/checkresults/delete-check-results"}]},{"group":"Tracks","pages":[{"title":"Get tracks","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml get /tracks","href":"/plugins/soundcheck/api-reference/tracks/get-tracks"},{"title":"Create tracks","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml post /tracks","href":"/plugins/soundcheck/api-reference/tracks/create-tracks"},{"title":"Get a track","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml get /tracks/{trackId}","href":"/plugins/soundcheck/api-reference/tracks/get-a-track"},{"title":"Update a track","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml put /tracks/{trackId}","href":"/plugins/soundcheck/api-reference/tracks/update-a-track"},{"title":"Delete a track","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml delete /tracks/{trackId}","href":"/plugins/soundcheck/api-reference/tracks/delete-a-track"},{"title":"Get entities for a track filtered by certification status","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml get /tracks/{trackId}/entities","href":"/plugins/soundcheck/api-reference/tracks/get-entities-for-a-track-filtered-by-certification-status"},{"title":"Get entities failing checks in a track","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml post /tracks/{trackId}/failing-entities","href":"/plugins/soundcheck/api-reference/tracks/get-entities-failing-checks-in-a-track"},{"title":"Get the aggregate certification status for a track","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml get /tracks/{trackId}/status","href":"/plugins/soundcheck/api-reference/tracks/get-the-aggregate-certification-status-for-a-track"},{"title":"Get the aggregate certification status for a track","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml post /tracks/{trackId}/status","href":"/plugins/soundcheck/api-reference/tracks/get-the-aggregate-certification-status-for-a-track-1"},{"title":"Get the aggregate certification status history of a track","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml get /tracks/{trackId}/status-history","href":"/plugins/soundcheck/api-reference/tracks/get-the-aggregate-certification-status-history-of-a-track"},{"title":"Get the aggregate certification status history of a track","deprecated":null,"version":null,"openapi":"/plugins/soundcheck/openapi.yaml post /tracks/{trackId}/status-history","href":"/plugins/soundcheck/api-reference/tracks/get-the-aggregate-certification-status-history-of-a-track-1"}]}]},{"title":"API Client","sidebarTitle":"API Client","href":"/plugins/soundcheck/api-client"},{"title":"MCP Actions","href":"/plugins/soundcheck/mcp-actions"},{"title":"Health Page","sidebarTitle":"Health Page","href":"/plugins/soundcheck/health"},{"title":"Soundcheck - Advanced Performance Tuning","sidebarTitle":"Advanced Performance Tuning","href":"/plugins/soundcheck/performance"},{"title":"Internationalization (i18n)","sidebarTitle":"Internationalization","href":"/plugins/soundcheck/internationalization"},{"group":"Troubleshooting","root":{"title":"Troubleshooting","href":"/plugins/soundcheck/troubleshooting/index"},"pages":[{"title":"Job Queue Statistics","href":"/plugins/soundcheck/troubleshooting/job-queue-statistics"}]}]},{"group":"RBAC","root":{"title":"RBAC","sidebarTitle":"Overview","href":"/plugins/rbac/index"},"pages":[{"title":"Installation \u0026 Setup","sidebarTitle":"Setup \u0026 Installation","href":"/plugins/rbac/setup-and-installation"},{"title":"Core Concepts","href":"/plugins/rbac/core-concepts"},{"title":"MCP Actions","href":"/plugins/rbac/mcp-actions"},{"group":"Tutorials","pages":[{"title":"Fine-tune Software Templates Access","href":"/plugins/rbac/tutorials/fine-tune-template-access"},{"title":"Read-Only Catalog Permissions","href":"/plugins/rbac/tutorials/read-only-catalog"},{"title":"Catalog Delete Permissions","href":"/plugins/rbac/tutorials/delete-catalog-for-owners"},{"title":"Establish a foundational permission policy","href":"/plugins/rbac/tutorials/foundational-permission-policy"}]}]},{"group":"Skill Exchange","root":{"title":"Skill Exchange","sidebarTitle":"Overview","href":"/plugins/skill-exchange/index"},"pages":[{"title":"Setup \u0026 Installation","href":"/plugins/skill-exchange/setup-and-installation"},{"title":"Notifications","sidebarTitle":"Notifications","href":"/plugins/skill-exchange/notifications"},{"title":"Skill Exchange Actions","href":"/plugins/skill-exchange/actions"},{"group":"Tutorials","pages":[{"title":"Customizing Skill Exchange","href":"/plugins/skill-exchange/tutorials/customizing-skill-exchange"}]},{"group":"References","pages":[{"title":"EmbedsMessageBuilder","href":"/plugins/skill-exchange/references/EmbedsMessageBuilder"},{"title":"MentorsMessageBuilder","href":"/plugins/skill-exchange/references/MentorsMessageBuilder"},{"title":"HacksMessageBuilder","href":"/plugins/skill-exchange/references/HacksMessageBuilder"}]}]},{"group":"Insights","root":{"sidebarTitle":"Insights","title":"Overview","href":"/plugins/insights/index"},"pages":[{"title":"Setup \u0026 Installation","sidebarTitle":"Setup \u0026 Installation","href":"/plugins/insights/setup-and-installation"},{"group":"Core Concepts","pages":[{"title":"Usage Data","href":"/plugins/insights/core-concepts/usage-data"},{"title":"Feedback","href":"/plugins/insights/core-concepts/feedback"}]},{"title":"Migration \u0026 Installation","sidebarTitle":"Migrating to Insights with Feedback","href":"/plugins/insights/migrating-to-insights-with-feedback"},{"title":"MCP Actions","href":"/plugins/insights/mcp-actions"},{"group":"Tutorials","pages":[{"title":"Optimizing your Insights configuration","href":"/plugins/insights/tutorials/Optimizing-Insights-set-up"},{"title":"Tips for running your first Feedback Survey","href":"/plugins/insights/tutorials/feedback-survey"}]}]}]},{"tab":"Xirp","pages":[{"title":"Xirp","href":"/xirp"}]}]},"basePath":"","title":"Update a check - Spotify for Backstage","buildId":"dpl_AHzSCQPRq6mP9FZXEa5AbDZTffie","deploymentId":"dpl_AHzSCQPRq6mP9FZXEa5AbDZTffie","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C0w-WQJ2.js","utils-C5d2irbo.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CJr73d5s.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B9xqpnhe.js","snippetPresets-C6Ms_vrL.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C4vTqKLT.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Dvb1kse5.js","shallow-BIuit-p4.js","getApiPlaygroundDisplay-B4qYxU7P.js","CodeSnippet-DbbDcn2_.js","CodeSnippets-P3qMtezt.js","Page-DLEGoKJA.js","getPastedJson-rlg7qTiW.js","icon-ChyN3MIj.js","MethodPill-BDbONhDa.js","DuplicateIcon-CJlrtq8z.js","createIcon-BDOguHRU.js","DynamicMarkdown-mBxoveKr.js","SectionHeading-CAMJotVi.js","axios-vUo_bRtp.js","Markdown-BNXMbgxP.js","clsx-4BR7cppx.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CAwBMBkB.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CJogWhER.js"]}