Checks
Manage checks for your projects and deployments to track validation results. You can inspect individual runs, update their status, or request a check to run again.
Creates a new Check.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
deploymentId | string | Yes | The deployment to create the check for. |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
requestBody | object | Yes | Request body for this tool. |
Create a check run.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
deploymentId | string | Yes | The deployment ID. |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
requestBody | object | No | Request body for this tool. |
Get a single check.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
deploymentId | string | Yes | The deployment to get the check for. |
checkId | string | Yes | The check to fetch |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
Get a check run.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
deploymentId | string | Yes | The deployment ID. |
checkRunId | string | Yes | The check run ID. |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
Get a check.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
projectIdOrName | string | Yes | The project ID or name. |
checkId | string | Yes | The check ID. |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
List runs for a check.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
projectIdOrName | string | Yes | The project ID or name. |
checkId | string | Yes | The check ID. |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
Rerequest a check.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
deploymentId | string | Yes | The deployment to rerun the check for. |
checkId | string | Yes | The check to rerun |
autoUpdate | boolean | No | Mark the check as running |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
requestBody | unknown | No | Request body for this tool. |
Update a check.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
deploymentId | string | Yes | The deployment to update the check for. |
checkId | string | Yes | The check being updated |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
requestBody | object | Yes | Request body for this tool. |
Update a check run.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
deploymentId | string | Yes | The deployment ID. |
checkRunId | string | Yes | The check run ID. |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
requestBody | object | No | Request body for this tool. |
Update a check.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
projectIdOrName | string | Yes | The project ID or name. |
checkId | string | Yes | The check ID. |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
requestBody | object | No | Request body for this tool. |
Was this helpful?