PATCH /user/load_balancers/monitors/{monitor_id}
Apply changes to an existing monitor, overwriting the supplied properties.
Servers
- https://api.cloudflare.com/client/v4
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
monitor_id |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
consecutive_down |
Integer | No |
To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. Default value: 0 |
port |
Integer | No |
The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443). Default value: 0 |
description |
String | No |
Object description. |
expected_codes |
String | No |
The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors. |
interval |
Integer | No |
The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations. Default value: 60 |
consecutive_up |
Integer | No |
To be marked healthy the monitored origin must pass this healthcheck N consecutive times. Default value: 0 |
follow_redirects |
Boolean | No |
Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors. Default value: false |
retries |
Integer | No |
The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. Default value: 2 |
path |
String | No |
The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors. Default value: "/" |
method |
String | No |
The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks. Default value: "GET" |
header |
Object | No |
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. This parameter is only valid for HTTP and HTTPS monitors. |
header.name |
String | No | |
timeout |
Integer | No |
The timeout (in seconds) before marking the health check as failed. Default value: 5 |
type |
String | No |
The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'. Possible values:
Default value: "http" |
probe_zone |
String | No |
Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors. |
allow_insecure |
Boolean | No |
Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors. Default value: false |
expected_body |
String | No |
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. This parameter is only valid for HTTP and HTTPS monitors. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.