Jobs /

Update job health checks

Updates health checks for the given job.

Required permission

Project > Jobs > General > Update

Path parameters

projectId
string required
ID of the project
jobId
string required
ID of the job

Request body

{object}

healthChecks
[array] required
An array of health checks

{object}

protocol
string required
The protocol to access the health check with.
one of
HTTP, CMD, TCP
type
string required
The type of health check.
one of
livenessProbe, readinessProbe, startupProbe
path
string
The path of the health check endpoint. Required when protocol is HTTP.
pattern
^\/([a-zA-Z0-9-._]+\/)*[a-zA-Z0-9-._]+$
cmd
string
The command to run for the health check. Required when protocol is CMD
port
integer
Port number for the health check endpoint. Required when protocol is HTTP.
min
1
initialDelaySeconds
integer required
Initial delay, in seconds, before the health check is first run.
min
1
periodSeconds
integer required
The time between each check, in seconds.
min
1
timeoutSeconds
integer required
The time to wait for a response before marking the health check as a failure.
min
1
failureThreshold
integer required
The maximum number of allowed failures.
min
1
successThreshold
integer
The number of successes required to mark the health check as a success.
min
1

Response body

{object}
Response object.

data
{object} required
Result data.

API

CLI

JS Client

POST /v1/projects/{projectId}/jobs/{jobId}/health-checks

Example request

Request body

curl

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"healthChecks":[{"protocol":"HTTP","type":"readinessProbe","path":"/health-check","port":3000,"initialDelaySeconds":10,"periodSeconds":60,"timeoutSeconds":1,"failureThreshold":3,"successThreshold":1}]}' \
  http://api.northflank.com/v1/projects/{projectId}/jobs/{jobId}/health-checks

Example response

200 OK

The operation was performed successfully.

JSON

{
  "data": {}
}