Skip to main content
POST
/
results
Submit check results
curl --request POST \
  --url https://backstage.example.com/api/soundcheck/results \
  --header 'Content-Type: application/json' \
  --data '
{
  "results": [
    {
      "entityRef": "<string>",
      "checkId": "<string>",
      "state": "<string>",
      "details": {},
      "scope": "<string>",
      "submittedBy": "<string>"
    }
  ],
  "preserveStateOnError": true
}
'
{
  "results": [
    {
      "entityRef": "<string>",
      "checkId": "<string>",
      "state": "<string>",
      "details": {},
      "scope": "<string>",
      "submittedBy": "<string>"
    }
  ],
  "status": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://backstage.spotify.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Query Parameters

returnUpdatedResults
boolean

If true, return the updated results in the response.

Body

application/json
results
object[]
required
preserveStateOnError
boolean

When true, incoming results with state "error" will not override existing non-error states. If a prior result exists, its state is preserved and only details, submittedBy, and lastChecked are updated. Mimics internal check execution behavior.

Response

OK

results
object[]
status
string