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.
Servers
- https://api.vercel.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
deploymentId |
String | Yes |
The deployment to update the check for. |
checkId |
String | Yes |
The check being updated |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
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 fields
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | No |
The name of the check being created |
externalId |
String | No |
An identifier that can be used as an external reference |
output |
Object | No |
The results of the check Run |
output.metrics |
Object | No |
Metrics about the page |
output.metrics.virtualExperienceScore |
Object | No | |
output.metrics.virtualExperienceScore.source |
String | Yes |
Possible values:
|
output.metrics.virtualExperienceScore.previousValue |
Integer | No |
A previous Virtual Experience Score value to display a delta, between 0 and 100 |
output.metrics.virtualExperienceScore.value |
Integer | Yes |
The calculated Virtual Experience Score value, between 0 and 100 |
output.metrics.FCP |
Object | Yes | |
output.metrics.FCP.source |
String | Yes |
Possible values:
|
output.metrics.FCP.previousValue |
Number | No |
Previous First Contentful Paint value to display a delta |
output.metrics.FCP.value |
Number | Yes |
First Contentful Paint value |
output.metrics.TBT |
Object | Yes | |
output.metrics.TBT.source |
String | Yes |
Possible values:
|
output.metrics.TBT.previousValue |
Number | No |
Previous Total Blocking Time value to display a delta |
output.metrics.TBT.value |
Number | Yes |
Total Blocking Time value |
output.metrics.CLS |
Object | Yes | |
output.metrics.CLS.source |
String | Yes |
Possible values:
|
output.metrics.CLS.previousValue |
Number | No |
Previous Cumulative Layout Shift value to display a delta |
output.metrics.CLS.value |
Number | Yes |
Cumulative Layout Shift value |
output.metrics.LCP |
Object | Yes | |
output.metrics.LCP.source |
String | Yes |
Possible values:
|
output.metrics.LCP.previousValue |
Number | No |
Previous Largest Contentful Paint value to display a delta |
output.metrics.LCP.value |
Number | Yes |
Largest Contentful Paint value |
status |
String | No |
The current status of the check Possible values:
|
conclusion |
String | No |
The result of the check being run Possible values:
|
detailsUrl |
String | No |
A URL a user may visit to see more information about the check |
path |
String | No |
Path of the page that is being checked |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.