@distilled.cloud/cloudflare 0.0.0-john
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +59 -0
- package/lib/auth.d.ts +14 -0
- package/lib/auth.d.ts.map +1 -0
- package/lib/auth.js +13 -0
- package/lib/auth.js.map +1 -0
- package/lib/category.d.ts +2 -0
- package/lib/category.d.ts.map +1 -0
- package/lib/category.js +2 -0
- package/lib/category.js.map +1 -0
- package/lib/client/api.d.ts +12 -0
- package/lib/client/api.d.ts.map +1 -0
- package/lib/client/api.js +292 -0
- package/lib/client/api.js.map +1 -0
- package/lib/client/index.d.ts +8 -0
- package/lib/client/index.d.ts.map +1 -0
- package/lib/client/index.js +8 -0
- package/lib/client/index.js.map +1 -0
- package/lib/credentials.d.ts +68 -0
- package/lib/credentials.d.ts.map +1 -0
- package/lib/credentials.js +136 -0
- package/lib/credentials.js.map +1 -0
- package/lib/errors.d.ts +48 -0
- package/lib/errors.d.ts.map +1 -0
- package/lib/errors.js +31 -0
- package/lib/errors.js.map +1 -0
- package/lib/index.d.ts +10 -0
- package/lib/index.d.ts.map +1 -0
- package/lib/index.js +10 -0
- package/lib/index.js.map +1 -0
- package/lib/retry.d.ts +14 -0
- package/lib/retry.d.ts.map +1 -0
- package/lib/retry.js +14 -0
- package/lib/retry.js.map +1 -0
- package/lib/schemas.d.ts +29 -0
- package/lib/schemas.d.ts.map +1 -0
- package/lib/schemas.js +34 -0
- package/lib/schemas.js.map +1 -0
- package/lib/sensitive.d.ts +5 -0
- package/lib/sensitive.d.ts.map +1 -0
- package/lib/sensitive.js +5 -0
- package/lib/sensitive.js.map +1 -0
- package/lib/services/abuse-reports.d.ts +296 -0
- package/lib/services/abuse-reports.d.ts.map +1 -0
- package/lib/services/abuse-reports.js +414 -0
- package/lib/services/abuse-reports.js.map +1 -0
- package/lib/services/accounts.d.ts +766 -0
- package/lib/services/accounts.d.ts.map +1 -0
- package/lib/services/accounts.js +860 -0
- package/lib/services/accounts.js.map +1 -0
- package/lib/services/acm.d.ts +73 -0
- package/lib/services/acm.d.ts.map +1 -0
- package/lib/services/acm.js +80 -0
- package/lib/services/acm.js.map +1 -0
- package/lib/services/addressing.d.ts +1321 -0
- package/lib/services/addressing.d.ts.map +1 -0
- package/lib/services/addressing.js +1863 -0
- package/lib/services/addressing.js.map +1 -0
- package/lib/services/ai-gateway.d.ts +1137 -0
- package/lib/services/ai-gateway.d.ts.map +1 -0
- package/lib/services/ai-gateway.js +1830 -0
- package/lib/services/ai-gateway.js.map +1 -0
- package/lib/services/ai.d.ts +297 -0
- package/lib/services/ai.d.ts.map +1 -0
- package/lib/services/ai.js +352 -0
- package/lib/services/ai.js.map +1 -0
- package/lib/services/aisearch.d.ts +1069 -0
- package/lib/services/aisearch.d.ts.map +1 -0
- package/lib/services/aisearch.js +2542 -0
- package/lib/services/aisearch.js.map +1 -0
- package/lib/services/alerting.d.ts +855 -0
- package/lib/services/alerting.d.ts.map +1 -0
- package/lib/services/alerting.js +1445 -0
- package/lib/services/alerting.js.map +1 -0
- package/lib/services/api-gateway.d.ts +1088 -0
- package/lib/services/api-gateway.d.ts.map +1 -0
- package/lib/services/api-gateway.js +1655 -0
- package/lib/services/api-gateway.js.map +1 -0
- package/lib/services/argo.d.ts +101 -0
- package/lib/services/argo.d.ts.map +1 -0
- package/lib/services/argo.js +113 -0
- package/lib/services/argo.js.map +1 -0
- package/lib/services/audit-logs.d.ts +46 -0
- package/lib/services/audit-logs.d.ts.map +1 -0
- package/lib/services/audit-logs.js +37 -0
- package/lib/services/audit-logs.js.map +1 -0
- package/lib/services/billing.d.ts +62 -0
- package/lib/services/billing.d.ts.map +1 -0
- package/lib/services/billing.js +102 -0
- package/lib/services/billing.js.map +1 -0
- package/lib/services/bot-management.d.ts +124 -0
- package/lib/services/bot-management.d.ts.map +1 -0
- package/lib/services/bot-management.js +262 -0
- package/lib/services/bot-management.js.map +1 -0
- package/lib/services/botnet-feed.d.ts +65 -0
- package/lib/services/botnet-feed.d.ts.map +1 -0
- package/lib/services/botnet-feed.js +88 -0
- package/lib/services/botnet-feed.js.map +1 -0
- package/lib/services/brand-protection.d.ts +194 -0
- package/lib/services/brand-protection.d.ts.map +1 -0
- package/lib/services/brand-protection.js +221 -0
- package/lib/services/brand-protection.js.map +1 -0
- package/lib/services/browser-rendering.d.ts +857 -0
- package/lib/services/browser-rendering.d.ts.map +1 -0
- package/lib/services/browser-rendering.js +1142 -0
- package/lib/services/browser-rendering.js.map +1 -0
- package/lib/services/cache.d.ts +287 -0
- package/lib/services/cache.d.ts.map +1 -0
- package/lib/services/cache.js +354 -0
- package/lib/services/cache.js.map +1 -0
- package/lib/services/calls.d.ts +223 -0
- package/lib/services/calls.d.ts.map +1 -0
- package/lib/services/calls.js +188 -0
- package/lib/services/calls.js.map +1 -0
- package/lib/services/certificate-authorities.d.ts +40 -0
- package/lib/services/certificate-authorities.d.ts.map +1 -0
- package/lib/services/certificate-authorities.js +49 -0
- package/lib/services/certificate-authorities.js.map +1 -0
- package/lib/services/client-certificates.d.ts +288 -0
- package/lib/services/client-certificates.d.ts.map +1 -0
- package/lib/services/client-certificates.js +379 -0
- package/lib/services/client-certificates.js.map +1 -0
- package/lib/services/cloud-connector.d.ts +88 -0
- package/lib/services/cloud-connector.d.ts.map +1 -0
- package/lib/services/cloud-connector.js +97 -0
- package/lib/services/cloud-connector.js.map +1 -0
- package/lib/services/cloudforce-one.d.ts +1387 -0
- package/lib/services/cloudforce-one.d.ts.map +1 -0
- package/lib/services/cloudforce-one.js +1741 -0
- package/lib/services/cloudforce-one.js.map +1 -0
- package/lib/services/connectivity.d.ts +291 -0
- package/lib/services/connectivity.d.ts.map +1 -0
- package/lib/services/connectivity.js +404 -0
- package/lib/services/connectivity.js.map +1 -0
- package/lib/services/content-scanning.d.ts +156 -0
- package/lib/services/content-scanning.d.ts.map +1 -0
- package/lib/services/content-scanning.js +175 -0
- package/lib/services/content-scanning.js.map +1 -0
- package/lib/services/custom-certificates.d.ts +240 -0
- package/lib/services/custom-certificates.d.ts.map +1 -0
- package/lib/services/custom-certificates.js +336 -0
- package/lib/services/custom-certificates.js.map +1 -0
- package/lib/services/custom-hostnames.d.ts +590 -0
- package/lib/services/custom-hostnames.d.ts.map +1 -0
- package/lib/services/custom-hostnames.js +1204 -0
- package/lib/services/custom-hostnames.js.map +1 -0
- package/lib/services/custom-nameservers.d.ts +87 -0
- package/lib/services/custom-nameservers.d.ts.map +1 -0
- package/lib/services/custom-nameservers.js +95 -0
- package/lib/services/custom-nameservers.js.map +1 -0
- package/lib/services/custom-pages.d.ts +89 -0
- package/lib/services/custom-pages.d.ts.map +1 -0
- package/lib/services/custom-pages.js +140 -0
- package/lib/services/custom-pages.js.map +1 -0
- package/lib/services/d1.d.ts +392 -0
- package/lib/services/d1.d.ts.map +1 -0
- package/lib/services/d1.js +487 -0
- package/lib/services/d1.js.map +1 -0
- package/lib/services/dcv-delegation.d.ts +24 -0
- package/lib/services/dcv-delegation.d.ts.map +1 -0
- package/lib/services/dcv-delegation.js +24 -0
- package/lib/services/dcv-delegation.js.map +1 -0
- package/lib/services/diagnostics.d.ts +208 -0
- package/lib/services/diagnostics.d.ts.map +1 -0
- package/lib/services/diagnostics.js +288 -0
- package/lib/services/diagnostics.js.map +1 -0
- package/lib/services/dns-firewall.d.ts +317 -0
- package/lib/services/dns-firewall.d.ts.map +1 -0
- package/lib/services/dns-firewall.js +400 -0
- package/lib/services/dns-firewall.js.map +1 -0
- package/lib/services/dns.d.ts +3065 -0
- package/lib/services/dns.d.ts.map +1 -0
- package/lib/services/dns.js +4627 -0
- package/lib/services/dns.js.map +1 -0
- package/lib/services/durable-objects.d.ts +92 -0
- package/lib/services/durable-objects.d.ts.map +1 -0
- package/lib/services/durable-objects.js +103 -0
- package/lib/services/durable-objects.js.map +1 -0
- package/lib/services/email-routing.d.ts +598 -0
- package/lib/services/email-routing.d.ts.map +1 -0
- package/lib/services/email-routing.js +715 -0
- package/lib/services/email-routing.js.map +1 -0
- package/lib/services/email-security.d.ts +1389 -0
- package/lib/services/email-security.d.ts.map +1 -0
- package/lib/services/email-security.js +2261 -0
- package/lib/services/email-security.js.map +1 -0
- package/lib/services/filters.d.ts +197 -0
- package/lib/services/filters.d.ts.map +1 -0
- package/lib/services/filters.js +168 -0
- package/lib/services/filters.js.map +1 -0
- package/lib/services/firewall.d.ts +1352 -0
- package/lib/services/firewall.d.ts.map +1 -0
- package/lib/services/firewall.js +2084 -0
- package/lib/services/firewall.js.map +1 -0
- package/lib/services/healthchecks.d.ts +507 -0
- package/lib/services/healthchecks.d.ts.map +1 -0
- package/lib/services/healthchecks.js +867 -0
- package/lib/services/healthchecks.js.map +1 -0
- package/lib/services/hostnames.d.ts +86 -0
- package/lib/services/hostnames.d.ts.map +1 -0
- package/lib/services/hostnames.js +111 -0
- package/lib/services/hostnames.js.map +1 -0
- package/lib/services/hyperdrive.d.ts +203 -0
- package/lib/services/hyperdrive.d.ts.map +1 -0
- package/lib/services/hyperdrive.js +300 -0
- package/lib/services/hyperdrive.js.map +1 -0
- package/lib/services/iam.d.ts +657 -0
- package/lib/services/iam.d.ts.map +1 -0
- package/lib/services/iam.js +843 -0
- package/lib/services/iam.js.map +1 -0
- package/lib/services/images.d.ts +427 -0
- package/lib/services/images.d.ts.map +1 -0
- package/lib/services/images.js +444 -0
- package/lib/services/images.js.map +1 -0
- package/lib/services/intel.d.ts +865 -0
- package/lib/services/intel.d.ts.map +1 -0
- package/lib/services/intel.js +1266 -0
- package/lib/services/intel.js.map +1 -0
- package/lib/services/ips.d.ts +28 -0
- package/lib/services/ips.d.ts.map +1 -0
- package/lib/services/ips.js +39 -0
- package/lib/services/ips.js.map +1 -0
- package/lib/services/keyless-certificates.d.ts +197 -0
- package/lib/services/keyless-certificates.d.ts.map +1 -0
- package/lib/services/keyless-certificates.js +229 -0
- package/lib/services/keyless-certificates.js.map +1 -0
- package/lib/services/kv.d.ts +369 -0
- package/lib/services/kv.d.ts.map +1 -0
- package/lib/services/kv.js +453 -0
- package/lib/services/kv.js.map +1 -0
- package/lib/services/leaked-credential-checks.d.ts +129 -0
- package/lib/services/leaked-credential-checks.d.ts.map +1 -0
- package/lib/services/leaked-credential-checks.js +138 -0
- package/lib/services/leaked-credential-checks.js.map +1 -0
- package/lib/services/load-balancers.d.ts +1973 -0
- package/lib/services/load-balancers.d.ts.map +1 -0
- package/lib/services/load-balancers.js +3181 -0
- package/lib/services/load-balancers.js.map +1 -0
- package/lib/services/logpush.d.ts +401 -0
- package/lib/services/logpush.d.ts.map +1 -0
- package/lib/services/logpush.js +732 -0
- package/lib/services/logpush.js.map +1 -0
- package/lib/services/logs.d.ts +125 -0
- package/lib/services/logs.d.ts.map +1 -0
- package/lib/services/logs.js +149 -0
- package/lib/services/logs.js.map +1 -0
- package/lib/services/magic-cloud-networking.d.ts +1892 -0
- package/lib/services/magic-cloud-networking.d.ts.map +1 -0
- package/lib/services/magic-cloud-networking.js +5291 -0
- package/lib/services/magic-cloud-networking.js.map +1 -0
- package/lib/services/magic-network-monitoring.d.ts +379 -0
- package/lib/services/magic-network-monitoring.d.ts.map +1 -0
- package/lib/services/magic-network-monitoring.js +557 -0
- package/lib/services/magic-network-monitoring.js.map +1 -0
- package/lib/services/magic-transit.d.ts +3886 -0
- package/lib/services/magic-transit.d.ts.map +1 -0
- package/lib/services/magic-transit.js +6284 -0
- package/lib/services/magic-transit.js.map +1 -0
- package/lib/services/managed-transforms.d.ts +79 -0
- package/lib/services/managed-transforms.d.ts.map +1 -0
- package/lib/services/managed-transforms.js +111 -0
- package/lib/services/managed-transforms.js.map +1 -0
- package/lib/services/memberships.d.ts +204 -0
- package/lib/services/memberships.d.ts.map +1 -0
- package/lib/services/memberships.js +308 -0
- package/lib/services/memberships.js.map +1 -0
- package/lib/services/mtls-certificates.d.ts +164 -0
- package/lib/services/mtls-certificates.d.ts.map +1 -0
- package/lib/services/mtls-certificates.js +192 -0
- package/lib/services/mtls-certificates.js.map +1 -0
- package/lib/services/network-interconnects.d.ts +410 -0
- package/lib/services/network-interconnects.d.ts.map +1 -0
- package/lib/services/network-interconnects.js +583 -0
- package/lib/services/network-interconnects.js.map +1 -0
- package/lib/services/organizations.d.ts +232 -0
- package/lib/services/organizations.d.ts.map +1 -0
- package/lib/services/organizations.js +370 -0
- package/lib/services/organizations.js.map +1 -0
- package/lib/services/origin-ca-certificates.d.ts +119 -0
- package/lib/services/origin-ca-certificates.d.ts.map +1 -0
- package/lib/services/origin-ca-certificates.js +183 -0
- package/lib/services/origin-ca-certificates.js.map +1 -0
- package/lib/services/origin-post-quantum-encryption.d.ts +50 -0
- package/lib/services/origin-post-quantum-encryption.d.ts.map +1 -0
- package/lib/services/origin-post-quantum-encryption.js +64 -0
- package/lib/services/origin-post-quantum-encryption.js.map +1 -0
- package/lib/services/origin-tls-client-auth.d.ts +308 -0
- package/lib/services/origin-tls-client-auth.d.ts.map +1 -0
- package/lib/services/origin-tls-client-auth.js +435 -0
- package/lib/services/origin-tls-client-auth.js.map +1 -0
- package/lib/services/page-rules.d.ts +773 -0
- package/lib/services/page-rules.d.ts.map +1 -0
- package/lib/services/page-rules.js +1373 -0
- package/lib/services/page-rules.js.map +1 -0
- package/lib/services/page-shield.d.ts +505 -0
- package/lib/services/page-shield.d.ts.map +1 -0
- package/lib/services/page-shield.js +520 -0
- package/lib/services/page-shield.js.map +1 -0
- package/lib/services/pages.d.ts +1949 -0
- package/lib/services/pages.d.ts.map +1 -0
- package/lib/services/pages.js +3030 -0
- package/lib/services/pages.js.map +1 -0
- package/lib/services/pipelines.d.ts +1716 -0
- package/lib/services/pipelines.d.ts.map +1 -0
- package/lib/services/pipelines.js +2991 -0
- package/lib/services/pipelines.js.map +1 -0
- package/lib/services/queues.d.ts +904 -0
- package/lib/services/queues.d.ts.map +1 -0
- package/lib/services/queues.js +1250 -0
- package/lib/services/queues.js.map +1 -0
- package/lib/services/r2-data-catalog.d.ts +341 -0
- package/lib/services/r2-data-catalog.d.ts.map +1 -0
- package/lib/services/r2-data-catalog.js +513 -0
- package/lib/services/r2-data-catalog.js.map +1 -0
- package/lib/services/r2.d.ts +1087 -0
- package/lib/services/r2.d.ts.map +1 -0
- package/lib/services/r2.js +1404 -0
- package/lib/services/r2.js.map +1 -0
- package/lib/services/radar.d.ts +9365 -0
- package/lib/services/radar.d.ts.map +1 -0
- package/lib/services/radar.js +20552 -0
- package/lib/services/radar.js.map +1 -0
- package/lib/services/rate-limits.d.ts +360 -0
- package/lib/services/rate-limits.d.ts.map +1 -0
- package/lib/services/rate-limits.js +545 -0
- package/lib/services/rate-limits.js.map +1 -0
- package/lib/services/realtime-kit.d.ts +2728 -0
- package/lib/services/realtime-kit.d.ts.map +1 -0
- package/lib/services/realtime-kit.js +5402 -0
- package/lib/services/realtime-kit.js.map +1 -0
- package/lib/services/registrar.d.ts +121 -0
- package/lib/services/registrar.d.ts.map +1 -0
- package/lib/services/registrar.js +167 -0
- package/lib/services/registrar.js.map +1 -0
- package/lib/services/request-tracers.d.ts +61 -0
- package/lib/services/request-tracers.d.ts.map +1 -0
- package/lib/services/request-tracers.js +85 -0
- package/lib/services/request-tracers.js.map +1 -0
- package/lib/services/resource-sharing.d.ts +622 -0
- package/lib/services/resource-sharing.d.ts.map +1 -0
- package/lib/services/resource-sharing.js +929 -0
- package/lib/services/resource-sharing.js.map +1 -0
- package/lib/services/rules.d.ts +346 -0
- package/lib/services/rules.d.ts.map +1 -0
- package/lib/services/rules.js +431 -0
- package/lib/services/rules.js.map +1 -0
- package/lib/services/rulesets.d.ts +3345 -0
- package/lib/services/rulesets.d.ts.map +1 -0
- package/lib/services/rulesets.js +7904 -0
- package/lib/services/rulesets.js.map +1 -0
- package/lib/services/rum.d.ts +314 -0
- package/lib/services/rum.d.ts.map +1 -0
- package/lib/services/rum.js +442 -0
- package/lib/services/rum.js.map +1 -0
- package/lib/services/schema-validation.d.ts +273 -0
- package/lib/services/schema-validation.d.ts.map +1 -0
- package/lib/services/schema-validation.js +365 -0
- package/lib/services/schema-validation.js.map +1 -0
- package/lib/services/secrets-store.d.ts +393 -0
- package/lib/services/secrets-store.d.ts.map +1 -0
- package/lib/services/secrets-store.js +452 -0
- package/lib/services/secrets-store.js.map +1 -0
- package/lib/services/security-center.d.ts +136 -0
- package/lib/services/security-center.d.ts.map +1 -0
- package/lib/services/security-center.js +196 -0
- package/lib/services/security-center.js.map +1 -0
- package/lib/services/security-txt.d.ts +105 -0
- package/lib/services/security-txt.d.ts.map +1 -0
- package/lib/services/security-txt.js +136 -0
- package/lib/services/security-txt.js.map +1 -0
- package/lib/services/snippets.d.ts +190 -0
- package/lib/services/snippets.d.ts.map +1 -0
- package/lib/services/snippets.js +221 -0
- package/lib/services/snippets.js.map +1 -0
- package/lib/services/spectrum.d.ts +350 -0
- package/lib/services/spectrum.d.ts.map +1 -0
- package/lib/services/spectrum.js +535 -0
- package/lib/services/spectrum.js.map +1 -0
- package/lib/services/speed.d.ts +257 -0
- package/lib/services/speed.d.ts.map +1 -0
- package/lib/services/speed.js +471 -0
- package/lib/services/speed.js.map +1 -0
- package/lib/services/ssl.d.ts +412 -0
- package/lib/services/ssl.d.ts.map +1 -0
- package/lib/services/ssl.js +755 -0
- package/lib/services/ssl.js.map +1 -0
- package/lib/services/stream.d.ts +1110 -0
- package/lib/services/stream.d.ts.map +1 -0
- package/lib/services/stream.js +1085 -0
- package/lib/services/stream.js.map +1 -0
- package/lib/services/token-validation.d.ts +662 -0
- package/lib/services/token-validation.d.ts.map +1 -0
- package/lib/services/token-validation.js +834 -0
- package/lib/services/token-validation.js.map +1 -0
- package/lib/services/turnstile.d.ts +272 -0
- package/lib/services/turnstile.d.ts.map +1 -0
- package/lib/services/turnstile.js +339 -0
- package/lib/services/turnstile.js.map +1 -0
- package/lib/services/url-normalization.d.ts +53 -0
- package/lib/services/url-normalization.d.ts.map +1 -0
- package/lib/services/url-normalization.js +52 -0
- package/lib/services/url-normalization.js.map +1 -0
- package/lib/services/url-scanner.d.ts +612 -0
- package/lib/services/url-scanner.d.ts.map +1 -0
- package/lib/services/url-scanner.js +915 -0
- package/lib/services/url-scanner.js.map +1 -0
- package/lib/services/user.d.ts +507 -0
- package/lib/services/user.d.ts.map +1 -0
- package/lib/services/user.js +634 -0
- package/lib/services/user.js.map +1 -0
- package/lib/services/vectorize.d.ts +297 -0
- package/lib/services/vectorize.d.ts.map +1 -0
- package/lib/services/vectorize.js +351 -0
- package/lib/services/vectorize.js.map +1 -0
- package/lib/services/waiting-rooms.d.ts +1149 -0
- package/lib/services/waiting-rooms.d.ts.map +1 -0
- package/lib/services/waiting-rooms.js +1859 -0
- package/lib/services/waiting-rooms.js.map +1 -0
- package/lib/services/web3.d.ts +289 -0
- package/lib/services/web3.d.ts.map +1 -0
- package/lib/services/web3.js +381 -0
- package/lib/services/web3.js.map +1 -0
- package/lib/services/workers-for-platforms.d.ts +1394 -0
- package/lib/services/workers-for-platforms.d.ts.map +1 -0
- package/lib/services/workers-for-platforms.js +2121 -0
- package/lib/services/workers-for-platforms.js.map +1 -0
- package/lib/services/workers.d.ts +3827 -0
- package/lib/services/workers.d.ts.map +1 -0
- package/lib/services/workers.js +6105 -0
- package/lib/services/workers.js.map +1 -0
- package/lib/services/workflows.d.ts +442 -0
- package/lib/services/workflows.d.ts.map +1 -0
- package/lib/services/workflows.js +599 -0
- package/lib/services/workflows.js.map +1 -0
- package/lib/services/zaraz.d.ts +312 -0
- package/lib/services/zaraz.d.ts.map +1 -0
- package/lib/services/zaraz.js +305 -0
- package/lib/services/zaraz.js.map +1 -0
- package/lib/services/zero-trust.d.ts +18235 -0
- package/lib/services/zero-trust.d.ts.map +1 -0
- package/lib/services/zero-trust.js +30268 -0
- package/lib/services/zero-trust.js.map +1 -0
- package/lib/services/zones.d.ts +1382 -0
- package/lib/services/zones.d.ts.map +1 -0
- package/lib/services/zones.js +2477 -0
- package/lib/services/zones.js.map +1 -0
- package/lib/traits.d.ts +28 -0
- package/lib/traits.d.ts.map +1 -0
- package/lib/traits.js +26 -0
- package/lib/traits.js.map +1 -0
- package/package.json +82 -0
- package/src/auth.ts +15 -0
- package/src/category.ts +1 -0
- package/src/client/api.ts +421 -0
- package/src/client/index.ts +7 -0
- package/src/credentials.ts +271 -0
- package/src/errors.ts +73 -0
- package/src/index.ts +9 -0
- package/src/retry.ts +35 -0
- package/src/schemas.ts +51 -0
- package/src/sensitive.ts +4 -0
- package/src/services/abuse-reports.ts +955 -0
- package/src/services/accounts.ts +2152 -0
- package/src/services/acm.ts +178 -0
- package/src/services/addressing.ts +4262 -0
- package/src/services/ai-gateway.ts +3773 -0
- package/src/services/ai.ts +901 -0
- package/src/services/aisearch.ts +5215 -0
- package/src/services/alerting.ts +3303 -0
- package/src/services/api-gateway.ts +3890 -0
- package/src/services/argo.ts +270 -0
- package/src/services/audit-logs.ts +90 -0
- package/src/services/billing.ts +176 -0
- package/src/services/bot-management.ts +545 -0
- package/src/services/botnet-feed.ts +205 -0
- package/src/services/brand-protection.ts +575 -0
- package/src/services/browser-rendering.ts +2720 -0
- package/src/services/cache.ts +877 -0
- package/src/services/calls.ts +548 -0
- package/src/services/certificate-authorities.ts +114 -0
- package/src/services/client-certificates.ts +815 -0
- package/src/services/cloud-connector.ts +248 -0
- package/src/services/cloudforce-one.ts +4104 -0
- package/src/services/connectivity.ts +706 -0
- package/src/services/content-scanning.ts +458 -0
- package/src/services/custom-certificates.ts +690 -0
- package/src/services/custom-hostnames.ts +2641 -0
- package/src/services/custom-nameservers.ts +235 -0
- package/src/services/custom-pages.ts +311 -0
- package/src/services/d1.ts +1208 -0
- package/src/services/dcv-delegation.ts +54 -0
- package/src/services/diagnostics.ts +677 -0
- package/src/services/dns-firewall.ts +904 -0
- package/src/services/dns.ts +9277 -0
- package/src/services/durable-objects.ts +237 -0
- package/src/services/email-routing.ts +1796 -0
- package/src/services/email-security.ts +5052 -0
- package/src/services/filters.ts +488 -0
- package/src/services/firewall.ts +4728 -0
- package/src/services/healthchecks.ts +1866 -0
- package/src/services/hostnames.ts +254 -0
- package/src/services/hyperdrive.ts +595 -0
- package/src/services/iam.ts +1969 -0
- package/src/services/images.ts +1180 -0
- package/src/services/intel.ts +3072 -0
- package/src/services/ips.ts +88 -0
- package/src/services/keyless-certificates.ts +509 -0
- package/src/services/kv.ts +1129 -0
- package/src/services/leaked-credential-checks.ts +364 -0
- package/src/services/load-balancers.ts +6993 -0
- package/src/services/logpush.ts +1695 -0
- package/src/services/logs.ts +389 -0
- package/src/services/magic-cloud-networking.ts +10747 -0
- package/src/services/magic-network-monitoring.ts +1200 -0
- package/src/services/magic-transit.ts +13673 -0
- package/src/services/managed-transforms.ts +245 -0
- package/src/services/memberships.ts +698 -0
- package/src/services/mtls-certificates.ts +444 -0
- package/src/services/network-interconnects.ts +1253 -0
- package/src/services/organizations.ts +738 -0
- package/src/services/origin-ca-certificates.ts +369 -0
- package/src/services/origin-post-quantum-encryption.ts +136 -0
- package/src/services/origin-tls-client-auth.ts +1002 -0
- package/src/services/page-rules.ts +2632 -0
- package/src/services/page-shield.ts +1371 -0
- package/src/services/pages.ts +6167 -0
- package/src/services/pipelines.ts +6455 -0
- package/src/services/queues.ts +2827 -0
- package/src/services/r2-data-catalog.ts +1151 -0
- package/src/services/r2.ts +3529 -0
- package/src/services/radar.ts +42836 -0
- package/src/services/rate-limits.ts +1252 -0
- package/src/services/realtime-kit.ts +11080 -0
- package/src/services/registrar.ts +390 -0
- package/src/services/request-tracers.ts +161 -0
- package/src/services/resource-sharing.ts +2082 -0
- package/src/services/rules.ts +953 -0
- package/src/services/rulesets.ts +15361 -0
- package/src/services/rum.ts +994 -0
- package/src/services/schema-validation.ts +869 -0
- package/src/services/secrets-store.ts +1050 -0
- package/src/services/security-center.ts +495 -0
- package/src/services/security-txt.ts +317 -0
- package/src/services/snippets.ts +562 -0
- package/src/services/spectrum.ts +1190 -0
- package/src/services/speed.ts +1154 -0
- package/src/services/ssl.ts +1714 -0
- package/src/services/stream.ts +3008 -0
- package/src/services/token-validation.ts +1825 -0
- package/src/services/turnstile.ts +725 -0
- package/src/services/url-normalization.ts +133 -0
- package/src/services/url-scanner.ts +1851 -0
- package/src/services/user.ts +1587 -0
- package/src/services/vectorize.ts +875 -0
- package/src/services/waiting-rooms.ts +4216 -0
- package/src/services/web3.ts +899 -0
- package/src/services/workers-for-platforms.ts +4134 -0
- package/src/services/workers.ts +12298 -0
- package/src/services/workflows.ts +1372 -0
- package/src/services/zaraz.ts +833 -0
- package/src/services/zero-trust.ts +64685 -0
- package/src/services/zones.ts +5106 -0
- package/src/traits.ts +47 -0
|
@@ -0,0 +1,1973 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Cloudflare LOAD-BALANCERS API
|
|
3
|
+
*
|
|
4
|
+
* Generated from Cloudflare TypeScript SDK.
|
|
5
|
+
* DO NOT EDIT - regenerate with: bun scripts/generate.ts --service load-balancers
|
|
6
|
+
*/
|
|
7
|
+
import * as stream from "effect/Stream";
|
|
8
|
+
import * as Schema from "effect/Schema";
|
|
9
|
+
import type * as HttpClient from "effect/unstable/http/HttpClient";
|
|
10
|
+
import * as API from "../client/api.ts";
|
|
11
|
+
import type { Credentials } from "../credentials.ts";
|
|
12
|
+
import { type DefaultErrors } from "../errors.ts";
|
|
13
|
+
export interface GetLoadBalancerRequest {
|
|
14
|
+
loadBalancerId: string;
|
|
15
|
+
zoneId: string;
|
|
16
|
+
}
|
|
17
|
+
export declare const GetLoadBalancerRequest: Schema.Schema<GetLoadBalancerRequest>;
|
|
18
|
+
export interface GetLoadBalancerResponse {
|
|
19
|
+
id?: string | null;
|
|
20
|
+
/** Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-d */
|
|
21
|
+
adaptiveRouting?: {
|
|
22
|
+
failoverAcrossPools?: boolean | null;
|
|
23
|
+
} | null;
|
|
24
|
+
/** A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool ma */
|
|
25
|
+
countryPools?: Record<string, unknown> | null;
|
|
26
|
+
createdOn?: string | null;
|
|
27
|
+
/** A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region. */
|
|
28
|
+
defaultPools?: string[] | null;
|
|
29
|
+
/** Object description. */
|
|
30
|
+
description?: string | null;
|
|
31
|
+
/** Whether to enable (the default) this load balancer. */
|
|
32
|
+
enabled?: boolean | null;
|
|
33
|
+
/** The pool ID to use when all other pools are detected as unhealthy. */
|
|
34
|
+
fallbackPool?: string | null;
|
|
35
|
+
/** Controls location-based steering for non-proxied requests. See `steering_policy` to learn how steering is affected. */
|
|
36
|
+
locationStrategy?: {
|
|
37
|
+
mode?: "pop" | "resolver_ip" | null;
|
|
38
|
+
preferEcs?: "always" | "never" | "proximity" | "geo" | null;
|
|
39
|
+
} | null;
|
|
40
|
+
modifiedOn?: string | null;
|
|
41
|
+
/** The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used. */
|
|
42
|
+
name?: string | null;
|
|
43
|
+
/** List of networks where Load Balancer or Pool is enabled. */
|
|
44
|
+
networks?: string[] | null;
|
|
45
|
+
/** Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using th */
|
|
46
|
+
popPools?: Record<string, unknown> | null;
|
|
47
|
+
/** Whether the hostname should be gray clouded (false) or orange clouded (true). */
|
|
48
|
+
proxied?: boolean | null;
|
|
49
|
+
/** Configures pool weights. - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights. - `steering_policy="least_outstanding_requests"`: Use pool weights to s */
|
|
50
|
+
randomSteering?: {
|
|
51
|
+
defaultWeight?: number | null;
|
|
52
|
+
poolWeights?: Record<string, unknown> | null;
|
|
53
|
+
} | null;
|
|
54
|
+
/** A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools. */
|
|
55
|
+
regionPools?: Record<string, unknown> | null;
|
|
56
|
+
/** BETA Field Not General Access: A list of rules for this load balancer to execute. */
|
|
57
|
+
rules?: {
|
|
58
|
+
condition?: string | null;
|
|
59
|
+
disabled?: boolean | null;
|
|
60
|
+
fixedResponse?: {
|
|
61
|
+
contentType?: string | null;
|
|
62
|
+
location?: string | null;
|
|
63
|
+
messageBody?: string | null;
|
|
64
|
+
statusCode?: number | null;
|
|
65
|
+
} | null;
|
|
66
|
+
name?: string | null;
|
|
67
|
+
overrides?: {
|
|
68
|
+
adaptiveRouting?: unknown | null;
|
|
69
|
+
countryPools?: Record<string, unknown> | null;
|
|
70
|
+
defaultPools?: string[] | null;
|
|
71
|
+
fallbackPool?: string | null;
|
|
72
|
+
locationStrategy?: unknown | null;
|
|
73
|
+
popPools?: Record<string, unknown> | null;
|
|
74
|
+
randomSteering?: unknown | null;
|
|
75
|
+
regionPools?: Record<string, unknown> | null;
|
|
76
|
+
sessionAffinity?: "none" | "cookie" | "ip_cookie" | "header" | null;
|
|
77
|
+
sessionAffinityAttributes?: unknown | null;
|
|
78
|
+
sessionAffinityTtl?: number | null;
|
|
79
|
+
steeringPolicy?: "" | "off" | "geo" | "random" | "dynamic_latency" | "proximity" | "least_outstanding_requests" | "least_connections" | null;
|
|
80
|
+
ttl?: number | null;
|
|
81
|
+
} | null;
|
|
82
|
+
priority?: number | null;
|
|
83
|
+
terminates?: boolean | null;
|
|
84
|
+
}[] | null;
|
|
85
|
+
/** Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is ge */
|
|
86
|
+
sessionAffinity?: "none" | "cookie" | "ip_cookie" | "header" | null;
|
|
87
|
+
/** Configures attributes for session affinity. */
|
|
88
|
+
sessionAffinityAttributes?: {
|
|
89
|
+
drainDuration?: number | null;
|
|
90
|
+
headers?: string[] | null;
|
|
91
|
+
requireAllHeaders?: boolean | null;
|
|
92
|
+
samesite?: "Auto" | "Lax" | "None" | "Strict" | null;
|
|
93
|
+
secure?: "Auto" | "Always" | "Never" | null;
|
|
94
|
+
zeroDowntimeFailover?: "none" | "temporary" | "sticky" | null;
|
|
95
|
+
} | null;
|
|
96
|
+
/** Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `s */
|
|
97
|
+
sessionAffinityTtl?: number | null;
|
|
98
|
+
/** Steering Policy for this load balancer. - `"off"`: Use `default_pools`. - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determi */
|
|
99
|
+
steeringPolicy?: "" | "off" | "geo" | "random" | "dynamic_latency" | "proximity" | "least_outstanding_requests" | "least_connections" | null;
|
|
100
|
+
/** Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers. */
|
|
101
|
+
ttl?: number | null;
|
|
102
|
+
zoneName?: string | null;
|
|
103
|
+
}
|
|
104
|
+
export declare const GetLoadBalancerResponse: Schema.Schema<GetLoadBalancerResponse>;
|
|
105
|
+
export type GetLoadBalancerError = DefaultErrors;
|
|
106
|
+
export declare const getLoadBalancer: API.OperationMethod<GetLoadBalancerRequest, GetLoadBalancerResponse, GetLoadBalancerError, Credentials | HttpClient.HttpClient>;
|
|
107
|
+
export interface ListLoadBalancersRequest {
|
|
108
|
+
zoneId: string;
|
|
109
|
+
}
|
|
110
|
+
export declare const ListLoadBalancersRequest: Schema.Schema<ListLoadBalancersRequest>;
|
|
111
|
+
export interface ListLoadBalancersResponse {
|
|
112
|
+
result: {
|
|
113
|
+
id?: string | null;
|
|
114
|
+
adaptiveRouting?: {
|
|
115
|
+
failoverAcrossPools?: boolean | null;
|
|
116
|
+
} | null;
|
|
117
|
+
countryPools?: Record<string, unknown> | null;
|
|
118
|
+
createdOn?: string | null;
|
|
119
|
+
defaultPools?: string[] | null;
|
|
120
|
+
description?: string | null;
|
|
121
|
+
enabled?: boolean | null;
|
|
122
|
+
fallbackPool?: string | null;
|
|
123
|
+
locationStrategy?: {
|
|
124
|
+
mode?: "pop" | "resolver_ip" | null;
|
|
125
|
+
preferEcs?: "always" | "never" | "proximity" | "geo" | null;
|
|
126
|
+
} | null;
|
|
127
|
+
modifiedOn?: string | null;
|
|
128
|
+
name?: string | null;
|
|
129
|
+
networks?: string[] | null;
|
|
130
|
+
popPools?: Record<string, unknown> | null;
|
|
131
|
+
proxied?: boolean | null;
|
|
132
|
+
randomSteering?: {
|
|
133
|
+
defaultWeight?: number | null;
|
|
134
|
+
poolWeights?: Record<string, unknown> | null;
|
|
135
|
+
} | null;
|
|
136
|
+
regionPools?: Record<string, unknown> | null;
|
|
137
|
+
rules?: {
|
|
138
|
+
condition?: string | null;
|
|
139
|
+
disabled?: boolean | null;
|
|
140
|
+
fixedResponse?: {
|
|
141
|
+
contentType?: string | null;
|
|
142
|
+
location?: string | null;
|
|
143
|
+
messageBody?: string | null;
|
|
144
|
+
statusCode?: number | null;
|
|
145
|
+
} | null;
|
|
146
|
+
name?: string | null;
|
|
147
|
+
overrides?: {
|
|
148
|
+
adaptiveRouting?: unknown | null;
|
|
149
|
+
countryPools?: Record<string, unknown> | null;
|
|
150
|
+
defaultPools?: string[] | null;
|
|
151
|
+
fallbackPool?: string | null;
|
|
152
|
+
locationStrategy?: unknown | null;
|
|
153
|
+
popPools?: Record<string, unknown> | null;
|
|
154
|
+
randomSteering?: unknown | null;
|
|
155
|
+
regionPools?: Record<string, unknown> | null;
|
|
156
|
+
sessionAffinity?: "none" | "cookie" | "ip_cookie" | "header" | null;
|
|
157
|
+
sessionAffinityAttributes?: unknown | null;
|
|
158
|
+
sessionAffinityTtl?: number | null;
|
|
159
|
+
steeringPolicy?: "" | "off" | "geo" | "random" | "dynamic_latency" | "proximity" | "least_outstanding_requests" | "least_connections" | null;
|
|
160
|
+
ttl?: number | null;
|
|
161
|
+
} | null;
|
|
162
|
+
priority?: number | null;
|
|
163
|
+
terminates?: boolean | null;
|
|
164
|
+
}[] | null;
|
|
165
|
+
sessionAffinity?: "none" | "cookie" | "ip_cookie" | "header" | null;
|
|
166
|
+
sessionAffinityAttributes?: {
|
|
167
|
+
drainDuration?: number | null;
|
|
168
|
+
headers?: string[] | null;
|
|
169
|
+
requireAllHeaders?: boolean | null;
|
|
170
|
+
samesite?: "Auto" | "Lax" | "None" | "Strict" | null;
|
|
171
|
+
secure?: "Auto" | "Always" | "Never" | null;
|
|
172
|
+
zeroDowntimeFailover?: "none" | "temporary" | "sticky" | null;
|
|
173
|
+
} | null;
|
|
174
|
+
sessionAffinityTtl?: number | null;
|
|
175
|
+
steeringPolicy?: "" | "off" | "geo" | "random" | "dynamic_latency" | "proximity" | "least_outstanding_requests" | "least_connections" | null;
|
|
176
|
+
ttl?: number | null;
|
|
177
|
+
zoneName?: string | null;
|
|
178
|
+
}[];
|
|
179
|
+
}
|
|
180
|
+
export declare const ListLoadBalancersResponse: Schema.Schema<ListLoadBalancersResponse>;
|
|
181
|
+
export type ListLoadBalancersError = DefaultErrors;
|
|
182
|
+
export declare const listLoadBalancers: API.PaginatedOperationMethod<ListLoadBalancersRequest, ListLoadBalancersResponse, ListLoadBalancersError, Credentials | HttpClient.HttpClient> & {
|
|
183
|
+
pages: (input: ListLoadBalancersRequest) => stream.Stream<ListLoadBalancersResponse, ListLoadBalancersError, Credentials | HttpClient.HttpClient>;
|
|
184
|
+
items: (input: ListLoadBalancersRequest) => stream.Stream<{
|
|
185
|
+
id?: string | null;
|
|
186
|
+
adaptiveRouting?: {
|
|
187
|
+
failoverAcrossPools?: boolean | null;
|
|
188
|
+
} | null;
|
|
189
|
+
countryPools?: Record<string, unknown> | null;
|
|
190
|
+
createdOn?: string | null;
|
|
191
|
+
defaultPools?: string[] | null;
|
|
192
|
+
description?: string | null;
|
|
193
|
+
enabled?: boolean | null;
|
|
194
|
+
fallbackPool?: string | null;
|
|
195
|
+
locationStrategy?: {
|
|
196
|
+
mode?: "pop" | "resolver_ip" | null;
|
|
197
|
+
preferEcs?: "always" | "never" | "proximity" | "geo" | null;
|
|
198
|
+
} | null;
|
|
199
|
+
modifiedOn?: string | null;
|
|
200
|
+
name?: string | null;
|
|
201
|
+
networks?: string[] | null;
|
|
202
|
+
popPools?: Record<string, unknown> | null;
|
|
203
|
+
proxied?: boolean | null;
|
|
204
|
+
randomSteering?: {
|
|
205
|
+
defaultWeight?: number | null;
|
|
206
|
+
poolWeights?: Record<string, unknown> | null;
|
|
207
|
+
} | null;
|
|
208
|
+
regionPools?: Record<string, unknown> | null;
|
|
209
|
+
rules?: {
|
|
210
|
+
condition?: string | null;
|
|
211
|
+
disabled?: boolean | null;
|
|
212
|
+
fixedResponse?: {
|
|
213
|
+
contentType?: string | null;
|
|
214
|
+
location?: string | null;
|
|
215
|
+
messageBody?: string | null;
|
|
216
|
+
statusCode?: number | null;
|
|
217
|
+
} | null;
|
|
218
|
+
name?: string | null;
|
|
219
|
+
overrides?: {
|
|
220
|
+
adaptiveRouting?: unknown | null;
|
|
221
|
+
countryPools?: Record<string, unknown> | null;
|
|
222
|
+
defaultPools?: string[] | null;
|
|
223
|
+
fallbackPool?: string | null;
|
|
224
|
+
locationStrategy?: unknown | null;
|
|
225
|
+
popPools?: Record<string, unknown> | null;
|
|
226
|
+
randomSteering?: unknown | null;
|
|
227
|
+
regionPools?: Record<string, unknown> | null;
|
|
228
|
+
sessionAffinity?: "none" | "cookie" | "ip_cookie" | "header" | null;
|
|
229
|
+
sessionAffinityAttributes?: unknown | null;
|
|
230
|
+
sessionAffinityTtl?: number | null;
|
|
231
|
+
steeringPolicy?: "" | "off" | "geo" | "random" | "dynamic_latency" | "proximity" | "least_outstanding_requests" | "least_connections" | null;
|
|
232
|
+
ttl?: number | null;
|
|
233
|
+
} | null;
|
|
234
|
+
priority?: number | null;
|
|
235
|
+
terminates?: boolean | null;
|
|
236
|
+
}[] | null;
|
|
237
|
+
sessionAffinity?: "none" | "cookie" | "ip_cookie" | "header" | null;
|
|
238
|
+
sessionAffinityAttributes?: {
|
|
239
|
+
drainDuration?: number | null;
|
|
240
|
+
headers?: string[] | null;
|
|
241
|
+
requireAllHeaders?: boolean | null;
|
|
242
|
+
samesite?: "Auto" | "Lax" | "None" | "Strict" | null;
|
|
243
|
+
secure?: "Auto" | "Always" | "Never" | null;
|
|
244
|
+
zeroDowntimeFailover?: "none" | "temporary" | "sticky" | null;
|
|
245
|
+
} | null;
|
|
246
|
+
sessionAffinityTtl?: number | null;
|
|
247
|
+
steeringPolicy?: "" | "off" | "geo" | "random" | "dynamic_latency" | "proximity" | "least_outstanding_requests" | "least_connections" | null;
|
|
248
|
+
ttl?: number | null;
|
|
249
|
+
zoneName?: string | null;
|
|
250
|
+
}, ListLoadBalancersError, Credentials | HttpClient.HttpClient>;
|
|
251
|
+
};
|
|
252
|
+
export interface CreateLoadBalancerRequest {
|
|
253
|
+
/** Path param: */
|
|
254
|
+
zoneId: string;
|
|
255
|
+
/** Body param: A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region. */
|
|
256
|
+
defaultPools: string[];
|
|
257
|
+
/** Body param: The pool ID to use when all other pools are detected as unhealthy. */
|
|
258
|
+
fallbackPool: string;
|
|
259
|
+
/** Body param: The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will n */
|
|
260
|
+
name: string;
|
|
261
|
+
/** Body param: Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For exa */
|
|
262
|
+
adaptiveRouting?: {
|
|
263
|
+
failoverAcrossPools?: boolean;
|
|
264
|
+
};
|
|
265
|
+
/** Body param: A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding re */
|
|
266
|
+
countryPools?: Record<string, unknown>;
|
|
267
|
+
/** Body param: Object description. */
|
|
268
|
+
description?: string;
|
|
269
|
+
/** Body param: Controls location-based steering for non-proxied requests. See `steering_policy` to learn how steering is affected. */
|
|
270
|
+
locationStrategy?: {
|
|
271
|
+
mode?: "pop" | "resolver_ip";
|
|
272
|
+
preferEcs?: "always" | "never" | "proximity" | "geo";
|
|
273
|
+
};
|
|
274
|
+
/** Body param: List of networks where Load Balancer or Pool is enabled. */
|
|
275
|
+
networks?: string[];
|
|
276
|
+
/** Body param: Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back */
|
|
277
|
+
popPools?: Record<string, unknown>;
|
|
278
|
+
/** Body param: Whether the hostname should be gray clouded (false) or orange clouded (true). */
|
|
279
|
+
proxied?: boolean;
|
|
280
|
+
/** Body param: Configures pool weights. - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights. - `steering_policy="least_outstanding_requests"`: Use pool */
|
|
281
|
+
randomSteering?: {
|
|
282
|
+
defaultWeight?: number;
|
|
283
|
+
poolWeights?: Record<string, unknown>;
|
|
284
|
+
};
|
|
285
|
+
/** Body param: A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools. */
|
|
286
|
+
regionPools?: Record<string, unknown>;
|
|
287
|
+
/** Body param: BETA Field Not General Access: A list of rules for this load balancer to execute. */
|
|
288
|
+
rules?: {
|
|
289
|
+
condition?: string;
|
|
290
|
+
disabled?: boolean;
|
|
291
|
+
fixedResponse?: {
|
|
292
|
+
contentType?: string;
|
|
293
|
+
location?: string;
|
|
294
|
+
messageBody?: string;
|
|
295
|
+
statusCode?: number;
|
|
296
|
+
};
|
|
297
|
+
name?: string;
|
|
298
|
+
overrides?: {
|
|
299
|
+
adaptiveRouting?: unknown;
|
|
300
|
+
countryPools?: Record<string, unknown>;
|
|
301
|
+
defaultPools?: string[];
|
|
302
|
+
fallbackPool?: string;
|
|
303
|
+
locationStrategy?: unknown;
|
|
304
|
+
popPools?: Record<string, unknown>;
|
|
305
|
+
randomSteering?: unknown;
|
|
306
|
+
regionPools?: Record<string, unknown>;
|
|
307
|
+
sessionAffinity?: "none" | "cookie" | "ip_cookie" | "header";
|
|
308
|
+
sessionAffinityAttributes?: unknown;
|
|
309
|
+
sessionAffinityTtl?: number;
|
|
310
|
+
steeringPolicy?: "" | "off" | "geo" | "random" | "dynamic_latency" | "proximity" | "least_outstanding_requests" | "least_connections";
|
|
311
|
+
ttl?: number;
|
|
312
|
+
};
|
|
313
|
+
priority?: number;
|
|
314
|
+
terminates?: boolean;
|
|
315
|
+
}[];
|
|
316
|
+
/** Body param: Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a */
|
|
317
|
+
sessionAffinity?: "none" | "cookie" | "ip_cookie" | "header";
|
|
318
|
+
/** Body param: Configures attributes for session affinity. */
|
|
319
|
+
sessionAffinityAttributes?: {
|
|
320
|
+
drainDuration?: number;
|
|
321
|
+
headers?: string[];
|
|
322
|
+
requireAllHeaders?: boolean;
|
|
323
|
+
samesite?: "Auto" | "Lax" | "None" | "Strict";
|
|
324
|
+
secure?: "Auto" | "Always" | "Never";
|
|
325
|
+
zeroDowntimeFailover?: "none" | "temporary" | "sticky";
|
|
326
|
+
};
|
|
327
|
+
/** Body param: Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted r */
|
|
328
|
+
sessionAffinityTtl?: number;
|
|
329
|
+
/** Body param: Steering Policy for this load balancer. - `"off"`: Use `default_pools`. - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools */
|
|
330
|
+
steeringPolicy?: "" | "off" | "geo" | "random" | "dynamic_latency" | "proximity" | "least_outstanding_requests" | "least_connections";
|
|
331
|
+
/** Body param: Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers. */
|
|
332
|
+
ttl?: number;
|
|
333
|
+
}
|
|
334
|
+
export declare const CreateLoadBalancerRequest: Schema.Schema<CreateLoadBalancerRequest>;
|
|
335
|
+
export interface CreateLoadBalancerResponse {
|
|
336
|
+
id?: string | null;
|
|
337
|
+
/** Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-d */
|
|
338
|
+
adaptiveRouting?: {
|
|
339
|
+
failoverAcrossPools?: boolean | null;
|
|
340
|
+
} | null;
|
|
341
|
+
/** A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool ma */
|
|
342
|
+
countryPools?: Record<string, unknown> | null;
|
|
343
|
+
createdOn?: string | null;
|
|
344
|
+
/** A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region. */
|
|
345
|
+
defaultPools?: string[] | null;
|
|
346
|
+
/** Object description. */
|
|
347
|
+
description?: string | null;
|
|
348
|
+
/** Whether to enable (the default) this load balancer. */
|
|
349
|
+
enabled?: boolean | null;
|
|
350
|
+
/** The pool ID to use when all other pools are detected as unhealthy. */
|
|
351
|
+
fallbackPool?: string | null;
|
|
352
|
+
/** Controls location-based steering for non-proxied requests. See `steering_policy` to learn how steering is affected. */
|
|
353
|
+
locationStrategy?: {
|
|
354
|
+
mode?: "pop" | "resolver_ip" | null;
|
|
355
|
+
preferEcs?: "always" | "never" | "proximity" | "geo" | null;
|
|
356
|
+
} | null;
|
|
357
|
+
modifiedOn?: string | null;
|
|
358
|
+
/** The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used. */
|
|
359
|
+
name?: string | null;
|
|
360
|
+
/** List of networks where Load Balancer or Pool is enabled. */
|
|
361
|
+
networks?: string[] | null;
|
|
362
|
+
/** Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using th */
|
|
363
|
+
popPools?: Record<string, unknown> | null;
|
|
364
|
+
/** Whether the hostname should be gray clouded (false) or orange clouded (true). */
|
|
365
|
+
proxied?: boolean | null;
|
|
366
|
+
/** Configures pool weights. - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights. - `steering_policy="least_outstanding_requests"`: Use pool weights to s */
|
|
367
|
+
randomSteering?: {
|
|
368
|
+
defaultWeight?: number | null;
|
|
369
|
+
poolWeights?: Record<string, unknown> | null;
|
|
370
|
+
} | null;
|
|
371
|
+
/** A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools. */
|
|
372
|
+
regionPools?: Record<string, unknown> | null;
|
|
373
|
+
/** BETA Field Not General Access: A list of rules for this load balancer to execute. */
|
|
374
|
+
rules?: {
|
|
375
|
+
condition?: string | null;
|
|
376
|
+
disabled?: boolean | null;
|
|
377
|
+
fixedResponse?: {
|
|
378
|
+
contentType?: string | null;
|
|
379
|
+
location?: string | null;
|
|
380
|
+
messageBody?: string | null;
|
|
381
|
+
statusCode?: number | null;
|
|
382
|
+
} | null;
|
|
383
|
+
name?: string | null;
|
|
384
|
+
overrides?: {
|
|
385
|
+
adaptiveRouting?: unknown | null;
|
|
386
|
+
countryPools?: Record<string, unknown> | null;
|
|
387
|
+
defaultPools?: string[] | null;
|
|
388
|
+
fallbackPool?: string | null;
|
|
389
|
+
locationStrategy?: unknown | null;
|
|
390
|
+
popPools?: Record<string, unknown> | null;
|
|
391
|
+
randomSteering?: unknown | null;
|
|
392
|
+
regionPools?: Record<string, unknown> | null;
|
|
393
|
+
sessionAffinity?: "none" | "cookie" | "ip_cookie" | "header" | null;
|
|
394
|
+
sessionAffinityAttributes?: unknown | null;
|
|
395
|
+
sessionAffinityTtl?: number | null;
|
|
396
|
+
steeringPolicy?: "" | "off" | "geo" | "random" | "dynamic_latency" | "proximity" | "least_outstanding_requests" | "least_connections" | null;
|
|
397
|
+
ttl?: number | null;
|
|
398
|
+
} | null;
|
|
399
|
+
priority?: number | null;
|
|
400
|
+
terminates?: boolean | null;
|
|
401
|
+
}[] | null;
|
|
402
|
+
/** Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is ge */
|
|
403
|
+
sessionAffinity?: "none" | "cookie" | "ip_cookie" | "header" | null;
|
|
404
|
+
/** Configures attributes for session affinity. */
|
|
405
|
+
sessionAffinityAttributes?: {
|
|
406
|
+
drainDuration?: number | null;
|
|
407
|
+
headers?: string[] | null;
|
|
408
|
+
requireAllHeaders?: boolean | null;
|
|
409
|
+
samesite?: "Auto" | "Lax" | "None" | "Strict" | null;
|
|
410
|
+
secure?: "Auto" | "Always" | "Never" | null;
|
|
411
|
+
zeroDowntimeFailover?: "none" | "temporary" | "sticky" | null;
|
|
412
|
+
} | null;
|
|
413
|
+
/** Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `s */
|
|
414
|
+
sessionAffinityTtl?: number | null;
|
|
415
|
+
/** Steering Policy for this load balancer. - `"off"`: Use `default_pools`. - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determi */
|
|
416
|
+
steeringPolicy?: "" | "off" | "geo" | "random" | "dynamic_latency" | "proximity" | "least_outstanding_requests" | "least_connections" | null;
|
|
417
|
+
/** Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers. */
|
|
418
|
+
ttl?: number | null;
|
|
419
|
+
zoneName?: string | null;
|
|
420
|
+
}
|
|
421
|
+
export declare const CreateLoadBalancerResponse: Schema.Schema<CreateLoadBalancerResponse>;
|
|
422
|
+
export type CreateLoadBalancerError = DefaultErrors;
|
|
423
|
+
export declare const createLoadBalancer: API.OperationMethod<CreateLoadBalancerRequest, CreateLoadBalancerResponse, CreateLoadBalancerError, Credentials | HttpClient.HttpClient>;
|
|
424
|
+
export interface UpdateLoadBalancerRequest {
|
|
425
|
+
loadBalancerId: string;
|
|
426
|
+
/** Path param: */
|
|
427
|
+
zoneId: string;
|
|
428
|
+
/** Body param: A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region. */
|
|
429
|
+
defaultPools: string[];
|
|
430
|
+
/** Body param: The pool ID to use when all other pools are detected as unhealthy. */
|
|
431
|
+
fallbackPool: string;
|
|
432
|
+
/** Body param: The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will n */
|
|
433
|
+
name: string;
|
|
434
|
+
/** Body param: Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For exa */
|
|
435
|
+
adaptiveRouting?: {
|
|
436
|
+
failoverAcrossPools?: boolean;
|
|
437
|
+
};
|
|
438
|
+
/** Body param: A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding re */
|
|
439
|
+
countryPools?: Record<string, unknown>;
|
|
440
|
+
/** Body param: Object description. */
|
|
441
|
+
description?: string;
|
|
442
|
+
/** Body param: Whether to enable (the default) this load balancer. */
|
|
443
|
+
enabled?: boolean;
|
|
444
|
+
/** Body param: Controls location-based steering for non-proxied requests. See `steering_policy` to learn how steering is affected. */
|
|
445
|
+
locationStrategy?: {
|
|
446
|
+
mode?: "pop" | "resolver_ip";
|
|
447
|
+
preferEcs?: "always" | "never" | "proximity" | "geo";
|
|
448
|
+
};
|
|
449
|
+
/** Body param: List of networks where Load Balancer or Pool is enabled. */
|
|
450
|
+
networks?: string[];
|
|
451
|
+
/** Body param: Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back */
|
|
452
|
+
popPools?: Record<string, unknown>;
|
|
453
|
+
/** Body param: Whether the hostname should be gray clouded (false) or orange clouded (true). */
|
|
454
|
+
proxied?: boolean;
|
|
455
|
+
/** Body param: Configures pool weights. - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights. - `steering_policy="least_outstanding_requests"`: Use pool */
|
|
456
|
+
randomSteering?: {
|
|
457
|
+
defaultWeight?: number;
|
|
458
|
+
poolWeights?: Record<string, unknown>;
|
|
459
|
+
};
|
|
460
|
+
/** Body param: A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools. */
|
|
461
|
+
regionPools?: Record<string, unknown>;
|
|
462
|
+
/** Body param: BETA Field Not General Access: A list of rules for this load balancer to execute. */
|
|
463
|
+
rules?: {
|
|
464
|
+
condition?: string;
|
|
465
|
+
disabled?: boolean;
|
|
466
|
+
fixedResponse?: {
|
|
467
|
+
contentType?: string;
|
|
468
|
+
location?: string;
|
|
469
|
+
messageBody?: string;
|
|
470
|
+
statusCode?: number;
|
|
471
|
+
};
|
|
472
|
+
name?: string;
|
|
473
|
+
overrides?: {
|
|
474
|
+
adaptiveRouting?: unknown;
|
|
475
|
+
countryPools?: Record<string, unknown>;
|
|
476
|
+
defaultPools?: string[];
|
|
477
|
+
fallbackPool?: string;
|
|
478
|
+
locationStrategy?: unknown;
|
|
479
|
+
popPools?: Record<string, unknown>;
|
|
480
|
+
randomSteering?: unknown;
|
|
481
|
+
regionPools?: Record<string, unknown>;
|
|
482
|
+
sessionAffinity?: "none" | "cookie" | "ip_cookie" | "header";
|
|
483
|
+
sessionAffinityAttributes?: unknown;
|
|
484
|
+
sessionAffinityTtl?: number;
|
|
485
|
+
steeringPolicy?: "" | "off" | "geo" | "random" | "dynamic_latency" | "proximity" | "least_outstanding_requests" | "least_connections";
|
|
486
|
+
ttl?: number;
|
|
487
|
+
};
|
|
488
|
+
priority?: number;
|
|
489
|
+
terminates?: boolean;
|
|
490
|
+
}[];
|
|
491
|
+
/** Body param: Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a */
|
|
492
|
+
sessionAffinity?: "none" | "cookie" | "ip_cookie" | "header";
|
|
493
|
+
/** Body param: Configures attributes for session affinity. */
|
|
494
|
+
sessionAffinityAttributes?: {
|
|
495
|
+
drainDuration?: number;
|
|
496
|
+
headers?: string[];
|
|
497
|
+
requireAllHeaders?: boolean;
|
|
498
|
+
samesite?: "Auto" | "Lax" | "None" | "Strict";
|
|
499
|
+
secure?: "Auto" | "Always" | "Never";
|
|
500
|
+
zeroDowntimeFailover?: "none" | "temporary" | "sticky";
|
|
501
|
+
};
|
|
502
|
+
/** Body param: Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted r */
|
|
503
|
+
sessionAffinityTtl?: number;
|
|
504
|
+
/** Body param: Steering Policy for this load balancer. - `"off"`: Use `default_pools`. - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools */
|
|
505
|
+
steeringPolicy?: "" | "off" | "geo" | "random" | "dynamic_latency" | "proximity" | "least_outstanding_requests" | "least_connections";
|
|
506
|
+
/** Body param: Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers. */
|
|
507
|
+
ttl?: number;
|
|
508
|
+
}
|
|
509
|
+
export declare const UpdateLoadBalancerRequest: Schema.Schema<UpdateLoadBalancerRequest>;
|
|
510
|
+
export interface UpdateLoadBalancerResponse {
|
|
511
|
+
id?: string | null;
|
|
512
|
+
/** Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-d */
|
|
513
|
+
adaptiveRouting?: {
|
|
514
|
+
failoverAcrossPools?: boolean | null;
|
|
515
|
+
} | null;
|
|
516
|
+
/** A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool ma */
|
|
517
|
+
countryPools?: Record<string, unknown> | null;
|
|
518
|
+
createdOn?: string | null;
|
|
519
|
+
/** A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region. */
|
|
520
|
+
defaultPools?: string[] | null;
|
|
521
|
+
/** Object description. */
|
|
522
|
+
description?: string | null;
|
|
523
|
+
/** Whether to enable (the default) this load balancer. */
|
|
524
|
+
enabled?: boolean | null;
|
|
525
|
+
/** The pool ID to use when all other pools are detected as unhealthy. */
|
|
526
|
+
fallbackPool?: string | null;
|
|
527
|
+
/** Controls location-based steering for non-proxied requests. See `steering_policy` to learn how steering is affected. */
|
|
528
|
+
locationStrategy?: {
|
|
529
|
+
mode?: "pop" | "resolver_ip" | null;
|
|
530
|
+
preferEcs?: "always" | "never" | "proximity" | "geo" | null;
|
|
531
|
+
} | null;
|
|
532
|
+
modifiedOn?: string | null;
|
|
533
|
+
/** The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used. */
|
|
534
|
+
name?: string | null;
|
|
535
|
+
/** List of networks where Load Balancer or Pool is enabled. */
|
|
536
|
+
networks?: string[] | null;
|
|
537
|
+
/** Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using th */
|
|
538
|
+
popPools?: Record<string, unknown> | null;
|
|
539
|
+
/** Whether the hostname should be gray clouded (false) or orange clouded (true). */
|
|
540
|
+
proxied?: boolean | null;
|
|
541
|
+
/** Configures pool weights. - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights. - `steering_policy="least_outstanding_requests"`: Use pool weights to s */
|
|
542
|
+
randomSteering?: {
|
|
543
|
+
defaultWeight?: number | null;
|
|
544
|
+
poolWeights?: Record<string, unknown> | null;
|
|
545
|
+
} | null;
|
|
546
|
+
/** A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools. */
|
|
547
|
+
regionPools?: Record<string, unknown> | null;
|
|
548
|
+
/** BETA Field Not General Access: A list of rules for this load balancer to execute. */
|
|
549
|
+
rules?: {
|
|
550
|
+
condition?: string | null;
|
|
551
|
+
disabled?: boolean | null;
|
|
552
|
+
fixedResponse?: {
|
|
553
|
+
contentType?: string | null;
|
|
554
|
+
location?: string | null;
|
|
555
|
+
messageBody?: string | null;
|
|
556
|
+
statusCode?: number | null;
|
|
557
|
+
} | null;
|
|
558
|
+
name?: string | null;
|
|
559
|
+
overrides?: {
|
|
560
|
+
adaptiveRouting?: unknown | null;
|
|
561
|
+
countryPools?: Record<string, unknown> | null;
|
|
562
|
+
defaultPools?: string[] | null;
|
|
563
|
+
fallbackPool?: string | null;
|
|
564
|
+
locationStrategy?: unknown | null;
|
|
565
|
+
popPools?: Record<string, unknown> | null;
|
|
566
|
+
randomSteering?: unknown | null;
|
|
567
|
+
regionPools?: Record<string, unknown> | null;
|
|
568
|
+
sessionAffinity?: "none" | "cookie" | "ip_cookie" | "header" | null;
|
|
569
|
+
sessionAffinityAttributes?: unknown | null;
|
|
570
|
+
sessionAffinityTtl?: number | null;
|
|
571
|
+
steeringPolicy?: "" | "off" | "geo" | "random" | "dynamic_latency" | "proximity" | "least_outstanding_requests" | "least_connections" | null;
|
|
572
|
+
ttl?: number | null;
|
|
573
|
+
} | null;
|
|
574
|
+
priority?: number | null;
|
|
575
|
+
terminates?: boolean | null;
|
|
576
|
+
}[] | null;
|
|
577
|
+
/** Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is ge */
|
|
578
|
+
sessionAffinity?: "none" | "cookie" | "ip_cookie" | "header" | null;
|
|
579
|
+
/** Configures attributes for session affinity. */
|
|
580
|
+
sessionAffinityAttributes?: {
|
|
581
|
+
drainDuration?: number | null;
|
|
582
|
+
headers?: string[] | null;
|
|
583
|
+
requireAllHeaders?: boolean | null;
|
|
584
|
+
samesite?: "Auto" | "Lax" | "None" | "Strict" | null;
|
|
585
|
+
secure?: "Auto" | "Always" | "Never" | null;
|
|
586
|
+
zeroDowntimeFailover?: "none" | "temporary" | "sticky" | null;
|
|
587
|
+
} | null;
|
|
588
|
+
/** Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `s */
|
|
589
|
+
sessionAffinityTtl?: number | null;
|
|
590
|
+
/** Steering Policy for this load balancer. - `"off"`: Use `default_pools`. - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determi */
|
|
591
|
+
steeringPolicy?: "" | "off" | "geo" | "random" | "dynamic_latency" | "proximity" | "least_outstanding_requests" | "least_connections" | null;
|
|
592
|
+
/** Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers. */
|
|
593
|
+
ttl?: number | null;
|
|
594
|
+
zoneName?: string | null;
|
|
595
|
+
}
|
|
596
|
+
export declare const UpdateLoadBalancerResponse: Schema.Schema<UpdateLoadBalancerResponse>;
|
|
597
|
+
export type UpdateLoadBalancerError = DefaultErrors;
|
|
598
|
+
export declare const updateLoadBalancer: API.OperationMethod<UpdateLoadBalancerRequest, UpdateLoadBalancerResponse, UpdateLoadBalancerError, Credentials | HttpClient.HttpClient>;
|
|
599
|
+
export interface PatchLoadBalancerRequest {
|
|
600
|
+
loadBalancerId: string;
|
|
601
|
+
/** Path param: */
|
|
602
|
+
zoneId: string;
|
|
603
|
+
/** Body param: Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For exa */
|
|
604
|
+
adaptiveRouting?: {
|
|
605
|
+
failoverAcrossPools?: boolean;
|
|
606
|
+
};
|
|
607
|
+
/** Body param: A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding re */
|
|
608
|
+
countryPools?: Record<string, unknown>;
|
|
609
|
+
/** Body param: A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region. */
|
|
610
|
+
defaultPools?: string[];
|
|
611
|
+
/** Body param: Object description. */
|
|
612
|
+
description?: string;
|
|
613
|
+
/** Body param: Whether to enable (the default) this load balancer. */
|
|
614
|
+
enabled?: boolean;
|
|
615
|
+
/** Body param: The pool ID to use when all other pools are detected as unhealthy. */
|
|
616
|
+
fallbackPool?: string;
|
|
617
|
+
/** Body param: Controls location-based steering for non-proxied requests. See `steering_policy` to learn how steering is affected. */
|
|
618
|
+
locationStrategy?: {
|
|
619
|
+
mode?: "pop" | "resolver_ip";
|
|
620
|
+
preferEcs?: "always" | "never" | "proximity" | "geo";
|
|
621
|
+
};
|
|
622
|
+
/** Body param: The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will n */
|
|
623
|
+
name?: string;
|
|
624
|
+
/** Body param: Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back */
|
|
625
|
+
popPools?: Record<string, unknown>;
|
|
626
|
+
/** Body param: Whether the hostname should be gray clouded (false) or orange clouded (true). */
|
|
627
|
+
proxied?: boolean;
|
|
628
|
+
/** Body param: Configures pool weights. - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights. - `steering_policy="least_outstanding_requests"`: Use pool */
|
|
629
|
+
randomSteering?: {
|
|
630
|
+
defaultWeight?: number;
|
|
631
|
+
poolWeights?: Record<string, unknown>;
|
|
632
|
+
};
|
|
633
|
+
/** Body param: A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools. */
|
|
634
|
+
regionPools?: Record<string, unknown>;
|
|
635
|
+
/** Body param: BETA Field Not General Access: A list of rules for this load balancer to execute. */
|
|
636
|
+
rules?: {
|
|
637
|
+
condition?: string;
|
|
638
|
+
disabled?: boolean;
|
|
639
|
+
fixedResponse?: {
|
|
640
|
+
contentType?: string;
|
|
641
|
+
location?: string;
|
|
642
|
+
messageBody?: string;
|
|
643
|
+
statusCode?: number;
|
|
644
|
+
};
|
|
645
|
+
name?: string;
|
|
646
|
+
overrides?: {
|
|
647
|
+
adaptiveRouting?: unknown;
|
|
648
|
+
countryPools?: Record<string, unknown>;
|
|
649
|
+
defaultPools?: string[];
|
|
650
|
+
fallbackPool?: string;
|
|
651
|
+
locationStrategy?: unknown;
|
|
652
|
+
popPools?: Record<string, unknown>;
|
|
653
|
+
randomSteering?: unknown;
|
|
654
|
+
regionPools?: Record<string, unknown>;
|
|
655
|
+
sessionAffinity?: "none" | "cookie" | "ip_cookie" | "header";
|
|
656
|
+
sessionAffinityAttributes?: unknown;
|
|
657
|
+
sessionAffinityTtl?: number;
|
|
658
|
+
steeringPolicy?: "" | "off" | "geo" | "random" | "dynamic_latency" | "proximity" | "least_outstanding_requests" | "least_connections";
|
|
659
|
+
ttl?: number;
|
|
660
|
+
};
|
|
661
|
+
priority?: number;
|
|
662
|
+
terminates?: boolean;
|
|
663
|
+
}[];
|
|
664
|
+
/** Body param: Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a */
|
|
665
|
+
sessionAffinity?: "none" | "cookie" | "ip_cookie" | "header";
|
|
666
|
+
/** Body param: Configures attributes for session affinity. */
|
|
667
|
+
sessionAffinityAttributes?: {
|
|
668
|
+
drainDuration?: number;
|
|
669
|
+
headers?: string[];
|
|
670
|
+
requireAllHeaders?: boolean;
|
|
671
|
+
samesite?: "Auto" | "Lax" | "None" | "Strict";
|
|
672
|
+
secure?: "Auto" | "Always" | "Never";
|
|
673
|
+
zeroDowntimeFailover?: "none" | "temporary" | "sticky";
|
|
674
|
+
};
|
|
675
|
+
/** Body param: Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted r */
|
|
676
|
+
sessionAffinityTtl?: number;
|
|
677
|
+
/** Body param: Steering Policy for this load balancer. - `"off"`: Use `default_pools`. - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools */
|
|
678
|
+
steeringPolicy?: "" | "off" | "geo" | "random" | "dynamic_latency" | "proximity" | "least_outstanding_requests" | "least_connections";
|
|
679
|
+
/** Body param: Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers. */
|
|
680
|
+
ttl?: number;
|
|
681
|
+
}
|
|
682
|
+
export declare const PatchLoadBalancerRequest: Schema.Schema<PatchLoadBalancerRequest>;
|
|
683
|
+
export interface PatchLoadBalancerResponse {
|
|
684
|
+
id?: string | null;
|
|
685
|
+
/** Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-d */
|
|
686
|
+
adaptiveRouting?: {
|
|
687
|
+
failoverAcrossPools?: boolean | null;
|
|
688
|
+
} | null;
|
|
689
|
+
/** A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool ma */
|
|
690
|
+
countryPools?: Record<string, unknown> | null;
|
|
691
|
+
createdOn?: string | null;
|
|
692
|
+
/** A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region. */
|
|
693
|
+
defaultPools?: string[] | null;
|
|
694
|
+
/** Object description. */
|
|
695
|
+
description?: string | null;
|
|
696
|
+
/** Whether to enable (the default) this load balancer. */
|
|
697
|
+
enabled?: boolean | null;
|
|
698
|
+
/** The pool ID to use when all other pools are detected as unhealthy. */
|
|
699
|
+
fallbackPool?: string | null;
|
|
700
|
+
/** Controls location-based steering for non-proxied requests. See `steering_policy` to learn how steering is affected. */
|
|
701
|
+
locationStrategy?: {
|
|
702
|
+
mode?: "pop" | "resolver_ip" | null;
|
|
703
|
+
preferEcs?: "always" | "never" | "proximity" | "geo" | null;
|
|
704
|
+
} | null;
|
|
705
|
+
modifiedOn?: string | null;
|
|
706
|
+
/** The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used. */
|
|
707
|
+
name?: string | null;
|
|
708
|
+
/** List of networks where Load Balancer or Pool is enabled. */
|
|
709
|
+
networks?: string[] | null;
|
|
710
|
+
/** Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using th */
|
|
711
|
+
popPools?: Record<string, unknown> | null;
|
|
712
|
+
/** Whether the hostname should be gray clouded (false) or orange clouded (true). */
|
|
713
|
+
proxied?: boolean | null;
|
|
714
|
+
/** Configures pool weights. - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights. - `steering_policy="least_outstanding_requests"`: Use pool weights to s */
|
|
715
|
+
randomSteering?: {
|
|
716
|
+
defaultWeight?: number | null;
|
|
717
|
+
poolWeights?: Record<string, unknown> | null;
|
|
718
|
+
} | null;
|
|
719
|
+
/** A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools. */
|
|
720
|
+
regionPools?: Record<string, unknown> | null;
|
|
721
|
+
/** BETA Field Not General Access: A list of rules for this load balancer to execute. */
|
|
722
|
+
rules?: {
|
|
723
|
+
condition?: string | null;
|
|
724
|
+
disabled?: boolean | null;
|
|
725
|
+
fixedResponse?: {
|
|
726
|
+
contentType?: string | null;
|
|
727
|
+
location?: string | null;
|
|
728
|
+
messageBody?: string | null;
|
|
729
|
+
statusCode?: number | null;
|
|
730
|
+
} | null;
|
|
731
|
+
name?: string | null;
|
|
732
|
+
overrides?: {
|
|
733
|
+
adaptiveRouting?: unknown | null;
|
|
734
|
+
countryPools?: Record<string, unknown> | null;
|
|
735
|
+
defaultPools?: string[] | null;
|
|
736
|
+
fallbackPool?: string | null;
|
|
737
|
+
locationStrategy?: unknown | null;
|
|
738
|
+
popPools?: Record<string, unknown> | null;
|
|
739
|
+
randomSteering?: unknown | null;
|
|
740
|
+
regionPools?: Record<string, unknown> | null;
|
|
741
|
+
sessionAffinity?: "none" | "cookie" | "ip_cookie" | "header" | null;
|
|
742
|
+
sessionAffinityAttributes?: unknown | null;
|
|
743
|
+
sessionAffinityTtl?: number | null;
|
|
744
|
+
steeringPolicy?: "" | "off" | "geo" | "random" | "dynamic_latency" | "proximity" | "least_outstanding_requests" | "least_connections" | null;
|
|
745
|
+
ttl?: number | null;
|
|
746
|
+
} | null;
|
|
747
|
+
priority?: number | null;
|
|
748
|
+
terminates?: boolean | null;
|
|
749
|
+
}[] | null;
|
|
750
|
+
/** Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is ge */
|
|
751
|
+
sessionAffinity?: "none" | "cookie" | "ip_cookie" | "header" | null;
|
|
752
|
+
/** Configures attributes for session affinity. */
|
|
753
|
+
sessionAffinityAttributes?: {
|
|
754
|
+
drainDuration?: number | null;
|
|
755
|
+
headers?: string[] | null;
|
|
756
|
+
requireAllHeaders?: boolean | null;
|
|
757
|
+
samesite?: "Auto" | "Lax" | "None" | "Strict" | null;
|
|
758
|
+
secure?: "Auto" | "Always" | "Never" | null;
|
|
759
|
+
zeroDowntimeFailover?: "none" | "temporary" | "sticky" | null;
|
|
760
|
+
} | null;
|
|
761
|
+
/** Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `s */
|
|
762
|
+
sessionAffinityTtl?: number | null;
|
|
763
|
+
/** Steering Policy for this load balancer. - `"off"`: Use `default_pools`. - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determi */
|
|
764
|
+
steeringPolicy?: "" | "off" | "geo" | "random" | "dynamic_latency" | "proximity" | "least_outstanding_requests" | "least_connections" | null;
|
|
765
|
+
/** Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers. */
|
|
766
|
+
ttl?: number | null;
|
|
767
|
+
zoneName?: string | null;
|
|
768
|
+
}
|
|
769
|
+
export declare const PatchLoadBalancerResponse: Schema.Schema<PatchLoadBalancerResponse>;
|
|
770
|
+
export type PatchLoadBalancerError = DefaultErrors;
|
|
771
|
+
export declare const patchLoadBalancer: API.OperationMethod<PatchLoadBalancerRequest, PatchLoadBalancerResponse, PatchLoadBalancerError, Credentials | HttpClient.HttpClient>;
|
|
772
|
+
export interface DeleteLoadBalancerRequest {
|
|
773
|
+
loadBalancerId: string;
|
|
774
|
+
zoneId: string;
|
|
775
|
+
}
|
|
776
|
+
export declare const DeleteLoadBalancerRequest: Schema.Schema<DeleteLoadBalancerRequest>;
|
|
777
|
+
export interface DeleteLoadBalancerResponse {
|
|
778
|
+
id?: string | null;
|
|
779
|
+
}
|
|
780
|
+
export declare const DeleteLoadBalancerResponse: Schema.Schema<DeleteLoadBalancerResponse>;
|
|
781
|
+
export type DeleteLoadBalancerError = DefaultErrors;
|
|
782
|
+
export declare const deleteLoadBalancer: API.OperationMethod<DeleteLoadBalancerRequest, DeleteLoadBalancerResponse, DeleteLoadBalancerError, Credentials | HttpClient.HttpClient>;
|
|
783
|
+
export interface GetMonitorRequest {
|
|
784
|
+
monitorId: string;
|
|
785
|
+
/** Identifier. */
|
|
786
|
+
accountId: string;
|
|
787
|
+
}
|
|
788
|
+
export declare const GetMonitorRequest: Schema.Schema<GetMonitorRequest>;
|
|
789
|
+
export interface GetMonitorResponse {
|
|
790
|
+
id?: string | null;
|
|
791
|
+
/** Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors. */
|
|
792
|
+
allowInsecure?: boolean | null;
|
|
793
|
+
/** To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. */
|
|
794
|
+
consecutiveDown?: number | null;
|
|
795
|
+
/** To be marked healthy the monitored origin must pass this healthcheck N consecutive times. */
|
|
796
|
+
consecutiveUp?: number | null;
|
|
797
|
+
createdOn?: string | null;
|
|
798
|
+
/** Object description. */
|
|
799
|
+
description?: string | null;
|
|
800
|
+
/** 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. */
|
|
801
|
+
expectedBody?: string | null;
|
|
802
|
+
/** The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
803
|
+
expectedCodes?: string | null;
|
|
804
|
+
/** Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
805
|
+
followRedirects?: boolean | null;
|
|
806
|
+
/** 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 mo */
|
|
807
|
+
header?: Record<string, unknown> | null;
|
|
808
|
+
/** 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. */
|
|
809
|
+
interval?: number | null;
|
|
810
|
+
/** 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. */
|
|
811
|
+
method?: string | null;
|
|
812
|
+
modifiedOn?: string | null;
|
|
813
|
+
/** The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
814
|
+
path?: string | null;
|
|
815
|
+
/** 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: d */
|
|
816
|
+
port?: number | null;
|
|
817
|
+
/** Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
818
|
+
probeZone?: string | null;
|
|
819
|
+
/** The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. */
|
|
820
|
+
retries?: number | null;
|
|
821
|
+
/** The timeout (in seconds) before marking the health check as failed. */
|
|
822
|
+
timeout?: number | null;
|
|
823
|
+
/** The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'. */
|
|
824
|
+
type?: "http" | "https" | "tcp" | "udp_icmp" | "icmp_ping" | "smtp" | null;
|
|
825
|
+
}
|
|
826
|
+
export declare const GetMonitorResponse: Schema.Schema<GetMonitorResponse>;
|
|
827
|
+
export type GetMonitorError = DefaultErrors;
|
|
828
|
+
export declare const getMonitor: API.OperationMethod<GetMonitorRequest, GetMonitorResponse, GetMonitorError, Credentials | HttpClient.HttpClient>;
|
|
829
|
+
export interface ListMonitorsRequest {
|
|
830
|
+
/** Identifier. */
|
|
831
|
+
accountId: string;
|
|
832
|
+
}
|
|
833
|
+
export declare const ListMonitorsRequest: Schema.Schema<ListMonitorsRequest>;
|
|
834
|
+
export interface ListMonitorsResponse {
|
|
835
|
+
result: {
|
|
836
|
+
id?: string | null;
|
|
837
|
+
allowInsecure?: boolean | null;
|
|
838
|
+
consecutiveDown?: number | null;
|
|
839
|
+
consecutiveUp?: number | null;
|
|
840
|
+
createdOn?: string | null;
|
|
841
|
+
description?: string | null;
|
|
842
|
+
expectedBody?: string | null;
|
|
843
|
+
expectedCodes?: string | null;
|
|
844
|
+
followRedirects?: boolean | null;
|
|
845
|
+
header?: Record<string, unknown> | null;
|
|
846
|
+
interval?: number | null;
|
|
847
|
+
method?: string | null;
|
|
848
|
+
modifiedOn?: string | null;
|
|
849
|
+
path?: string | null;
|
|
850
|
+
port?: number | null;
|
|
851
|
+
probeZone?: string | null;
|
|
852
|
+
retries?: number | null;
|
|
853
|
+
timeout?: number | null;
|
|
854
|
+
type?: "http" | "https" | "tcp" | "udp_icmp" | "icmp_ping" | "smtp" | null;
|
|
855
|
+
}[];
|
|
856
|
+
}
|
|
857
|
+
export declare const ListMonitorsResponse: Schema.Schema<ListMonitorsResponse>;
|
|
858
|
+
export type ListMonitorsError = DefaultErrors;
|
|
859
|
+
export declare const listMonitors: API.PaginatedOperationMethod<ListMonitorsRequest, ListMonitorsResponse, ListMonitorsError, Credentials | HttpClient.HttpClient> & {
|
|
860
|
+
pages: (input: ListMonitorsRequest) => stream.Stream<ListMonitorsResponse, ListMonitorsError, Credentials | HttpClient.HttpClient>;
|
|
861
|
+
items: (input: ListMonitorsRequest) => stream.Stream<{
|
|
862
|
+
id?: string | null;
|
|
863
|
+
allowInsecure?: boolean | null;
|
|
864
|
+
consecutiveDown?: number | null;
|
|
865
|
+
consecutiveUp?: number | null;
|
|
866
|
+
createdOn?: string | null;
|
|
867
|
+
description?: string | null;
|
|
868
|
+
expectedBody?: string | null;
|
|
869
|
+
expectedCodes?: string | null;
|
|
870
|
+
followRedirects?: boolean | null;
|
|
871
|
+
header?: Record<string, unknown> | null;
|
|
872
|
+
interval?: number | null;
|
|
873
|
+
method?: string | null;
|
|
874
|
+
modifiedOn?: string | null;
|
|
875
|
+
path?: string | null;
|
|
876
|
+
port?: number | null;
|
|
877
|
+
probeZone?: string | null;
|
|
878
|
+
retries?: number | null;
|
|
879
|
+
timeout?: number | null;
|
|
880
|
+
type?: "http" | "https" | "tcp" | "udp_icmp" | "icmp_ping" | "smtp" | null;
|
|
881
|
+
}, ListMonitorsError, Credentials | HttpClient.HttpClient>;
|
|
882
|
+
};
|
|
883
|
+
export interface CreateMonitorRequest {
|
|
884
|
+
/** Path param: Identifier. */
|
|
885
|
+
accountId: string;
|
|
886
|
+
/** Body param: Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors. */
|
|
887
|
+
allowInsecure?: boolean;
|
|
888
|
+
/** Body param: To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. */
|
|
889
|
+
consecutiveDown?: number;
|
|
890
|
+
/** Body param: To be marked healthy the monitored origin must pass this healthcheck N consecutive times. */
|
|
891
|
+
consecutiveUp?: number;
|
|
892
|
+
/** Body param: Object description. */
|
|
893
|
+
description?: string;
|
|
894
|
+
/** 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 monitor */
|
|
895
|
+
expectedBody?: string;
|
|
896
|
+
/** Body param: The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
897
|
+
expectedCodes?: string;
|
|
898
|
+
/** Body param: Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
899
|
+
followRedirects?: boolean;
|
|
900
|
+
/** 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 */
|
|
901
|
+
header?: Record<string, unknown>;
|
|
902
|
+
/** 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. */
|
|
903
|
+
interval?: number;
|
|
904
|
+
/** 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. */
|
|
905
|
+
method?: string;
|
|
906
|
+
/** Body param: The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
907
|
+
path?: string;
|
|
908
|
+
/** 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 */
|
|
909
|
+
port?: number | null;
|
|
910
|
+
/** Body param: Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
911
|
+
probeZone?: string;
|
|
912
|
+
/** Body param: The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. */
|
|
913
|
+
retries?: number;
|
|
914
|
+
/** Body param: The timeout (in seconds) before marking the health check as failed. */
|
|
915
|
+
timeout?: number;
|
|
916
|
+
/** Body param: The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'. */
|
|
917
|
+
type?: "http" | "https" | "tcp" | "udp_icmp" | "icmp_ping" | "smtp";
|
|
918
|
+
}
|
|
919
|
+
export declare const CreateMonitorRequest: Schema.Schema<CreateMonitorRequest>;
|
|
920
|
+
export interface CreateMonitorResponse {
|
|
921
|
+
id?: string | null;
|
|
922
|
+
/** Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors. */
|
|
923
|
+
allowInsecure?: boolean | null;
|
|
924
|
+
/** To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. */
|
|
925
|
+
consecutiveDown?: number | null;
|
|
926
|
+
/** To be marked healthy the monitored origin must pass this healthcheck N consecutive times. */
|
|
927
|
+
consecutiveUp?: number | null;
|
|
928
|
+
createdOn?: string | null;
|
|
929
|
+
/** Object description. */
|
|
930
|
+
description?: string | null;
|
|
931
|
+
/** 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. */
|
|
932
|
+
expectedBody?: string | null;
|
|
933
|
+
/** The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
934
|
+
expectedCodes?: string | null;
|
|
935
|
+
/** Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
936
|
+
followRedirects?: boolean | null;
|
|
937
|
+
/** 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 mo */
|
|
938
|
+
header?: Record<string, unknown> | null;
|
|
939
|
+
/** 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. */
|
|
940
|
+
interval?: number | null;
|
|
941
|
+
/** 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. */
|
|
942
|
+
method?: string | null;
|
|
943
|
+
modifiedOn?: string | null;
|
|
944
|
+
/** The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
945
|
+
path?: string | null;
|
|
946
|
+
/** 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: d */
|
|
947
|
+
port?: number | null;
|
|
948
|
+
/** Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
949
|
+
probeZone?: string | null;
|
|
950
|
+
/** The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. */
|
|
951
|
+
retries?: number | null;
|
|
952
|
+
/** The timeout (in seconds) before marking the health check as failed. */
|
|
953
|
+
timeout?: number | null;
|
|
954
|
+
/** The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'. */
|
|
955
|
+
type?: "http" | "https" | "tcp" | "udp_icmp" | "icmp_ping" | "smtp" | null;
|
|
956
|
+
}
|
|
957
|
+
export declare const CreateMonitorResponse: Schema.Schema<CreateMonitorResponse>;
|
|
958
|
+
export type CreateMonitorError = DefaultErrors;
|
|
959
|
+
export declare const createMonitor: API.OperationMethod<CreateMonitorRequest, CreateMonitorResponse, CreateMonitorError, Credentials | HttpClient.HttpClient>;
|
|
960
|
+
export interface UpdateMonitorRequest {
|
|
961
|
+
monitorId: string;
|
|
962
|
+
/** Path param: Identifier. */
|
|
963
|
+
accountId: string;
|
|
964
|
+
/** Body param: Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors. */
|
|
965
|
+
allowInsecure?: boolean;
|
|
966
|
+
/** Body param: To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. */
|
|
967
|
+
consecutiveDown?: number;
|
|
968
|
+
/** Body param: To be marked healthy the monitored origin must pass this healthcheck N consecutive times. */
|
|
969
|
+
consecutiveUp?: number;
|
|
970
|
+
/** Body param: Object description. */
|
|
971
|
+
description?: string;
|
|
972
|
+
/** 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 monitor */
|
|
973
|
+
expectedBody?: string;
|
|
974
|
+
/** Body param: The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
975
|
+
expectedCodes?: string;
|
|
976
|
+
/** Body param: Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
977
|
+
followRedirects?: boolean;
|
|
978
|
+
/** 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 */
|
|
979
|
+
header?: Record<string, unknown>;
|
|
980
|
+
/** 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. */
|
|
981
|
+
interval?: number;
|
|
982
|
+
/** 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. */
|
|
983
|
+
method?: string;
|
|
984
|
+
/** Body param: The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
985
|
+
path?: string;
|
|
986
|
+
/** 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 */
|
|
987
|
+
port?: number | null;
|
|
988
|
+
/** Body param: Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
989
|
+
probeZone?: string;
|
|
990
|
+
/** Body param: The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. */
|
|
991
|
+
retries?: number;
|
|
992
|
+
/** Body param: The timeout (in seconds) before marking the health check as failed. */
|
|
993
|
+
timeout?: number;
|
|
994
|
+
/** Body param: The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'. */
|
|
995
|
+
type?: "http" | "https" | "tcp" | "udp_icmp" | "icmp_ping" | "smtp";
|
|
996
|
+
}
|
|
997
|
+
export declare const UpdateMonitorRequest: Schema.Schema<UpdateMonitorRequest>;
|
|
998
|
+
export interface UpdateMonitorResponse {
|
|
999
|
+
id?: string | null;
|
|
1000
|
+
/** Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors. */
|
|
1001
|
+
allowInsecure?: boolean | null;
|
|
1002
|
+
/** To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. */
|
|
1003
|
+
consecutiveDown?: number | null;
|
|
1004
|
+
/** To be marked healthy the monitored origin must pass this healthcheck N consecutive times. */
|
|
1005
|
+
consecutiveUp?: number | null;
|
|
1006
|
+
createdOn?: string | null;
|
|
1007
|
+
/** Object description. */
|
|
1008
|
+
description?: string | null;
|
|
1009
|
+
/** 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. */
|
|
1010
|
+
expectedBody?: string | null;
|
|
1011
|
+
/** The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
1012
|
+
expectedCodes?: string | null;
|
|
1013
|
+
/** Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
1014
|
+
followRedirects?: boolean | null;
|
|
1015
|
+
/** 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 mo */
|
|
1016
|
+
header?: Record<string, unknown> | null;
|
|
1017
|
+
/** 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. */
|
|
1018
|
+
interval?: number | null;
|
|
1019
|
+
/** 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. */
|
|
1020
|
+
method?: string | null;
|
|
1021
|
+
modifiedOn?: string | null;
|
|
1022
|
+
/** The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
1023
|
+
path?: string | null;
|
|
1024
|
+
/** 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: d */
|
|
1025
|
+
port?: number | null;
|
|
1026
|
+
/** Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
1027
|
+
probeZone?: string | null;
|
|
1028
|
+
/** The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. */
|
|
1029
|
+
retries?: number | null;
|
|
1030
|
+
/** The timeout (in seconds) before marking the health check as failed. */
|
|
1031
|
+
timeout?: number | null;
|
|
1032
|
+
/** The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'. */
|
|
1033
|
+
type?: "http" | "https" | "tcp" | "udp_icmp" | "icmp_ping" | "smtp" | null;
|
|
1034
|
+
}
|
|
1035
|
+
export declare const UpdateMonitorResponse: Schema.Schema<UpdateMonitorResponse>;
|
|
1036
|
+
export type UpdateMonitorError = DefaultErrors;
|
|
1037
|
+
export declare const updateMonitor: API.OperationMethod<UpdateMonitorRequest, UpdateMonitorResponse, UpdateMonitorError, Credentials | HttpClient.HttpClient>;
|
|
1038
|
+
export interface PatchMonitorRequest {
|
|
1039
|
+
monitorId: string;
|
|
1040
|
+
/** Path param: Identifier. */
|
|
1041
|
+
accountId: string;
|
|
1042
|
+
/** Body param: Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors. */
|
|
1043
|
+
allowInsecure?: boolean;
|
|
1044
|
+
/** Body param: To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. */
|
|
1045
|
+
consecutiveDown?: number;
|
|
1046
|
+
/** Body param: To be marked healthy the monitored origin must pass this healthcheck N consecutive times. */
|
|
1047
|
+
consecutiveUp?: number;
|
|
1048
|
+
/** Body param: Object description. */
|
|
1049
|
+
description?: string;
|
|
1050
|
+
/** 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 monitor */
|
|
1051
|
+
expectedBody?: string;
|
|
1052
|
+
/** Body param: The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
1053
|
+
expectedCodes?: string;
|
|
1054
|
+
/** Body param: Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
1055
|
+
followRedirects?: boolean;
|
|
1056
|
+
/** 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 */
|
|
1057
|
+
header?: Record<string, unknown>;
|
|
1058
|
+
/** 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. */
|
|
1059
|
+
interval?: number;
|
|
1060
|
+
/** 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. */
|
|
1061
|
+
method?: string;
|
|
1062
|
+
/** Body param: The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
1063
|
+
path?: string;
|
|
1064
|
+
/** 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 */
|
|
1065
|
+
port?: number | null;
|
|
1066
|
+
/** Body param: Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
1067
|
+
probeZone?: string;
|
|
1068
|
+
/** Body param: The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. */
|
|
1069
|
+
retries?: number;
|
|
1070
|
+
/** Body param: The timeout (in seconds) before marking the health check as failed. */
|
|
1071
|
+
timeout?: number;
|
|
1072
|
+
/** Body param: The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'. */
|
|
1073
|
+
type?: "http" | "https" | "tcp" | "udp_icmp" | "icmp_ping" | "smtp";
|
|
1074
|
+
}
|
|
1075
|
+
export declare const PatchMonitorRequest: Schema.Schema<PatchMonitorRequest>;
|
|
1076
|
+
export interface PatchMonitorResponse {
|
|
1077
|
+
id?: string | null;
|
|
1078
|
+
/** Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors. */
|
|
1079
|
+
allowInsecure?: boolean | null;
|
|
1080
|
+
/** To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. */
|
|
1081
|
+
consecutiveDown?: number | null;
|
|
1082
|
+
/** To be marked healthy the monitored origin must pass this healthcheck N consecutive times. */
|
|
1083
|
+
consecutiveUp?: number | null;
|
|
1084
|
+
createdOn?: string | null;
|
|
1085
|
+
/** Object description. */
|
|
1086
|
+
description?: string | null;
|
|
1087
|
+
/** 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. */
|
|
1088
|
+
expectedBody?: string | null;
|
|
1089
|
+
/** The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
1090
|
+
expectedCodes?: string | null;
|
|
1091
|
+
/** Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
1092
|
+
followRedirects?: boolean | null;
|
|
1093
|
+
/** 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 mo */
|
|
1094
|
+
header?: Record<string, unknown> | null;
|
|
1095
|
+
/** 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. */
|
|
1096
|
+
interval?: number | null;
|
|
1097
|
+
/** 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. */
|
|
1098
|
+
method?: string | null;
|
|
1099
|
+
modifiedOn?: string | null;
|
|
1100
|
+
/** The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
1101
|
+
path?: string | null;
|
|
1102
|
+
/** 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: d */
|
|
1103
|
+
port?: number | null;
|
|
1104
|
+
/** Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
1105
|
+
probeZone?: string | null;
|
|
1106
|
+
/** The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. */
|
|
1107
|
+
retries?: number | null;
|
|
1108
|
+
/** The timeout (in seconds) before marking the health check as failed. */
|
|
1109
|
+
timeout?: number | null;
|
|
1110
|
+
/** The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'. */
|
|
1111
|
+
type?: "http" | "https" | "tcp" | "udp_icmp" | "icmp_ping" | "smtp" | null;
|
|
1112
|
+
}
|
|
1113
|
+
export declare const PatchMonitorResponse: Schema.Schema<PatchMonitorResponse>;
|
|
1114
|
+
export type PatchMonitorError = DefaultErrors;
|
|
1115
|
+
export declare const patchMonitor: API.OperationMethod<PatchMonitorRequest, PatchMonitorResponse, PatchMonitorError, Credentials | HttpClient.HttpClient>;
|
|
1116
|
+
export interface DeleteMonitorRequest {
|
|
1117
|
+
monitorId: string;
|
|
1118
|
+
/** Identifier. */
|
|
1119
|
+
accountId: string;
|
|
1120
|
+
}
|
|
1121
|
+
export declare const DeleteMonitorRequest: Schema.Schema<DeleteMonitorRequest>;
|
|
1122
|
+
export interface DeleteMonitorResponse {
|
|
1123
|
+
id?: string | null;
|
|
1124
|
+
}
|
|
1125
|
+
export declare const DeleteMonitorResponse: Schema.Schema<DeleteMonitorResponse>;
|
|
1126
|
+
export type DeleteMonitorError = DefaultErrors;
|
|
1127
|
+
export declare const deleteMonitor: API.OperationMethod<DeleteMonitorRequest, DeleteMonitorResponse, DeleteMonitorError, Credentials | HttpClient.HttpClient>;
|
|
1128
|
+
export interface GetMonitorGroupRequest {
|
|
1129
|
+
monitorGroupId: string;
|
|
1130
|
+
/** Identifier. */
|
|
1131
|
+
accountId: string;
|
|
1132
|
+
}
|
|
1133
|
+
export declare const GetMonitorGroupRequest: Schema.Schema<GetMonitorGroupRequest>;
|
|
1134
|
+
export interface GetMonitorGroupResponse {
|
|
1135
|
+
/** The ID of the Monitor Group to use for checking the health of origins within this pool. */
|
|
1136
|
+
id: string;
|
|
1137
|
+
/** A short description of the monitor group */
|
|
1138
|
+
description: string;
|
|
1139
|
+
/** List of monitors in this group */
|
|
1140
|
+
members: {
|
|
1141
|
+
enabled: boolean;
|
|
1142
|
+
monitorId: string;
|
|
1143
|
+
monitoringOnly: boolean;
|
|
1144
|
+
mustBeHealthy: boolean;
|
|
1145
|
+
createdAt?: string | null;
|
|
1146
|
+
updatedAt?: string | null;
|
|
1147
|
+
}[];
|
|
1148
|
+
/** The timestamp of when the monitor group was created */
|
|
1149
|
+
createdAt?: string | null;
|
|
1150
|
+
/** The timestamp of when the monitor group was last updated */
|
|
1151
|
+
updatedAt?: string | null;
|
|
1152
|
+
}
|
|
1153
|
+
export declare const GetMonitorGroupResponse: Schema.Schema<GetMonitorGroupResponse>;
|
|
1154
|
+
export type GetMonitorGroupError = DefaultErrors;
|
|
1155
|
+
export declare const getMonitorGroup: API.OperationMethod<GetMonitorGroupRequest, GetMonitorGroupResponse, GetMonitorGroupError, Credentials | HttpClient.HttpClient>;
|
|
1156
|
+
export interface ListMonitorGroupsRequest {
|
|
1157
|
+
/** Identifier. */
|
|
1158
|
+
accountId: string;
|
|
1159
|
+
}
|
|
1160
|
+
export declare const ListMonitorGroupsRequest: Schema.Schema<ListMonitorGroupsRequest>;
|
|
1161
|
+
export interface ListMonitorGroupsResponse {
|
|
1162
|
+
result: {
|
|
1163
|
+
id: string;
|
|
1164
|
+
description: string;
|
|
1165
|
+
members: {
|
|
1166
|
+
enabled: boolean;
|
|
1167
|
+
monitorId: string;
|
|
1168
|
+
monitoringOnly: boolean;
|
|
1169
|
+
mustBeHealthy: boolean;
|
|
1170
|
+
createdAt?: string | null;
|
|
1171
|
+
updatedAt?: string | null;
|
|
1172
|
+
}[];
|
|
1173
|
+
createdAt?: string | null;
|
|
1174
|
+
updatedAt?: string | null;
|
|
1175
|
+
}[];
|
|
1176
|
+
}
|
|
1177
|
+
export declare const ListMonitorGroupsResponse: Schema.Schema<ListMonitorGroupsResponse>;
|
|
1178
|
+
export type ListMonitorGroupsError = DefaultErrors;
|
|
1179
|
+
export declare const listMonitorGroups: API.PaginatedOperationMethod<ListMonitorGroupsRequest, ListMonitorGroupsResponse, ListMonitorGroupsError, Credentials | HttpClient.HttpClient> & {
|
|
1180
|
+
pages: (input: ListMonitorGroupsRequest) => stream.Stream<ListMonitorGroupsResponse, ListMonitorGroupsError, Credentials | HttpClient.HttpClient>;
|
|
1181
|
+
items: (input: ListMonitorGroupsRequest) => stream.Stream<{
|
|
1182
|
+
id: string;
|
|
1183
|
+
description: string;
|
|
1184
|
+
members: {
|
|
1185
|
+
enabled: boolean;
|
|
1186
|
+
monitorId: string;
|
|
1187
|
+
monitoringOnly: boolean;
|
|
1188
|
+
mustBeHealthy: boolean;
|
|
1189
|
+
createdAt?: string | null;
|
|
1190
|
+
updatedAt?: string | null;
|
|
1191
|
+
}[];
|
|
1192
|
+
createdAt?: string | null;
|
|
1193
|
+
updatedAt?: string | null;
|
|
1194
|
+
}, ListMonitorGroupsError, Credentials | HttpClient.HttpClient>;
|
|
1195
|
+
};
|
|
1196
|
+
export interface CreateMonitorGroupRequest {
|
|
1197
|
+
/** Path param: Identifier. */
|
|
1198
|
+
accountId: string;
|
|
1199
|
+
/** Body param: The ID of the Monitor Group to use for checking the health of origins within this pool. */
|
|
1200
|
+
id: string;
|
|
1201
|
+
/** Body param: A short description of the monitor group */
|
|
1202
|
+
description: string;
|
|
1203
|
+
/** Body param: List of monitors in this group */
|
|
1204
|
+
members: {
|
|
1205
|
+
enabled: boolean;
|
|
1206
|
+
monitorId: string;
|
|
1207
|
+
monitoringOnly: boolean;
|
|
1208
|
+
mustBeHealthy: boolean;
|
|
1209
|
+
}[];
|
|
1210
|
+
}
|
|
1211
|
+
export declare const CreateMonitorGroupRequest: Schema.Schema<CreateMonitorGroupRequest>;
|
|
1212
|
+
export interface CreateMonitorGroupResponse {
|
|
1213
|
+
/** The ID of the Monitor Group to use for checking the health of origins within this pool. */
|
|
1214
|
+
id: string;
|
|
1215
|
+
/** A short description of the monitor group */
|
|
1216
|
+
description: string;
|
|
1217
|
+
/** List of monitors in this group */
|
|
1218
|
+
members: {
|
|
1219
|
+
enabled: boolean;
|
|
1220
|
+
monitorId: string;
|
|
1221
|
+
monitoringOnly: boolean;
|
|
1222
|
+
mustBeHealthy: boolean;
|
|
1223
|
+
createdAt?: string | null;
|
|
1224
|
+
updatedAt?: string | null;
|
|
1225
|
+
}[];
|
|
1226
|
+
/** The timestamp of when the monitor group was created */
|
|
1227
|
+
createdAt?: string | null;
|
|
1228
|
+
/** The timestamp of when the monitor group was last updated */
|
|
1229
|
+
updatedAt?: string | null;
|
|
1230
|
+
}
|
|
1231
|
+
export declare const CreateMonitorGroupResponse: Schema.Schema<CreateMonitorGroupResponse>;
|
|
1232
|
+
export type CreateMonitorGroupError = DefaultErrors;
|
|
1233
|
+
export declare const createMonitorGroup: API.OperationMethod<CreateMonitorGroupRequest, CreateMonitorGroupResponse, CreateMonitorGroupError, Credentials | HttpClient.HttpClient>;
|
|
1234
|
+
export interface UpdateMonitorGroupRequest {
|
|
1235
|
+
monitorGroupId: string;
|
|
1236
|
+
/** Path param: Identifier. */
|
|
1237
|
+
accountId: string;
|
|
1238
|
+
/** Body param: The ID of the Monitor Group to use for checking the health of origins within this pool. */
|
|
1239
|
+
id: string;
|
|
1240
|
+
/** Body param: A short description of the monitor group */
|
|
1241
|
+
description: string;
|
|
1242
|
+
/** Body param: List of monitors in this group */
|
|
1243
|
+
members: {
|
|
1244
|
+
enabled: boolean;
|
|
1245
|
+
monitorId: string;
|
|
1246
|
+
monitoringOnly: boolean;
|
|
1247
|
+
mustBeHealthy: boolean;
|
|
1248
|
+
}[];
|
|
1249
|
+
}
|
|
1250
|
+
export declare const UpdateMonitorGroupRequest: Schema.Schema<UpdateMonitorGroupRequest>;
|
|
1251
|
+
export interface UpdateMonitorGroupResponse {
|
|
1252
|
+
/** The ID of the Monitor Group to use for checking the health of origins within this pool. */
|
|
1253
|
+
id: string;
|
|
1254
|
+
/** A short description of the monitor group */
|
|
1255
|
+
description: string;
|
|
1256
|
+
/** List of monitors in this group */
|
|
1257
|
+
members: {
|
|
1258
|
+
enabled: boolean;
|
|
1259
|
+
monitorId: string;
|
|
1260
|
+
monitoringOnly: boolean;
|
|
1261
|
+
mustBeHealthy: boolean;
|
|
1262
|
+
createdAt?: string | null;
|
|
1263
|
+
updatedAt?: string | null;
|
|
1264
|
+
}[];
|
|
1265
|
+
/** The timestamp of when the monitor group was created */
|
|
1266
|
+
createdAt?: string | null;
|
|
1267
|
+
/** The timestamp of when the monitor group was last updated */
|
|
1268
|
+
updatedAt?: string | null;
|
|
1269
|
+
}
|
|
1270
|
+
export declare const UpdateMonitorGroupResponse: Schema.Schema<UpdateMonitorGroupResponse>;
|
|
1271
|
+
export type UpdateMonitorGroupError = DefaultErrors;
|
|
1272
|
+
export declare const updateMonitorGroup: API.OperationMethod<UpdateMonitorGroupRequest, UpdateMonitorGroupResponse, UpdateMonitorGroupError, Credentials | HttpClient.HttpClient>;
|
|
1273
|
+
export interface PatchMonitorGroupRequest {
|
|
1274
|
+
monitorGroupId: string;
|
|
1275
|
+
/** Path param: Identifier. */
|
|
1276
|
+
accountId: string;
|
|
1277
|
+
/** Body param: The ID of the Monitor Group to use for checking the health of origins within this pool. */
|
|
1278
|
+
id: string;
|
|
1279
|
+
/** Body param: A short description of the monitor group */
|
|
1280
|
+
description: string;
|
|
1281
|
+
/** Body param: List of monitors in this group */
|
|
1282
|
+
members: {
|
|
1283
|
+
enabled: boolean;
|
|
1284
|
+
monitorId: string;
|
|
1285
|
+
monitoringOnly: boolean;
|
|
1286
|
+
mustBeHealthy: boolean;
|
|
1287
|
+
}[];
|
|
1288
|
+
}
|
|
1289
|
+
export declare const PatchMonitorGroupRequest: Schema.Schema<PatchMonitorGroupRequest>;
|
|
1290
|
+
export interface PatchMonitorGroupResponse {
|
|
1291
|
+
/** The ID of the Monitor Group to use for checking the health of origins within this pool. */
|
|
1292
|
+
id: string;
|
|
1293
|
+
/** A short description of the monitor group */
|
|
1294
|
+
description: string;
|
|
1295
|
+
/** List of monitors in this group */
|
|
1296
|
+
members: {
|
|
1297
|
+
enabled: boolean;
|
|
1298
|
+
monitorId: string;
|
|
1299
|
+
monitoringOnly: boolean;
|
|
1300
|
+
mustBeHealthy: boolean;
|
|
1301
|
+
createdAt?: string | null;
|
|
1302
|
+
updatedAt?: string | null;
|
|
1303
|
+
}[];
|
|
1304
|
+
/** The timestamp of when the monitor group was created */
|
|
1305
|
+
createdAt?: string | null;
|
|
1306
|
+
/** The timestamp of when the monitor group was last updated */
|
|
1307
|
+
updatedAt?: string | null;
|
|
1308
|
+
}
|
|
1309
|
+
export declare const PatchMonitorGroupResponse: Schema.Schema<PatchMonitorGroupResponse>;
|
|
1310
|
+
export type PatchMonitorGroupError = DefaultErrors;
|
|
1311
|
+
export declare const patchMonitorGroup: API.OperationMethod<PatchMonitorGroupRequest, PatchMonitorGroupResponse, PatchMonitorGroupError, Credentials | HttpClient.HttpClient>;
|
|
1312
|
+
export interface DeleteMonitorGroupRequest {
|
|
1313
|
+
monitorGroupId: string;
|
|
1314
|
+
/** Identifier. */
|
|
1315
|
+
accountId: string;
|
|
1316
|
+
}
|
|
1317
|
+
export declare const DeleteMonitorGroupRequest: Schema.Schema<DeleteMonitorGroupRequest>;
|
|
1318
|
+
export interface DeleteMonitorGroupResponse {
|
|
1319
|
+
/** The ID of the Monitor Group to use for checking the health of origins within this pool. */
|
|
1320
|
+
id: string;
|
|
1321
|
+
/** A short description of the monitor group */
|
|
1322
|
+
description: string;
|
|
1323
|
+
/** List of monitors in this group */
|
|
1324
|
+
members: {
|
|
1325
|
+
enabled: boolean;
|
|
1326
|
+
monitorId: string;
|
|
1327
|
+
monitoringOnly: boolean;
|
|
1328
|
+
mustBeHealthy: boolean;
|
|
1329
|
+
createdAt?: string | null;
|
|
1330
|
+
updatedAt?: string | null;
|
|
1331
|
+
}[];
|
|
1332
|
+
/** The timestamp of when the monitor group was created */
|
|
1333
|
+
createdAt?: string | null;
|
|
1334
|
+
/** The timestamp of when the monitor group was last updated */
|
|
1335
|
+
updatedAt?: string | null;
|
|
1336
|
+
}
|
|
1337
|
+
export declare const DeleteMonitorGroupResponse: Schema.Schema<DeleteMonitorGroupResponse>;
|
|
1338
|
+
export type DeleteMonitorGroupError = DefaultErrors;
|
|
1339
|
+
export declare const deleteMonitorGroup: API.OperationMethod<DeleteMonitorGroupRequest, DeleteMonitorGroupResponse, DeleteMonitorGroupError, Credentials | HttpClient.HttpClient>;
|
|
1340
|
+
export interface CreateMonitorPreviewRequest {
|
|
1341
|
+
monitorId: string;
|
|
1342
|
+
/** Path param: Identifier. */
|
|
1343
|
+
accountId: string;
|
|
1344
|
+
/** Body param: Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors. */
|
|
1345
|
+
allowInsecure?: boolean;
|
|
1346
|
+
/** Body param: To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. */
|
|
1347
|
+
consecutiveDown?: number;
|
|
1348
|
+
/** Body param: To be marked healthy the monitored origin must pass this healthcheck N consecutive times. */
|
|
1349
|
+
consecutiveUp?: number;
|
|
1350
|
+
/** Body param: Object description. */
|
|
1351
|
+
description?: string;
|
|
1352
|
+
/** 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 monitor */
|
|
1353
|
+
expectedBody?: string;
|
|
1354
|
+
/** Body param: The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
1355
|
+
expectedCodes?: string;
|
|
1356
|
+
/** Body param: Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
1357
|
+
followRedirects?: boolean;
|
|
1358
|
+
/** 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 */
|
|
1359
|
+
header?: Record<string, unknown>;
|
|
1360
|
+
/** 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. */
|
|
1361
|
+
interval?: number;
|
|
1362
|
+
/** 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. */
|
|
1363
|
+
method?: string;
|
|
1364
|
+
/** Body param: The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
1365
|
+
path?: string;
|
|
1366
|
+
/** 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 */
|
|
1367
|
+
port?: number | null;
|
|
1368
|
+
/** Body param: Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
1369
|
+
probeZone?: string;
|
|
1370
|
+
/** Body param: The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. */
|
|
1371
|
+
retries?: number;
|
|
1372
|
+
/** Body param: The timeout (in seconds) before marking the health check as failed. */
|
|
1373
|
+
timeout?: number;
|
|
1374
|
+
/** Body param: The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'. */
|
|
1375
|
+
type?: "http" | "https" | "tcp" | "udp_icmp" | "icmp_ping" | "smtp";
|
|
1376
|
+
}
|
|
1377
|
+
export declare const CreateMonitorPreviewRequest: Schema.Schema<CreateMonitorPreviewRequest>;
|
|
1378
|
+
export interface CreateMonitorPreviewResponse {
|
|
1379
|
+
/** Monitored pool IDs mapped to their respective names. */
|
|
1380
|
+
pools?: Record<string, unknown> | null;
|
|
1381
|
+
previewId?: string | null;
|
|
1382
|
+
}
|
|
1383
|
+
export declare const CreateMonitorPreviewResponse: Schema.Schema<CreateMonitorPreviewResponse>;
|
|
1384
|
+
export type CreateMonitorPreviewError = DefaultErrors;
|
|
1385
|
+
export declare const createMonitorPreview: API.OperationMethod<CreateMonitorPreviewRequest, CreateMonitorPreviewResponse, CreateMonitorPreviewError, Credentials | HttpClient.HttpClient>;
|
|
1386
|
+
export interface GetMonitorReferenceRequest {
|
|
1387
|
+
monitorId: string;
|
|
1388
|
+
/** Identifier. */
|
|
1389
|
+
accountId: string;
|
|
1390
|
+
}
|
|
1391
|
+
export declare const GetMonitorReferenceRequest: Schema.Schema<GetMonitorReferenceRequest>;
|
|
1392
|
+
export interface GetMonitorReferenceResponse {
|
|
1393
|
+
result: {
|
|
1394
|
+
referenceType?: "*" | "referral" | "referrer" | null;
|
|
1395
|
+
resourceId?: string | null;
|
|
1396
|
+
resourceName?: string | null;
|
|
1397
|
+
resourceType?: string | null;
|
|
1398
|
+
}[];
|
|
1399
|
+
}
|
|
1400
|
+
export declare const GetMonitorReferenceResponse: Schema.Schema<GetMonitorReferenceResponse>;
|
|
1401
|
+
export type GetMonitorReferenceError = DefaultErrors;
|
|
1402
|
+
export declare const getMonitorReference: API.PaginatedOperationMethod<GetMonitorReferenceRequest, GetMonitorReferenceResponse, GetMonitorReferenceError, Credentials | HttpClient.HttpClient> & {
|
|
1403
|
+
pages: (input: GetMonitorReferenceRequest) => stream.Stream<GetMonitorReferenceResponse, GetMonitorReferenceError, Credentials | HttpClient.HttpClient>;
|
|
1404
|
+
items: (input: GetMonitorReferenceRequest) => stream.Stream<{
|
|
1405
|
+
referenceType?: "*" | "referral" | "referrer" | null;
|
|
1406
|
+
resourceId?: string | null;
|
|
1407
|
+
resourceName?: string | null;
|
|
1408
|
+
resourceType?: string | null;
|
|
1409
|
+
}, GetMonitorReferenceError, Credentials | HttpClient.HttpClient>;
|
|
1410
|
+
};
|
|
1411
|
+
export interface GetPoolRequest {
|
|
1412
|
+
poolId: string;
|
|
1413
|
+
/** Identifier. */
|
|
1414
|
+
accountId: string;
|
|
1415
|
+
}
|
|
1416
|
+
export declare const GetPoolRequest: Schema.Schema<GetPoolRequest>;
|
|
1417
|
+
export interface GetPoolResponse {
|
|
1418
|
+
id?: string | null;
|
|
1419
|
+
/** A list of regions from which to run health checks. Null means every Cloudflare data center. */
|
|
1420
|
+
checkRegions?: ("WNAM" | "ENAM" | "WEU" | "EEU" | "NSAM" | "SSAM" | "OC" | "ME" | "NAF" | "SAF" | "SEAS" | "NEAS" | "ALL_REGIONS" | "SAS")[] | null;
|
|
1421
|
+
createdOn?: string | null;
|
|
1422
|
+
/** A human-readable description of the pool. */
|
|
1423
|
+
description?: string | null;
|
|
1424
|
+
/** This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at. */
|
|
1425
|
+
disabledAt?: string | null;
|
|
1426
|
+
/** 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 t */
|
|
1427
|
+
enabled?: boolean | null;
|
|
1428
|
+
/** 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. */
|
|
1429
|
+
latitude?: number | null;
|
|
1430
|
+
/** Configures load shedding policies and percentages for the pool. */
|
|
1431
|
+
loadShedding?: unknown | null;
|
|
1432
|
+
/** 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. */
|
|
1433
|
+
longitude?: number | null;
|
|
1434
|
+
/** 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 */
|
|
1435
|
+
minimumOrigins?: number | null;
|
|
1436
|
+
modifiedOn?: string | null;
|
|
1437
|
+
/** The ID of the Monitor to use for checking the health of origins within this pool. */
|
|
1438
|
+
monitor?: string | null;
|
|
1439
|
+
/** The ID of the Monitor Group to use for checking the health of origins within this pool. */
|
|
1440
|
+
monitorGroup?: string | null;
|
|
1441
|
+
/** A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed. */
|
|
1442
|
+
name?: string | null;
|
|
1443
|
+
/** List of networks where Load Balancer or Pool is enabled. */
|
|
1444
|
+
networks?: string[] | null;
|
|
1445
|
+
/** 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 */
|
|
1446
|
+
notificationEmail?: string | null;
|
|
1447
|
+
/** Filter pool and origin health notifications by resource type or health status. Use null to reset. */
|
|
1448
|
+
notificationFilter?: unknown | null;
|
|
1449
|
+
/** Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity. */
|
|
1450
|
+
originSteering?: unknown | null;
|
|
1451
|
+
/** 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. */
|
|
1452
|
+
origins?: unknown[] | null;
|
|
1453
|
+
}
|
|
1454
|
+
export declare const GetPoolResponse: Schema.Schema<GetPoolResponse>;
|
|
1455
|
+
export type GetPoolError = DefaultErrors;
|
|
1456
|
+
export declare const getPool: API.OperationMethod<GetPoolRequest, GetPoolResponse, GetPoolError, Credentials | HttpClient.HttpClient>;
|
|
1457
|
+
export interface ListPoolsRequest {
|
|
1458
|
+
/** Path param: Identifier. */
|
|
1459
|
+
accountId: string;
|
|
1460
|
+
/** Query param: The ID of the Monitor to use for checking the health of origins within this pool. */
|
|
1461
|
+
monitor?: string;
|
|
1462
|
+
}
|
|
1463
|
+
export declare const ListPoolsRequest: Schema.Schema<ListPoolsRequest>;
|
|
1464
|
+
export interface ListPoolsResponse {
|
|
1465
|
+
result: {
|
|
1466
|
+
id?: string | null;
|
|
1467
|
+
checkRegions?: ("WNAM" | "ENAM" | "WEU" | "EEU" | "NSAM" | "SSAM" | "OC" | "ME" | "NAF" | "SAF" | "SEAS" | "NEAS" | "ALL_REGIONS" | "SAS")[] | null;
|
|
1468
|
+
createdOn?: string | null;
|
|
1469
|
+
description?: string | null;
|
|
1470
|
+
disabledAt?: string | null;
|
|
1471
|
+
enabled?: boolean | null;
|
|
1472
|
+
latitude?: number | null;
|
|
1473
|
+
loadShedding?: unknown | null;
|
|
1474
|
+
longitude?: number | null;
|
|
1475
|
+
minimumOrigins?: number | null;
|
|
1476
|
+
modifiedOn?: string | null;
|
|
1477
|
+
monitor?: string | null;
|
|
1478
|
+
monitorGroup?: string | null;
|
|
1479
|
+
name?: string | null;
|
|
1480
|
+
networks?: string[] | null;
|
|
1481
|
+
notificationEmail?: string | null;
|
|
1482
|
+
notificationFilter?: unknown | null;
|
|
1483
|
+
originSteering?: unknown | null;
|
|
1484
|
+
origins?: unknown[] | null;
|
|
1485
|
+
}[];
|
|
1486
|
+
}
|
|
1487
|
+
export declare const ListPoolsResponse: Schema.Schema<ListPoolsResponse>;
|
|
1488
|
+
export type ListPoolsError = DefaultErrors;
|
|
1489
|
+
export declare const listPools: API.PaginatedOperationMethod<ListPoolsRequest, ListPoolsResponse, ListPoolsError, Credentials | HttpClient.HttpClient> & {
|
|
1490
|
+
pages: (input: ListPoolsRequest) => stream.Stream<ListPoolsResponse, ListPoolsError, Credentials | HttpClient.HttpClient>;
|
|
1491
|
+
items: (input: ListPoolsRequest) => stream.Stream<{
|
|
1492
|
+
id?: string | null;
|
|
1493
|
+
checkRegions?: ("WNAM" | "ENAM" | "WEU" | "EEU" | "NSAM" | "SSAM" | "OC" | "ME" | "NAF" | "SAF" | "SEAS" | "NEAS" | "ALL_REGIONS" | "SAS")[] | null;
|
|
1494
|
+
createdOn?: string | null;
|
|
1495
|
+
description?: string | null;
|
|
1496
|
+
disabledAt?: string | null;
|
|
1497
|
+
enabled?: boolean | null;
|
|
1498
|
+
latitude?: number | null;
|
|
1499
|
+
loadShedding?: unknown | null;
|
|
1500
|
+
longitude?: number | null;
|
|
1501
|
+
minimumOrigins?: number | null;
|
|
1502
|
+
modifiedOn?: string | null;
|
|
1503
|
+
monitor?: string | null;
|
|
1504
|
+
monitorGroup?: string | null;
|
|
1505
|
+
name?: string | null;
|
|
1506
|
+
networks?: string[] | null;
|
|
1507
|
+
notificationEmail?: string | null;
|
|
1508
|
+
notificationFilter?: unknown | null;
|
|
1509
|
+
originSteering?: unknown | null;
|
|
1510
|
+
origins?: unknown[] | null;
|
|
1511
|
+
}, ListPoolsError, Credentials | HttpClient.HttpClient>;
|
|
1512
|
+
};
|
|
1513
|
+
export interface CreatePoolRequest {
|
|
1514
|
+
/** Path param: Identifier. */
|
|
1515
|
+
accountId: string;
|
|
1516
|
+
/** Body param: A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed. */
|
|
1517
|
+
name: string;
|
|
1518
|
+
/** Body param: 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. */
|
|
1519
|
+
origins: unknown[];
|
|
1520
|
+
/** Body param: A human-readable description of the pool. */
|
|
1521
|
+
description?: string;
|
|
1522
|
+
/** Body param: 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 t */
|
|
1523
|
+
enabled?: boolean;
|
|
1524
|
+
/** Body param: 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. */
|
|
1525
|
+
latitude?: number;
|
|
1526
|
+
/** Body param: Configures load shedding policies and percentages for the pool. */
|
|
1527
|
+
loadShedding?: unknown | null;
|
|
1528
|
+
/** Body param: 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. */
|
|
1529
|
+
longitude?: number;
|
|
1530
|
+
/** Body param: 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 fail */
|
|
1531
|
+
minimumOrigins?: number;
|
|
1532
|
+
/** Body param: The ID of the Monitor to use for checking the health of origins within this pool. */
|
|
1533
|
+
monitor?: string;
|
|
1534
|
+
/** Body param: The ID of the Monitor Group to use for checking the health of origins within this pool. */
|
|
1535
|
+
monitorGroup?: string;
|
|
1536
|
+
/** Body param: 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 he */
|
|
1537
|
+
notificationEmail?: string;
|
|
1538
|
+
/** Body param: Filter pool and origin health notifications by resource type or health status. Use null to reset. */
|
|
1539
|
+
notificationFilter?: unknown | null;
|
|
1540
|
+
/** Body param: Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity. */
|
|
1541
|
+
originSteering?: unknown | null;
|
|
1542
|
+
}
|
|
1543
|
+
export declare const CreatePoolRequest: Schema.Schema<CreatePoolRequest>;
|
|
1544
|
+
export interface CreatePoolResponse {
|
|
1545
|
+
id?: string | null;
|
|
1546
|
+
/** A list of regions from which to run health checks. Null means every Cloudflare data center. */
|
|
1547
|
+
checkRegions?: ("WNAM" | "ENAM" | "WEU" | "EEU" | "NSAM" | "SSAM" | "OC" | "ME" | "NAF" | "SAF" | "SEAS" | "NEAS" | "ALL_REGIONS" | "SAS")[] | null;
|
|
1548
|
+
createdOn?: string | null;
|
|
1549
|
+
/** A human-readable description of the pool. */
|
|
1550
|
+
description?: string | null;
|
|
1551
|
+
/** This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at. */
|
|
1552
|
+
disabledAt?: string | null;
|
|
1553
|
+
/** 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 t */
|
|
1554
|
+
enabled?: boolean | null;
|
|
1555
|
+
/** 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. */
|
|
1556
|
+
latitude?: number | null;
|
|
1557
|
+
/** Configures load shedding policies and percentages for the pool. */
|
|
1558
|
+
loadShedding?: unknown | null;
|
|
1559
|
+
/** 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. */
|
|
1560
|
+
longitude?: number | null;
|
|
1561
|
+
/** 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 */
|
|
1562
|
+
minimumOrigins?: number | null;
|
|
1563
|
+
modifiedOn?: string | null;
|
|
1564
|
+
/** The ID of the Monitor to use for checking the health of origins within this pool. */
|
|
1565
|
+
monitor?: string | null;
|
|
1566
|
+
/** The ID of the Monitor Group to use for checking the health of origins within this pool. */
|
|
1567
|
+
monitorGroup?: string | null;
|
|
1568
|
+
/** A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed. */
|
|
1569
|
+
name?: string | null;
|
|
1570
|
+
/** List of networks where Load Balancer or Pool is enabled. */
|
|
1571
|
+
networks?: string[] | null;
|
|
1572
|
+
/** 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 */
|
|
1573
|
+
notificationEmail?: string | null;
|
|
1574
|
+
/** Filter pool and origin health notifications by resource type or health status. Use null to reset. */
|
|
1575
|
+
notificationFilter?: unknown | null;
|
|
1576
|
+
/** Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity. */
|
|
1577
|
+
originSteering?: unknown | null;
|
|
1578
|
+
/** 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. */
|
|
1579
|
+
origins?: unknown[] | null;
|
|
1580
|
+
}
|
|
1581
|
+
export declare const CreatePoolResponse: Schema.Schema<CreatePoolResponse>;
|
|
1582
|
+
export type CreatePoolError = DefaultErrors;
|
|
1583
|
+
export declare const createPool: API.OperationMethod<CreatePoolRequest, CreatePoolResponse, CreatePoolError, Credentials | HttpClient.HttpClient>;
|
|
1584
|
+
export interface UpdatePoolRequest {
|
|
1585
|
+
poolId: string;
|
|
1586
|
+
/** Path param: Identifier. */
|
|
1587
|
+
accountId: string;
|
|
1588
|
+
/** Body param: A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed. */
|
|
1589
|
+
name: string;
|
|
1590
|
+
/** Body param: 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. */
|
|
1591
|
+
origins: unknown[];
|
|
1592
|
+
/** Body param: A list of regions from which to run health checks. Null means every Cloudflare data center. */
|
|
1593
|
+
checkRegions?: ("WNAM" | "ENAM" | "WEU" | "EEU" | "NSAM" | "SSAM" | "OC" | "ME" | "NAF" | "SAF" | "SEAS" | "NEAS" | "ALL_REGIONS" | "SAS")[] | null;
|
|
1594
|
+
/** Body param: A human-readable description of the pool. */
|
|
1595
|
+
description?: string;
|
|
1596
|
+
/** Body param: 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 t */
|
|
1597
|
+
enabled?: boolean;
|
|
1598
|
+
/** Body param: 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. */
|
|
1599
|
+
latitude?: number;
|
|
1600
|
+
/** Body param: Configures load shedding policies and percentages for the pool. */
|
|
1601
|
+
loadShedding?: unknown | null;
|
|
1602
|
+
/** Body param: 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. */
|
|
1603
|
+
longitude?: number;
|
|
1604
|
+
/** Body param: 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 fail */
|
|
1605
|
+
minimumOrigins?: number;
|
|
1606
|
+
/** Body param: The ID of the Monitor to use for checking the health of origins within this pool. */
|
|
1607
|
+
monitor?: string;
|
|
1608
|
+
/** Body param: The ID of the Monitor Group to use for checking the health of origins within this pool. */
|
|
1609
|
+
monitorGroup?: string;
|
|
1610
|
+
/** Body param: 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 he */
|
|
1611
|
+
notificationEmail?: string;
|
|
1612
|
+
/** Body param: Filter pool and origin health notifications by resource type or health status. Use null to reset. */
|
|
1613
|
+
notificationFilter?: unknown | null;
|
|
1614
|
+
/** Body param: Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity. */
|
|
1615
|
+
originSteering?: unknown | null;
|
|
1616
|
+
}
|
|
1617
|
+
export declare const UpdatePoolRequest: Schema.Schema<UpdatePoolRequest>;
|
|
1618
|
+
export interface UpdatePoolResponse {
|
|
1619
|
+
id?: string | null;
|
|
1620
|
+
/** A list of regions from which to run health checks. Null means every Cloudflare data center. */
|
|
1621
|
+
checkRegions?: ("WNAM" | "ENAM" | "WEU" | "EEU" | "NSAM" | "SSAM" | "OC" | "ME" | "NAF" | "SAF" | "SEAS" | "NEAS" | "ALL_REGIONS" | "SAS")[] | null;
|
|
1622
|
+
createdOn?: string | null;
|
|
1623
|
+
/** A human-readable description of the pool. */
|
|
1624
|
+
description?: string | null;
|
|
1625
|
+
/** This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at. */
|
|
1626
|
+
disabledAt?: string | null;
|
|
1627
|
+
/** 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 t */
|
|
1628
|
+
enabled?: boolean | null;
|
|
1629
|
+
/** 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. */
|
|
1630
|
+
latitude?: number | null;
|
|
1631
|
+
/** Configures load shedding policies and percentages for the pool. */
|
|
1632
|
+
loadShedding?: unknown | null;
|
|
1633
|
+
/** 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. */
|
|
1634
|
+
longitude?: number | null;
|
|
1635
|
+
/** 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 */
|
|
1636
|
+
minimumOrigins?: number | null;
|
|
1637
|
+
modifiedOn?: string | null;
|
|
1638
|
+
/** The ID of the Monitor to use for checking the health of origins within this pool. */
|
|
1639
|
+
monitor?: string | null;
|
|
1640
|
+
/** The ID of the Monitor Group to use for checking the health of origins within this pool. */
|
|
1641
|
+
monitorGroup?: string | null;
|
|
1642
|
+
/** A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed. */
|
|
1643
|
+
name?: string | null;
|
|
1644
|
+
/** List of networks where Load Balancer or Pool is enabled. */
|
|
1645
|
+
networks?: string[] | null;
|
|
1646
|
+
/** 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 */
|
|
1647
|
+
notificationEmail?: string | null;
|
|
1648
|
+
/** Filter pool and origin health notifications by resource type or health status. Use null to reset. */
|
|
1649
|
+
notificationFilter?: unknown | null;
|
|
1650
|
+
/** Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity. */
|
|
1651
|
+
originSteering?: unknown | null;
|
|
1652
|
+
/** 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. */
|
|
1653
|
+
origins?: unknown[] | null;
|
|
1654
|
+
}
|
|
1655
|
+
export declare const UpdatePoolResponse: Schema.Schema<UpdatePoolResponse>;
|
|
1656
|
+
export type UpdatePoolError = DefaultErrors;
|
|
1657
|
+
export declare const updatePool: API.OperationMethod<UpdatePoolRequest, UpdatePoolResponse, UpdatePoolError, Credentials | HttpClient.HttpClient>;
|
|
1658
|
+
export interface PatchPoolRequest {
|
|
1659
|
+
poolId: string;
|
|
1660
|
+
/** Path param: Identifier. */
|
|
1661
|
+
accountId: string;
|
|
1662
|
+
/** Body param: A list of regions from which to run health checks. Null means every Cloudflare data center. */
|
|
1663
|
+
checkRegions?: ("WNAM" | "ENAM" | "WEU" | "EEU" | "NSAM" | "SSAM" | "OC" | "ME" | "NAF" | "SAF" | "SEAS" | "NEAS" | "ALL_REGIONS" | "SAS")[] | null;
|
|
1664
|
+
/** Body param: A human-readable description of the pool. */
|
|
1665
|
+
description?: string;
|
|
1666
|
+
/** Body param: 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 t */
|
|
1667
|
+
enabled?: boolean;
|
|
1668
|
+
/** Body param: 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. */
|
|
1669
|
+
latitude?: number;
|
|
1670
|
+
/** Body param: Configures load shedding policies and percentages for the pool. */
|
|
1671
|
+
loadShedding?: unknown | null;
|
|
1672
|
+
/** Body param: 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. */
|
|
1673
|
+
longitude?: number;
|
|
1674
|
+
/** Body param: 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 fail */
|
|
1675
|
+
minimumOrigins?: number;
|
|
1676
|
+
/** Body param: The ID of the Monitor to use for checking the health of origins within this pool. */
|
|
1677
|
+
monitor?: string;
|
|
1678
|
+
/** Body param: The ID of the Monitor Group to use for checking the health of origins within this pool. */
|
|
1679
|
+
monitorGroup?: string;
|
|
1680
|
+
/** Body param: A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed. */
|
|
1681
|
+
name?: string;
|
|
1682
|
+
/** Body param: 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 he */
|
|
1683
|
+
notificationEmail?: string;
|
|
1684
|
+
/** Body param: Filter pool and origin health notifications by resource type or health status. Use null to reset. */
|
|
1685
|
+
notificationFilter?: unknown | null;
|
|
1686
|
+
/** Body param: Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity. */
|
|
1687
|
+
originSteering?: unknown | null;
|
|
1688
|
+
/** Body param: 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. */
|
|
1689
|
+
origins?: unknown[];
|
|
1690
|
+
}
|
|
1691
|
+
export declare const PatchPoolRequest: Schema.Schema<PatchPoolRequest>;
|
|
1692
|
+
export interface PatchPoolResponse {
|
|
1693
|
+
id?: string | null;
|
|
1694
|
+
/** A list of regions from which to run health checks. Null means every Cloudflare data center. */
|
|
1695
|
+
checkRegions?: ("WNAM" | "ENAM" | "WEU" | "EEU" | "NSAM" | "SSAM" | "OC" | "ME" | "NAF" | "SAF" | "SEAS" | "NEAS" | "ALL_REGIONS" | "SAS")[] | null;
|
|
1696
|
+
createdOn?: string | null;
|
|
1697
|
+
/** A human-readable description of the pool. */
|
|
1698
|
+
description?: string | null;
|
|
1699
|
+
/** This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at. */
|
|
1700
|
+
disabledAt?: string | null;
|
|
1701
|
+
/** 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 t */
|
|
1702
|
+
enabled?: boolean | null;
|
|
1703
|
+
/** 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. */
|
|
1704
|
+
latitude?: number | null;
|
|
1705
|
+
/** Configures load shedding policies and percentages for the pool. */
|
|
1706
|
+
loadShedding?: unknown | null;
|
|
1707
|
+
/** 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. */
|
|
1708
|
+
longitude?: number | null;
|
|
1709
|
+
/** 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 */
|
|
1710
|
+
minimumOrigins?: number | null;
|
|
1711
|
+
modifiedOn?: string | null;
|
|
1712
|
+
/** The ID of the Monitor to use for checking the health of origins within this pool. */
|
|
1713
|
+
monitor?: string | null;
|
|
1714
|
+
/** The ID of the Monitor Group to use for checking the health of origins within this pool. */
|
|
1715
|
+
monitorGroup?: string | null;
|
|
1716
|
+
/** A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed. */
|
|
1717
|
+
name?: string | null;
|
|
1718
|
+
/** List of networks where Load Balancer or Pool is enabled. */
|
|
1719
|
+
networks?: string[] | null;
|
|
1720
|
+
/** 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 */
|
|
1721
|
+
notificationEmail?: string | null;
|
|
1722
|
+
/** Filter pool and origin health notifications by resource type or health status. Use null to reset. */
|
|
1723
|
+
notificationFilter?: unknown | null;
|
|
1724
|
+
/** Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity. */
|
|
1725
|
+
originSteering?: unknown | null;
|
|
1726
|
+
/** 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. */
|
|
1727
|
+
origins?: unknown[] | null;
|
|
1728
|
+
}
|
|
1729
|
+
export declare const PatchPoolResponse: Schema.Schema<PatchPoolResponse>;
|
|
1730
|
+
export type PatchPoolError = DefaultErrors;
|
|
1731
|
+
export declare const patchPool: API.OperationMethod<PatchPoolRequest, PatchPoolResponse, PatchPoolError, Credentials | HttpClient.HttpClient>;
|
|
1732
|
+
export interface DeletePoolRequest {
|
|
1733
|
+
poolId: string;
|
|
1734
|
+
/** Identifier. */
|
|
1735
|
+
accountId: string;
|
|
1736
|
+
}
|
|
1737
|
+
export declare const DeletePoolRequest: Schema.Schema<DeletePoolRequest>;
|
|
1738
|
+
export interface DeletePoolResponse {
|
|
1739
|
+
id?: string | null;
|
|
1740
|
+
}
|
|
1741
|
+
export declare const DeletePoolResponse: Schema.Schema<DeletePoolResponse>;
|
|
1742
|
+
export type DeletePoolError = DefaultErrors;
|
|
1743
|
+
export declare const deletePool: API.OperationMethod<DeletePoolRequest, DeletePoolResponse, DeletePoolError, Credentials | HttpClient.HttpClient>;
|
|
1744
|
+
export interface BulkPatchPoolsRequest {
|
|
1745
|
+
/** Path param: Identifier. */
|
|
1746
|
+
accountId: string;
|
|
1747
|
+
/** Body param: 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 s */
|
|
1748
|
+
notificationEmail?: "";
|
|
1749
|
+
}
|
|
1750
|
+
export declare const BulkPatchPoolsRequest: Schema.Schema<BulkPatchPoolsRequest>;
|
|
1751
|
+
export interface BulkPatchPoolsResponse {
|
|
1752
|
+
result: {
|
|
1753
|
+
id?: string | null;
|
|
1754
|
+
checkRegions?: ("WNAM" | "ENAM" | "WEU" | "EEU" | "NSAM" | "SSAM" | "OC" | "ME" | "NAF" | "SAF" | "SEAS" | "NEAS" | "ALL_REGIONS" | "SAS")[] | null;
|
|
1755
|
+
createdOn?: string | null;
|
|
1756
|
+
description?: string | null;
|
|
1757
|
+
disabledAt?: string | null;
|
|
1758
|
+
enabled?: boolean | null;
|
|
1759
|
+
latitude?: number | null;
|
|
1760
|
+
loadShedding?: unknown | null;
|
|
1761
|
+
longitude?: number | null;
|
|
1762
|
+
minimumOrigins?: number | null;
|
|
1763
|
+
modifiedOn?: string | null;
|
|
1764
|
+
monitor?: string | null;
|
|
1765
|
+
monitorGroup?: string | null;
|
|
1766
|
+
name?: string | null;
|
|
1767
|
+
networks?: string[] | null;
|
|
1768
|
+
notificationEmail?: string | null;
|
|
1769
|
+
notificationFilter?: unknown | null;
|
|
1770
|
+
originSteering?: unknown | null;
|
|
1771
|
+
origins?: unknown[] | null;
|
|
1772
|
+
}[];
|
|
1773
|
+
}
|
|
1774
|
+
export declare const BulkPatchPoolsResponse: Schema.Schema<BulkPatchPoolsResponse>;
|
|
1775
|
+
export type BulkPatchPoolsError = DefaultErrors;
|
|
1776
|
+
export declare const bulkPatchPools: API.PaginatedOperationMethod<BulkPatchPoolsRequest, BulkPatchPoolsResponse, BulkPatchPoolsError, Credentials | HttpClient.HttpClient> & {
|
|
1777
|
+
pages: (input: BulkPatchPoolsRequest) => stream.Stream<BulkPatchPoolsResponse, BulkPatchPoolsError, Credentials | HttpClient.HttpClient>;
|
|
1778
|
+
items: (input: BulkPatchPoolsRequest) => stream.Stream<{
|
|
1779
|
+
id?: string | null;
|
|
1780
|
+
checkRegions?: ("WNAM" | "ENAM" | "WEU" | "EEU" | "NSAM" | "SSAM" | "OC" | "ME" | "NAF" | "SAF" | "SEAS" | "NEAS" | "ALL_REGIONS" | "SAS")[] | null;
|
|
1781
|
+
createdOn?: string | null;
|
|
1782
|
+
description?: string | null;
|
|
1783
|
+
disabledAt?: string | null;
|
|
1784
|
+
enabled?: boolean | null;
|
|
1785
|
+
latitude?: number | null;
|
|
1786
|
+
loadShedding?: unknown | null;
|
|
1787
|
+
longitude?: number | null;
|
|
1788
|
+
minimumOrigins?: number | null;
|
|
1789
|
+
modifiedOn?: string | null;
|
|
1790
|
+
monitor?: string | null;
|
|
1791
|
+
monitorGroup?: string | null;
|
|
1792
|
+
name?: string | null;
|
|
1793
|
+
networks?: string[] | null;
|
|
1794
|
+
notificationEmail?: string | null;
|
|
1795
|
+
notificationFilter?: unknown | null;
|
|
1796
|
+
originSteering?: unknown | null;
|
|
1797
|
+
origins?: unknown[] | null;
|
|
1798
|
+
}, BulkPatchPoolsError, Credentials | HttpClient.HttpClient>;
|
|
1799
|
+
};
|
|
1800
|
+
export interface GetPoolHealthRequest {
|
|
1801
|
+
poolId: string;
|
|
1802
|
+
/** Identifier. */
|
|
1803
|
+
accountId: string;
|
|
1804
|
+
}
|
|
1805
|
+
export declare const GetPoolHealthRequest: Schema.Schema<GetPoolHealthRequest>;
|
|
1806
|
+
export interface GetPoolHealthResponse {
|
|
1807
|
+
/** Pool ID. */
|
|
1808
|
+
poolId?: string | null;
|
|
1809
|
+
/** List of regions and associated health status. */
|
|
1810
|
+
popHealth?: {
|
|
1811
|
+
healthy?: boolean | null;
|
|
1812
|
+
origins?: {
|
|
1813
|
+
ip?: {
|
|
1814
|
+
failureReason?: string | null;
|
|
1815
|
+
healthy?: boolean | null;
|
|
1816
|
+
responseCode?: number | null;
|
|
1817
|
+
rtt?: string | null;
|
|
1818
|
+
} | null;
|
|
1819
|
+
}[] | null;
|
|
1820
|
+
} | null;
|
|
1821
|
+
}
|
|
1822
|
+
export declare const GetPoolHealthResponse: Schema.Schema<GetPoolHealthResponse>;
|
|
1823
|
+
export type GetPoolHealthError = DefaultErrors;
|
|
1824
|
+
export declare const getPoolHealth: API.OperationMethod<GetPoolHealthRequest, GetPoolHealthResponse, GetPoolHealthError, Credentials | HttpClient.HttpClient>;
|
|
1825
|
+
export interface CreatePoolHealthRequest {
|
|
1826
|
+
poolId: string;
|
|
1827
|
+
/** Path param: Identifier. */
|
|
1828
|
+
accountId: string;
|
|
1829
|
+
/** Body param: Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors. */
|
|
1830
|
+
allowInsecure?: boolean;
|
|
1831
|
+
/** Body param: To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. */
|
|
1832
|
+
consecutiveDown?: number;
|
|
1833
|
+
/** Body param: To be marked healthy the monitored origin must pass this healthcheck N consecutive times. */
|
|
1834
|
+
consecutiveUp?: number;
|
|
1835
|
+
/** Body param: Object description. */
|
|
1836
|
+
description?: string;
|
|
1837
|
+
/** 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 monitor */
|
|
1838
|
+
expectedBody?: string;
|
|
1839
|
+
/** Body param: The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
1840
|
+
expectedCodes?: string;
|
|
1841
|
+
/** Body param: Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
1842
|
+
followRedirects?: boolean;
|
|
1843
|
+
/** 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 */
|
|
1844
|
+
header?: Record<string, unknown>;
|
|
1845
|
+
/** 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. */
|
|
1846
|
+
interval?: number;
|
|
1847
|
+
/** 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. */
|
|
1848
|
+
method?: string;
|
|
1849
|
+
/** Body param: The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
1850
|
+
path?: string;
|
|
1851
|
+
/** 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 */
|
|
1852
|
+
port?: number | null;
|
|
1853
|
+
/** Body param: Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors. */
|
|
1854
|
+
probeZone?: string;
|
|
1855
|
+
/** Body param: The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. */
|
|
1856
|
+
retries?: number;
|
|
1857
|
+
/** Body param: The timeout (in seconds) before marking the health check as failed. */
|
|
1858
|
+
timeout?: number;
|
|
1859
|
+
/** Body param: The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'. */
|
|
1860
|
+
type?: "http" | "https" | "tcp" | "udp_icmp" | "icmp_ping" | "smtp";
|
|
1861
|
+
}
|
|
1862
|
+
export declare const CreatePoolHealthRequest: Schema.Schema<CreatePoolHealthRequest>;
|
|
1863
|
+
export interface CreatePoolHealthResponse {
|
|
1864
|
+
/** Monitored pool IDs mapped to their respective names. */
|
|
1865
|
+
pools?: Record<string, unknown> | null;
|
|
1866
|
+
previewId?: string | null;
|
|
1867
|
+
}
|
|
1868
|
+
export declare const CreatePoolHealthResponse: Schema.Schema<CreatePoolHealthResponse>;
|
|
1869
|
+
export type CreatePoolHealthError = DefaultErrors;
|
|
1870
|
+
export declare const createPoolHealth: API.OperationMethod<CreatePoolHealthRequest, CreatePoolHealthResponse, CreatePoolHealthError, Credentials | HttpClient.HttpClient>;
|
|
1871
|
+
export interface GetPoolReferenceRequest {
|
|
1872
|
+
poolId: string;
|
|
1873
|
+
/** Identifier. */
|
|
1874
|
+
accountId: string;
|
|
1875
|
+
}
|
|
1876
|
+
export declare const GetPoolReferenceRequest: Schema.Schema<GetPoolReferenceRequest>;
|
|
1877
|
+
export interface GetPoolReferenceResponse {
|
|
1878
|
+
result: {
|
|
1879
|
+
referenceType?: "*" | "referral" | "referrer" | null;
|
|
1880
|
+
resourceId?: string | null;
|
|
1881
|
+
resourceName?: string | null;
|
|
1882
|
+
resourceType?: string | null;
|
|
1883
|
+
}[];
|
|
1884
|
+
}
|
|
1885
|
+
export declare const GetPoolReferenceResponse: Schema.Schema<GetPoolReferenceResponse>;
|
|
1886
|
+
export type GetPoolReferenceError = DefaultErrors;
|
|
1887
|
+
export declare const getPoolReference: API.PaginatedOperationMethod<GetPoolReferenceRequest, GetPoolReferenceResponse, GetPoolReferenceError, Credentials | HttpClient.HttpClient> & {
|
|
1888
|
+
pages: (input: GetPoolReferenceRequest) => stream.Stream<GetPoolReferenceResponse, GetPoolReferenceError, Credentials | HttpClient.HttpClient>;
|
|
1889
|
+
items: (input: GetPoolReferenceRequest) => stream.Stream<{
|
|
1890
|
+
referenceType?: "*" | "referral" | "referrer" | null;
|
|
1891
|
+
resourceId?: string | null;
|
|
1892
|
+
resourceName?: string | null;
|
|
1893
|
+
resourceType?: string | null;
|
|
1894
|
+
}, GetPoolReferenceError, Credentials | HttpClient.HttpClient>;
|
|
1895
|
+
};
|
|
1896
|
+
export interface GetPreviewRequest {
|
|
1897
|
+
previewId: string;
|
|
1898
|
+
/** Identifier. */
|
|
1899
|
+
accountId: string;
|
|
1900
|
+
}
|
|
1901
|
+
export declare const GetPreviewRequest: Schema.Schema<GetPreviewRequest>;
|
|
1902
|
+
export type GetPreviewResponse = Record<string, unknown>;
|
|
1903
|
+
export declare const GetPreviewResponse: Schema.Schema<GetPreviewResponse>;
|
|
1904
|
+
export type GetPreviewError = DefaultErrors;
|
|
1905
|
+
export declare const getPreview: API.OperationMethod<GetPreviewRequest, GetPreviewResponse, GetPreviewError, Credentials | HttpClient.HttpClient>;
|
|
1906
|
+
export interface GetRegionRequest {
|
|
1907
|
+
regionId: "WNAM" | "ENAM" | "WEU" | "EEU" | "NSAM" | "SSAM" | "OC" | "ME" | "NAF" | "SAF" | "SAS" | "SEAS" | "NEAS";
|
|
1908
|
+
/** Identifier. */
|
|
1909
|
+
accountId: string;
|
|
1910
|
+
}
|
|
1911
|
+
export declare const GetRegionRequest: Schema.Schema<GetRegionRequest>;
|
|
1912
|
+
export type GetRegionResponse = string | null;
|
|
1913
|
+
export declare const GetRegionResponse: Schema.Schema<GetRegionResponse>;
|
|
1914
|
+
export type GetRegionError = DefaultErrors;
|
|
1915
|
+
export declare const getRegion: API.OperationMethod<GetRegionRequest, GetRegionResponse, GetRegionError, Credentials | HttpClient.HttpClient>;
|
|
1916
|
+
export interface ListRegionsRequest {
|
|
1917
|
+
/** Path param: Identifier. */
|
|
1918
|
+
accountId: string;
|
|
1919
|
+
/** Query param: Two-letter alpha-2 country code followed in ISO 3166-1. */
|
|
1920
|
+
countryCodeA2?: string;
|
|
1921
|
+
/** Query param: Two-letter subdivision code followed in ISO 3166-2. */
|
|
1922
|
+
subdivisionCode?: string;
|
|
1923
|
+
/** Query param: Two-letter subdivision code followed in ISO 3166-2. */
|
|
1924
|
+
subdivisionCodeA2?: string;
|
|
1925
|
+
}
|
|
1926
|
+
export declare const ListRegionsRequest: Schema.Schema<ListRegionsRequest>;
|
|
1927
|
+
export type ListRegionsResponse = string | null;
|
|
1928
|
+
export declare const ListRegionsResponse: Schema.Schema<ListRegionsResponse>;
|
|
1929
|
+
export type ListRegionsError = DefaultErrors;
|
|
1930
|
+
export declare const listRegions: API.OperationMethod<ListRegionsRequest, ListRegionsResponse, ListRegionsError, Credentials | HttpClient.HttpClient>;
|
|
1931
|
+
export interface ListSearchesRequest {
|
|
1932
|
+
/** Path param: Identifier. */
|
|
1933
|
+
accountId: string;
|
|
1934
|
+
/** Query param: Search query term. */
|
|
1935
|
+
query?: string;
|
|
1936
|
+
/** Query param: The type of references to include. "\ " to include both referral and referrer references. "" to not include any reference information. */
|
|
1937
|
+
references?: "" | "*" | "referral" | "referrer";
|
|
1938
|
+
}
|
|
1939
|
+
export declare const ListSearchesRequest: Schema.Schema<ListSearchesRequest>;
|
|
1940
|
+
export interface ListSearchesResponse {
|
|
1941
|
+
result: {
|
|
1942
|
+
items?: {
|
|
1943
|
+
resources?: {
|
|
1944
|
+
referenceType?: "referral" | "referrer" | null;
|
|
1945
|
+
references?: unknown[] | null;
|
|
1946
|
+
resourceId?: string | null;
|
|
1947
|
+
resourceName?: string | null;
|
|
1948
|
+
resourceType?: "load_balancer" | "monitor" | "pool" | null;
|
|
1949
|
+
}[] | null;
|
|
1950
|
+
}[] | null;
|
|
1951
|
+
};
|
|
1952
|
+
resultInfo: {
|
|
1953
|
+
count?: number | null;
|
|
1954
|
+
page?: number | null;
|
|
1955
|
+
perPage?: number | null;
|
|
1956
|
+
totalCount?: number | null;
|
|
1957
|
+
};
|
|
1958
|
+
}
|
|
1959
|
+
export declare const ListSearchesResponse: Schema.Schema<ListSearchesResponse>;
|
|
1960
|
+
export type ListSearchesError = DefaultErrors;
|
|
1961
|
+
export declare const listSearches: API.PaginatedOperationMethod<ListSearchesRequest, ListSearchesResponse, ListSearchesError, Credentials | HttpClient.HttpClient> & {
|
|
1962
|
+
pages: (input: ListSearchesRequest) => stream.Stream<ListSearchesResponse, ListSearchesError, Credentials | HttpClient.HttpClient>;
|
|
1963
|
+
items: (input: ListSearchesRequest) => stream.Stream<{
|
|
1964
|
+
resources?: {
|
|
1965
|
+
referenceType?: "referral" | "referrer" | null;
|
|
1966
|
+
references?: unknown[] | null;
|
|
1967
|
+
resourceId?: string | null;
|
|
1968
|
+
resourceName?: string | null;
|
|
1969
|
+
resourceType?: "load_balancer" | "monitor" | "pool" | null;
|
|
1970
|
+
}[] | null;
|
|
1971
|
+
}, ListSearchesError, Credentials | HttpClient.HttpClient>;
|
|
1972
|
+
};
|
|
1973
|
+
//# sourceMappingURL=load-balancers.d.ts.map
|