checks
Update a check
Endpoints
- access-groups
- artifacts
- checks
- projects
- deployments
- domains
- dns
- logDrains
- edge-config
- user
- marketplace
- integrations
- authentication
- projectMembers
- environment
- security
- teams
- webhooks
- aliases
- certs
checks
Update a check
Update an existing check. This endpoint must be called with an OAuth2 or it will produce a 400 error.
PATCH
/
v1
/
deployments
/
{deploymentId}
/
checks
/
{checkId}
import { Vercel } from "@vercel/sdk";
const vercel = new Vercel({
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await vercel.checks.updateCheck({
deploymentId: "dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6",
checkId: "check_2qn7PZrx89yxY34vEZPD31Y9XVj6",
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
slug: "my-team-url-slug",
requestBody: {
name: "Performance Check",
path: "/",
detailsUrl: "https://example.com/check/run/1234abc",
output: {
metrics: {
fcp: {
value: 1200,
previousValue: 900,
source: "web-vitals",
},
lcp: {
value: 1200,
previousValue: 1000,
source: "web-vitals",
},
cls: {
value: 4,
previousValue: 2,
source: "web-vitals",
},
tbt: {
value: 3000,
previousValue: 3500,
source: "web-vitals",
},
virtualExperienceScore: {
value: 30,
previousValue: 35,
source: "web-vitals",
},
},
},
externalId: "1234abc",
},
});
// Handle the result
console.log(result);
}
run();
{
"id": "<string>",
"name": "<string>",
"path": "<string>",
"status": "registered",
"conclusion": "canceled",
"blocking": true,
"output": {
"metrics": {
"FCP": {
"value": 123,
"previousValue": 123,
"source": "web-vitals"
},
"LCP": {
"value": 123,
"previousValue": 123,
"source": "web-vitals"
},
"CLS": {
"value": 123,
"previousValue": 123,
"source": "web-vitals"
},
"TBT": {
"value": 123,
"previousValue": 123,
"source": "web-vitals"
},
"virtualExperienceScore": {
"value": 123,
"previousValue": 123,
"source": "web-vitals"
}
}
},
"detailsUrl": "<string>",
"integrationId": "<string>",
"deploymentId": "<string>",
"externalId": "<string>",
"createdAt": 123,
"updatedAt": 123,
"startedAt": 123,
"completedAt": 123,
"rerequestable": true
}
Authorizations
Default authentication mechanism
Path Parameters
The deployment to update the check for.
Example:
"dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6"
The check being updated
Example:
"check_2qn7PZrx89yxY34vEZPD31Y9XVj6"
Query Parameters
The Team identifier to perform the request on behalf of.
Example:
"team_1a2b3c4d5e6f7g8h9i0j1k2l"
The Team slug to perform the request on behalf of.
Example:
"my-team-url-slug"
Body
application/json
Response
200
application/json
The response is of type object
.
import { Vercel } from "@vercel/sdk";
const vercel = new Vercel({
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await vercel.checks.updateCheck({
deploymentId: "dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6",
checkId: "check_2qn7PZrx89yxY34vEZPD31Y9XVj6",
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
slug: "my-team-url-slug",
requestBody: {
name: "Performance Check",
path: "/",
detailsUrl: "https://example.com/check/run/1234abc",
output: {
metrics: {
fcp: {
value: 1200,
previousValue: 900,
source: "web-vitals",
},
lcp: {
value: 1200,
previousValue: 1000,
source: "web-vitals",
},
cls: {
value: 4,
previousValue: 2,
source: "web-vitals",
},
tbt: {
value: 3000,
previousValue: 3500,
source: "web-vitals",
},
virtualExperienceScore: {
value: 30,
previousValue: 35,
source: "web-vitals",
},
},
},
externalId: "1234abc",
},
});
// Handle the result
console.log(result);
}
run();
{
"id": "<string>",
"name": "<string>",
"path": "<string>",
"status": "registered",
"conclusion": "canceled",
"blocking": true,
"output": {
"metrics": {
"FCP": {
"value": 123,
"previousValue": 123,
"source": "web-vitals"
},
"LCP": {
"value": 123,
"previousValue": 123,
"source": "web-vitals"
},
"CLS": {
"value": 123,
"previousValue": 123,
"source": "web-vitals"
},
"TBT": {
"value": 123,
"previousValue": 123,
"source": "web-vitals"
},
"virtualExperienceScore": {
"value": 123,
"previousValue": 123,
"source": "web-vitals"
}
}
},
"detailsUrl": "<string>",
"integrationId": "<string>",
"deploymentId": "<string>",
"externalId": "<string>",
"createdAt": 123,
"updatedAt": 123,
"startedAt": 123,
"completedAt": 123,
"rerequestable": true
}