> ## Documentation Index
> Fetch the complete documentation index at: https://docs.siderolabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

> HTTPProbeConfig is a config document to configure network HTTP connectivity probes.

# HTTPProbeConfig

```yaml theme={null}
apiVersion: v1alpha1
kind: HTTPProbeConfig
name: http-check # Name of the probe.
interval: 1s # Interval between probe attempts.
failureThreshold: 3 # Number of consecutive failures for the probe to be considered failed after having succeeded.
url: https://example.com # HTTP or HTTPS URL to probe. The probe succeeds if the server responds with a 2xx or 3xx status code.
timeout: 10s # Timeout for the probe.
```

<table>
  <thead>
    <tr>
      <th>Field</th>
      <th>Type</th>
      <th>Description</th>
      <th>Value(s)</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>`name`</td>
      <td>string</td>
      <td>Name of the probe.</td>

      <td />
    </tr>

    <tr>
      <td>`interval`</td>
      <td>Duration</td>
      <td>Interval between probe attempts.<br />Defaults to 1s.</td>

      <td />
    </tr>

    <tr>
      <td>`failureThreshold`</td>
      <td>int</td>
      <td>Number of consecutive failures for the probe to be considered failed after having succeeded.<br />Defaults to 0 (immediately fail on first failure).</td>

      <td />
    </tr>

    <tr>
      <td>`url`</td>
      <td>URL</td>
      <td>HTTP or HTTPS URL to probe. The probe succeeds if the server responds with a 2xx or 3xx status code.<br />Probe does not follow redirects.</td>

      <td />
    </tr>

    <tr>
      <td>`timeout`</td>
      <td>Duration</td>
      <td>Timeout for the probe.<br />Defaults to 10s.</td>

      <td />
    </tr>
  </tbody>
</table>