--- title: Create Monitor --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Load Balancers](https://developers.cloudflare.com/api/go/resources/load_balancers) [Monitors](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/monitors) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Create Monitor client.LoadBalancers.Monitors.New(ctx, params) (\*[Monitor](), error) POST/accounts/{account\_id}/load\_balancers/monitors Create a configured monitor. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `Load Balancing: Monitors and Pools Write` ##### ParametersExpand Collapse
params MonitorNewParams AccountID param.Field\[string] Path param: Identifier. maxLength32 Link to this property AllowInsecure param.Field\[bool]Optional Body param: Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors. Link to this property ConsecutiveDown param.Field\[int64]Optional Body param: To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. Link to this property ConsecutiveUp param.Field\[int64]Optional Body param: To be marked healthy the monitored origin must pass this healthcheck N consecutive times. Link to this property Description param.Field\[string]Optional Body param: Object description. Link to this property ExpectedBody param.Field\[string]Optional Body param: 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. Link to this property ExpectedCodes param.Field\[string]Optional Body param: The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors. Link to this property FollowRedirects param.Field\[bool]Optional Body param: Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors. Link to this property Header param.Field\[map\[string, \[]string]]Optional Body param: 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. Link to this property Interval param.Field\[int64]Optional Body param: 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. Link to this property Method param.Field\[string]Optional Body param: 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. Link to this property Path param.Field\[string]Optional Body param: The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors. Link to this property Port param.Field\[int64]Optional Body param: 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). Link to this property ProbeZone param.Field\[string]Optional Body param: Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors. Link to this property Retries param.Field\[int64]Optional Body param: The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. Link to this property Timeout param.Field\[int64]Optional Body param: The timeout (in seconds) before marking the health check as failed. Link to this property
Type param.Field\[MonitorNewParamsType]Optional Body param: The protocol to use for the health check. Currently supported protocols are ‘HTTP’,‘HTTPS’, ‘TCP’, ‘ICMP-PING’, ‘UDP-ICMP’, and ‘SMTP’. const MonitorNewParamsTypeHTTP MonitorNewParamsType = "http" Link to this property const MonitorNewParamsTypeHTTPS MonitorNewParamsType = "https" Link to this property const MonitorNewParamsTypeTCP MonitorNewParamsType = "tcp" Link to this property const MonitorNewParamsTypeUdpIcmp MonitorNewParamsType = "udp\_icmp" Link to this property const MonitorNewParamsTypeIcmpPing MonitorNewParamsType = "icmp\_ping" Link to this property const MonitorNewParamsTypeSmtp MonitorNewParamsType = "smtp" Link to this property
Link to this property
[Link to this property](<#(resource)%20load_balancers.monitors%20%3E%20(method)%20create%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type Monitor struct{…} ID stringOptional Link to this property AllowInsecure boolOptional Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors. Link to this property ConsecutiveDown int64Optional To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. Link to this property ConsecutiveUp int64Optional To be marked healthy the monitored origin must pass this healthcheck N consecutive times. Link to this property CreatedOn stringOptional Link to this property Description stringOptional Object description. Link to this property ExpectedBody stringOptional 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. Link to this property ExpectedCodes stringOptional The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors. Link to this property FollowRedirects boolOptional Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors. Link to this property Header map\[string, \[]string]Optional 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. Link to this property Interval int64Optional 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. Link to this property Method stringOptional 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. Link to this property ModifiedOn stringOptional Link to this property Path stringOptional The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors. Link to this property Port int64Optional 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). Link to this property ProbeZone stringOptional Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors. Link to this property Retries int64Optional The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. Link to this property Timeout int64Optional The timeout (in seconds) before marking the health check as failed. Link to this property
Type MonitorTypeOptional The protocol to use for the health check. Currently supported protocols are ‘HTTP’,‘HTTPS’, ‘TCP’, ‘ICMP-PING’, ‘UDP-ICMP’, and ‘SMTP’. One of the following: const MonitorTypeHTTP MonitorType = "http" Link to this property const MonitorTypeHTTPS MonitorType = "https" Link to this property const MonitorTypeTCP MonitorType = "tcp" Link to this property const MonitorTypeUdpIcmp MonitorType = "udp\_icmp" Link to this property const MonitorTypeIcmpPing MonitorType = "icmp\_ping" Link to this property const MonitorTypeSmtp MonitorType = "smtp" Link to this property
Link to this property
[Link to this property](<#(resource)%20load_balancers.monitors%20%3E%20(model)%20monitor%20%3E%20(schema)>) ### Create Monitor Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/load_balancers" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) monitor, err := client.LoadBalancers.Monitors.New(context.TODO(), load_balancers.MonitorNewParams{ AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", monitor.ID) } ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "id": "f1aba936b94213e5b8dca0c0dbf1f9cc", "allow_insecure": true, "consecutive_down": 0, "consecutive_up": 0, "created_on": "2014-01-01T05:20:00.12345Z", "description": "Login page monitor", "expected_body": "alive", "expected_codes": "2xx", "follow_redirects": true, "header": { "Host": [ "example.com" ], "X-App-ID": [ "abc123" ] }, "interval": 0, "method": "GET", "modified_on": "2014-01-01T05:20:00.12345Z", "path": "/health", "port": 0, "probe_zone": "example.com", "retries": 0, "timeout": 0, "type": "https" }, "success": true } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "id": "f1aba936b94213e5b8dca0c0dbf1f9cc", "allow_insecure": true, "consecutive_down": 0, "consecutive_up": 0, "created_on": "2014-01-01T05:20:00.12345Z", "description": "Login page monitor", "expected_body": "alive", "expected_codes": "2xx", "follow_redirects": true, "header": { "Host": [ "example.com" ], "X-App-ID": [ "abc123" ] }, "interval": 0, "method": "GET", "modified_on": "2014-01-01T05:20:00.12345Z", "path": "/health", "port": 0, "probe_zone": "example.com", "retries": 0, "timeout": 0, "type": "https" }, "success": true } ```