---
title: "Creates a new Check"
method: POST
path: "/v1/deployments/{deploymentId}/checks"
tags: ["checks"]
deprecated: true
---

# Creates a new Check

`POST /v1/deployments/{deploymentId}/checks`

> **Deprecated.**

Creates a new check. This endpoint must be called with an OAuth2 or it will produce a 400 error.

## Path parameters

- `deploymentId` string, required — The deployment to create the check for.

## Query parameters

- `teamId` string
- `slug` string

## Request body

- object
  - `name` string, required — The name of the check being created
  - `path` string — Path of the page that is being checked
  - `blocking` boolean, required — Whether the check should block a deployment from succeeding
  - `detailsUrl` string — URL to display for further details
  - `externalId` string — An identifier that can be used as an external reference
  - `rerequestable` boolean — Whether a user should be able to request for the check to be rerun if it fails

## Response `200`

- object
  - `id` string, required
  - `name` string, required
  - `createdAt` number, required
  - `updatedAt` number, required
  - `deploymentId` string, required
  - `status` 'completed' | 'registered' | 'running', required
  - `conclusion` 'canceled' | 'failed' | 'neutral' | 'skipped' | 'stale' | 'succeeded'
  - `externalId` string
  - `output` object
    - `metrics` object
      - `FCP` object, required
        - `value` number, nullable, required
        - `previousValue` number
        - `source` 'web-vitals', required
      - `LCP` object, required
        - `value` number, nullable, required
        - `previousValue` number
        - `source` 'web-vitals', required
      - `CLS` object, required
        - `value` number, nullable, required
        - `previousValue` number
        - `source` 'web-vitals', required
      - `TBT` object, required
        - `value` number, nullable, required
        - `previousValue` number
        - `source` 'web-vitals', required
      - `virtualExperienceScore` object
        - `value` number, nullable, required
        - `previousValue` number
        - `source` 'web-vitals', required
  - `completedAt` number
  - `path` string
  - `blocking` false | true, required
  - `detailsUrl` string
  - `integrationId` string, required
  - `startedAt` number
  - `rerequestable` false | true

## Other responses

- `400` — One of the provided values in the request body is invalid. One of the provided values in the request query is invalid. Cannot create check for finished deployment The provided token is not from an OAuth2 Client
- `401` — The request is not authorized.
- `403` — You do not have permission to access this resource.
- `404` — The deployment was not found
- `410`

---

[API](https://skmtc.net/vercel/apis/api.md) · [All operations](https://skmtc.net/vercel/apis/api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vercel/api/versions/b4d86a3e3479/schema)