healthchecks_http_config

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/healthchecks_http_config",
  "title": "healthchecks_http_config",
  "description": "Parameters specific to an HTTP or HTTPS health check.",
  "nullable": true,
  "properties": {
    "allow_insecure": {
      "default": false,
      "description": "Do not validate the certificate when the health check uses HTTPS.",
      "type": "boolean"
    },
    "expected_body": {
      "description": "A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy.",
      "example": "success",
      "type": "string"
    },
    "expected_codes": {
      "default": "200",
      "description": "The expected HTTP response codes (e.g. \"200\") or code ranges (e.g. \"2xx\" for all codes starting with 2) of the health check.",
      "example": [
        "2xx",
        "302"
      ],
      "items": {
        "type": "string"
      },
      "nullable": true,
      "type": "array"
    },
    "follow_redirects": {
      "default": false,
      "description": "Follow redirects if the origin returns a 3xx status code.",
      "type": "boolean"
    },
    "header": {
      "additionalProperties": {
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "description": "The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden.",
      "example": {
        "Host": [
          "example.com"
        ],
        "X-App-ID": [
          "abc123"
        ]
      },
      "nullable": true,
      "type": "object"
    },
    "method": {
      "default": "GET",
      "description": "The HTTP method to use for the health check.",
      "enum": [
        "GET",
        "HEAD"
      ],
      "type": "string"
    },
    "path": {
      "default": "/",
      "description": "The endpoint path to health check against.",
      "example": "/health",
      "type": "string"
    },
    "port": {
      "default": 80,
      "description": "Port number to connect to for the health check. Defaults to 80 if type is HTTP or 443 if type is HTTPS.",
      "type": "integer"
    }
  },
  "type": "object"
}