package
4.1.0
Repository: https://github.com/cloudflare/cloudflare-go.git
Documentation: pkg.go.dev

# Functions

NewAppService generates a new service that applies the given options to each request.
NewCfInterconnectService generates a new service that applies the given options to each request.
NewConnectorService generates a new service that applies the given options to each request.
NewGRETunnelService generates a new service that applies the given options to each request.
NewIPSECTunnelService generates a new service that applies the given options to each request.
NewMagicTransitService generates a new service that applies the given options to each request.
NewPCAPDownloadService generates a new service that applies the given options to each request.
NewPCAPOwnershipService generates a new service that applies the given options to each request.
NewPCAPService generates a new service that applies the given options to each request.
NewRouteService generates a new service that applies the given options to each request.
NewSiteACLService generates a new service that applies the given options to each request.
NewSiteLANService generates a new service that applies the given options to each request.
NewSiteService generates a new service that applies the given options to each request.
NewSiteWANService generates a new service that applies the given options to each request.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
This is an alias to an internal value.
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

Bidirectional ACL policy for network traffic within a site.
No description provided by the author
No description provided by the author
No description provided by the author
Custom app defined for an account.
No description provided by the author
No description provided by the author
Collection of Hostnames and/or IP Subnets to associate with traffic decisions.
Custom app defined for an account.
Managed app defined by Cloudflare.
No description provided by the author
Custom app defined for an account.
No description provided by the author
AppService contains methods and other services that help with interacting with the cloudflare API.
No description provided by the author
Custom app defined for an account.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The configuration specific to GRE interconnects.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The configuration specific to GRE interconnects.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The configuration specific to GRE interconnects.
CfInterconnectService contains methods and other services that help with interacting with the cloudflare API.
No description provided by the author
The configuration specific to GRE interconnects.
No description provided by the author
No description provided by the author
No description provided by the author
The configuration specific to GRE interconnects.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ConnectorService contains methods and other services that help with interacting with the cloudflare API.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The destination address in a request type health check.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The destination address in a request type health check.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The destination address in a request type health check.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The destination address in a request type health check.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The destination address in a request type health check.
GRETunnelService contains methods and other services that help with interacting with the cloudflare API.
No description provided by the author
No description provided by the author
The destination address in a request type health check.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The destination address in a request type health check.
No description provided by the author
No description provided by the author
The destination address in a request type health check.
The destination address in a request type health check.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The destination address in a request type health check.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The destination address in a request type health check.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The destination address in a request type health check.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The destination address in a request type health check.
No description provided by the author
No description provided by the author
The destination address in a request type health check.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The destination address in a request type health check.
No description provided by the author
No description provided by the author
No description provided by the author
IPSECTunnelService contains methods and other services that help with interacting with the cloudflare API.
No description provided by the author
No description provided by the author
The destination address in a request type health check.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The destination address in a request type health check.
No description provided by the author
If the site is not configured in high availability mode, this configuration is optional (if omitted, use DHCP).
If the site is not configured in high availability mode, this configuration is optional (if omitted, use DHCP).
MagicTransitService contains methods and other services that help with interacting with the cloudflare API.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PCAPDownloadService contains methods and other services that help with interacting with the cloudflare API.
The packet capture filter.
The packet capture filter.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PCAPOwnershipService contains methods and other services that help with interacting with the cloudflare API.
No description provided by the author
No description provided by the author
PCAPService contains methods and other services that help with interacting with the cloudflare API.
The PSK metadata that includes when the PSK was generated.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RouteService contains methods and other services that help with interacting with the cloudflare API.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Used only for ECMP routes.
Used only for ECMP routes.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SiteACLService contains methods and other services that help with interacting with the cloudflare API.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SiteLANService contains methods and other services that help with interacting with the cloudflare API.
No description provided by the author
No description provided by the author
No description provided by the author
Location of site in latitude and longitude.
Location of site in latitude and longitude.
No description provided by the author
No description provided by the author
SiteService contains methods and other services that help with interacting with the cloudflare API.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SiteWANService contains methods and other services that help with interacting with the cloudflare API.
No description provided by the author
No description provided by the author
No description provided by the author
(optional) if omitted, use DHCP.
(optional) if omitted, use DHCP.

# Interfaces

Collection of Hostnames and/or IP Subnets to associate with traffic decisions.
The destination address in a request type health check.
The destination address in a request type health check.
The destination address in a request type health check.
The destination address in a request type health check.
The destination address in a request type health check.
The destination address in a request type health check.
The destination address in a request type health check.
The destination address in a request type health check.
The destination address in a request type health check.
The destination address in a request type health check.
The destination address in a request type health check.
The destination address in a request type health check.
The destination address in a request type health check.
The destination address in a request type health check.
The destination address in a request type health check.
The destination address in a request type health check.
The destination address in a request type health check.
Union satisfied by [magic_transit.PCAP] or [magic_transit.PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFull].
Union satisfied by [magic_transit.PCAP] or [magic_transit.PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFull].
Satisfied by [magic_transit.PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimple], [magic_transit.PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFull], [PCAPNewParamsBody].
Union satisfied by [magic_transit.PCAP] or [magic_transit.PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFull].

# Type aliases

Array of allowed communication protocols between configured LANs.
Whether the API call was successful.
Whether the API call was successful.
Whether the API call was successful.
This is an alias to an internal type.
This is an alias to an internal type.
This is an alias to an internal type.
This is an alias to an internal type.
This is an alias to an internal type.
The type of actor, whether a User, Cloudflare Admin, or an Automated System.
This is an alias to an internal type.
This is an alias to an internal type.
The Certificate Authority that will issue the certificate This is an alias to an internal type.
Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).
Whether the API call was successful.
Whether the API call was successful.
Whether the API call was successful.
Whether the API call was successful.
A Cloudflare Tunnel that connects your origin to Cloudflare's edge.
This is an alias to an internal type.
The status of the tunnel.
The type of tunnel.
No description provided by the author
This is an alias to an internal type.
Whether the API call was successful.
The direction of the flow of the healthcheck.
The direction of the flow of the healthcheck.
Whether the API call was successful.
Whether the API call was successful.
The direction of the flow of the healthcheck.
Whether the API call was successful.
The direction of the flow of the healthcheck.
Whether the API call was successful.
The direction of the flow of the healthcheck.
The direction of the flow of the healthcheck.
Whether the API call was successful.
The direction of the flow of the healthcheck.
How frequent the health check is run.
The type of healthcheck to run, reply or request.
Whether the API call was successful.
The direction of the flow of the healthcheck.
The direction of the flow of the healthcheck.
Whether the API call was successful.
Whether the API call was successful.
The direction of the flow of the healthcheck.
Whether the API call was successful.
The direction of the flow of the healthcheck.
The direction of the flow of the healthcheck.
Whether the API call was successful.
The direction of the flow of the healthcheck.
Whether the API call was successful.
The direction of the flow of the healthcheck.
Whether the API call was successful.
The direction of the flow of the healthcheck.
This is an alias to an internal type.
Allow or deny operations against the resources.
A named group of permissions that map to a group of operations against resources.
Attributes associated to the permission group.
A group of scoped resources.
Attributes associated to the resource group.
A scope is a combination of scope objects which provides additional context.
A scope object represents any resource that can have actions applied against invite.
This is an alias to an internal type.
A member's status in the account.
Details of the user associated to the membership.
The status of the ownership challenge.
Whether the API call was successful.
The status of the packet capture request.
The system used to collect packet captures.
The type of packet capture.
The status of the packet capture request.
The system used to collect packet captures.
The type of packet capture.
The status of the packet capture request.
The system used to collect packet captures.
The type of packet capture.
The status of the packet capture request.
The system used to collect packet captures.
The type of packet capture.
The system used to collect packet captures.
The type of packet capture.
The system used to collect packet captures.
The type of packet capture.
The system used to collect packet captures.
The type of packet capture.
Whether the API call was successful.
The status of the packet capture request.
The system used to collect packet captures.
The type of packet capture.
The status of the packet capture request.
The system used to collect packet captures.
The type of packet capture.
Whether the API call was successful.
Whether the API call was successful.
The status of the packet capture request.
The system used to collect packet captures.
The type of packet capture.
This is an alias to an internal type.
This is an alias to an internal type.
This is an alias to an internal type.
The rate plan applied to the subscription.
The ID of the rate plan.
The rate plan applied to the subscription.
This is an alias to an internal type.
This is an alias to an internal type.
This is an alias to an internal type.
This is an alias to an internal type.
This is an alias to an internal type.
Whether the API call was successful.
Whether the API call was successful.
Whether the API call was successful.
Whether the API call was successful.
Whether the API call was successful.
Whether the API call was successful.
Whether the API call was successful.
Whether the API call was successful.
Whether the API call was successful.
Whether the API call was successful.
Whether the API call was successful.
Whether the API call was successful.
Whether the API call was successful.
Whether the API call was successful.
Whether the API call was successful.
Whether the API call was successful.
Whether the API call was successful.
Whether the API call was successful.
Whether the API call was successful.
Whether the API call was successful.
Whether the API call was successful.
Whether the API call was successful.
Whether the API call was successful.
Whether the API call was successful.
Whether the API call was successful.
Direction to order DNS records in.
No description provided by the author
No description provided by the author
This is an alias to an internal type.
How often the subscription is renewed automatically.
This is an alias to an internal type.
The state that the subscription is in.
This is an alias to an internal type.
This is an alias to an internal type.
IPv4/IPv6 CIDR.
IPv4/IPv6 CIDR.
This is an alias to an internal type.
Client IP restrictions.
Client IP restrictions.
This is an alias to an internal type.
This is an alias to an internal type.
Allow or deny operations against the resources.
This is an alias to an internal type.
A named group of permissions that map to a group of operations against resources.
A named group of permissions that map to a group of operations against resources.
Attributes associated to the permission group.
Attributes associated to the permission group.
Status of the token.
The token value.
Magic WAN health check rate for tunnels created on this link.