Skip to main content
POST
/
checks
/
{checkId}
/
status
Get the aggregate status of a check
curl --request POST \
  --url https://backstage.example.com/api/soundcheck/checks/{checkId}/status \
  --header 'Content-Type: application/json' \
  --data '{
  "filter": {}
}'
{
  "passed": 123,
  "failed": 123,
  "warning": 123,
  "exempt": 123,
  "notApplicable": 123,
  "error": 123,
  "notReported": 123,
  "id": "<string>",
  "numberOfEntities": 123
}

Path Parameters

checkId
string
required

The ID of the check

Body

application/json
filter
object

Response

OK

passed
integer
required
failed
integer
required
warning
integer
required
exempt
integer
required
notApplicable
integer
required
error
integer
required
notReported
integer
required
id
string
required
numberOfEntities
integer
required