Skip to content
Docs

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

ParameterTypeRequiredDescription
deploymentIdstringYesThe deployment to create the check for.
teamIdstringNoTeam ID.
slugstringNoTeam slug.
requestBodyobjectYesRequest body for this tool.

Create a check run.

Parameters

ParameterTypeRequiredDescription
deploymentIdstringYesThe deployment ID.
teamIdstringNoTeam ID.
slugstringNoTeam slug.
requestBodyobjectNoRequest body for this tool.

Get a single check.

Parameters

ParameterTypeRequiredDescription
deploymentIdstringYesThe deployment to get the check for.
checkIdstringYesThe check to fetch
teamIdstringNoTeam ID.
slugstringNoTeam slug.

Get a check run.

Parameters

ParameterTypeRequiredDescription
deploymentIdstringYesThe deployment ID.
checkRunIdstringYesThe check run ID.
teamIdstringNoTeam ID.
slugstringNoTeam slug.

Get a check.

Parameters

ParameterTypeRequiredDescription
projectIdOrNamestringYesThe project ID or name.
checkIdstringYesThe check ID.
teamIdstringNoTeam ID.
slugstringNoTeam slug.

List runs for a check.

Parameters

ParameterTypeRequiredDescription
projectIdOrNamestringYesThe project ID or name.
checkIdstringYesThe check ID.
teamIdstringNoTeam ID.
slugstringNoTeam slug.

Rerequest a check.

Parameters

ParameterTypeRequiredDescription
deploymentIdstringYesThe deployment to rerun the check for.
checkIdstringYesThe check to rerun
autoUpdatebooleanNoMark the check as running
teamIdstringNoTeam ID.
slugstringNoTeam slug.
requestBodyunknownNoRequest body for this tool.

Update a check.

Parameters

ParameterTypeRequiredDescription
deploymentIdstringYesThe deployment to update the check for.
checkIdstringYesThe check being updated
teamIdstringNoTeam ID.
slugstringNoTeam slug.
requestBodyobjectYesRequest body for this tool.

Update a check run.

Parameters

ParameterTypeRequiredDescription
deploymentIdstringYesThe deployment ID.
checkRunIdstringYesThe check run ID.
teamIdstringNoTeam ID.
slugstringNoTeam slug.
requestBodyobjectNoRequest body for this tool.

Update a check.

Parameters

ParameterTypeRequiredDescription
projectIdOrNamestringYesThe project ID or name.
checkIdstringYesThe check ID.
teamIdstringNoTeam ID.
slugstringNoTeam slug.
requestBodyobjectNoRequest body for this tool.

Was this helpful?

supported.