Checks API Reference
The Vercel Checks API let you create tests and assertions that run after each deployment has been built, and are powered by Vercel Integrations.API endpoints allow integrations to interact with the Vercel platform. Integrations can run checks every time you create a deployment.
The post and patch endpoints
must be called with an OAuth2, or it will produce a
400 error.
Allows the integration to create and register checks. When the "deployment" event triggers, the endpoint registers new checks. It runs until the "deployment.succeeded" event. The endpoint will then set the check "status" to "running".
| Action | Endpoint |
|---|---|
Read/Write |
Allows the integration to update existing checks with a new status or conclusion. This endpoint sets the status to “completed”. The value for the conclusion can be "canceled", "failed", "neutral", "succeeded", or "skipped".
| Action | Endpoint |
|---|---|
Read/Write |
Allows integration to fetch all existing checks with all their attributes. For comparison purposes, you can use it to get information from a previous deployment.
| Action | Endpoint |
|---|---|
Read |
Allows integration to fetch only a single check with all the attributes. For comparison purposes, you can use it to get information from a previous deployment.
| Action | Endpoint |
|---|---|
Read |
Allows integration to return a new outcome or rewrite an existing check result. This endpoint is used for check reruns.
| Action | Endpoint |
|---|---|
Read/Write |
Was this helpful?