Deployment Checks

Create a deployment check

Creates a new deployment check on the project. A check has a stage (pre_build or post_deploy) and a check_type (ssh, http, or vulnerability_scan). SSH checks run on selected servers; HTTP checks run from the deployment worker against the configured URL; vulnerability_scan checks run a scanner (Trivy, TruffleHog, or a custom CLI emitting SARIF) on the build server against the checked-out source, and are pre-build only.

post/projects/{project_id}/deployment_checks

Request

  • Base URL: https://sg.deployhq.com
  • URL: https://sg.deployhq.com/projects/{project_id}/deployment_checks
  • Auth: HTTP basic

Path parameters

project_idstring required

The identifier or permalink of the project

Request body

Response

Success

identifierstring
namestring
stagestring
check_typestring
enabledboolean
positioninteger
commandstring
serversstring[]
http_methodstring
http_urlstring
http_expected_statusinteger
http_body_matchstring
timeout_secondsinteger
scannerstring
scan_target_kindstring
scan_targetstring
severity_thresholdstring
fail_on_unfixed_onlyboolean
sarif_output_pathstring
integration_identifierstring
window_minutesinteger
match_by_releaseboolean

Changes

No recorded changes to this operation across all 1 revision of this API.