---
title: update-a-check
product: vercel
url: /docs/rest-api/checks/update-a-check
type: reference
prerequisites:
  []
related:
  - /docs/rest-api
summary: Learn about update-a-check on Vercel.
install_vercel_plugin: npx plugins add vercel/vercel-plugin
---

# Update a check

> **Deprecated**: This endpoint is deprecated and may be removed in a future version.

```http
PATCH /v1/deployments/{deploymentId}/checks/{checkId}
```

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

## Authentication

**bearerToken**: HTTP bearer

## Path parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `deploymentId` | string | Yes | The deployment to update the check for. |
| `checkId` | string | Yes | The check being updated |


## Query parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `teamId` | string | No | The Team identifier to perform the request on behalf of. |
| `slug` | string | No | The Team slug to perform the request on behalf of. |


## Request body

Required: Yes

Content-Type: `application/json`

```json
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the check being created",
      "maxLength": 100
    },
    "path": {
      "type": "string",
      "description": "Path of the page that is being checked",
      "maxLength": 255
    },
    "status": {
      "description": "The current status of the check",
      "enum": [
        "running",
        "completed"
      ]
    },
    "conclusion": {
      "description": "The result of the check being run",
      "enum": [
        "canceled",
        "failed",
        "neutral",
        "succeeded",
        "skipped"
      ]
    },
    "detailsUrl": {
      "type": "string",
      "description": "A URL a user may visit to see more information about the check"
    },
    "output": {
      "type": "object",
      "description": "The results of the check Run",
      "properties": {
        "metrics": {
          "type": "object",
          "description": "Metrics about the page",
          "required": [
            "FCP",
            "LCP",
            "CLS",
            "TBT"
          ],
          "properties": {
            "FCP": {
              "type": "object",
              "required": [
                "value",
                "source"
              ],
              "properties": {
                "value": {
                  "type": "number",
                  "description": "First Contentful Paint value",
                  "nullable": true
                },
                "previousValue": {
                  "type": "number",
                  "description": "Previous First Contentful Paint value to display a delta"
                },
                "source": {
                  "type": "string",
                  "enum": [
                    "web-vitals"
                  ]
                }
              }
            },
            "LCP": {
              "type": "object",
              "required": [
                "value",
                "source"
              ],
              "properties": {
                "value": {
                  "type": "number",
                  "description": "Largest Contentful Paint value",
                  "nullable": true
                },
                "previousValue": {
                  "type": "number",
                  "description": "Previous Largest Contentful Paint value to display a delta"
                },
                "source": {
                  "type": "string",
                  "enum": [
                    "web-vitals"
                  ]
                }
              }
            },
            "CLS": {
              "type": "object",
              "required": [
                "value",
                "source"
              ],
              "properties": {
                "value": {
                  "type": "number",
                  "description": "Cumulative Layout Shift value",
                  "nullable": true
                },
                "previousValue": {
                  "type": "number",
                  "description": "Previous Cumulative Layout Shift value to display a delta"
                },
                "source": {
                  "type": "string",
                  "enum": [
                    "web-vitals"
                  ]
                }
              }
            },
            "TBT": {
              "type": "object",
              "required": [
                "value",
                "source"
              ],
              "properties": {
                "value": {
                  "type": "number",
                  "description": "Total Blocking Time value",
                  "nullable": true
                },
                "previousValue": {
                  "type": "number",
                  "description": "Previous Total Blocking Time value to display a delta"
                },
                "source": {
                  "enum": [
                    "web-vitals"
                  ]
                }
              }
            },
            "virtualExperienceScore": {
              "type": "object",
              "required": [
                "value",
                "source"
              ],
              "properties": {
                "value": {
                  "type": "integer",
                  "description": "The calculated Virtual Experience Score value, between 0 and 100",
                  "minimum": 0,
                  "maximum": 100,
                  "nullable": true
                },
                "previousValue": {
                  "type": "integer",
                  "description": "A previous Virtual Experience Score value to display a delta, between 0 and 100",
                  "minimum": 0,
                  "maximum": 100
                },
                "source": {
                  "enum": [
                    "web-vitals"
                  ]
                }
              }
            }
          }
        }
      }
    },
    "externalId": {
      "type": "string",
      "description": "An identifier that can be used as an external reference"
    }
  }
}
```

## Responses

### 200: No description

Content-Type: `application/json`

```json
{
  "type": "object",
  "required": [
    "blocking",
    "createdAt",
    "deploymentId",
    "id",
    "integrationId",
    "name",
    "status",
    "updatedAt"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "createdAt": {
      "type": "number"
    },
    "updatedAt": {
      "type": "number"
    },
    "deploymentId": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "running",
        "completed",
        "registered"
      ]
    },
    "conclusion": {
      "type": "string",
      "enum": [
        "canceled",
        "skipped",
        "failed",
        "neutral",
        "succeeded",
        "stale"
      ]
    },
    "externalId": {
      "type": "string"
    },
    "output": {
      "type": "object",
      "properties": {
        "metrics": {
          "type": "object",
          "required": [
            "CLS",
            "FCP",
            "LCP",
            "TBT"
          ],
          "properties": {
            "FCP": {
              "type": "object",
              "required": [
                "source",
                "value"
              ],
              "properties": {
                "value": {
                  "type": "number",
                  "nullable": true
                },
                "previousValue": {
                  "type": "number"
                },
                "source": {
                  "type": "string",
                  "enum": [
                    "web-vitals"
                  ]
                }
              }
            },
            "LCP": {
              "type": "object",
              "required": [
                "source",
                "value"
              ],
              "properties": {
                "value": {
                  "type": "number",
                  "nullable": true
                },
                "previousValue": {
                  "type": "number"
                },
                "source": {
                  "type": "string",
                  "enum": [
                    "web-vitals"
                  ]
                }
              }
            },
            "CLS": {
              "type": "object",
              "required": [
                "source",
                "value"
              ],
              "properties": {
                "value": {
                  "type": "number",
                  "nullable": true
                },
                "previousValue": {
                  "type": "number"
                },
                "source": {
                  "type": "string",
                  "enum": [
                    "web-vitals"
                  ]
                }
              }
            },
            "TBT": {
              "type": "object",
              "required": [
                "source",
                "value"
              ],
              "properties": {
                "value": {
                  "type": "number",
                  "nullable": true
                },
                "previousValue": {
                  "type": "number"
                },
                "source": {
                  "type": "string",
                  "enum": [
                    "web-vitals"
                  ]
                }
              }
            },
            "virtualExperienceScore": {
              "type": "object",
              "required": [
                "source",
                "value"
              ],
              "properties": {
                "value": {
                  "type": "number",
                  "nullable": true
                },
                "previousValue": {
                  "type": "number"
                },
                "source": {
                  "type": "string",
                  "enum": [
                    "web-vitals"
                  ]
                }
              }
            }
          }
        }
      }
    },
    "completedAt": {
      "type": "number"
    },
    "path": {
      "type": "string"
    },
    "blocking": {
      "type": "boolean",
      "enum": [
        false,
        true
      ]
    },
    "detailsUrl": {
      "type": "string"
    },
    "integrationId": {
      "type": "string"
    },
    "startedAt": {
      "type": "number"
    },
    "rerequestable": {
      "type": "boolean",
      "enum": [
        false,
        true
      ]
    }
  }
}
```

### 400: One of the provided values in the request body is invalid.
One of the provided values in the request query is invalid.
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: Check was not found
The deployment was not found

### 413: The output provided is too large

---

## Related

- [checks endpoints](/docs/rest-api#checks)

- [REST API overview](/docs/rest-api)

- [OpenAPI spec](https://openapi.vercel.sh/) (machine-readable, all endpoints)

---

[View full sitemap](/docs/sitemap)