# Pools ## List Pools `load_balancers.pools.list(PoolListParams**kwargs) -> SyncSinglePage[Pool]` **get** `/accounts/{account_id}/load_balancers/pools` List configured pools. ### Parameters - `account_id: str` Identifier. - `monitor: Optional[str]` The ID of the Monitor to use for checking the health of origins within this pool. ### Returns - `class Pool: …` - `id: Optional[str]` - `check_regions: Optional[List[CheckRegion]]` A list of regions from which to run health checks. Null means every Cloudflare data center. - `"WNAM"` - `"ENAM"` - `"WEU"` - `"EEU"` - `"NSAM"` - `"SSAM"` - `"OC"` - `"ME"` - `"NAF"` - `"SAF"` - `"SAS"` - `"SEAS"` - `"NEAS"` - `"ALL_REGIONS"` - `created_on: Optional[str]` - `description: Optional[str]` A human-readable description of the pool. - `disabled_at: Optional[datetime]` This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at. - `enabled: Optional[bool]` Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any). - `latitude: Optional[float]` The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set. - `load_shedding: Optional[LoadShedding]` Configures load shedding policies and percentages for the pool. - `default_percent: Optional[float]` The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity. - `default_policy: Optional[Literal["random", "hash"]]` The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs. - `"random"` - `"hash"` - `session_percent: Optional[float]` The percent of existing sessions to shed from the pool, according to the session policy. - `session_policy: Optional[Literal["hash"]]` Only the hash policy is supported for existing sessions (to avoid exponential decay). - `"hash"` - `longitude: Optional[float]` The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set. - `minimum_origins: Optional[int]` The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool. - `modified_on: Optional[str]` - `monitor: Optional[str]` The ID of the Monitor to use for checking the health of origins within this pool. - `monitor_group: Optional[str]` The ID of the Monitor Group to use for checking the health of origins within this pool. - `name: Optional[str]` A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed. - `networks: Optional[List[str]]` List of networks where Load Balancer or Pool is enabled. - `notification_email: Optional[str]` This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list. - `notification_filter: Optional[NotificationFilter]` Filter pool and origin health notifications by resource type or health status. Use null to reset. - `origin: Optional[FilterOptions]` Filter options for a particular resource type (pool or origin). Use null to reset. - `disable: Optional[bool]` If set true, disable notifications for this type of resource (pool or origin). - `healthy: Optional[bool]` If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events). - `pool: Optional[FilterOptions]` Filter options for a particular resource type (pool or origin). Use null to reset. - `origin_steering: Optional[OriginSteering]` Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity. - `policy: Optional[Literal["random", "hash", "least_outstanding_requests", "least_connections"]]` The type of origin steering policy to use. - `"random"`: Select an origin randomly. - `"hash"`: Select an origin by computing a hash over the CF-Connecting-IP address. - `"least_outstanding_requests"`: Select an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others. - `"least_connections"`: Select an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections. - `"random"` - `"hash"` - `"least_outstanding_requests"` - `"least_connections"` - `origins: Optional[List[Origin]]` The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy. - `address: Optional[str]` The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtual_network_id must also be set. - `disabled_at: Optional[datetime]` This field shows up only if the origin is disabled. This field is set with the time the origin was disabled. - `enabled: Optional[bool]` Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool. - `header: Optional[Header]` The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'. - `host: Optional[List[Host]]` The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin. - `name: Optional[str]` A human-identifiable name for the origin. - `port: Optional[int]` The port for upstream connections. A value of 0 means the default port for the protocol will be used. - `virtual_network_id: Optional[str]` The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account. - `weight: Optional[float]` The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool. - `origin_steering.policy="least_outstanding_requests"`: Use weight to scale the origin's outstanding requests. - `origin_steering.policy="least_connections"`: Use weight to scale the origin's open connections. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) page = client.load_balancers.pools.list( account_id="023e105f4ecef8ad9ca31a8372d0c353", ) page = page.result[0] print(page.id) ``` #### Response ```json { "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": "17b5962d775c646f3f9725cbc7a53df4", "check_regions": [ "WEU", "ENAM" ], "created_on": "2014-01-01T05:20:00.12345Z", "description": "Primary data center - Provider XYZ", "disabled_at": "2019-12-27T18:11:19.117Z", "enabled": false, "latitude": 0, "load_shedding": { "default_percent": 0, "default_policy": "random", "session_percent": 0, "session_policy": "hash" }, "longitude": 0, "minimum_origins": 0, "modified_on": "2014-01-01T05:20:00.12345Z", "monitor": "monitor", "monitor_group": "monitor_group", "name": "primary-dc-1", "networks": [ "string" ], "notification_email": "someone@example.com,sometwo@example.com", "notification_filter": { "origin": { "disable": true, "healthy": true }, "pool": { "disable": true, "healthy": false } }, "origin_steering": { "policy": "random" }, "origins": [ { "address": "0.0.0.0", "disabled_at": "2019-12-27T18:11:19.117Z", "enabled": true, "header": { "Host": [ "example.com" ] }, "name": "app-server-1", "port": 0, "virtual_network_id": "a5624d4e-044a-4ff0-b3e1-e2465353d4b4", "weight": 0.6 } ] } ], "success": true, "result_info": { "count": 20, "page": 1, "per_page": 20, "total_count": 2000, "total_pages": 100 } } ``` ## Pool Details `load_balancers.pools.get(strpool_id, PoolGetParams**kwargs) -> Pool` **get** `/accounts/{account_id}/load_balancers/pools/{pool_id}` Fetch a single configured pool. ### Parameters - `account_id: str` Identifier. - `pool_id: str` ### Returns - `class Pool: …` - `id: Optional[str]` - `check_regions: Optional[List[CheckRegion]]` A list of regions from which to run health checks. Null means every Cloudflare data center. - `"WNAM"` - `"ENAM"` - `"WEU"` - `"EEU"` - `"NSAM"` - `"SSAM"` - `"OC"` - `"ME"` - `"NAF"` - `"SAF"` - `"SAS"` - `"SEAS"` - `"NEAS"` - `"ALL_REGIONS"` - `created_on: Optional[str]` - `description: Optional[str]` A human-readable description of the pool. - `disabled_at: Optional[datetime]` This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at. - `enabled: Optional[bool]` Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any). - `latitude: Optional[float]` The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set. - `load_shedding: Optional[LoadShedding]` Configures load shedding policies and percentages for the pool. - `default_percent: Optional[float]` The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity. - `default_policy: Optional[Literal["random", "hash"]]` The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs. - `"random"` - `"hash"` - `session_percent: Optional[float]` The percent of existing sessions to shed from the pool, according to the session policy. - `session_policy: Optional[Literal["hash"]]` Only the hash policy is supported for existing sessions (to avoid exponential decay). - `"hash"` - `longitude: Optional[float]` The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set. - `minimum_origins: Optional[int]` The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool. - `modified_on: Optional[str]` - `monitor: Optional[str]` The ID of the Monitor to use for checking the health of origins within this pool. - `monitor_group: Optional[str]` The ID of the Monitor Group to use for checking the health of origins within this pool. - `name: Optional[str]` A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed. - `networks: Optional[List[str]]` List of networks where Load Balancer or Pool is enabled. - `notification_email: Optional[str]` This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list. - `notification_filter: Optional[NotificationFilter]` Filter pool and origin health notifications by resource type or health status. Use null to reset. - `origin: Optional[FilterOptions]` Filter options for a particular resource type (pool or origin). Use null to reset. - `disable: Optional[bool]` If set true, disable notifications for this type of resource (pool or origin). - `healthy: Optional[bool]` If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events). - `pool: Optional[FilterOptions]` Filter options for a particular resource type (pool or origin). Use null to reset. - `origin_steering: Optional[OriginSteering]` Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity. - `policy: Optional[Literal["random", "hash", "least_outstanding_requests", "least_connections"]]` The type of origin steering policy to use. - `"random"`: Select an origin randomly. - `"hash"`: Select an origin by computing a hash over the CF-Connecting-IP address. - `"least_outstanding_requests"`: Select an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others. - `"least_connections"`: Select an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections. - `"random"` - `"hash"` - `"least_outstanding_requests"` - `"least_connections"` - `origins: Optional[List[Origin]]` The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy. - `address: Optional[str]` The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtual_network_id must also be set. - `disabled_at: Optional[datetime]` This field shows up only if the origin is disabled. This field is set with the time the origin was disabled. - `enabled: Optional[bool]` Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool. - `header: Optional[Header]` The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'. - `host: Optional[List[Host]]` The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin. - `name: Optional[str]` A human-identifiable name for the origin. - `port: Optional[int]` The port for upstream connections. A value of 0 means the default port for the protocol will be used. - `virtual_network_id: Optional[str]` The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account. - `weight: Optional[float]` The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool. - `origin_steering.policy="least_outstanding_requests"`: Use weight to scale the origin's outstanding requests. - `origin_steering.policy="least_connections"`: Use weight to scale the origin's open connections. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) pool = client.load_balancers.pools.get( pool_id="17b5962d775c646f3f9725cbc7a53df4", account_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(pool.id) ``` #### Response ```json { "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": "17b5962d775c646f3f9725cbc7a53df4", "check_regions": [ "WEU", "ENAM" ], "created_on": "2014-01-01T05:20:00.12345Z", "description": "Primary data center - Provider XYZ", "disabled_at": "2019-12-27T18:11:19.117Z", "enabled": false, "latitude": 0, "load_shedding": { "default_percent": 0, "default_policy": "random", "session_percent": 0, "session_policy": "hash" }, "longitude": 0, "minimum_origins": 0, "modified_on": "2014-01-01T05:20:00.12345Z", "monitor": "monitor", "monitor_group": "monitor_group", "name": "primary-dc-1", "networks": [ "string" ], "notification_email": "someone@example.com,sometwo@example.com", "notification_filter": { "origin": { "disable": true, "healthy": true }, "pool": { "disable": true, "healthy": false } }, "origin_steering": { "policy": "random" }, "origins": [ { "address": "0.0.0.0", "disabled_at": "2019-12-27T18:11:19.117Z", "enabled": true, "header": { "Host": [ "example.com" ] }, "name": "app-server-1", "port": 0, "virtual_network_id": "a5624d4e-044a-4ff0-b3e1-e2465353d4b4", "weight": 0.6 } ] }, "success": true } ``` ## Create Pool `load_balancers.pools.create(PoolCreateParams**kwargs) -> Pool` **post** `/accounts/{account_id}/load_balancers/pools` Create a new pool. ### Parameters - `account_id: str` Identifier. - `name: str` A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed. - `origins: Iterable[OriginParam]` The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy. - `address: Optional[str]` The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtual_network_id must also be set. - `disabled_at: Optional[datetime]` This field shows up only if the origin is disabled. This field is set with the time the origin was disabled. - `enabled: Optional[bool]` Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool. - `header: Optional[Header]` The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'. - `host: Optional[List[Host]]` The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin. - `name: Optional[str]` A human-identifiable name for the origin. - `port: Optional[int]` The port for upstream connections. A value of 0 means the default port for the protocol will be used. - `virtual_network_id: Optional[str]` The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account. - `weight: Optional[float]` The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool. - `origin_steering.policy="least_outstanding_requests"`: Use weight to scale the origin's outstanding requests. - `origin_steering.policy="least_connections"`: Use weight to scale the origin's open connections. - `description: Optional[str]` A human-readable description of the pool. - `enabled: Optional[bool]` Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any). - `latitude: Optional[float]` The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set. - `load_shedding: Optional[LoadSheddingParam]` Configures load shedding policies and percentages for the pool. - `default_percent: Optional[float]` The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity. - `default_policy: Optional[Literal["random", "hash"]]` The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs. - `"random"` - `"hash"` - `session_percent: Optional[float]` The percent of existing sessions to shed from the pool, according to the session policy. - `session_policy: Optional[Literal["hash"]]` Only the hash policy is supported for existing sessions (to avoid exponential decay). - `"hash"` - `longitude: Optional[float]` The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set. - `minimum_origins: Optional[int]` The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool. - `monitor: Optional[str]` The ID of the Monitor to use for checking the health of origins within this pool. - `monitor_group: Optional[str]` The ID of the Monitor Group to use for checking the health of origins within this pool. - `notification_email: Optional[str]` This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list. - `notification_filter: Optional[NotificationFilterParam]` Filter pool and origin health notifications by resource type or health status. Use null to reset. - `origin: Optional[FilterOptions]` Filter options for a particular resource type (pool or origin). Use null to reset. - `disable: Optional[bool]` If set true, disable notifications for this type of resource (pool or origin). - `healthy: Optional[bool]` If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events). - `pool: Optional[FilterOptions]` Filter options for a particular resource type (pool or origin). Use null to reset. - `origin_steering: Optional[OriginSteeringParam]` Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity. - `policy: Optional[Literal["random", "hash", "least_outstanding_requests", "least_connections"]]` The type of origin steering policy to use. - `"random"`: Select an origin randomly. - `"hash"`: Select an origin by computing a hash over the CF-Connecting-IP address. - `"least_outstanding_requests"`: Select an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others. - `"least_connections"`: Select an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections. - `"random"` - `"hash"` - `"least_outstanding_requests"` - `"least_connections"` ### Returns - `class Pool: …` - `id: Optional[str]` - `check_regions: Optional[List[CheckRegion]]` A list of regions from which to run health checks. Null means every Cloudflare data center. - `"WNAM"` - `"ENAM"` - `"WEU"` - `"EEU"` - `"NSAM"` - `"SSAM"` - `"OC"` - `"ME"` - `"NAF"` - `"SAF"` - `"SAS"` - `"SEAS"` - `"NEAS"` - `"ALL_REGIONS"` - `created_on: Optional[str]` - `description: Optional[str]` A human-readable description of the pool. - `disabled_at: Optional[datetime]` This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at. - `enabled: Optional[bool]` Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any). - `latitude: Optional[float]` The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set. - `load_shedding: Optional[LoadShedding]` Configures load shedding policies and percentages for the pool. - `default_percent: Optional[float]` The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity. - `default_policy: Optional[Literal["random", "hash"]]` The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs. - `"random"` - `"hash"` - `session_percent: Optional[float]` The percent of existing sessions to shed from the pool, according to the session policy. - `session_policy: Optional[Literal["hash"]]` Only the hash policy is supported for existing sessions (to avoid exponential decay). - `"hash"` - `longitude: Optional[float]` The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set. - `minimum_origins: Optional[int]` The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool. - `modified_on: Optional[str]` - `monitor: Optional[str]` The ID of the Monitor to use for checking the health of origins within this pool. - `monitor_group: Optional[str]` The ID of the Monitor Group to use for checking the health of origins within this pool. - `name: Optional[str]` A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed. - `networks: Optional[List[str]]` List of networks where Load Balancer or Pool is enabled. - `notification_email: Optional[str]` This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list. - `notification_filter: Optional[NotificationFilter]` Filter pool and origin health notifications by resource type or health status. Use null to reset. - `origin: Optional[FilterOptions]` Filter options for a particular resource type (pool or origin). Use null to reset. - `disable: Optional[bool]` If set true, disable notifications for this type of resource (pool or origin). - `healthy: Optional[bool]` If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events). - `pool: Optional[FilterOptions]` Filter options for a particular resource type (pool or origin). Use null to reset. - `origin_steering: Optional[OriginSteering]` Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity. - `policy: Optional[Literal["random", "hash", "least_outstanding_requests", "least_connections"]]` The type of origin steering policy to use. - `"random"`: Select an origin randomly. - `"hash"`: Select an origin by computing a hash over the CF-Connecting-IP address. - `"least_outstanding_requests"`: Select an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others. - `"least_connections"`: Select an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections. - `"random"` - `"hash"` - `"least_outstanding_requests"` - `"least_connections"` - `origins: Optional[List[Origin]]` The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy. - `address: Optional[str]` The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtual_network_id must also be set. - `disabled_at: Optional[datetime]` This field shows up only if the origin is disabled. This field is set with the time the origin was disabled. - `enabled: Optional[bool]` Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool. - `header: Optional[Header]` The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'. - `host: Optional[List[Host]]` The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin. - `name: Optional[str]` A human-identifiable name for the origin. - `port: Optional[int]` The port for upstream connections. A value of 0 means the default port for the protocol will be used. - `virtual_network_id: Optional[str]` The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account. - `weight: Optional[float]` The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool. - `origin_steering.policy="least_outstanding_requests"`: Use weight to scale the origin's outstanding requests. - `origin_steering.policy="least_connections"`: Use weight to scale the origin's open connections. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) pool = client.load_balancers.pools.create( account_id="023e105f4ecef8ad9ca31a8372d0c353", name="primary-dc-1", origins=[{}], ) print(pool.id) ``` #### Response ```json { "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": "17b5962d775c646f3f9725cbc7a53df4", "check_regions": [ "WEU", "ENAM" ], "created_on": "2014-01-01T05:20:00.12345Z", "description": "Primary data center - Provider XYZ", "disabled_at": "2019-12-27T18:11:19.117Z", "enabled": false, "latitude": 0, "load_shedding": { "default_percent": 0, "default_policy": "random", "session_percent": 0, "session_policy": "hash" }, "longitude": 0, "minimum_origins": 0, "modified_on": "2014-01-01T05:20:00.12345Z", "monitor": "monitor", "monitor_group": "monitor_group", "name": "primary-dc-1", "networks": [ "string" ], "notification_email": "someone@example.com,sometwo@example.com", "notification_filter": { "origin": { "disable": true, "healthy": true }, "pool": { "disable": true, "healthy": false } }, "origin_steering": { "policy": "random" }, "origins": [ { "address": "0.0.0.0", "disabled_at": "2019-12-27T18:11:19.117Z", "enabled": true, "header": { "Host": [ "example.com" ] }, "name": "app-server-1", "port": 0, "virtual_network_id": "a5624d4e-044a-4ff0-b3e1-e2465353d4b4", "weight": 0.6 } ] }, "success": true } ``` ## Update Pool `load_balancers.pools.update(strpool_id, PoolUpdateParams**kwargs) -> Pool` **put** `/accounts/{account_id}/load_balancers/pools/{pool_id}` Modify a configured pool. ### Parameters - `account_id: str` Identifier. - `pool_id: str` - `name: str` A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed. - `origins: Iterable[OriginParam]` The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy. - `address: Optional[str]` The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtual_network_id must also be set. - `disabled_at: Optional[datetime]` This field shows up only if the origin is disabled. This field is set with the time the origin was disabled. - `enabled: Optional[bool]` Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool. - `header: Optional[Header]` The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'. - `host: Optional[List[Host]]` The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin. - `name: Optional[str]` A human-identifiable name for the origin. - `port: Optional[int]` The port for upstream connections. A value of 0 means the default port for the protocol will be used. - `virtual_network_id: Optional[str]` The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account. - `weight: Optional[float]` The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool. - `origin_steering.policy="least_outstanding_requests"`: Use weight to scale the origin's outstanding requests. - `origin_steering.policy="least_connections"`: Use weight to scale the origin's open connections. - `check_regions: Optional[List[CheckRegion]]` A list of regions from which to run health checks. Null means every Cloudflare data center. - `"WNAM"` - `"ENAM"` - `"WEU"` - `"EEU"` - `"NSAM"` - `"SSAM"` - `"OC"` - `"ME"` - `"NAF"` - `"SAF"` - `"SAS"` - `"SEAS"` - `"NEAS"` - `"ALL_REGIONS"` - `description: Optional[str]` A human-readable description of the pool. - `enabled: Optional[bool]` Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any). - `latitude: Optional[float]` The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set. - `load_shedding: Optional[LoadSheddingParam]` Configures load shedding policies and percentages for the pool. - `default_percent: Optional[float]` The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity. - `default_policy: Optional[Literal["random", "hash"]]` The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs. - `"random"` - `"hash"` - `session_percent: Optional[float]` The percent of existing sessions to shed from the pool, according to the session policy. - `session_policy: Optional[Literal["hash"]]` Only the hash policy is supported for existing sessions (to avoid exponential decay). - `"hash"` - `longitude: Optional[float]` The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set. - `minimum_origins: Optional[int]` The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool. - `monitor: Optional[str]` The ID of the Monitor to use for checking the health of origins within this pool. - `monitor_group: Optional[str]` The ID of the Monitor Group to use for checking the health of origins within this pool. - `notification_email: Optional[str]` This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list. - `notification_filter: Optional[NotificationFilterParam]` Filter pool and origin health notifications by resource type or health status. Use null to reset. - `origin: Optional[FilterOptions]` Filter options for a particular resource type (pool or origin). Use null to reset. - `disable: Optional[bool]` If set true, disable notifications for this type of resource (pool or origin). - `healthy: Optional[bool]` If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events). - `pool: Optional[FilterOptions]` Filter options for a particular resource type (pool or origin). Use null to reset. - `origin_steering: Optional[OriginSteeringParam]` Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity. - `policy: Optional[Literal["random", "hash", "least_outstanding_requests", "least_connections"]]` The type of origin steering policy to use. - `"random"`: Select an origin randomly. - `"hash"`: Select an origin by computing a hash over the CF-Connecting-IP address. - `"least_outstanding_requests"`: Select an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others. - `"least_connections"`: Select an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections. - `"random"` - `"hash"` - `"least_outstanding_requests"` - `"least_connections"` ### Returns - `class Pool: …` - `id: Optional[str]` - `check_regions: Optional[List[CheckRegion]]` A list of regions from which to run health checks. Null means every Cloudflare data center. - `"WNAM"` - `"ENAM"` - `"WEU"` - `"EEU"` - `"NSAM"` - `"SSAM"` - `"OC"` - `"ME"` - `"NAF"` - `"SAF"` - `"SAS"` - `"SEAS"` - `"NEAS"` - `"ALL_REGIONS"` - `created_on: Optional[str]` - `description: Optional[str]` A human-readable description of the pool. - `disabled_at: Optional[datetime]` This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at. - `enabled: Optional[bool]` Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any). - `latitude: Optional[float]` The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set. - `load_shedding: Optional[LoadShedding]` Configures load shedding policies and percentages for the pool. - `default_percent: Optional[float]` The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity. - `default_policy: Optional[Literal["random", "hash"]]` The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs. - `"random"` - `"hash"` - `session_percent: Optional[float]` The percent of existing sessions to shed from the pool, according to the session policy. - `session_policy: Optional[Literal["hash"]]` Only the hash policy is supported for existing sessions (to avoid exponential decay). - `"hash"` - `longitude: Optional[float]` The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set. - `minimum_origins: Optional[int]` The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool. - `modified_on: Optional[str]` - `monitor: Optional[str]` The ID of the Monitor to use for checking the health of origins within this pool. - `monitor_group: Optional[str]` The ID of the Monitor Group to use for checking the health of origins within this pool. - `name: Optional[str]` A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed. - `networks: Optional[List[str]]` List of networks where Load Balancer or Pool is enabled. - `notification_email: Optional[str]` This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list. - `notification_filter: Optional[NotificationFilter]` Filter pool and origin health notifications by resource type or health status. Use null to reset. - `origin: Optional[FilterOptions]` Filter options for a particular resource type (pool or origin). Use null to reset. - `disable: Optional[bool]` If set true, disable notifications for this type of resource (pool or origin). - `healthy: Optional[bool]` If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events). - `pool: Optional[FilterOptions]` Filter options for a particular resource type (pool or origin). Use null to reset. - `origin_steering: Optional[OriginSteering]` Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity. - `policy: Optional[Literal["random", "hash", "least_outstanding_requests", "least_connections"]]` The type of origin steering policy to use. - `"random"`: Select an origin randomly. - `"hash"`: Select an origin by computing a hash over the CF-Connecting-IP address. - `"least_outstanding_requests"`: Select an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others. - `"least_connections"`: Select an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections. - `"random"` - `"hash"` - `"least_outstanding_requests"` - `"least_connections"` - `origins: Optional[List[Origin]]` The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy. - `address: Optional[str]` The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtual_network_id must also be set. - `disabled_at: Optional[datetime]` This field shows up only if the origin is disabled. This field is set with the time the origin was disabled. - `enabled: Optional[bool]` Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool. - `header: Optional[Header]` The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'. - `host: Optional[List[Host]]` The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin. - `name: Optional[str]` A human-identifiable name for the origin. - `port: Optional[int]` The port for upstream connections. A value of 0 means the default port for the protocol will be used. - `virtual_network_id: Optional[str]` The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account. - `weight: Optional[float]` The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool. - `origin_steering.policy="least_outstanding_requests"`: Use weight to scale the origin's outstanding requests. - `origin_steering.policy="least_connections"`: Use weight to scale the origin's open connections. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) pool = client.load_balancers.pools.update( pool_id="17b5962d775c646f3f9725cbc7a53df4", account_id="023e105f4ecef8ad9ca31a8372d0c353", name="primary-dc-1", origins=[{}], ) print(pool.id) ``` #### Response ```json { "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": "17b5962d775c646f3f9725cbc7a53df4", "check_regions": [ "WEU", "ENAM" ], "created_on": "2014-01-01T05:20:00.12345Z", "description": "Primary data center - Provider XYZ", "disabled_at": "2019-12-27T18:11:19.117Z", "enabled": false, "latitude": 0, "load_shedding": { "default_percent": 0, "default_policy": "random", "session_percent": 0, "session_policy": "hash" }, "longitude": 0, "minimum_origins": 0, "modified_on": "2014-01-01T05:20:00.12345Z", "monitor": "monitor", "monitor_group": "monitor_group", "name": "primary-dc-1", "networks": [ "string" ], "notification_email": "someone@example.com,sometwo@example.com", "notification_filter": { "origin": { "disable": true, "healthy": true }, "pool": { "disable": true, "healthy": false } }, "origin_steering": { "policy": "random" }, "origins": [ { "address": "0.0.0.0", "disabled_at": "2019-12-27T18:11:19.117Z", "enabled": true, "header": { "Host": [ "example.com" ] }, "name": "app-server-1", "port": 0, "virtual_network_id": "a5624d4e-044a-4ff0-b3e1-e2465353d4b4", "weight": 0.6 } ] }, "success": true } ``` ## Patch Pool `load_balancers.pools.edit(strpool_id, PoolEditParams**kwargs) -> Pool` **patch** `/accounts/{account_id}/load_balancers/pools/{pool_id}` Apply changes to an existing pool, overwriting the supplied properties. ### Parameters - `account_id: str` Identifier. - `pool_id: str` - `check_regions: Optional[List[CheckRegion]]` A list of regions from which to run health checks. Null means every Cloudflare data center. - `"WNAM"` - `"ENAM"` - `"WEU"` - `"EEU"` - `"NSAM"` - `"SSAM"` - `"OC"` - `"ME"` - `"NAF"` - `"SAF"` - `"SAS"` - `"SEAS"` - `"NEAS"` - `"ALL_REGIONS"` - `description: Optional[str]` A human-readable description of the pool. - `enabled: Optional[bool]` Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any). - `latitude: Optional[float]` The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set. - `load_shedding: Optional[LoadSheddingParam]` Configures load shedding policies and percentages for the pool. - `default_percent: Optional[float]` The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity. - `default_policy: Optional[Literal["random", "hash"]]` The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs. - `"random"` - `"hash"` - `session_percent: Optional[float]` The percent of existing sessions to shed from the pool, according to the session policy. - `session_policy: Optional[Literal["hash"]]` Only the hash policy is supported for existing sessions (to avoid exponential decay). - `"hash"` - `longitude: Optional[float]` The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set. - `minimum_origins: Optional[int]` The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool. - `monitor: Optional[str]` The ID of the Monitor to use for checking the health of origins within this pool. - `monitor_group: Optional[str]` The ID of the Monitor Group to use for checking the health of origins within this pool. - `name: Optional[str]` A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed. - `notification_email: Optional[str]` This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list. - `notification_filter: Optional[NotificationFilterParam]` Filter pool and origin health notifications by resource type or health status. Use null to reset. - `origin: Optional[FilterOptions]` Filter options for a particular resource type (pool or origin). Use null to reset. - `disable: Optional[bool]` If set true, disable notifications for this type of resource (pool or origin). - `healthy: Optional[bool]` If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events). - `pool: Optional[FilterOptions]` Filter options for a particular resource type (pool or origin). Use null to reset. - `origin_steering: Optional[OriginSteeringParam]` Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity. - `policy: Optional[Literal["random", "hash", "least_outstanding_requests", "least_connections"]]` The type of origin steering policy to use. - `"random"`: Select an origin randomly. - `"hash"`: Select an origin by computing a hash over the CF-Connecting-IP address. - `"least_outstanding_requests"`: Select an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others. - `"least_connections"`: Select an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections. - `"random"` - `"hash"` - `"least_outstanding_requests"` - `"least_connections"` - `origins: Optional[Iterable[OriginParam]]` The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy. - `address: Optional[str]` The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtual_network_id must also be set. - `disabled_at: Optional[datetime]` This field shows up only if the origin is disabled. This field is set with the time the origin was disabled. - `enabled: Optional[bool]` Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool. - `header: Optional[Header]` The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'. - `host: Optional[List[Host]]` The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin. - `name: Optional[str]` A human-identifiable name for the origin. - `port: Optional[int]` The port for upstream connections. A value of 0 means the default port for the protocol will be used. - `virtual_network_id: Optional[str]` The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account. - `weight: Optional[float]` The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool. - `origin_steering.policy="least_outstanding_requests"`: Use weight to scale the origin's outstanding requests. - `origin_steering.policy="least_connections"`: Use weight to scale the origin's open connections. ### Returns - `class Pool: …` - `id: Optional[str]` - `check_regions: Optional[List[CheckRegion]]` A list of regions from which to run health checks. Null means every Cloudflare data center. - `"WNAM"` - `"ENAM"` - `"WEU"` - `"EEU"` - `"NSAM"` - `"SSAM"` - `"OC"` - `"ME"` - `"NAF"` - `"SAF"` - `"SAS"` - `"SEAS"` - `"NEAS"` - `"ALL_REGIONS"` - `created_on: Optional[str]` - `description: Optional[str]` A human-readable description of the pool. - `disabled_at: Optional[datetime]` This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at. - `enabled: Optional[bool]` Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any). - `latitude: Optional[float]` The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set. - `load_shedding: Optional[LoadShedding]` Configures load shedding policies and percentages for the pool. - `default_percent: Optional[float]` The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity. - `default_policy: Optional[Literal["random", "hash"]]` The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs. - `"random"` - `"hash"` - `session_percent: Optional[float]` The percent of existing sessions to shed from the pool, according to the session policy. - `session_policy: Optional[Literal["hash"]]` Only the hash policy is supported for existing sessions (to avoid exponential decay). - `"hash"` - `longitude: Optional[float]` The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set. - `minimum_origins: Optional[int]` The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool. - `modified_on: Optional[str]` - `monitor: Optional[str]` The ID of the Monitor to use for checking the health of origins within this pool. - `monitor_group: Optional[str]` The ID of the Monitor Group to use for checking the health of origins within this pool. - `name: Optional[str]` A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed. - `networks: Optional[List[str]]` List of networks where Load Balancer or Pool is enabled. - `notification_email: Optional[str]` This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list. - `notification_filter: Optional[NotificationFilter]` Filter pool and origin health notifications by resource type or health status. Use null to reset. - `origin: Optional[FilterOptions]` Filter options for a particular resource type (pool or origin). Use null to reset. - `disable: Optional[bool]` If set true, disable notifications for this type of resource (pool or origin). - `healthy: Optional[bool]` If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events). - `pool: Optional[FilterOptions]` Filter options for a particular resource type (pool or origin). Use null to reset. - `origin_steering: Optional[OriginSteering]` Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity. - `policy: Optional[Literal["random", "hash", "least_outstanding_requests", "least_connections"]]` The type of origin steering policy to use. - `"random"`: Select an origin randomly. - `"hash"`: Select an origin by computing a hash over the CF-Connecting-IP address. - `"least_outstanding_requests"`: Select an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others. - `"least_connections"`: Select an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections. - `"random"` - `"hash"` - `"least_outstanding_requests"` - `"least_connections"` - `origins: Optional[List[Origin]]` The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy. - `address: Optional[str]` The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtual_network_id must also be set. - `disabled_at: Optional[datetime]` This field shows up only if the origin is disabled. This field is set with the time the origin was disabled. - `enabled: Optional[bool]` Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool. - `header: Optional[Header]` The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'. - `host: Optional[List[Host]]` The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin. - `name: Optional[str]` A human-identifiable name for the origin. - `port: Optional[int]` The port for upstream connections. A value of 0 means the default port for the protocol will be used. - `virtual_network_id: Optional[str]` The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account. - `weight: Optional[float]` The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool. - `origin_steering.policy="least_outstanding_requests"`: Use weight to scale the origin's outstanding requests. - `origin_steering.policy="least_connections"`: Use weight to scale the origin's open connections. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) pool = client.load_balancers.pools.edit( pool_id="17b5962d775c646f3f9725cbc7a53df4", account_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(pool.id) ``` #### Response ```json { "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": "17b5962d775c646f3f9725cbc7a53df4", "check_regions": [ "WEU", "ENAM" ], "created_on": "2014-01-01T05:20:00.12345Z", "description": "Primary data center - Provider XYZ", "disabled_at": "2019-12-27T18:11:19.117Z", "enabled": false, "latitude": 0, "load_shedding": { "default_percent": 0, "default_policy": "random", "session_percent": 0, "session_policy": "hash" }, "longitude": 0, "minimum_origins": 0, "modified_on": "2014-01-01T05:20:00.12345Z", "monitor": "monitor", "monitor_group": "monitor_group", "name": "primary-dc-1", "networks": [ "string" ], "notification_email": "someone@example.com,sometwo@example.com", "notification_filter": { "origin": { "disable": true, "healthy": true }, "pool": { "disable": true, "healthy": false } }, "origin_steering": { "policy": "random" }, "origins": [ { "address": "0.0.0.0", "disabled_at": "2019-12-27T18:11:19.117Z", "enabled": true, "header": { "Host": [ "example.com" ] }, "name": "app-server-1", "port": 0, "virtual_network_id": "a5624d4e-044a-4ff0-b3e1-e2465353d4b4", "weight": 0.6 } ] }, "success": true } ``` ## Delete Pool `load_balancers.pools.delete(strpool_id, PoolDeleteParams**kwargs) -> PoolDeleteResponse` **delete** `/accounts/{account_id}/load_balancers/pools/{pool_id}` Delete a configured pool. ### Parameters - `account_id: str` Identifier. - `pool_id: str` ### Returns - `class PoolDeleteResponse: …` - `id: Optional[str]` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) pool = client.load_balancers.pools.delete( pool_id="17b5962d775c646f3f9725cbc7a53df4", account_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(pool.id) ``` #### Response ```json { "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": "17b5962d775c646f3f9725cbc7a53df4" }, "success": true } ``` ## Patch Pools `load_balancers.pools.bulk_edit(PoolBulkEditParams**kwargs) -> SyncSinglePage[Pool]` **patch** `/accounts/{account_id}/load_balancers/pools` Apply changes to a number of existing pools, overwriting the supplied properties. Pools are ordered by ascending `name`. Returns the list of affected pools. Supports the standard pagination query parameters, either `limit`/`offset` or `per_page`/`page`. ### Parameters - `account_id: str` Identifier. - `notification_email: Optional[Literal[""]]` The email address to send health status notifications to. This field is now deprecated in favor of Cloudflare Notifications for Load Balancing, so only resetting this field with an empty string `""` is accepted. - `""` ### Returns - `class Pool: …` - `id: Optional[str]` - `check_regions: Optional[List[CheckRegion]]` A list of regions from which to run health checks. Null means every Cloudflare data center. - `"WNAM"` - `"ENAM"` - `"WEU"` - `"EEU"` - `"NSAM"` - `"SSAM"` - `"OC"` - `"ME"` - `"NAF"` - `"SAF"` - `"SAS"` - `"SEAS"` - `"NEAS"` - `"ALL_REGIONS"` - `created_on: Optional[str]` - `description: Optional[str]` A human-readable description of the pool. - `disabled_at: Optional[datetime]` This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at. - `enabled: Optional[bool]` Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any). - `latitude: Optional[float]` The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set. - `load_shedding: Optional[LoadShedding]` Configures load shedding policies and percentages for the pool. - `default_percent: Optional[float]` The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity. - `default_policy: Optional[Literal["random", "hash"]]` The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs. - `"random"` - `"hash"` - `session_percent: Optional[float]` The percent of existing sessions to shed from the pool, according to the session policy. - `session_policy: Optional[Literal["hash"]]` Only the hash policy is supported for existing sessions (to avoid exponential decay). - `"hash"` - `longitude: Optional[float]` The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set. - `minimum_origins: Optional[int]` The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool. - `modified_on: Optional[str]` - `monitor: Optional[str]` The ID of the Monitor to use for checking the health of origins within this pool. - `monitor_group: Optional[str]` The ID of the Monitor Group to use for checking the health of origins within this pool. - `name: Optional[str]` A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed. - `networks: Optional[List[str]]` List of networks where Load Balancer or Pool is enabled. - `notification_email: Optional[str]` This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list. - `notification_filter: Optional[NotificationFilter]` Filter pool and origin health notifications by resource type or health status. Use null to reset. - `origin: Optional[FilterOptions]` Filter options for a particular resource type (pool or origin). Use null to reset. - `disable: Optional[bool]` If set true, disable notifications for this type of resource (pool or origin). - `healthy: Optional[bool]` If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events). - `pool: Optional[FilterOptions]` Filter options for a particular resource type (pool or origin). Use null to reset. - `origin_steering: Optional[OriginSteering]` Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity. - `policy: Optional[Literal["random", "hash", "least_outstanding_requests", "least_connections"]]` The type of origin steering policy to use. - `"random"`: Select an origin randomly. - `"hash"`: Select an origin by computing a hash over the CF-Connecting-IP address. - `"least_outstanding_requests"`: Select an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others. - `"least_connections"`: Select an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections. - `"random"` - `"hash"` - `"least_outstanding_requests"` - `"least_connections"` - `origins: Optional[List[Origin]]` The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy. - `address: Optional[str]` The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtual_network_id must also be set. - `disabled_at: Optional[datetime]` This field shows up only if the origin is disabled. This field is set with the time the origin was disabled. - `enabled: Optional[bool]` Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool. - `header: Optional[Header]` The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'. - `host: Optional[List[Host]]` The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin. - `name: Optional[str]` A human-identifiable name for the origin. - `port: Optional[int]` The port for upstream connections. A value of 0 means the default port for the protocol will be used. - `virtual_network_id: Optional[str]` The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account. - `weight: Optional[float]` The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool. - `origin_steering.policy="least_outstanding_requests"`: Use weight to scale the origin's outstanding requests. - `origin_steering.policy="least_connections"`: Use weight to scale the origin's open connections. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) page = client.load_balancers.pools.bulk_edit( account_id="023e105f4ecef8ad9ca31a8372d0c353", ) page = page.result[0] print(page.id) ``` #### Response ```json { "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": "17b5962d775c646f3f9725cbc7a53df4", "check_regions": [ "WEU", "ENAM" ], "created_on": "2014-01-01T05:20:00.12345Z", "description": "Primary data center - Provider XYZ", "disabled_at": "2019-12-27T18:11:19.117Z", "enabled": false, "latitude": 0, "load_shedding": { "default_percent": 0, "default_policy": "random", "session_percent": 0, "session_policy": "hash" }, "longitude": 0, "minimum_origins": 0, "modified_on": "2014-01-01T05:20:00.12345Z", "monitor": "monitor", "monitor_group": "monitor_group", "name": "primary-dc-1", "networks": [ "string" ], "notification_email": "someone@example.com,sometwo@example.com", "notification_filter": { "origin": { "disable": true, "healthy": true }, "pool": { "disable": true, "healthy": false } }, "origin_steering": { "policy": "random" }, "origins": [ { "address": "0.0.0.0", "disabled_at": "2019-12-27T18:11:19.117Z", "enabled": true, "header": { "Host": [ "example.com" ] }, "name": "app-server-1", "port": 0, "virtual_network_id": "a5624d4e-044a-4ff0-b3e1-e2465353d4b4", "weight": 0.6 } ] } ], "success": true, "result_info": { "count": 20, "page": 1, "per_page": 20, "total_count": 2000, "total_pages": 100 } } ``` ## Domain Types ### Pool - `class Pool: …` - `id: Optional[str]` - `check_regions: Optional[List[CheckRegion]]` A list of regions from which to run health checks. Null means every Cloudflare data center. - `"WNAM"` - `"ENAM"` - `"WEU"` - `"EEU"` - `"NSAM"` - `"SSAM"` - `"OC"` - `"ME"` - `"NAF"` - `"SAF"` - `"SAS"` - `"SEAS"` - `"NEAS"` - `"ALL_REGIONS"` - `created_on: Optional[str]` - `description: Optional[str]` A human-readable description of the pool. - `disabled_at: Optional[datetime]` This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at. - `enabled: Optional[bool]` Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any). - `latitude: Optional[float]` The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set. - `load_shedding: Optional[LoadShedding]` Configures load shedding policies and percentages for the pool. - `default_percent: Optional[float]` The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity. - `default_policy: Optional[Literal["random", "hash"]]` The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs. - `"random"` - `"hash"` - `session_percent: Optional[float]` The percent of existing sessions to shed from the pool, according to the session policy. - `session_policy: Optional[Literal["hash"]]` Only the hash policy is supported for existing sessions (to avoid exponential decay). - `"hash"` - `longitude: Optional[float]` The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set. - `minimum_origins: Optional[int]` The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool. - `modified_on: Optional[str]` - `monitor: Optional[str]` The ID of the Monitor to use for checking the health of origins within this pool. - `monitor_group: Optional[str]` The ID of the Monitor Group to use for checking the health of origins within this pool. - `name: Optional[str]` A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed. - `networks: Optional[List[str]]` List of networks where Load Balancer or Pool is enabled. - `notification_email: Optional[str]` This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list. - `notification_filter: Optional[NotificationFilter]` Filter pool and origin health notifications by resource type or health status. Use null to reset. - `origin: Optional[FilterOptions]` Filter options for a particular resource type (pool or origin). Use null to reset. - `disable: Optional[bool]` If set true, disable notifications for this type of resource (pool or origin). - `healthy: Optional[bool]` If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events). - `pool: Optional[FilterOptions]` Filter options for a particular resource type (pool or origin). Use null to reset. - `origin_steering: Optional[OriginSteering]` Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity. - `policy: Optional[Literal["random", "hash", "least_outstanding_requests", "least_connections"]]` The type of origin steering policy to use. - `"random"`: Select an origin randomly. - `"hash"`: Select an origin by computing a hash over the CF-Connecting-IP address. - `"least_outstanding_requests"`: Select an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others. - `"least_connections"`: Select an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections. - `"random"` - `"hash"` - `"least_outstanding_requests"` - `"least_connections"` - `origins: Optional[List[Origin]]` The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy. - `address: Optional[str]` The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtual_network_id must also be set. - `disabled_at: Optional[datetime]` This field shows up only if the origin is disabled. This field is set with the time the origin was disabled. - `enabled: Optional[bool]` Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool. - `header: Optional[Header]` The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'. - `host: Optional[List[Host]]` The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin. - `name: Optional[str]` A human-identifiable name for the origin. - `port: Optional[int]` The port for upstream connections. A value of 0 means the default port for the protocol will be used. - `virtual_network_id: Optional[str]` The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account. - `weight: Optional[float]` The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool. - `origin_steering.policy="least_outstanding_requests"`: Use weight to scale the origin's outstanding requests. - `origin_steering.policy="least_connections"`: Use weight to scale the origin's open connections. ### Pool Delete Response - `class PoolDeleteResponse: …` - `id: Optional[str]` # Health ## Pool Health Details `load_balancers.pools.health.get(strpool_id, HealthGetParams**kwargs) -> HealthGetResponse` **get** `/accounts/{account_id}/load_balancers/pools/{pool_id}/health` Fetch the latest pool health status for a single pool. ### Parameters - `account_id: str` Identifier. - `pool_id: str` ### Returns - `class HealthGetResponse: …` A list of regions from which to run health checks. Null means every Cloudflare data center. - `pool_id: Optional[str]` Pool ID. - `pop_health: Optional[POPHealth]` List of regions and associated health status. - `healthy: Optional[bool]` Whether health check in region is healthy. - `origins: Optional[List[POPHealthOrigin]]` - `ip: Optional[POPHealthOriginIP]` - `failure_reason: Optional[str]` Failure reason. - `healthy: Optional[bool]` Origin health status. - `response_code: Optional[float]` Response code from origin health check. - `rtt: Optional[str]` Origin RTT (Round Trip Time) response. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) health = client.load_balancers.pools.health.get( pool_id="17b5962d775c646f3f9725cbc7a53df4", account_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(health.pool_id) ``` #### Response ```json { "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": { "pool_id": "17b5962d775c646f3f9725cbc7a53df4", "pop_health": { "healthy": true, "origins": [ { "ip": { "failure_reason": "No failure reasons", "healthy": true, "response_code": 200, "rtt": "201.5ms" } } ] } }, "success": true } ``` ## Preview Pool `load_balancers.pools.health.create(strpool_id, HealthCreateParams**kwargs) -> HealthCreateResponse` **post** `/accounts/{account_id}/load_balancers/pools/{pool_id}/preview` Preview pool health using provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results. ### Parameters - `account_id: str` Identifier. - `pool_id: str` - `allow_insecure: Optional[bool]` Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors. - `consecutive_down: Optional[int]` To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. - `consecutive_up: Optional[int]` To be marked healthy the monitored origin must pass this healthcheck N consecutive times. - `description: Optional[str]` Object description. - `expected_body: Optional[str]` 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. - `expected_codes: Optional[str]` The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors. - `follow_redirects: Optional[bool]` Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors. - `header: Optional[Dict[str, SequenceNotStr[str]]]` 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. - `interval: Optional[int]` 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. - `method: Optional[str]` 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. - `path: Optional[str]` The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors. - `port: Optional[int]` 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). - `probe_zone: Optional[str]` Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors. - `retries: Optional[int]` The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. - `load_balancer_monitor_timeout: Optional[int]` The timeout (in seconds) before marking the health check as failed. - `type: Optional[Literal["http", "https", "tcp", 3 more]]` The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'. - `"http"` - `"https"` - `"tcp"` - `"udp_icmp"` - `"icmp_ping"` - `"smtp"` ### Returns - `class HealthCreateResponse: …` - `pools: Optional[Dict[str, str]]` Monitored pool IDs mapped to their respective names. - `preview_id: Optional[str]` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) health = client.load_balancers.pools.health.create( pool_id="17b5962d775c646f3f9725cbc7a53df4", account_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(health.preview_id) ``` #### Response ```json { "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": { "pools": { "abwlnp5jbqn45ecgxd03erbgtxtqai0d": "WNAM Datacenter", "ve8h9lrcip5n5bbga9yqmdws28ay5d0l": "EEU Datacenter" }, "preview_id": "f1aba936b94213e5b8dca0c0dbf1f9cc" }, "success": true } ``` ## Domain Types ### Health Get Response - `class HealthGetResponse: …` A list of regions from which to run health checks. Null means every Cloudflare data center. - `pool_id: Optional[str]` Pool ID. - `pop_health: Optional[POPHealth]` List of regions and associated health status. - `healthy: Optional[bool]` Whether health check in region is healthy. - `origins: Optional[List[POPHealthOrigin]]` - `ip: Optional[POPHealthOriginIP]` - `failure_reason: Optional[str]` Failure reason. - `healthy: Optional[bool]` Origin health status. - `response_code: Optional[float]` Response code from origin health check. - `rtt: Optional[str]` Origin RTT (Round Trip Time) response. ### Health Create Response - `class HealthCreateResponse: …` - `pools: Optional[Dict[str, str]]` Monitored pool IDs mapped to their respective names. - `preview_id: Optional[str]` # References ## List Pool References `load_balancers.pools.references.get(strpool_id, ReferenceGetParams**kwargs) -> SyncSinglePage[ReferenceGetResponse]` **get** `/accounts/{account_id}/load_balancers/pools/{pool_id}/references` Get the list of resources that reference the provided pool. ### Parameters - `account_id: str` Identifier. - `pool_id: str` ### Returns - `class ReferenceGetResponse: …` - `reference_type: Optional[Literal["*", "referral", "referrer"]]` - `"*"` - `"referral"` - `"referrer"` - `resource_id: Optional[str]` - `resource_name: Optional[str]` - `resource_type: Optional[str]` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) page = client.load_balancers.pools.references.get( pool_id="17b5962d775c646f3f9725cbc7a53df4", account_id="023e105f4ecef8ad9ca31a8372d0c353", ) page = page.result[0] print(page.resource_id) ``` #### Response ```json { "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": [ { "reference_type": "referrer", "resource_id": "699d98642c564d2e855e9661899b7252", "resource_name": "www.example.com", "resource_type": "load_balancer" }, { "reference_type": "referral", "resource_id": "f1aba936b94213e5b8dca0c0dbf1f9cc", "resource_name": "Login page monitor", "resource_type": "monitor" } ], "success": true } ``` ## Domain Types ### Reference Get Response - `class ReferenceGetResponse: …` - `reference_type: Optional[Literal["*", "referral", "referrer"]]` - `"*"` - `"referral"` - `"referrer"` - `resource_id: Optional[str]` - `resource_name: Optional[str]` - `resource_type: Optional[str]`