PATCH /v2/deployments/{deploymentId}/check-runs/{checkRunId}
Update an existing check run for a deployment.
Servers
- https://api.vercel.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
deploymentId |
String | Yes | |
checkRunId |
String | Yes |
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 |
|---|---|---|---|
conclusionText |
String | No | |
externalId |
String | No | |
output |
Object | No | |
status |
String | No |
Valid values:
|
conclusion |
String | No |
Valid values:
|
externalUrl |
String | No | |
completedAt |
Number | No |
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.