Health Checks

Update health check

Changed on Apr 26, 2026

Update health check.

Auth: Required (bearer token). Scope: Organization-scoped in authenticated context. Side effects: May mutate server state.

put/api/v1/healthcheck

Request

Base URL
http://:8080
URL
http://:8080/api/v1/healthcheck
Auth
none declared

Headers

Acceptstring

Request body /

application_idstring uuid required

ID of the application to update health check for

bodystring nullable

Request body to send with health check requests

endpointstring nullable

Health check endpoint path or URL. Must start with /, http://, or https://

expected_status_codesinteger[] nullable

Expected HTTP status codes

failure_thresholdinteger nullable

Consecutive failures before marking unhealthy (1-10)

headersobject nullable

Custom HTTP headers to include in health check requests

interval_secondsinteger nullable

Check interval in seconds (30-3600)

methodstring nullable

HTTP method to use. Must be GET, POST, or HEAD

retention_daysinteger nullable

Number of days to retain health check results (1-365)

success_thresholdinteger nullable

Consecutive successes before marking healthy (1-10)

timeout_secondsinteger nullable

Request timeout in seconds (5-120)

Example request

{
  "application_id": "550e8400-e29b-41d4-a716-446655440000",
  "endpoint": "/health",
  "failure_threshold": 3,
  "interval_seconds": 60,
  "method": "GET",
  "retention_days": 30,
  "success_threshold": 1,
  "timeout_seconds": 30
}

Response

messagestring

statusstring

Changes

Apr 26, 202609f18af670c4 Revision changes
- warning
  the request property's max was set to 10.00
- warning
  the request property's max was set to 3600.00
- warning
  the request property's max was set to 365.00
- warning
  the request property's max was set to 10.00
- warning
  the request property's max was set to 120.00
- warning
  the request property's min was set to 1.00
- warning
  the request property's min was set to 30.00
- warning
  the request property's min was set to 1.00
- warning
  the request property's min was set to 1.00
- warning
  the request property's min was set to 5.00
- info
  api tag Health Checks added
- info
  api tag api/v1/healthcheck removed
Apr 2, 20262beb810c5221 Revision changes
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- warning
  removed the optional property from the response with the status (media type: application/json)
- warning
  removed the optional property from the response with the status (media type: application/xml)
- info
  api operation id updateEndpoint6 removed and replaced with updateHealthCheck
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/xml)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/xml)
- info
  added the required property to the response with the status (media type: application/json)
- info
  added the required property to the response with the status (media type: application/xml)
- info
  added the required property to the response with the status (media type: application/json)
- info
  added the required property to the response with the status (media type: application/xml)
- info
  added the required property to the response with the status (media type: application/json)
- info
  added the required property to the response with the status (media type: application/xml)
- info
  added the required property to the response with the status (media type: application/json)
- info
  added the required property to the response with the status (media type: application/xml)

Operation history (6 revisions)