> ## 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.

# Submit check results

> Submit check results for one or more entities.



## OpenAPI

````yaml /plugins/soundcheck/openapi.yaml post /results
openapi: 3.0.0
info:
  title: soundcheck
  version: 0.1.0
  description: API for interacting with Soundcheck.
servers:
  - url: https://backstage.example.com/api/soundcheck
security: []
tags:
  - name: Campaigns
  - name: Certification
  - name: CheckResults
  - name: Checks
  - name: FactCollectors
  - name: Facts
  - name: Tracks
paths:
  /results:
    post:
      tags:
        - CheckResults
      summary: Submit check results
      description: Submit check results for one or more entities.
      operationId: submitResults
      parameters:
        - name: returnUpdatedResults
          in: query
          description: If true, return the updated results in the response.
          required: false
          schema:
            type: boolean
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitResultsRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitResultsResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: No permission to update check results
          content:
            text/plain:
              schema:
                type: string
components:
  schemas:
    SubmitResultsRequest:
      type: object
      required:
        - results
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/CheckResult'
        preserveStateOnError:
          type: boolean
          description: >
            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.
      additionalProperties: false
    SubmitResultsResponse:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/CheckResult'
        status:
          type: string
      additionalProperties: false
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            name:
              type: string
            message:
              type: string
          required:
            - name
            - message
          additionalProperties: true
        request:
          type: object
          properties:
            method:
              type: string
            url:
              type: string
          required:
            - method
            - url
          additionalProperties: false
        response:
          type: object
          properties:
            statusCode:
              type: integer
          required:
            - statusCode
          additionalProperties: false
      required:
        - error
        - response
      additionalProperties: false
    CheckResult:
      type: object
      properties:
        entityRef:
          type: string
        checkId:
          type: string
        state:
          type: string
        details:
          type: object
          additionalProperties: true
        scope:
          type: string
        submittedBy:
          type: string
      required:
        - entityRef
        - checkId
        - state
      additionalProperties: false

````