Octopus.HealthCheck exported 2026-07-22 by Octopus Deploy belongs to ‘Other’ category.
Perform a health check and take action based on the result.
Parameters
When this step is included in a project’s deployment process, the parameters below can be set.
Health check type
Octopus.Action.HealthCheck.Type (required)
Choose to perform a full health check or a connection-only test.
Allowed values: FullHealthCheck, ConnectionTest
Default: FullHealthCheck
Health check errors
Octopus.Action.HealthCheck.ErrorHandling (required)
Select which action to take on a health check error. Fail the deployment or skip deployment targets that are unavailable.
Allowed values: TreatExceptionsAsErrors, TreatExceptionsAsWarnings
Default: TreatExceptionsAsErrors
New deployment targets
Octopus.Action.HealthCheck.IncludeMachinesInDeployment (required)
Select which action to take on new machines. Ignore any newly available deployment targets or include them in the deployment.
Allowed values: DoNotAlterMachines, IncludeCheckedMachines
Default: DoNotAlterMachines
Step configuration using OCL
Example in Octopus Configuration Language (OCL):
step "health-check" {
name = "Health Check"
properties = {
Octopus.Action.TargetRoles = "web-server"
}
action {
action_type = "Octopus.HealthCheck"
properties = {
Octopus.Action.HealthCheck.ErrorHandling = "TreatExceptionsAsErrors"
Octopus.Action.HealthCheck.IncludeMachinesInDeployment = "DoNotAlterMachines"
Octopus.Action.HealthCheck.Type = "FullHealthCheck"
Octopus.Action.RunOnServer = "false"
}
}
}Page updated on Wednesday, July 22, 2026