checks-v2

Update a check run

Changed on

Update an existing check run for a deployment.

patch/v2/deployments/{deploymentId}/check-runs/{checkRunId}

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v2/deployments/{deploymentId}/check-runs/{checkRunId}
  • Auth: HTTP bearer

Path parameters

deploymentIdstring required
checkRunIdstring required

Query parameters

teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Request body

externalIdstring
externalUrlstring uri
status'queued' | 'running' | 'completed'
outputobject
completedAtnumber
conclusion'canceled' | 'skipped' | 'timeout' | 'failed' | 'neutral' | 'succeeded'
conclusionTextstring

Response

OR

Changes

  • e78cd78343b7Revision changes
    • info

      removed subschema #3 from the /// response property oneOf list for the response status

  • b426de1e3932Revision changes
    • breaking

      added subschema #1 subschema #2 to the response body oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body oneOf list for the response status