cloudflare

func (*API) APITokens ¶

func (api *API) APITokens(ctx context.Context) ([]APIToken, error)

APITokens returns all available API tokens.

API reference: https://api.cloudflare.com/#user-api-tokens-list-tokens

func (*API) AccessApplication ¶

func (api *API) AccessApplication(ctx context.Context, accountID, applicationID string) (AccessApplication, error)

AccessApplication returns a single application based on the application ID.

API reference: https://api.cloudflare.com/#access-applications-access-applications-details

func (*API) AccessApplications ¶

func (api *API) AccessApplications(ctx context.Context, accountID string, pageOpts PaginationOptions) ([]AccessApplication, ResultInfo, error)

AccessApplications returns all applications within an account.

API reference: https://api.cloudflare.com/#access-applications-list-access-applications

func (*API) AccessAuditLogs ¶

func (api *API) AccessAuditLogs(ctx context.Context, accountID string, opts AccessAuditLogFilterOptions) ([]AccessAuditLogRecord, error)

AccessAuditLogs retrieves all audit logs for the Access service.

API reference: https://api.cloudflare.com/#access-requests-access-requests-audit

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"log"

	cloudflare "github.com/grafana/cloudflare-go"
)

func main() {
	api, err := cloudflare.New("deadbeef", "test@example.org")
	if err != nil {
		log.Fatal(err)
	}

	filterOpts := cloudflare.AccessAuditLogFilterOptions{}
	results, _ := api.AccessAuditLogs(context.Background(), "someaccountid", filterOpts)

	for _, record := range results {
		b, _ := json.Marshal(record)
		fmt.Println(string(b))
	}
}

Output:

func (*API) AccessCACertificate ¶

func (api *API) AccessCACertificate(ctx context.Context, accountID, applicationID string) (AccessCACertificate, error)

AccessCACertificate returns a single CA certificate associated with an Access Application.

API reference: https://api.cloudflare.com/#access-short-lived-certificates-short-lived-certificate-details

func (*API) AccessCACertificates ¶

func (api *API) AccessCACertificates(ctx context.Context, accountID string) ([]AccessCACertificate, error)

AccessCACertificates returns all CA certificates within Access.

API reference: https://api.cloudflare.com/#access-short-lived-certificates-list-short-lived-certificates

func (*API) AccessGroup ¶

func (api *API) AccessGroup(ctx context.Context, accountID, groupID string) (AccessGroup, error)

AccessGroup returns a single group based on the group ID.

API reference: https://api.cloudflare.com/#access-groups-access-group-details

func (*API) AccessGroups ¶

func (api *API) AccessGroups(ctx context.Context, accountID string, pageOpts PaginationOptions) ([]AccessGroup, ResultInfo, error)

AccessGroups returns all access groups for an access application.

API reference: https://api.cloudflare.com/#access-groups-list-access-groups

func (*API) AccessIdentityProviderDetails ¶

func (api *API) AccessIdentityProviderDetails(ctx context.Context, accountID, identityProviderID string) (AccessIdentityProvider, error)

AccessIdentityProviderDetails returns a single Access Identity Provider for an account.

API reference: https://api.cloudflare.com/#access-identity-providers-access-identity-providers-details

func (*API) AccessIdentityProviders ¶

func (api *API) AccessIdentityProviders(ctx context.Context, accountID string) ([]AccessIdentityProvider, error)

AccessIdentityProviders returns all Access Identity Providers for an account.

API reference: https://api.cloudflare.com/#access-identity-providers-list-access-identity-providers

func (*API) AccessKeysConfig ¶

func (api *API) AccessKeysConfig(ctx context.Context, accountID string) (AccessKeysConfig, error)

AccessKeysConfig returns the Access Keys Configuration for an account.

API reference: https://api.cloudflare.com/#access-keys-configuration-get-access-keys-configuration

func (*API) AccessMutualTLSCertificate ¶

func (api *API) AccessMutualTLSCertificate(ctx context.Context, accountID, certificateID string) (AccessMutualTLSCertificate, error)

AccessMutualTLSCertificate returns a single account level Access Mutual TLS certificate.

API reference: https://api.cloudflare.com/#access-mutual-tls-authentication-access-certificate-details

func (*API) AccessMutualTLSCertificates ¶

func (api *API) AccessMutualTLSCertificates(ctx context.Context, accountID string) ([]AccessMutualTLSCertificate, error)

AccessMutualTLSCertificates returns all Access TLS certificates for the account level.

API reference: https://api.cloudflare.com/#access-mutual-tls-authentication-properties

func (*API) AccessOrganization ¶

func (api *API) AccessOrganization(ctx context.Context, accountID string) (AccessOrganization, ResultInfo, error)

AccessOrganization returns the Access organisation details.

API reference: https://api.cloudflare.com/#access-organizations-access-organization-details

func (*API) AccessPolicies ¶

func (api *API) AccessPolicies(ctx context.Context, accountID, applicationID string, pageOpts PaginationOptions) ([]AccessPolicy, ResultInfo, error)

AccessPolicies returns all access policies for an access application.

API reference: https://api.cloudflare.com/#access-policy-list-access-policies

func (*API) AccessPolicy ¶

func (api *API) AccessPolicy(ctx context.Context, accountID, applicationID, policyID string) (AccessPolicy, error)

AccessPolicy returns a single policy based on the policy ID.

API reference: https://api.cloudflare.com/#access-policy-access-policy-details

func (*API) AccessServiceTokens ¶

func (api *API) AccessServiceTokens(ctx context.Context, accountID string) ([]AccessServiceToken, ResultInfo, error)

AccessServiceTokens returns all Access Service Tokens for an account.

API reference: https://api.cloudflare.com/#access-service-tokens-list-access-service-tokens

func (*API) Account ¶

func (api *API) Account(ctx context.Context, accountID string) (Account, ResultInfo, error)

Account returns a single account based on the ID.

API reference: https://api.cloudflare.com/#accounts-account-details

func (*API) AccountAccessRule ¶

func (api *API) AccountAccessRule(ctx context.Context, accountID string, accessRuleID string) (*AccessRuleResponse, error)

AccountAccessRule returns the details of an account's access rule.

API reference: https://api.cloudflare.com/#account-level-firewall-access-rule-access-rule-details

func (*API) AccountMember ¶

func (api *API) AccountMember(ctx context.Context, accountID string, memberID string) (AccountMember, error)

AccountMember returns details of a single account member.

API reference: https://api.cloudflare.com/#account-members-member-details

func (*API) AccountMembers ¶

func (api *API) AccountMembers(ctx context.Context, accountID string, pageOpts PaginationOptions) ([]AccountMember, ResultInfo, error)

AccountMembers returns all members of an account.

API reference: https://api.cloudflare.com/#accounts-list-accounts

func (*API) AccountRole ¶

func (api *API) AccountRole(ctx context.Context, accountID string, roleID string) (AccountRole, error)

AccountRole returns the details of a single account role.

API reference: https://api.cloudflare.com/#account-roles-role-details

func (*API) AccountRoles ¶

func (api *API) AccountRoles(ctx context.Context, accountID string) ([]AccountRole, error)

AccountRoles returns all roles of an account.

API reference: https://api.cloudflare.com/#account-roles-list-roles

func (*API) Accounts ¶

func (api *API) Accounts(ctx context.Context, pageOpts PaginationOptions) ([]Account, ResultInfo, error)

Accounts returns all accounts the logged in user has access to.

API reference: https://api.cloudflare.com/#accounts-list-accounts

func (*API) ArgoSmartRouting ¶

func (api *API) ArgoSmartRouting(ctx context.Context, zoneID string) (ArgoFeatureSetting, error)

ArgoSmartRouting returns the current settings for smart routing.

API reference: https://api.cloudflare.com/#argo-smart-routing-get-argo-smart-routing-setting

package main

import (
	"context"
	"fmt"
	"log"

	cloudflare "github.com/grafana/cloudflare-go"
)

func main() {
	api, err := cloudflare.New("deadbeef", "test@example.org")
	if err != nil {
		log.Fatal(err)
	}

	smartRoutingSettings, err := api.ArgoSmartRouting(context.Background(), "01a7362d577a6c3019a474fd6f485823")
	if err != nil {
		log.Fatal(err)
	}

	fmt.Printf("smart routing is %s", smartRoutingSettings.Value)
}

Output:

func (*API) ArgoTieredCaching ¶

func (api *API) ArgoTieredCaching(ctx context.Context, zoneID string) (ArgoFeatureSetting, error)

ArgoTieredCaching returns the current settings for tiered caching.

API reference: TBA

package main

import (
	"context"
	"fmt"
	"log"

	cloudflare "github.com/grafana/cloudflare-go"
)

func main() {
	api, err := cloudflare.New("deadbeef", "test@example.org")
	if err != nil {
		log.Fatal(err)
	}

	tieredCachingSettings, err := api.ArgoTieredCaching(context.Background(), "01a7362d577a6c3019a474fd6f485823")
	if err != nil {
		log.Fatal(err)
	}

	fmt.Printf("tiered caching is %s", tieredCachingSettings.Value)
}

Output:

func (*API) ArgoTunnel ¶

func (api *API) ArgoTunnel(ctx context.Context, accountID, tunnelUUID string) (ArgoTunnel, error)

ArgoTunnel returns a single Argo tunnel.

API reference: https://api.cloudflare.com/#argo-tunnel-get-argo-tunnel

func (*API) ArgoTunnels ¶

func (api *API) ArgoTunnels(ctx context.Context, accountID string) ([]ArgoTunnel, error)

ArgoTunnels lists all tunnels.

API reference: https://api.cloudflare.com/#argo-tunnel-list-argo-tunnels

func (*API) AvailableZonePlans ¶

func (api *API) AvailableZonePlans(ctx context.Context, zoneID string) ([]ZonePlan, error)

AvailableZonePlans returns information about all plans available to the specified zone.

API reference: https://api.cloudflare.com/#zone-rate-plan-list-available-plans

func (*API) AvailableZoneRatePlans ¶

func (api *API) AvailableZoneRatePlans(ctx context.Context, zoneID string) ([]ZoneRatePlan, error)

AvailableZoneRatePlans returns information about all plans available to the specified zone.

API reference: https://api.cloudflare.com/#zone-plan-available-plans

func (*API) CancelRegistrarDomainTransfer ¶

func (api *API) CancelRegistrarDomainTransfer(ctx context.Context, accountID, domainName string) ([]RegistrarDomain, error)

CancelRegistrarDomainTransfer cancels a pending domain transfer.

API reference: https://api.cloudflare.com/#registrar-domains-cancel-transfer

api, err := cloudflare.New(apiKey, user)
if err != nil {
	log.Fatal(err)
}

domains, err := api.CancelRegistrarDomainTransfer(context.Background(), "01a7362d577a6c3019a474fd6f485823", "cloudflare.com")
if err != nil {
	log.Fatal(err)
}

fmt.Printf("%+v\n", domains)

func (*API) CertificatePack ¶

func (api *API) CertificatePack(ctx context.Context, zoneID, certificatePackID string) (CertificatePack, error)

CertificatePack returns a single TLS certificate pack on a zone.

API Reference: https://api.cloudflare.com/#certificate-packs-get-certificate-pack

func (*API) ChangePageRule ¶

func (api *API) ChangePageRule(ctx context.Context, zoneID, ruleID string, rule PageRule) error

ChangePageRule lets you change individual settings for a Page Rule. This is in contrast to UpdatePageRule which replaces the entire Page Rule.

API reference: https://api.cloudflare.com/#page-rules-for-a-zone-change-a-page-rule

func (*API) ChangeWaitingRoom ¶

func (api *API) ChangeWaitingRoom(ctx context.Context, zoneID, waitingRoomID string, waitingRoom WaitingRoom) (WaitingRoom, error)

ChangeWaitingRoom lets you change individual settings for a Waiting room. This is in contrast to UpdateWaitingRoom which replaces the entire Waiting room.

API reference: https://api.cloudflare.com/#waiting-room-update-waiting-room

func (*API) CheckAccountLogpushDestinationExists ¶

func (api *API) CheckAccountLogpushDestinationExists(ctx context.Context, accountID, destinationConf string) (bool, error)

CheckAccountLogpushDestinationExists returns account-level destination exists check result.

API reference: https://api.cloudflare.com/#logpush-jobs-check-destination-exists

func (*API) CheckZoneLogpushDestinationExists ¶

func (api *API) CheckZoneLogpushDestinationExists(ctx context.Context, zoneID, destinationConf string) (bool, error)

CheckZoneLogpushDestinationExists returns zone-level destination exists check result.

API reference: https://api.cloudflare.com/#logpush-jobs-check-destination-exists

api, err := cloudflare.New(apiKey, user)
if err != nil {
	log.Fatal(err)
}

zoneID, err := api.ZoneIDByName(domain)
if err != nil {
	log.Fatal(err)
}

exists, err := api.CheckZoneLogpushDestinationExists(context.Background(), zoneID, "destination_conf")
if err != nil {
	log.Fatal(err)
}

fmt.Printf("%+v\n", exists)

func (*API) CleanupArgoTunnelConnections ¶

func (api *API) CleanupArgoTunnelConnections(ctx context.Context, accountID, tunnelUUID string) error

CleanupArgoTunnelConnections deletes any inactive connections on a tunnel.

API reference: https://api.cloudflare.com/#argo-tunnel-clean-up-argo-tunnel-connections

func (*API) ConnectZoneRailgun ¶

func (api *API) ConnectZoneRailgun(ctx context.Context, zoneID, railgunID string) (ZoneRailgun, error)

ConnectZoneRailgun connects a Railgun for a given zone.

API reference: https://api.cloudflare.com/#railguns-for-a-zone-connect-or-disconnect-a-railgun

func (*API) CreateAPIToken ¶

func (api *API) CreateAPIToken(ctx context.Context, token APIToken) (APIToken, error)

CreateAPIToken creates a new token. Returns the API token that has been generated.

The token value itself is only shown once (post create) and will present as `Value` from this method. If you fail to capture it at this point, you will need to roll the token in order to get a new value.

API reference: https://api.cloudflare.com/#user-api-tokens-create-token

func (*API) CreateAccessApplication ¶

func (api *API) CreateAccessApplication(ctx context.Context, accountID string, accessApplication AccessApplication) (AccessApplication, error)

CreateAccessApplication creates a new access application.

API reference: https://api.cloudflare.com/#access-applications-create-access-application

func (*API) CreateAccessCACertificate ¶

func (api *API) CreateAccessCACertificate(ctx context.Context, accountID, applicationID string) (AccessCACertificate, error)

CreateAccessCACertificate creates a new CA certificate for an Access Application.

API reference: https://api.cloudflare.com/#access-short-lived-certificates-create-short-lived-certificate

func (*API) CreateAccessGroup ¶

func (api *API) CreateAccessGroup(ctx context.Context, accountID string, accessGroup AccessGroup) (AccessGroup, error)

CreateAccessGroup creates a new access group.

API reference: https://api.cloudflare.com/#access-groups-create-access-group

func (*API) CreateAccessIdentityProvider ¶

func (api *API) CreateAccessIdentityProvider(ctx context.Context, accountID string, identityProviderConfiguration AccessIdentityProvider) (AccessIdentityProvider, error)

CreateAccessIdentityProvider creates a new Access Identity Provider.

API reference: https://api.cloudflare.com/#access-identity-providers-create-access-identity-provider

func (*API) CreateAccessMutualTLSCertificate ¶

func (api *API) CreateAccessMutualTLSCertificate(ctx context.Context, accountID string, certificate AccessMutualTLSCertificate) (AccessMutualTLSCertificate, error)

CreateAccessMutualTLSCertificate creates an account level Access TLS Mutual certificate.

API reference: https://api.cloudflare.com/#access-mutual-tls-authentication-create-access-certificate

func (*API) CreateAccessOrganization ¶

func (api *API) CreateAccessOrganization(ctx context.Context, accountID string, accessOrganization AccessOrganization) (AccessOrganization, error)

CreateAccessOrganization creates the Access organisation details.

API reference: https://api.cloudflare.com/#access-organizations-create-access-organization

func (*API) CreateAccessPolicy ¶

func (api *API) CreateAccessPolicy(ctx context.Context, accountID, applicationID string, accessPolicy AccessPolicy) (AccessPolicy, error)

CreateAccessPolicy creates a new access policy.

API reference: https://api.cloudflare.com/#access-policy-create-access-policy

func (*API) CreateAccessServiceToken ¶

func (api *API) CreateAccessServiceToken(ctx context.Context, accountID, name string) (AccessServiceTokenCreateResponse, error)

CreateAccessServiceToken creates a new Access Service Token for an account.

API reference: https://api.cloudflare.com/#access-service-tokens-create-access-service-token

func (*API) CreateAccount ¶

func (api *API) CreateAccount(ctx context.Context, account Account) (Account, error)

CreateAccount creates a new account. Note: This requires the Tenant entitlement.

API reference: https://developers.cloudflare.com/tenant/tutorial/provisioning-resources#creating-an-account

func (*API) CreateAccountAccessRule ¶

func (api *API) CreateAccountAccessRule(ctx context.Context, accountID string, accessRule AccessRule) (*AccessRuleResponse, error)

CreateAccountAccessRule creates a firewall access rule for the given account identifier.

API reference: https://api.cloudflare.com/#account-level-firewall-access-rule-create-access-rule

func (*API) CreateAccountLogpushJob ¶

func (api *API) CreateAccountLogpushJob(ctx context.Context, accountID string, job LogpushJob) (*LogpushJob, error)

CreateAccountLogpushJob creates a new account-level Logpush Job.

API reference: https://api.cloudflare.com/#logpush-jobs-create-logpush-job

func (*API) CreateAccountMember ¶

func (api *API) CreateAccountMember(ctx context.Context, accountID string, emailAddress string, roles []string) (AccountMember, error)

CreateAccountMember invites a new member to join an account. The member will be placed into "pending" status and receive an email confirmation.

API reference: https://api.cloudflare.com/#account-members-add-member

func (*API) CreateAccountMemberWithStatus ¶

func (api *API) CreateAccountMemberWithStatus(ctx context.Context, accountID string, emailAddress string, roles []string, status string) (AccountMember, error)

CreateAccountMemberWithStatus invites a new member to join an account, allowing setting the status.

Refer to the API reference for valid statuses.

API reference: https://api.cloudflare.com/#account-members-add-member

func (*API) CreateAccountRuleset ¶

func (api *API) CreateAccountRuleset(ctx context.Context, accountID string, ruleset Ruleset) (Ruleset, error)

CreateAccountRuleset creates a new ruleset for an account.

API reference: https://api.cloudflare.com/#account-rulesets-create-account-ruleset

func (*API) CreateAdvancedCertificatePack ¶

func (api *API) CreateAdvancedCertificatePack(ctx context.Context, zoneID string, cert CertificatePackAdvancedCertificate) (CertificatePackAdvancedCertificate, error)

CreateAdvancedCertificatePack creates a new certificate pack associated with a zone.

API Reference: https://api.cloudflare.com/#certificate-packs-order-certificate-pack

func (*API) CreateArgoTunnel ¶

func (api *API) CreateArgoTunnel(ctx context.Context, accountID, name, secret string) (ArgoTunnel, error)

CreateArgoTunnel creates a new tunnel for the account.

API reference: https://api.cloudflare.com/#argo-tunnel-create-argo-tunnel

func (*API) CreateCertificatePack ¶

func (api *API) CreateCertificatePack(ctx context.Context, zoneID string, cert CertificatePackRequest) (CertificatePack, error)

CreateCertificatePack creates a new certificate pack associated with a zone.

API Reference: https://api.cloudflare.com/#certificate-packs-order-certificate-pack

func (*API) CreateCustomHostname ¶

func (api *API) CreateCustomHostname(ctx context.Context, zoneID string, ch CustomHostname) (*CustomHostnameResponse, error)

CreateCustomHostname creates a new custom hostname and requests that an SSL certificate be issued for it.

API reference: https://api.cloudflare.com/#custom-hostname-for-a-zone-create-custom-hostname

func (*API) CreateDNSRecord ¶

func (api *API) CreateDNSRecord(ctx context.Context, zoneID string, rr DNSRecord) (*DNSRecordResponse, error)

CreateDNSRecord creates a DNS record for the zone identifier.

API reference: https://api.cloudflare.com/#dns-records-for-a-zone-create-dns-record

func (*API) CreateDevicePostureIntegration ¶

func (api *API) CreateDevicePostureIntegration(ctx context.Context, accountID string, integration DevicePostureIntegration) (DevicePostureIntegration, error)

CreateDevicePostureIntegration creates a device posture integration within an account.

API reference: https://api.cloudflare.com/#device-posture-integrations-create-device-posture-integration

func (*API) CreateDevicePostureRule ¶

func (api *API) CreateDevicePostureRule(ctx context.Context, accountID string, rule DevicePostureRule) (DevicePostureRule, error)

CreateDevicePostureRule creates a new device posture rule.

API reference: https://api.cloudflare.com/#device-posture-rules-create-device-posture-rule

func (*API) CreateFilters ¶

func (api *API) CreateFilters(ctx context.Context, zoneID string, filters []Filter) ([]Filter, error)

CreateFilters creates new filters.

API reference: https://developers.cloudflare.com/firewall/api/cf-filters/post/

func (*API) CreateFirewallRules ¶

func (api *API) CreateFirewallRules(ctx context.Context, zoneID string, firewallRules []FirewallRule) ([]FirewallRule, error)

CreateFirewallRules creates new firewall rules.

API reference: https://developers.cloudflare.com/firewall/api/cf-firewall-rules/post/

func (*API) CreateHealthcheck ¶

func (api *API) CreateHealthcheck(ctx context.Context, zoneID string, healthcheck Healthcheck) (Healthcheck, error)

CreateHealthcheck creates a new healthcheck in a zone.

API reference: https://api.cloudflare.com/#health-checks-create-health-check

func (*API) CreateHealthcheckPreview ¶

func (api *API) CreateHealthcheckPreview(ctx context.Context, zoneID string, healthcheck Healthcheck) (Healthcheck, error)

CreateHealthcheckPreview creates a new preview of a healthcheck in a zone.

API reference: https://api.cloudflare.com/#health-checks-create-preview-health-check

func (*API) CreateIPList ¶

func (api *API) CreateIPList(ctx context.Context, name string, description string, kind string) (IPList,
	error)

CreateIPList creates a new IP List

API reference: https://api.cloudflare.com/#rules-lists-create-list

func (*API) CreateIPListItem ¶

func (api *API) CreateIPListItem(ctx context.Context, id, ip, comment string) ([]IPListItem, error)

CreateIPListItem creates a new IP List Item synchronously and returns the current set of IP List Items

func (*API) CreateIPListItemAsync ¶

func (api *API) CreateIPListItemAsync(ctx context.Context, id, ip, comment string) (IPListItemCreateResponse, error)

CreateIPListItemAsync creates a new IP List Item asynchronously. Users have to poll the operation status by using the operation_id returned by this function.

API reference: https://api.cloudflare.com/#rules-lists-create-list-items

func (*API) CreateIPListItems ¶

func (api *API) CreateIPListItems(ctx context.Context, id string, items []IPListItemCreateRequest) (
	[]IPListItem, error)

CreateIPListItems bulk creates many IP List Items synchronously and returns the current set of IP List Items

func (*API) CreateIPListItemsAsync ¶

func (api *API) CreateIPListItemsAsync(ctx context.Context, id string, items []IPListItemCreateRequest) (
	IPListItemCreateResponse, error)

CreateIPListItemsAsync bulk creates many IP List Items asynchronously. Users have to poll the operation status by using the operation_id returned by this function.

API reference: https://api.cloudflare.com/#rules-lists-create-list-items

func (*API) CreateKeylessSSL ¶

func (api *API) CreateKeylessSSL(ctx context.Context, zoneID string, keylessSSL KeylessSSLCreateRequest) (KeylessSSL, error)

CreateKeylessSSL creates a new Keyless SSL configuration for the zone.

API reference: https://api.cloudflare.com/#keyless-ssl-for-a-zone-create-keyless-ssl-configuration

func (*API) CreateLoadBalancer ¶

func (api *API) CreateLoadBalancer(ctx context.Context, zoneID string, lb LoadBalancer) (LoadBalancer, error)

CreateLoadBalancer creates a new load balancer.

API reference: https://api.cloudflare.com/#load-balancers-create-load-balancer

func (*API) CreateLoadBalancerMonitor ¶

func (api *API) CreateLoadBalancerMonitor(ctx context.Context, monitor LoadBalancerMonitor) (LoadBalancerMonitor, error)

CreateLoadBalancerMonitor creates a new load balancer monitor.

API reference: https://api.cloudflare.com/#load-balancer-monitors-create-monitor

func (*API) CreateLoadBalancerPool ¶

func (api *API) CreateLoadBalancerPool(ctx context.Context, pool LoadBalancerPool) (LoadBalancerPool, error)

CreateLoadBalancerPool creates a new load balancer pool.

API reference: https://api.cloudflare.com/#load-balancer-pools-create-pool

func (*API) CreateMagicFirewallRuleset ¶

func (api *API) CreateMagicFirewallRuleset(ctx context.Context, name string, description string, rules []MagicFirewallRulesetRule) (MagicFirewallRuleset, error)

CreateMagicFirewallRuleset creates a Magic Firewall ruleset

API reference: https://api.cloudflare.com/#rulesets-list-rulesets

func (*API) CreateMagicTransitStaticRoute ¶

func (api *API) CreateMagicTransitStaticRoute(ctx context.Context, route MagicTransitStaticRoute) ([]MagicTransitStaticRoute, error)

CreateMagicTransitStaticRoute creates a new static route

API reference: https://api.cloudflare.com/#magic-transit-static-routes-create-routes

func (*API) CreateNotificationPolicy ¶

func (api *API) CreateNotificationPolicy(ctx context.Context, accountID string, policy NotificationPolicy) (SaveResponse, error)

CreateNotificationPolicy creates a notification policy for an account.

API Reference: https://api.cloudflare.com/#notification-policies-create-notification-policy

func (*API) CreateNotificationWebhooks ¶

func (api *API) CreateNotificationWebhooks(ctx context.Context, accountID string, webhooks *NotificationUpsertWebhooks) (SaveResponse, error)

CreateNotificationWebhooks will help connect a webhooks destination. A test message will be sent to the webhooks endpoint during creation. If added successfully, the webhooks can be setup as a destination mechanism while creating policies.

Notifications will be posted to this URL.

API Reference: https://api.cloudflare.com/#notification-webhooks-create-webhook

func (*API) CreateOriginCertificate ¶

func (api *API) CreateOriginCertificate(ctx context.Context, certificate OriginCACertificate) (*OriginCACertificate, error)

CreateOriginCertificate creates a Cloudflare-signed certificate.

This function requires api.APIUserServiceKey be set to your Certificates API key.

API reference: https://api.cloudflare.com/#cloudflare-ca-create-certificate

func (*API) CreatePageRule ¶

func (api *API) CreatePageRule(ctx context.Context, zoneID string, rule PageRule) (*PageRule, error)

CreatePageRule creates a new Page Rule for a zone.

API reference: https://api.cloudflare.com/#page-rules-for-a-zone-create-a-page-rule

api, err := cloudflare.New(apiKey, user)
if err != nil {
	log.Fatal(err)
}

zoneID, err := api.ZoneIDByName(domain)
if err != nil {
	log.Fatal(err)
}

pageRule, err := api.CreatePageRule(context.Background(), zoneID, exampleNewPageRule)
if err != nil {
	log.Fatal(err)
}

fmt.Printf("%+v\n", pageRule)

func (*API) CreatePagesProject ¶

func (api *API) CreatePagesProject(ctx context.Context, accountID string, pagesProject PagesProject) (PagesProject, error)

CreatePagesProject creates a new Pages project in an account.

API reference: https://api.cloudflare.com/#pages-project-create-project

func (*API) CreateRailgun ¶

func (api *API) CreateRailgun(ctx context.Context, name string) (Railgun, error)

CreateRailgun creates a new Railgun.

API reference: https://api.cloudflare.com/#railgun-create-railgun

func (*API) CreateRateLimit ¶

func (api *API) CreateRateLimit(ctx context.Context, zoneID string, limit RateLimit) (RateLimit, error)

CreateRateLimit creates a new rate limit for a zone.

API reference: https://api.cloudflare.com/#rate-limits-for-a-zone-create-a-ratelimit

api, err := cloudflare.New(apiKey, user)
if err != nil {
	log.Fatal(err)
}

zoneID, err := api.ZoneIDByName(domain)
if err != nil {
	log.Fatal(err)
}

rateLimit, err := api.CreateRateLimit(context.Background(), zoneID, exampleNewRateLimit)
if err != nil {
	log.Fatal(err)
}

fmt.Printf("%+v\n", rateLimit)

func (*API) CreateSSL ¶

func (api *API) CreateSSL(ctx context.Context, zoneID string, options ZoneCustomSSLOptions) (ZoneCustomSSL, error)

CreateSSL allows you to add a custom SSL certificate to the given zone.

API reference: https://api.cloudflare.com/#custom-ssl-for-a-zone-create-ssl-configuration

func (*API) CreateSecondaryDNSPrimary ¶

func (api *API) CreateSecondaryDNSPrimary(ctx context.Context, accountID string, primary SecondaryDNSPrimary) (SecondaryDNSPrimary, error)

CreateSecondaryDNSPrimary creates a secondary DNS primary.

API reference: https://api.cloudflare.com/#secondary-dns-primary--create-primary

func (*API) CreateSecondaryDNSTSIG ¶

func (api *API) CreateSecondaryDNSTSIG(ctx context.Context, accountID string, tsig SecondaryDNSTSIG) (SecondaryDNSTSIG, error)

CreateSecondaryDNSTSIG creates a secondary DNS TSIG at the account level.

API reference: https://api.cloudflare.com/#secondary-dns-tsig--create-tsig

func (*API) CreateSecondaryDNSZone ¶

func (api *API) CreateSecondaryDNSZone(ctx context.Context, zoneID string, zone SecondaryDNSZone) (SecondaryDNSZone, error)

CreateSecondaryDNSZone creates a secondary DNS zone.

API reference: https://api.cloudflare.com/#secondary-dns-create-secondary-zone-configuration

func (*API) CreateSpectrumApplication ¶

func (api *API) CreateSpectrumApplication(ctx context.Context, zoneID string, appDetails SpectrumApplication) (SpectrumApplication, error)

CreateSpectrumApplication creates a new Spectrum application.

API reference: https://developers.cloudflare.com/spectrum/api-reference/#create-a-spectrum-application

func (*API) CreateTeamsList ¶

func (api *API) CreateTeamsList(ctx context.Context, accountID string, teamsList TeamsList) (TeamsList, error)

CreateTeamsList creates a new teams list.

API reference: https://api.cloudflare.com/#teams-lists-create-teams-list

func (*API) CreateTeamsLocation ¶

func (api *API) CreateTeamsLocation(ctx context.Context, accountID string, teamsLocation TeamsLocation) (TeamsLocation, error)

CreateTeamsLocation creates a new teams location.

API reference: https://api.cloudflare.com/#teams-locations-create-teams-location

func (*API) CreateUserAccessRule ¶

func (api *API) CreateUserAccessRule(ctx context.Context, accessRule AccessRule) (*AccessRuleResponse, error)

CreateUserAccessRule creates a firewall access rule for the logged-in user.

API reference: https://api.cloudflare.com/#user-level-firewall-access-rule-create-access-rule

func (*API) CreateUserAgentRule ¶

func (api *API) CreateUserAgentRule(ctx context.Context, zoneID string, ld UserAgentRule) (*UserAgentRuleResponse, error)

CreateUserAgentRule creates a User-Agent Block rule for the given zone ID.

API reference: https://api.cloudflare.com/#user-agent-blocking-rules-create-a-useragent-rule

func (*API) CreateVirtualDNS ¶

func (api *API) CreateVirtualDNS(ctx context.Context, v *VirtualDNS) (*VirtualDNS, error)

CreateVirtualDNS creates a new Virtual DNS cluster.

API reference: https://api.cloudflare.com/#virtual-dns-users--create-a-virtual-dns-cluster

func (*API) CreateWAFOverride ¶

func (api *API) CreateWAFOverride(ctx context.Context, zoneID string, override WAFOverride) (WAFOverride, error)

CreateWAFOverride creates a new WAF override.

API reference: https://api.cloudflare.com/#waf-overrides-create-a-uri-controlled-waf-configuration

func (*API) CreateWaitingRoom ¶

func (api *API) CreateWaitingRoom(ctx context.Context, zoneID string, waitingRoom WaitingRoom) (*WaitingRoom, error)

CreateWaitingRoom creates a new Waiting Room for a zone.

API reference: https://api.cloudflare.com/#waiting-room-create-waiting-room

func (*API) CreateWorkerRoute ¶

func (api *API) CreateWorkerRoute(ctx context.Context, zoneID string, route WorkerRoute) (WorkerRouteResponse, error)

CreateWorkerRoute creates worker route for a zone

API reference: https://api.cloudflare.com/#worker-filters-create-filter, https://api.cloudflare.com/#worker-routes-create-route

api, err := cloudflare.New(apiKey, user)
if err != nil {
	log.Fatal(err)
}

zoneID, err := api.ZoneIDByName(domain)
if err != nil {
	log.Fatal(err)
}
route := cloudflare.WorkerRoute{Pattern: "app1.example.com/*", Enabled: true}
res, err := api.CreateWorkerRoute(context.Background(), zoneID, route)
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v", res)

func (*API) CreateWorkersKVNamespace ¶

func (api *API) CreateWorkersKVNamespace(ctx context.Context, req *WorkersKVNamespaceRequest) (WorkersKVNamespaceResponse, error)

CreateWorkersKVNamespace creates a namespace under the given title. A 400 is returned if the account already owns a namespace with this title. A namespace must be explicitly deleted to be replaced.

API reference: https://api.cloudflare.com/#workers-kv-namespace-create-a-namespace

api, err := cloudflare.New(apiKey, user, cloudflare.UsingAccount(accountID))
if err != nil {
	log.Fatal(err)
}

req := &cloudflare.WorkersKVNamespaceRequest{Title: "test_namespace2"}
response, err := api.CreateWorkersKVNamespace(context.Background(), req)
if err != nil {
	log.Fatal(err)
}

fmt.Println(response)

func (*API) CreateZone ¶

func (api *API) CreateZone(ctx context.Context, name string, jumpstart bool, account Account, zoneType string) (Zone, error)

CreateZone creates a zone on an account.

Setting jumpstart to true will attempt to automatically scan for existing DNS records. Setting this to false will create the zone with no DNS records.

If account is non-empty, it must have at least the ID field populated. This will add the new zone to the specified multi-user account.

API reference: https://api.cloudflare.com/#zone-create-a-zone

func (*API) CreateZoneAccessMutualTLSCertificate ¶

func (api *API) CreateZoneAccessMutualTLSCertificate(ctx context.Context, zoneID string, certificate AccessMutualTLSCertificate) (AccessMutualTLSCertificate, error)

CreateZoneAccessMutualTLSCertificate creates a zone level Access TLS Mutual certificate.

API reference: https://api.cloudflare.com/#zone-level-access-mutual-tls-authentication-create-access-certificate

func (*API) CreateZoneAccessRule ¶

func (api *API) CreateZoneAccessRule(ctx context.Context, zoneID string, accessRule AccessRule) (*AccessRuleResponse, error)

CreateZoneAccessRule creates a firewall access rule for the given zone identifier.

API reference: https://api.cloudflare.com/#firewall-access-rule-for-a-zone-create-access-rule

func (*API) CreateZoneLevelAccessApplication ¶

func (api *API) CreateZoneLevelAccessApplication(ctx context.Context, zoneID string, accessApplication AccessApplication) (AccessApplication, error)

CreateZoneLevelAccessApplication creates a new zone level access application.

API reference: https://api.cloudflare.com/#zone-level-access-applications-create-access-application

func (*API) CreateZoneLevelAccessCACertificate ¶

func (api *API) CreateZoneLevelAccessCACertificate(ctx context.Context, zoneID string, applicationID string) (AccessCACertificate, error)

CreateZoneLevelAccessCACertificate creates a new zone level CA certificate for an Access Application.

API reference: https://api.cloudflare.com/#zone-level-access-short-lived-certificates-create-short-lived-certificate

func (*API) CreateZoneLevelAccessGroup ¶

func (api *API) CreateZoneLevelAccessGroup(ctx context.Context, zoneID string, accessGroup AccessGroup) (AccessGroup, error)

CreateZoneLevelAccessGroup creates a new zone level access group.

API reference: https://api.cloudflare.com/#zone-level-access-groups-create-access-group

func (*API) CreateZoneLevelAccessIdentityProvider ¶

func (api *API) CreateZoneLevelAccessIdentityProvider(ctx context.Context, zoneID string, identityProviderConfiguration AccessIdentityProvider) (AccessIdentityProvider, error)

CreateZoneLevelAccessIdentityProvider creates a new zone level Access Identity Provider.

API reference: https://api.cloudflare.com/#zone-level-access-identity-providers-create-access-identity-provider

func (*API) CreateZoneLevelAccessOrganization ¶

func (api *API) CreateZoneLevelAccessOrganization(ctx context.Context, zoneID string, accessOrganization AccessOrganization) (AccessOrganization, error)

CreateZoneLevelAccessOrganization creates the zone level Access organisation details.

API reference: https://api.cloudflare.com/#zone-level-access-organizations-create-access-organization

func (*API) CreateZoneLevelAccessPolicy ¶

func (api *API) CreateZoneLevelAccessPolicy(ctx context.Context, zoneID, applicationID string, accessPolicy AccessPolicy) (AccessPolicy, error)

CreateZoneLevelAccessPolicy creates a new zone level access policy.

API reference: https://api.cloudflare.com/#zone-level-access-policy-create-access-policy

func (*API) CreateZoneLevelAccessServiceToken ¶

func (api *API) CreateZoneLevelAccessServiceToken(ctx context.Context, zoneID, name string) (AccessServiceTokenCreateResponse, error)

CreateZoneLevelAccessServiceToken creates a new Access Service Token for a zone.

API reference: https://api.cloudflare.com/#zone-level-access-service-tokens-create-access-service-token

func (*API) CreateZoneLockdown ¶

func (api *API) CreateZoneLockdown(ctx context.Context, zoneID string, ld ZoneLockdown) (*ZoneLockdownResponse, error)

CreateZoneLockdown creates a Zone ZoneLockdown rule for the given zone ID.

API reference: https://api.cloudflare.com/#zone-ZoneLockdown-create-a-ZoneLockdown-rule

package main

import (
	"context"
	"fmt"
	"log"

	cloudflare "github.com/grafana/cloudflare-go"
)

func main() {
	api, err := cloudflare.New("deadbeef", "test@example.org")
	if err != nil {
		log.Fatal(err)
	}

	zoneID, err := api.ZoneIDByName("example.org")
	if err != nil {
		log.Fatal(err)
	}

	newZoneLockdown := cloudflare.ZoneLockdown{
		Description: "Test Zone Lockdown Rule",
		URLs: []string{
			"*.example.org/test",
		},
		Configurations: []cloudflare.ZoneLockdownConfig{
			{
				Target: "ip",
				Value:  "127.0.0.1",
			},
		},
		Paused:   false,
		Priority: 1,
	}

	response, err := api.CreateZoneLockdown(context.Background(), zoneID, newZoneLockdown)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println("Response: ", response)
}

Output:

func (*API) CreateZoneLogpushJob ¶

func (api *API) CreateZoneLogpushJob(ctx context.Context, zoneID string, job LogpushJob) (*LogpushJob, error)

CreateZoneLogpushJob creates a new zone-level Logpush Job.

API reference: https://api.cloudflare.com/#logpush-jobs-create-logpush-job

api, err := cloudflare.New(apiKey, user)
if err != nil {
	log.Fatal(err)
}

zoneID, err := api.ZoneIDByName(domain)
if err != nil {
	log.Fatal(err)
}

job, err := api.CreateZoneLogpushJob(context.Background(), zoneID, exampleNewLogpushJob)
if err != nil {
	log.Fatal(err)
}

fmt.Printf("%+v\n", job)

func (*API) CreateZoneRuleset ¶

func (api *API) CreateZoneRuleset(ctx context.Context, zoneID string, ruleset Ruleset) (Ruleset, error)

CreateZoneRuleset creates a new ruleset for a zone.

API reference: https://api.cloudflare.com/#zone-rulesets-create-zone-ruleset

func (*API) CustomHostname ¶

func (api *API) CustomHostname(ctx context.Context, zoneID string, customHostnameID string) (CustomHostname, error)

CustomHostname inspects the given custom hostname in the given zone.

API reference: https://api.cloudflare.com/#custom-hostname-for-a-zone-custom-hostname-configuration-details

func (*API) CustomHostnameFallbackOrigin ¶

func (api *API) CustomHostnameFallbackOrigin(ctx context.Context, zoneID string) (CustomHostnameFallbackOrigin, error)

CustomHostnameFallbackOrigin inspects the Custom Hostname Fallback origin in the given zone.

API reference: https://api.cloudflare.com/#custom-hostname-fallback-origin-for-a-zone-properties

func (*API) CustomHostnameIDByName ¶

func (api *API) CustomHostnameIDByName(ctx context.Context, zoneID string, hostname string) (string, error)

CustomHostnameIDByName retrieves the ID for the given hostname in the given zone.

func (*API) CustomHostnames ¶

func (api *API) CustomHostnames(ctx context.Context, zoneID string, page int, filter CustomHostname) ([]CustomHostname, ResultInfo, error)

CustomHostnames fetches custom hostnames for the given zone, by applying filter.Hostname if not empty and scoping the result to page'th 50 items.

The returned ResultInfo can be used to implement pagination.

API reference: https://api.cloudflare.com/#custom-hostname-for-a-zone-list-custom-hostnames

func (*API) CustomPage ¶

func (api *API) CustomPage(ctx context.Context, options *CustomPageOptions, customPageID string) (CustomPage, error)

CustomPage lists a single custom page based on the ID.

Zone API reference: https://api.cloudflare.com/#custom-pages-for-a-zone-custom-page-details Account API reference: https://api.cloudflare.com/#custom-pages-account--custom-page-details

func (*API) CustomPages ¶

func (api *API) CustomPages(ctx context.Context, options *CustomPageOptions) ([]CustomPage, error)

CustomPages lists custom pages for a zone or account.

Zone API reference: https://api.cloudflare.com/#custom-pages-for-a-zone-list-available-custom-pages Account API reference: https://api.cloudflare.com/#custom-pages-account--list-custom-pages

func (*API) DNSRecord ¶

func (api *API) DNSRecord(ctx context.Context, zoneID, recordID string) (DNSRecord, error)

DNSRecord returns a single DNS record for the given zone & record identifiers.

API reference: https://api.cloudflare.com/#dns-records-for-a-zone-dns-record-details

func (*API) DNSRecords ¶

func (api *API) DNSRecords(ctx context.Context, zoneID string, rr DNSRecord) ([]DNSRecord, error)

DNSRecords returns a slice of DNS records for the given zone identifier.

This takes a DNSRecord to allow filtering of the results returned.

API reference: https://api.cloudflare.com/#dns-records-for-a-zone-list-dns-records

package main

import (
	"context"
	"fmt"
	"log"

	cloudflare "github.com/grafana/cloudflare-go"
)

func main() {
	api, err := cloudflare.New("deadbeef", "test@example.org")
	if err != nil {
		log.Fatal(err)
	}

	zoneID, err := api.ZoneIDByName("example.com")
	if err != nil {
		log.Fatal(err)
	}

	// Fetch all records for a zone
	recs, err := api.DNSRecords(context.Background(), zoneID, cloudflare.DNSRecord{})
	if err != nil {
		log.Fatal(err)
	}

	for _, r := range recs {
		fmt.Printf("%s: %s\n", r.Name, r.Content)
	}
}

Output:

package main

import (
	"context"
	"fmt"
	"log"

	cloudflare "github.com/grafana/cloudflare-go"
)

func main() {
	api, err := cloudflare.New("deadbeef", "test@example.org")
	if err != nil {
		log.Fatal(err)
	}

	zoneID, err := api.ZoneIDByName("example.com")
	if err != nil {
		log.Fatal(err)
	}

	// Fetch only records whose content is 127.0.0.1
	localhost := cloudflare.DNSRecord{Content: "127.0.0.1"}
	recs, err := api.DNSRecords(context.Background(), zoneID, localhost)
	if err != nil {
		log.Fatal(err)
	}

	for _, r := range recs {
		fmt.Printf("%s: %s\n", r.Name, r.Content)
	}
}

Output:

package main

import (
	"context"
	"fmt"
	"log"

	cloudflare "github.com/grafana/cloudflare-go"
)

func main() {
	api, err := cloudflare.New("deadbeef", "test@example.org")
	if err != nil {
		log.Fatal(err)
	}

	zoneID, err := api.ZoneIDByName("example.com")
	if err != nil {
		log.Fatal(err)
	}

	// Fetch records of any type with name "foo.example.com"
	// The name must be fully-qualified
	foo := cloudflare.DNSRecord{Name: "foo.example.com"}
	recs, err := api.DNSRecords(context.Background(), zoneID, foo)
	if err != nil {
		log.Fatal(err)
	}

	for _, r := range recs {
		fmt.Printf("%s: %s\n", r.Name, r.Content)
	}
}

Output:

package main

import (
	"context"
	"fmt"
	"log"

	cloudflare "github.com/grafana/cloudflare-go"
)

func main() {
	api, err := cloudflare.New("deadbeef", "test@example.org")
	if err != nil {
		log.Fatal(err)
	}

	zoneID, err := api.ZoneIDByName("example.com")
	if err != nil {
		log.Fatal(err)
	}

	// Fetch only AAAA type records
	aaaa := cloudflare.DNSRecord{Type: "AAAA"}
	recs, err := api.DNSRecords(context.Background(), zoneID, aaaa)
	if err != nil {
		log.Fatal(err)
	}

	for _, r := range recs {
		fmt.Printf("%s: %s\n", r.Name, r.Content)
	}
}

Output:

func (*API) DeleteAPIToken ¶

func (api *API) DeleteAPIToken(ctx context.Context, tokenID string) error

DeleteAPIToken deletes a single API token.

API reference: https://api.cloudflare.com/#user-api-tokens-delete-token

func (*API) DeleteAccessApplication ¶

func (api *API) DeleteAccessApplication(ctx context.Context, accountID, applicationID string) error

DeleteAccessApplication deletes an access application.

API reference: https://api.cloudflare.com/#access-applications-delete-access-application

func (*API) DeleteAccessCACertificate ¶

func (api *API) DeleteAccessCACertificate(ctx context.Context, accountID, applicationID string) error

DeleteAccessCACertificate deletes an Access CA certificate on a defined Access Application.

API reference: https://api.cloudflare.com/#access-short-lived-certificates-delete-access-certificate

func (*API) DeleteAccessGroup ¶

func (api *API) DeleteAccessGroup(ctx context.Context, accountID, groupID string) error

DeleteAccessGroup deletes an access group.

API reference: https://api.cloudflare.com/#access-groups-delete-access-group

func (*API) DeleteAccessIdentityProvider ¶

func (api *API) DeleteAccessIdentityProvider(ctx context.Context, accountID, identityProviderUUID string) (AccessIdentityProvider, error)

DeleteAccessIdentityProvider deletes an Access Identity Provider.

API reference: https://api.cloudflare.com/#access-identity-providers-create-access-identity-provider

func (*API) DeleteAccessMutualTLSCertificate ¶

func (api *API) DeleteAccessMutualTLSCertificate(ctx context.Context, accountID, certificateID string) error

DeleteAccessMutualTLSCertificate destroys an account level Access Mutual TLS certificate.

API reference: https://api.cloudflare.com/#access-mutual-tls-authentication-update-access-certificate

func (*API) DeleteAccessPolicy ¶

func (api *API) DeleteAccessPolicy(ctx context.Context, accountID, applicationID, accessPolicyID string) error

DeleteAccessPolicy deletes an access policy.

API reference: https://api.cloudflare.com/#access-policy-update-access-policy

func (*API) DeleteAccessServiceToken ¶

func (api *API) DeleteAccessServiceToken(ctx context.Context, accountID, uuid string) (AccessServiceTokenUpdateResponse, error)

DeleteAccessServiceToken removes an existing Access Service Token for an account.

API reference: https://api.cloudflare.com/#access-service-tokens-delete-access-service-token

func (*API) DeleteAccount ¶

func (api *API) DeleteAccount(ctx context.Context, accountID string) error

DeleteAccount removes an account. Note: This requires the Tenant entitlement.

API reference: https://developers.cloudflare.com/tenant/tutorial/provisioning-resources#optional-deleting-accounts

func (*API) DeleteAccountAccessRule ¶

func (api *API) DeleteAccountAccessRule(ctx context.Context, accountID, accessRuleID string) (*AccessRuleResponse, error)

DeleteAccountAccessRule deletes a single access rule for the given account and access rule identifiers.

API reference: https://api.cloudflare.com/#account-level-firewall-access-rule-delete-access-rule

func (*API) DeleteAccountLogpushJob ¶

func (api *API) DeleteAccountLogpushJob(ctx context.Context, accountID string, jobID int) error

DeleteAccountLogpushJob deletes an account-level Logpush Job.

API reference: https://api.cloudflare.com/#logpush-jobs-delete-logpush-job

func (*API) DeleteAccountMember ¶

func (api *API) DeleteAccountMember(ctx context.Context, accountID string, userID string) error

DeleteAccountMember removes a member from an account.

API reference: https://api.cloudflare.com/#account-members-remove-member

func (*API) DeleteAccountRuleset ¶

func (api *API) DeleteAccountRuleset(ctx context.Context, accountID, rulesetID string) error

DeleteAccountRuleset deletes a single ruleset for an account.

API reference: https://api.cloudflare.com/#account-rulesets-delete-account-ruleset

func (*API) DeleteArgoTunnel ¶

func (api *API) DeleteArgoTunnel(ctx context.Context, accountID, tunnelUUID string) error

DeleteArgoTunnel removes a single Argo tunnel.

API reference: https://api.cloudflare.com/#argo-tunnel-delete-argo-tunnel

func (*API) DeleteCertificatePack ¶

func (api *API) DeleteCertificatePack(ctx context.Context, zoneID, certificateID string) error

DeleteCertificatePack removes a certificate pack associated with a zone.

API Reference: https://api.cloudflare.com/#certificate-packs-delete-advanced-certificate-manager-certificate-pack

func (*API) DeleteCustomHostname ¶

func (api *API) DeleteCustomHostname(ctx context.Context, zoneID string, customHostnameID string) error

DeleteCustomHostname deletes a custom hostname (and any issued SSL certificates).

API reference: https://api.cloudflare.com/#custom-hostname-for-a-zone-delete-a-custom-hostname-and-any-issued-ssl-certificates-

func (*API) DeleteCustomHostnameFallbackOrigin ¶

func (api *API) DeleteCustomHostnameFallbackOrigin(ctx context.Context, zoneID string) error

DeleteCustomHostnameFallbackOrigin deletes the Custom Hostname Fallback origin in the given zone.

API reference: https://api.cloudflare.com/#custom-hostname-fallback-origin-for-a-zone-delete-fallback-origin-for-custom-hostnames

func (*API) DeleteDNSRecord ¶

func (api *API) DeleteDNSRecord(ctx context.Context, zoneID, recordID string) error

DeleteDNSRecord deletes a single DNS record for the given zone & record identifiers.

API reference: https://api.cloudflare.com/#dns-records-for-a-zone-delete-dns-record

func (*API) DeleteDevicePostureIntegration ¶

func (api *API) DeleteDevicePostureIntegration(ctx context.Context, accountID, ruleID string) error

DeleteDevicePostureIntegration deletes a device posture integration.

API reference: https://api.cloudflare.com/#device-posture-integrations-delete-device-posture-integration

func (*API) DeleteDevicePostureRule ¶

func (api *API) DeleteDevicePostureRule(ctx context.Context, accountID, ruleID string) error

DeleteDevicePostureRule deletes a device posture rule.

API reference: https://api.cloudflare.com/#device-posture-rules-delete-device-posture-rule

func (*API) DeleteFilter ¶

func (api *API) DeleteFilter(ctx context.Context, zoneID, filterID string) error

DeleteFilter deletes a single filter.

API reference: https://developers.cloudflare.com/firewall/api/cf-filters/delete/#delete-a-single-filter

func (*API) DeleteFilters ¶

func (api *API) DeleteFilters(ctx context.Context, zoneID string, filterIDs []string) error

DeleteFilters deletes multiple filters.

API reference: https://developers.cloudflare.com/firewall/api/cf-filters/delete/#delete-multiple-filters

func (*API) DeleteFirewallRule ¶

func (api *API) DeleteFirewallRule(ctx context.Context, zoneID, firewallRuleID string) error

DeleteFirewallRule deletes a single firewall rule.

API reference: https://developers.cloudflare.com/firewall/api/cf-firewall-rules/delete/#delete-a-single-rule

func (*API) DeleteFirewallRules ¶

func (api *API) DeleteFirewallRules(ctx context.Context, zoneID string, firewallRuleIDs []string) error

DeleteFirewallRules deletes multiple firewall rules at once.

API reference: https://developers.cloudflare.com/firewall/api/cf-firewall-rules/delete/#delete-multiple-rules

func (*API) DeleteHealthcheck ¶

func (api *API) DeleteHealthcheck(ctx context.Context, zoneID string, healthcheckID string) error

DeleteHealthcheck deletes a healthcheck in a zone.

API reference: https://api.cloudflare.com/#health-checks-delete-health-check

func (*API) DeleteHealthcheckPreview ¶

func (api *API) DeleteHealthcheckPreview(ctx context.Context, zoneID string, id string) error

DeleteHealthcheckPreview deletes a healthcheck preview in a zone if it exists.

API reference: https://api.cloudflare.com/#health-checks-delete-preview-health-check

func (*API) DeleteIPList ¶

func (api *API) DeleteIPList(ctx context.Context, id string) (IPListDeleteResponse, error)

DeleteIPList deletes an IP List

API reference: https://api.cloudflare.com/#rules-lists-delete-list

func (*API) DeleteIPListItems ¶

func (api *API) DeleteIPListItems(ctx context.Context, id string, items IPListItemDeleteRequest) (
	[]IPListItem, error)

DeleteIPListItems removes specific Items of an IP List by their ID synchronously and returns the current set of IP List Items

func (*API) DeleteIPListItemsAsync ¶

func (api *API) DeleteIPListItemsAsync(ctx context.Context, id string, items IPListItemDeleteRequest) (
	IPListItemDeleteResponse, error)

DeleteIPListItemsAsync removes specific Items of an IP List by their ID asynchronously. Users have to poll the operation status by using the operation_id returned by this function.

API reference: https://api.cloudflare.com/#rules-lists-delete-list-items

func (*API) DeleteKeylessSSL ¶

func (api *API) DeleteKeylessSSL(ctx context.Context, zoneID, keylessSSLID string) error

DeleteKeylessSSL deletes an existing Keyless SSL configuration.

API reference: https://api.cloudflare.com/#keyless-ssl-for-a-zone-delete-keyless-ssl-configuration

func (*API) DeleteLoadBalancer ¶

func (api *API) DeleteLoadBalancer(ctx context.Context, zoneID, lbID string) error

DeleteLoadBalancer disables and deletes a load balancer.

API reference: https://api.cloudflare.com/#load-balancers-delete-load-balancer

func (*API) DeleteLoadBalancerMonitor ¶

func (api *API) DeleteLoadBalancerMonitor(ctx context.Context, monitorID string) error

DeleteLoadBalancerMonitor disables and deletes a load balancer monitor.

API reference: https://api.cloudflare.com/#load-balancer-monitors-delete-monitor

func (*API) DeleteLoadBalancerPool ¶

func (api *API) DeleteLoadBalancerPool(ctx context.Context, poolID string) error

DeleteLoadBalancerPool disables and deletes a load balancer pool.

API reference: https://api.cloudflare.com/#load-balancer-pools-delete-pool

func (*API) DeleteMagicFirewallRuleset ¶

func (api *API) DeleteMagicFirewallRuleset(ctx context.Context, id string) error

DeleteMagicFirewallRuleset deletes a Magic Firewall ruleset

API reference: https://api.cloudflare.com/#rulesets-delete-ruleset

func (*API) DeleteMagicTransitStaticRoute ¶

func (api *API) DeleteMagicTransitStaticRoute(ctx context.Context, id string) (MagicTransitStaticRoute, error)

DeleteMagicTransitStaticRoute deletes a static route

API reference: https://api.cloudflare.com/#magic-transit-static-routes-delete-route

func (*API) DeleteNotificationPolicy ¶

func (api *API) DeleteNotificationPolicy(ctx context.Context, accountID, policyID string) (SaveResponse, error)

DeleteNotificationPolicy deletes a notification policy for an account.

API Reference: https://api.cloudflare.com/#notification-policies-delete-notification-policy

func (*API) DeleteNotificationWebhooks ¶

func (api *API) DeleteNotificationWebhooks(ctx context.Context, accountID, webhookID string) (SaveResponse, error)

DeleteNotificationWebhooks will delete a webhook, given the account and webhooks ids. Deleting the webhooks will remove it from any connected notification policies.

API Reference: https://api.cloudflare.com/#notification-webhooks-delete-webhook

func (*API) DeletePageRule ¶

func (api *API) DeletePageRule(ctx context.Context, zoneID, ruleID string) error

DeletePageRule deletes a Page Rule for a zone.

API reference: https://api.cloudflare.com/#page-rules-for-a-zone-delete-a-page-rule

api, err := cloudflare.New(apiKey, user)
if err != nil {
	log.Fatal(err)
}

zoneID, err := api.ZoneIDByName(domain)
if err != nil {
	log.Fatal(err)
}

err = api.DeletePageRule(context.Background(), zoneID, "my_page_rule_id")
if err != nil {
	log.Fatal(err)
}

func (*API) DeletePagesProject ¶

func (api *API) DeletePagesProject(ctx context.Context, accountID, projectName string) error

DeletePagesProject deletes a Pages project by name.

API reference: https://api.cloudflare.com/#pages-project-delete-project

func (*API) DeletePerHostnameAuthenticatedOriginPullsCertificate ¶

func (api *API) DeletePerHostnameAuthenticatedOriginPullsCertificate(ctx context.Context, zoneID, certificateID string) (PerHostnameAuthenticatedOriginPullsCertificateDetails, error)

DeletePerHostnameAuthenticatedOriginPullsCertificate will remove the requested Per Hostname certificate from the edge.

API reference: https://api.cloudflare.com/#per-hostname-authenticated-origin-pull-delete-hostname-client-certificate

func (*API) DeletePerZoneAuthenticatedOriginPullsCertificate ¶

func (api *API) DeletePerZoneAuthenticatedOriginPullsCertificate(ctx context.Context, zoneID, certificateID string) (PerZoneAuthenticatedOriginPullsCertificateDetails, error)

DeletePerZoneAuthenticatedOriginPullsCertificate removes the specified client certificate from the edge.

API reference: https://api.cloudflare.com/#zone-level-authenticated-origin-pulls-delete-certificate

func (*API) DeleteRailgun ¶

func (api *API) DeleteRailgun(ctx context.Context, railgunID string) error

DeleteRailgun disables and deletes a Railgun.

API reference: https://api.cloudflare.com/#railgun-delete-railgun

func (*API) DeleteRateLimit ¶

func (api *API) DeleteRateLimit(ctx context.Context, zoneID, limitID string) error

DeleteRateLimit deletes a Rate Limit for a zone.

API reference: https://api.cloudflare.com/#rate-limits-for-a-zone-delete-rate-limit

api, err := cloudflare.New(apiKey, user)
if err != nil {
	log.Fatal(err)
}

zoneID, err := api.ZoneIDByName(domain)
if err != nil {
	log.Fatal(err)
}

err = api.DeleteRateLimit(context.Background(), zoneID, "my_rate_limit_id")
if err != nil {
	log.Fatal(err)
}

func (*API) DeleteSSL ¶

func (api *API) DeleteSSL(ctx context.Context, zoneID, certificateID string) error

DeleteSSL deletes a custom SSL certificate from the given zone.

API reference: https://api.cloudflare.com/#custom-ssl-for-a-zone-delete-an-ssl-certificate

func (*API) DeleteSecondaryDNSPrimary ¶

func (api *API) DeleteSecondaryDNSPrimary(ctx context.Context, accountID, primaryID string) error

DeleteSecondaryDNSPrimary deletes a secondary DNS primary.

API reference: https://api.cloudflare.com/#secondary-dns-primary--delete-primary

func (*API) DeleteSecondaryDNSTSIG ¶

func (api *API) DeleteSecondaryDNSTSIG(ctx context.Context, accountID, tsigID string) error

DeleteSecondaryDNSTSIG deletes a secondary DNS TSIG.

API reference: https://api.cloudflare.com/#secondary-dns-tsig--delete-tsig

func (*API) DeleteSecondaryDNSZone ¶

func (api *API) DeleteSecondaryDNSZone(ctx context.Context, zoneID string) error

DeleteSecondaryDNSZone deletes a secondary DNS zone.

API reference: https://api.cloudflare.com/#secondary-dns-delete-secondary-zone-configuration

func (*API) DeleteSpectrumApplication ¶

func (api *API) DeleteSpectrumApplication(ctx context.Context, zoneID string, applicationID string) error

DeleteSpectrumApplication removes a Spectrum application based on the ID.

API reference: https://developers.cloudflare.com/spectrum/api-reference/#delete-a-spectrum-application

func (*API) DeleteTeamsList ¶

func (api *API) DeleteTeamsList(ctx context.Context, accountID, teamsListID string) error

DeleteTeamsList deletes a teams list.

API reference: https://api.cloudflare.com/#teams-lists-delete-teams-list

func (*API) DeleteTeamsLocation ¶

func (api *API) DeleteTeamsLocation(ctx context.Context, accountID, teamsLocationID string) error

DeleteTeamsLocation deletes a teams location.

API reference: https://api.cloudflare.com/#teams-locations-delete-teams-location

func (*API) DeleteUserAccessRule ¶

func (api *API) DeleteUserAccessRule(ctx context.Context, accessRuleID string) (*AccessRuleResponse, error)

DeleteUserAccessRule deletes a single access rule for the logged-in user and access rule identifiers.

API reference: https://api.cloudflare.com/#user-level-firewall-access-rule-update-access-rule

func (*API) DeleteUserAgentRule ¶

func (api *API) DeleteUserAgentRule(ctx context.Context, zoneID string, id string) (*UserAgentRuleResponse, error)

DeleteUserAgentRule deletes a User-Agent Block rule (based on the ID) for the given zone ID.

API reference: https://api.cloudflare.com/#user-agent-blocking-rules-delete-useragent-rule

func (*API) DeleteVirtualDNS ¶

func (api *API) DeleteVirtualDNS(ctx context.Context, virtualDNSID string) error

DeleteVirtualDNS deletes a Virtual DNS cluster. Note that this cannot be undone, and will stop all traffic to that cluster.

API reference: https://api.cloudflare.com/#virtual-dns-users--delete-a-virtual-dns-cluster

func (*API) DeleteWAFOverride ¶

func (api *API) DeleteWAFOverride(ctx context.Context, zoneID, overrideID string) error

DeleteWAFOverride deletes a WAF override for a zone.

API reference: https://api.cloudflare.com/#waf-overrides-delete-lockdown-rule

func (*API) DeleteWaitingRoom ¶

func (api *API) DeleteWaitingRoom(ctx context.Context, zoneID, waitingRoomID string) error

DeleteWaitingRoom deletes a Waiting Room for a zone.

API reference: https://api.cloudflare.com/#waiting-room-delete-waiting-room

func (*API) DeleteWorker ¶

func (api *API) DeleteWorker(ctx context.Context, requestParams *WorkerRequestParams) (WorkerScriptResponse, error)

DeleteWorker deletes worker for a zone.

API reference: https://api.cloudflare.com/#worker-script-delete-worker

api, err := cloudflare.New(apiKey, user)
if err != nil {
	log.Fatal(err)
}

zoneID, err := api.ZoneIDByName(domain)
if err != nil {
	log.Fatal(err)
}
res, err := api.DeleteWorker(context.Background(), &cloudflare.WorkerRequestParams{ZoneID: zoneID})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v", res)

DeleteWorkerWithName()

func (*API) DeleteWorkerRoute ¶

func (api *API) DeleteWorkerRoute(ctx context.Context, zoneID string, routeID string) (WorkerRouteResponse, error)

DeleteWorkerRoute deletes worker route for a zone

API reference: https://api.cloudflare.com/#worker-routes-delete-route

api, err := cloudflare.New(apiKey, user)
if err != nil {
	log.Fatal(err)
}

zoneID, err := api.ZoneIDByName(domain)
if err != nil {
	log.Fatal(err)
}
// pull from existing list of routes to perform delete on
routesResponse, err := api.ListWorkerRoutes(context.Background(), zoneID)
if err != nil {
	log.Fatal(err)
}
// delete first route retrieved from the listWorkerRoutes call
res, err := api.DeleteWorkerRoute(context.Background(), zoneID, routesResponse.Routes[0].ID)
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v", res)

func (API) DeleteWorkersKV ¶

func (api API) DeleteWorkersKV(ctx context.Context, namespaceID, key string) (Response, error)

DeleteWorkersKV deletes a key and value for a provided storage namespace

API reference: https://api.cloudflare.com/#workers-kv-namespace-delete-key-value-pair

api, err := cloudflare.New(apiKey, user, cloudflare.UsingAccount(accountID))
if err != nil {
	log.Fatal(err)
}

key := "test_key"
resp, err := api.DeleteWorkersKV(context.Background(), namespace, key)
if err != nil {
	log.Fatal(err)
}

fmt.Printf("%+v\n", resp)

func (*API) DeleteWorkersKVBulk ¶

func (api *API) DeleteWorkersKVBulk(ctx context.Context, namespaceID string, keys []string) (Response, error)

DeleteWorkersKVBulk deletes multiple KVs at once.

API reference: https://api.cloudflare.com/#workers-kv-namespace-delete-multiple-key-value-pairs

api, err := cloudflare.New(apiKey, user, cloudflare.UsingAccount(accountID))
if err != nil {
	log.Fatal(err)
}

keys := []string{"key1", "key2", "key3"}

resp, err := api.DeleteWorkersKVBulk(context.Background(), namespace, keys)
if err != nil {
	log.Fatal(err)
}

fmt.Println(resp)

func (*API) DeleteWorkersKVNamespace ¶

func (api *API) DeleteWorkersKVNamespace(ctx context.Context, namespaceID string) (Response, error)

DeleteWorkersKVNamespace deletes the namespace corresponding to the given ID

API reference: https://api.cloudflare.com/#workers-kv-namespace-remove-a-namespace

api, err := cloudflare.New(apiKey, user, cloudflare.UsingAccount(accountID))
if err != nil {
	log.Fatal(err)
}

response, err := api.DeleteWorkersKVNamespace(context.Background(), namespace)
if err != nil {
	log.Fatal(err)
}

fmt.Println(response)

func (*API) DeleteWorkersSecret ¶

func (api *API) DeleteWorkersSecret(ctx context.Context, script, secretName string) (Response, error)

DeleteWorkersSecret deletes a secret API reference: https://api.cloudflare.com/

func (*API) DeleteZone ¶

func (api *API) DeleteZone(ctx context.Context, zoneID string) (ZoneID, error)

DeleteZone deletes the given zone.

API reference: https://api.cloudflare.com/#zone-delete-a-zone

func (*API) DeleteZoneAccessMutualTLSCertificate ¶

func (api *API) DeleteZoneAccessMutualTLSCertificate(ctx context.Context, zoneID, certificateID string) error

DeleteZoneAccessMutualTLSCertificate destroys a zone level Access Mutual TLS certificate.

API reference: https://api.cloudflare.com/#zone-level-access-mutual-tls-authentication-update-access-certificate

func (*API) DeleteZoneAccessRule ¶

func (api *API) DeleteZoneAccessRule(ctx context.Context, zoneID, accessRuleID string) (*AccessRuleResponse, error)

DeleteZoneAccessRule deletes a single access rule for the given zone and access rule identifiers.

API reference: https://api.cloudflare.com/#firewall-access-rule-for-a-zone-delete-access-rule

func (*API) DeleteZoneDNSSEC ¶

func (api *API) DeleteZoneDNSSEC(ctx context.Context, zoneID string) (string, error)

DeleteZoneDNSSEC deletes DNSSEC for zone

API reference: https://api.cloudflare.com/#dnssec-delete-dnssec-records

func (*API) DeleteZoneLevelAccessApplication ¶

func (api *API) DeleteZoneLevelAccessApplication(ctx context.Context, zoneID, applicationID string) error

DeleteZoneLevelAccessApplication deletes a zone level access application.

API reference: https://api.cloudflare.com/#zone-level-access-applications-delete-access-application

func (*API) DeleteZoneLevelAccessCACertificate ¶

func (api *API) DeleteZoneLevelAccessCACertificate(ctx context.Context, zoneID, applicationID string) error

DeleteZoneLevelAccessCACertificate deletes a zone level Access CA certificate on a defined Access Application.

API reference: https://api.cloudflare.com/#zone-level-access-short-lived-certificates-delete-access-certificate

func (*API) DeleteZoneLevelAccessGroup ¶

func (api *API) DeleteZoneLevelAccessGroup(ctx context.Context, zoneID, groupID string) error

DeleteZoneLevelAccessGroup deletes a zone level access group.

API reference: https://api.cloudflare.com/#zone-level-access-groups-delete-access-group

func (*API) DeleteZoneLevelAccessIdentityProvider ¶

func (api *API) DeleteZoneLevelAccessIdentityProvider(ctx context.Context, zoneID, identityProviderUUID string) (AccessIdentityProvider, error)

DeleteZoneLevelAccessIdentityProvider deletes a zone level Access Identity Provider.

API reference: https://api.cloudflare.com/#zone-level-access-identity-providers-delete-access-identity-provider

func (*API) DeleteZoneLevelAccessPolicy ¶

func (api *API) DeleteZoneLevelAccessPolicy(ctx context.Context, zoneID, applicationID, accessPolicyID string) error

DeleteZoneLevelAccessPolicy deletes a zone level access policy.

API reference: https://api.cloudflare.com/#zone-level-access-policy-delete-access-policy

func (*API) DeleteZoneLevelAccessServiceToken ¶

func (api *API) DeleteZoneLevelAccessServiceToken(ctx context.Context, zoneID, uuid string) (AccessServiceTokenUpdateResponse, error)

DeleteZoneLevelAccessServiceToken removes an existing Access Service Token for a zone.

API reference: https://api.cloudflare.com/#zone-level-access-service-tokens-delete-access-service-token

func (*API) DeleteZoneLockdown ¶

func (api *API) DeleteZoneLockdown(ctx context.Context, zoneID string, id string) (*ZoneLockdownResponse, error)

DeleteZoneLockdown deletes a Zone ZoneLockdown rule (based on the ID) for the given zone ID.

API reference: https://api.cloudflare.com/#zone-ZoneLockdown-delete-ZoneLockdown-rule

func (*API) DeleteZoneLogpushJob ¶

func (api *API) DeleteZoneLogpushJob(ctx context.Context, zoneID string, jobID int) error

DeleteZoneLogpushJob deletes a Logpush Job for a zone.

API reference: https://api.cloudflare.com/#logpush-jobs-delete-logpush-job

api, err := cloudflare.New(apiKey, user)
if err != nil {
	log.Fatal(err)
}

zoneID, err := api.ZoneIDByName(domain)
if err != nil {
	log.Fatal(err)
}

err = api.DeleteZoneLogpushJob(context.Background(), zoneID, 1)
if err != nil {
	log.Fatal(err)
}

func (*API) DeleteZoneRuleset ¶

func (api *API) DeleteZoneRuleset(ctx context.Context, zoneID, rulesetID string) error

DeleteZoneRuleset deletes a single ruleset for a zone.

API reference: https://api.cloudflare.com/#zone-rulesets-delete-zone-ruleset

func (*API) DevicePostureIntegration ¶

func (api *API) DevicePostureIntegration(ctx context.Context, accountID, integrationID string) (DevicePostureIntegration, error)

DevicePostureIntegration returns a specific device posture integrations within an account.

API reference: https://api.cloudflare.com/#device-posture-integrations-device-posture-integration-details

func (*API) DevicePostureIntegrations ¶

func (api *API) DevicePostureIntegrations(ctx context.Context, accountID string) ([]DevicePostureIntegration, ResultInfo, error)

DevicePostureIntegrations returns all device posture integrations within an account.

API reference: https://api.cloudflare.com/#device-posture-integrations-list-device-posture-integrations

func (*API) DevicePostureRule ¶

func (api *API) DevicePostureRule(ctx context.Context, accountID, ruleID string) (DevicePostureRule, error)

DevicePostureRule returns a single device posture rule based on the rule ID.

API reference: https://api.cloudflare.com/#device-posture-rules-device-posture-rules-details

func (*API) DevicePostureRules ¶

func (api *API) DevicePostureRules(ctx context.Context, accountID string) ([]DevicePostureRule, ResultInfo, error)

DevicePostureRules returns all device posture rules within an account.

API reference: https://api.cloudflare.com/#device-posture-rules-list-device-posture-rules

func (*API) DisableRailgun ¶

func (api *API) DisableRailgun(ctx context.Context, railgunID string) (Railgun, error)

DisableRailgun enables a Railgun for all zones connected to it.

API reference: https://api.cloudflare.com/#railgun-enable-or-disable-a-railgun

func (*API) DisconnectZoneRailgun ¶

func (api *API) DisconnectZoneRailgun(ctx context.Context, zoneID, railgunID string) (ZoneRailgun, error)

DisconnectZoneRailgun disconnects a Railgun for a given zone.

API reference: https://api.cloudflare.com/#railguns-for-a-zone-connect-or-disconnect-a-railgun

func (*API) DownloadWorker ¶

func (api *API) DownloadWorker(ctx context.Context, requestParams *WorkerRequestParams) (WorkerScriptResponse, error)

DownloadWorker fetch raw script content for your worker returns []byte containing worker code js

API reference: https://api.cloudflare.com/#worker-script-download-worker

api, err := cloudflare.New(apiKey, user)
if err != nil {
	log.Fatal(err)
}

zoneID, err := api.ZoneIDByName(domain)
if err != nil {
	log.Fatal(err)
}

res, err := api.DownloadWorker(context.Background(), &cloudflare.WorkerRequestParams{ZoneID: zoneID})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v", res)

DownloadWorkerWithName()

func (*API) EditPerHostnameAuthenticatedOriginPullsConfig ¶

func (api *API) EditPerHostnameAuthenticatedOriginPullsConfig(ctx context.Context, zoneID string, config []PerHostnameAuthenticatedOriginPullsConfig) ([]PerHostnameAuthenticatedOriginPullsDetails, error)

EditPerHostnameAuthenticatedOriginPullsConfig applies the supplied Per Hostname AuthenticatedOriginPulls config onto a hostname(s) in the edge.

API reference: https://api.cloudflare.com/#per-hostname-authenticated-origin-pull-enable-or-disable-a-hostname-for-client-authentication

func (*API) EditUniversalSSLSetting ¶

func (api *API) EditUniversalSSLSetting(ctx context.Context, zoneID string, setting UniversalSSLSetting) (UniversalSSLSetting, error)

EditUniversalSSLSetting edits the universal ssl setting for a zone

API reference: https://api.cloudflare.com/#universal-ssl-settings-for-a-zone-edit-universal-ssl-settings

func (*API) EditZone ¶

func (api *API) EditZone(ctx context.Context, zoneID string, zoneOpts ZoneOptions) (Zone, error)

EditZone edits the given zone.

This is usually called by ZoneSetPaused, ZoneSetType, or ZoneSetVanityNS.

API reference: https://api.cloudflare.com/#zone-edit-zone-properties

func (*API) EnableRailgun ¶

func (api *API) EnableRailgun(ctx context.Context, railgunID string) (Railgun, error)

EnableRailgun enables a Railgun for all zones connected to it.

API reference: https://api.cloudflare.com/#railgun-enable-or-disable-a-railgun

func (*API) FallbackOrigin ¶

func (api *API) FallbackOrigin(ctx context.Context, zoneID string) (FallbackOrigin, error)

FallbackOrigin returns information about the fallback origin for the specified zone.

API reference: https://developers.cloudflare.com/ssl/ssl-for-saas/api-calls/#fallback-origin-configuration

func (*API) Filter ¶

func (api *API) Filter(ctx context.Context, zoneID, filterID string) (Filter, error)

Filter returns a single filter in a zone based on the filter ID.

API reference: https://developers.cloudflare.com/firewall/api/cf-filters/get/#get-by-filter-id

func (*API) Filters ¶

func (api *API) Filters(ctx context.Context, zoneID string, pageOpts PaginationOptions) ([]Filter, error)

Filters returns all filters for a zone.

API reference: https://developers.cloudflare.com/firewall/api/cf-filters/get/#get-all-filters

func (*API) FirewallRule ¶

func (api *API) FirewallRule(ctx context.Context, zoneID, firewallRuleID string) (FirewallRule, error)

FirewallRule returns a single firewall rule based on the ID.

API reference: https://developers.cloudflare.com/firewall/api/cf-firewall-rules/get/#get-by-rule-id

func (*API) FirewallRules ¶

func (api *API) FirewallRules(ctx context.Context, zoneID string, pageOpts PaginationOptions) ([]FirewallRule, error)

FirewallRules returns all firewall rules.

API reference: https://developers.cloudflare.com/firewall/api/cf-firewall-rules/get/#get-all-rules

func (*API) ForceSecondaryDNSZoneAXFR ¶

func (api *API) ForceSecondaryDNSZoneAXFR(ctx context.Context, zoneID string) error

ForceSecondaryDNSZoneAXFR requests an immediate AXFR request.

API reference: https://api.cloudflare.com/#secondary-dns-update-secondary-zone-configuration

func (*API) GetAPIToken ¶

func (api *API) GetAPIToken(ctx context.Context, tokenID string) (APIToken, error)

GetAPIToken returns a single API token based on the ID.

API reference: https://api.cloudflare.com/#user-api-tokens-token-details

func (*API) GetAccountLogpushFields ¶

func (api *API) GetAccountLogpushFields(ctx context.Context, accountID, dataset string) (LogpushFields, error)

GetAccountLogpushFields returns fields for a given account-level dataset.

Account fields documentation: https://developers.cloudflare.com/logs/reference/log-fields/account

API reference: https://api.cloudflare.com/#logpush-jobs-list-logpush-jobs

func (*API) GetAccountLogpushJob ¶

func (api *API) GetAccountLogpushJob(ctx context.Context, accountID string, jobID int) (LogpushJob, error)

GetAccountLogpushJob fetches detail about one account-level Logpush Job.

API reference: https://api.cloudflare.com/#logpush-jobs-logpush-job-details

func (*API) GetAccountLogpushOwnershipChallenge ¶

func (api *API) GetAccountLogpushOwnershipChallenge(ctx context.Context, accountID, destinationConf string) (*LogpushGetOwnershipChallenge, error)

GetAccountLogpushOwnershipChallenge returns ownership challenge.

API reference: https://api.cloudflare.com/#logpush-jobs-get-ownership-challenge

func (*API) GetAccountRuleset ¶

func (api *API) GetAccountRuleset(ctx context.Context, accountID, rulesetID string) (Ruleset, error)

GetAccountRuleset fetches a single ruleset for an account.

API reference: https://api.cloudflare.com/#account-rulesets-get-an-account-ruleset

func (*API) GetAccountRulesetPhase ¶

func (api *API) GetAccountRulesetPhase(ctx context.Context, accountID, rulesetPhase string) (Ruleset, error)

GetAccountRulesetPhase returns a ruleset phase for an account.

API reference: TBA

func (*API) GetAdvertisementStatus ¶

func (api *API) GetAdvertisementStatus(ctx context.Context, id string) (AdvertisementStatus, error)

GetAdvertisementStatus returns the BGP status of the IP prefix

API reference: https://api.cloudflare.com/#ip-address-management-prefixes-update-prefix-description

func (*API) GetAuthenticatedOriginPullsStatus ¶

func (api *API) GetAuthenticatedOriginPullsStatus(ctx context.Context, zoneID string) (AuthenticatedOriginPulls, error)

GetAuthenticatedOriginPullsStatus returns the configuration details for global AuthenticatedOriginPulls (tls_client_auth).

API reference: https://api.cloudflare.com/#zone-settings-get-tls-client-auth-setting

func (*API) GetAvailableNotificationTypes ¶

func (api *API) GetAvailableNotificationTypes(ctx context.Context, accountID string) (NotificationAvailableAlertsResponse, error)

GetAvailableNotificationTypes will return the alert types available for a given account.

API Reference: https://api.cloudflare.com/#notification-mechanism-eligibility-properties

func (*API) GetEligibleNotificationDestinations ¶

func (api *API) GetEligibleNotificationDestinations(ctx context.Context, accountID string) (NotificationEligibilityResponse, error)

GetEligibleNotificationDestinations will return the types of destinations an account is eligible to configure.

API Reference: https://api.cloudflare.com/#notification-mechanism-eligibility-properties

func (*API) GetIPList ¶

func (api *API) GetIPList(ctx context.Context, id string) (IPList, error)

GetIPList returns a single IP List

API reference: https://api.cloudflare.com/#rules-lists-get-list

func (*API) GetIPListBulkOperation ¶

func (api *API) GetIPListBulkOperation(ctx context.Context, id string) (IPListBulkOperation, error)

GetIPListBulkOperation returns the status of a bulk operation

API reference: https://api.cloudflare.com/#rules-lists-get-bulk-operation

func (*API) GetIPListItem ¶

func (api *API) GetIPListItem(ctx context.Context, listID, id string) (IPListItem, error)

GetIPListItem returns a single IP List Item

API reference: https://api.cloudflare.com/#rules-lists-get-list-item

func (*API) GetLogpullRetentionFlag ¶

func (api *API) GetLogpullRetentionFlag(ctx context.Context, zoneID string) (*LogpullRetentionConfiguration, error)

GetLogpullRetentionFlag gets the current setting flag.

API reference: https://developers.cloudflare.com/logs/logpull-api/enabling-log-retention/

func (*API) GetMagicFirewallRuleset ¶

func (api *API) GetMagicFirewallRuleset(ctx context.Context, id string) (MagicFirewallRuleset, error)

GetMagicFirewallRuleset returns a specific Magic Firewall Ruleset

API reference: https://api.cloudflare.com/#rulesets-get-a-ruleset

func (*API) GetMagicTransitStaticRoute ¶

func (api *API) GetMagicTransitStaticRoute(ctx context.Context, id string) (MagicTransitStaticRoute, error)

GetMagicTransitStaticRoute returns exactly one static route

API reference: https://api.cloudflare.com/#magic-transit-static-routes-route-details

func (*API) GetNotificationPolicy ¶

func (api *API) GetNotificationPolicy(ctx context.Context, accountID, policyID string) (NotificationPolicyResponse, error)

GetNotificationPolicy returns a specific created by a user, given the account id and the policy id.

API Reference: https://api.cloudflare.com/#notification-policies-properties

func (*API) GetNotificationWebhooks ¶

func (api *API) GetNotificationWebhooks(ctx context.Context, accountID, webhookID string) (NotificationWebhookResponse, error)

GetNotificationWebhooks will return a specific webhook destination, given the account and webhooks ids.

API Reference: https://api.cloudflare.com/#notification-webhooks-get-webhook

func (*API) GetOrganizationAuditLogs ¶

func (api *API) GetOrganizationAuditLogs(ctx context.Context, organizationID string, a AuditLogFilter) (AuditLogResponse, error)

GetOrganizationAuditLogs will return the audit logs of a specific organization, based on the ID passed in. The audit logs can be filtered based on any argument in the AuditLogFilter

API Reference: https://api.cloudflare.com/#audit-logs-list-organization-audit-logs

func (*API) GetPerHostnameAuthenticatedOriginPullsCertificate ¶

func (api *API) GetPerHostnameAuthenticatedOriginPullsCertificate(ctx context.Context, zoneID, certificateID string) (PerHostnameAuthenticatedOriginPullsCertificateDetails, error)

GetPerHostnameAuthenticatedOriginPullsCertificate retrieves certificate metadata about the requested Per Hostname certificate.

API reference: https://api.cloudflare.com/#per-hostname-authenticated-origin-pull-get-the-hostname-client-certificate

func (*API) GetPerHostnameAuthenticatedOriginPullsConfig ¶

func (api *API) GetPerHostnameAuthenticatedOriginPullsConfig(ctx context.Context, zoneID, hostname string) (PerHostnameAuthenticatedOriginPullsDetails, error)

GetPerHostnameAuthenticatedOriginPullsConfig returns the config state of Per Hostname AuthenticatedOriginPulls of the provided hostname within a zone.

API reference: https://api.cloudflare.com/#per-hostname-authenticated-origin-pull-get-the-hostname-status-for-client-authentication

func (*API) GetPerZoneAuthenticatedOriginPullsCertificateDetails ¶

func (api *API) GetPerZoneAuthenticatedOriginPullsCertificateDetails(ctx context.Context, zoneID, certificateID string) (PerZoneAuthenticatedOriginPullsCertificateDetails, error)

GetPerZoneAuthenticatedOriginPullsCertificateDetails returns the metadata associated with a user uploaded client certificate to Per Zone AuthenticatedOriginPulls.

API reference: https://api.cloudflare.com/#zone-level-authenticated-origin-pulls-get-certificate-details

func (*API) GetPerZoneAuthenticatedOriginPullsStatus ¶

func (api *API) GetPerZoneAuthenticatedOriginPullsStatus(ctx context.Context, zoneID string) (PerZoneAuthenticatedOriginPullsSettings, error)

GetPerZoneAuthenticatedOriginPullsStatus returns whether per zone AuthenticatedOriginPulls is enabled or not. It is false by default.

API reference: https://api.cloudflare.com/#zone-level-authenticated-origin-pulls-get-enablement-setting-for-zone

func (*API) GetPrefix ¶

func (api *API) GetPrefix(ctx context.Context, id string) (IPPrefix, error)

GetPrefix returns a specific IP prefix

API reference: https://api.cloudflare.com/#ip-address-management-prefixes-prefix-details

func (*API) GetSecondaryDNSPrimary ¶

func (api *API) GetSecondaryDNSPrimary(ctx context.Context, accountID, primaryID string) (SecondaryDNSPrimary, error)

GetSecondaryDNSPrimary returns a single secondary DNS primary.

API reference: https://api.cloudflare.com/#secondary-dns-primary--primary-details

func (*API) GetSecondaryDNSTSIG ¶

func (api *API) GetSecondaryDNSTSIG(ctx context.Context, accountID, tsigID string) (SecondaryDNSTSIG, error)

GetSecondaryDNSTSIG gets a single account level TSIG for a secondary DNS configuration.

API reference: https://api.cloudflare.com/#secondary-dns-tsig--tsig-details

func (*API) GetSecondaryDNSZone ¶

func (api *API) GetSecondaryDNSZone(ctx context.Context, zoneID string) (SecondaryDNSZone, error)

GetSecondaryDNSZone returns the secondary DNS zone configuration for a single zone.

API reference: https://api.cloudflare.com/#secondary-dns-secondary-zone-configuration-details

func (*API) GetUserAuditLogs ¶

func (api *API) GetUserAuditLogs(ctx context.Context, a AuditLogFilter) (AuditLogResponse, error)

GetUserAuditLogs will return your user's audit logs. The audit logs can be filtered based on any argument in the AuditLogFilter

API Reference: https://api.cloudflare.com/#audit-logs-list-user-audit-logs

func (*API) GetWorkerRoute ¶

func (api *API) GetWorkerRoute(ctx context.Context, zoneID string, routeID string) (WorkerRouteResponse, error)

GetWorkerRoute returns a worker route.

API reference: https://api.cloudflare.com/#worker-routes-get-route

func (*API) GetZoneLogpushFields ¶

func (api *API) GetZoneLogpushFields(ctx context.Context, zoneID, dataset string) (LogpushFields, error)

GetZoneLogpushFields returns fields for a given zone-level dataset.

Zone fields documentation: https://developers.cloudflare.com/logs/reference/log-fields/zone

API reference: https://api.cloudflare.com/#logpush-jobs-list-logpush-jobs

func (*API) GetZoneLogpushJob ¶

func (api *API) GetZoneLogpushJob(ctx context.Context, zoneID string, jobID int) (LogpushJob, error)

GetZoneLogpushJob fetches detail about one Logpush Job for a zone.

API reference: https://api.cloudflare.com/#logpush-jobs-logpush-job-details

api, err := cloudflare.New(apiKey, user)
if err != nil {
	log.Fatal(err)
}

zoneID, err := api.ZoneIDByName(domain)
if err != nil {
	log.Fatal(err)
}

job, err := api.GetZoneLogpushJob(context.Background(), zoneID, 1)
if err != nil {
	log.Fatal(err)
}

fmt.Printf("%+v\n", job)

func (*API) GetZoneLogpushOwnershipChallenge ¶

func (api *API) GetZoneLogpushOwnershipChallenge(ctx context.Context, zoneID, destinationConf string) (*LogpushGetOwnershipChallenge, error)

GetZoneLogpushOwnershipChallenge returns ownership challenge.

API reference: https://api.cloudflare.com/#logpush-jobs-get-ownership-challenge

api, err := cloudflare.New(apiKey, user)
if err != nil {
	log.Fatal(err)
}

zoneID, err := api.ZoneIDByName(domain)
if err != nil {
	log.Fatal(err)
}

ownershipChallenge, err := api.GetZoneLogpushOwnershipChallenge(context.Background(), zoneID, "destination_conf")
if err != nil {
	log.Fatal(err)
}

fmt.Printf("%+v\n", ownershipChallenge)

func (*API) GetZoneRuleset ¶

func (api *API) GetZoneRuleset(ctx context.Context, zoneID, rulesetID string) (Ruleset, error)

GetZoneRuleset fetches a single ruleset for a zone.

API reference: https://api.cloudflare.com/#zone-rulesets-get-a-zone-ruleset

func (*API) GetZoneRulesetPhase ¶

func (api *API) GetZoneRulesetPhase(ctx context.Context, zoneID, rulesetPhase string) (Ruleset, error)

GetZoneRulesetPhase returns a ruleset phase for a zone.

API reference: TBA

func (*API) Healthcheck ¶

func (api *API) Healthcheck(ctx context.Context, zoneID, healthcheckID string) (Healthcheck, error)

Healthcheck returns a single healthcheck by ID.

API reference: https://api.cloudflare.com/#health-checks-health-check-details

func (*API) HealthcheckPreview ¶

func (api *API) HealthcheckPreview(ctx context.Context, zoneID, id string) (Healthcheck, error)

HealthcheckPreview returns a single healthcheck preview by its ID.

API reference: https://api.cloudflare.com/#health-checks-health-check-preview-details

func (*API) Healthchecks ¶

func (api *API) Healthchecks(ctx context.Context, zoneID string) ([]Healthcheck, error)

Healthchecks returns all healthchecks for a zone.

API reference: https://api.cloudflare.com/#health-checks-list-health-checks

func (*API) KeylessSSL ¶

func (api *API) KeylessSSL(ctx context.Context, zoneID, keylessSSLID string) (KeylessSSL, error)

KeylessSSL provides the configuration for a given Keyless SSL identifier.

API reference: https://api.cloudflare.com/#keyless-ssl-for-a-zone-keyless-ssl-details

func (*API) ListAPITokensPermissionGroups ¶

func (api *API) ListAPITokensPermissionGroups(ctx context.Context) ([]APITokenPermissionGroups, error)

ListAPITokensPermissionGroups returns all available API token permission groups.

API reference: https://api.cloudflare.com/#permission-groups-list-permission-groups

func (*API) ListAccountAccessRules ¶

func (api *API) ListAccountAccessRules(ctx context.Context, accountID string, accessRule AccessRule, page int) (*AccessRuleListResponse, error)

ListAccountAccessRules returns a slice of access rules for the given account identifier.

This takes an AccessRule to allow filtering of the results returned.

API reference: https://api.cloudflare.com/#account-level-firewall-access-rule-list-access-rules

func (*API) ListAccountLogpushJobs ¶

func (api *API) ListAccountLogpushJobs(ctx context.Context, accountID string) ([]LogpushJob, error)

ListAccountLogpushJobs returns all account-level Logpush Jobs for all datasets.

API reference: https://api.cloudflare.com/#logpush-jobs-list-logpush-jobs

func (*API) ListAccountLogpushJobsForDataset ¶

func (api *API) ListAccountLogpushJobsForDataset(ctx context.Context, accountID, dataset string) ([]LogpushJob, error)

ListAccountLogpushJobsForDataset returns all account-level Logpush Jobs for a dataset.

API reference: https://api.cloudflare.com/#logpush-jobs-list-logpush-jobs-for-a-dataset

func (*API) ListAccountRulesets ¶

func (api *API) ListAccountRulesets(ctx context.Context, accountID string) ([]Ruleset, error)

ListAccountRulesets fetches all rulesets for an account.

API reference: https://api.cloudflare.com/#account-rulesets-list-account-rulesets

func (*API) ListAllRateLimits ¶

func (api *API) ListAllRateLimits(ctx context.Context, zoneID string) ([]RateLimit, error)

ListAllRateLimits returns all Rate Limits for a zone.

API reference: https://api.cloudflare.com/#rate-limits-for-a-zone-list-rate-limits

func (*API) ListCertificatePacks ¶

func (api *API) ListCertificatePacks(ctx context.Context, zoneID string) ([]CertificatePack, error)

ListCertificatePacks returns all available TLS certificate packs for a zone.

API Reference: https://api.cloudflare.com/#certificate-packs-list-certificate-packs

func (*API) ListIPListItems ¶

func (api *API) ListIPListItems(ctx context.Context, id string) ([]IPListItem, error)

ListIPListItems returns a list with all items in an IP List

API reference: https://api.cloudflare.com/#rules-lists-list-list-items

func (*API) ListIPLists ¶

func (api *API) ListIPLists(ctx context.Context) ([]IPList, error)

ListIPLists lists all IP Lists

API reference: https://api.cloudflare.com/#rules-lists-list-lists

func (*API) ListKeylessSSL ¶

func (api *API) ListKeylessSSL(ctx context.Context, zoneID string) ([]KeylessSSL, error)

ListKeylessSSL lists Keyless SSL configurations for a zone.

API reference: https://api.cloudflare.com/#keyless-ssl-for-a-zone-list-keyless-ssl-configurations

func (*API) ListLoadBalancerMonitors ¶

func (api *API) ListLoadBalancerMonitors(ctx context.Context) ([]LoadBalancerMonitor, error)

ListLoadBalancerMonitors lists load balancer monitors connected to an account.

API reference: https://api.cloudflare.com/#load-balancer-monitors-list-monitors

func (*API) ListLoadBalancerPools ¶

func (api *API) ListLoadBalancerPools(ctx context.Context) ([]LoadBalancerPool, error)

ListLoadBalancerPools lists load balancer pools connected to an account.

API reference: https://api.cloudflare.com/#load-balancer-pools-list-pools

func (*API) ListLoadBalancers ¶

func (api *API) ListLoadBalancers(ctx context.Context, zoneID string) ([]LoadBalancer, error)

ListLoadBalancers lists load balancers configured on a zone.

API reference: https://api.cloudflare.com/#load-balancers-list-load-balancers

package main

import (
	context "context"
	"fmt"
	"log"

	cloudflare "github.com/grafana/cloudflare-go"
)

func main() {
	// Construct a new API object.
	api, err := cloudflare.New("deadbeef", "test@example.com")
	if err != nil {
		log.Fatal(err)
	}

	// Fetch the zone ID.
	id, err := api.ZoneIDByName("example.com") // Assuming example.com exists in your Cloudflare account
	if err != nil {
		log.Fatal(err)
	}

	// List LBs configured in zone.
	lbList, err := api.ListLoadBalancers(context.Background(), id)
	if err != nil {
		log.Fatal(err)
	}

	for _, lb := range lbList {
		fmt.Println(lb)
	}
}

Output:

func (*API) ListMagicFirewallRulesets ¶

func (api *API) ListMagicFirewallRulesets(ctx context.Context) ([]MagicFirewallRuleset, error)

ListMagicFirewallRulesets lists all Rulesets for a given account

API reference: https://api.cloudflare.com/#rulesets-list-rulesets

func (*API) ListMagicTransitStaticRoutes ¶

func (api *API) ListMagicTransitStaticRoutes(ctx context.Context) ([]MagicTransitStaticRoute, error)

ListMagicTransitStaticRoutes lists all static routes for a given account

API reference: https://api.cloudflare.com/#magic-transit-static-routes-list-routes

func (*API) ListNotificationHistory ¶

func (api *API) ListNotificationHistory(ctx context.Context, accountID string, pageOpts PaginationOptions) ([]NotificationHistory, ResultInfo, error)

ListNotificationHistory will return the history of alerts sent for a given account. The time period varies based on zone plan. Free, Biz, Pro = 30 days Ent = 90 days

API Reference: https://api.cloudflare.com/#notification-history-list-history

func (*API) ListNotificationPolicies ¶

func (api *API) ListNotificationPolicies(ctx context.Context, accountID string) (NotificationPoliciesResponse, error)

ListNotificationPolicies will return the notification policies created by a user for a specific account.

API Reference: https://api.cloudflare.com/#notification-policies-properties

func (*API) ListNotificationWebhooks ¶

func (api *API) ListNotificationWebhooks(ctx context.Context, accountID string) (NotificationWebhooksResponse, error)

ListNotificationWebhooks will return the webhook destinations configured for an account.

API Reference: https://api.cloudflare.com/#notification-webhooks-list-webhooks

func (*API) ListPageRules ¶

func (api *API) ListPageRules(ctx context.Context, zoneID string) ([]PageRule, error)

ListPageRules returns all Page Rules for a zone.

API reference: https://api.cloudflare.com/#page-rules-for-a-zone-list-page-rules

api, err := cloudflare.New(apiKey, user)
if err != nil {
	log.Fatal(err)
}

zoneID, err := api.ZoneIDByName(domain)
if err != nil {
	log.Fatal(err)
}

pageRules, err := api.ListPageRules(context.Background(), zoneID)
if err != nil {
	log.Fatal(err)
}

fmt.Printf("%+v\n", pageRules)
for _, r := range pageRules {
	fmt.Printf("%+v\n", r)
}

func (*API) ListPagerDutyNotificationDestinations ¶

func (api *API) ListPagerDutyNotificationDestinations(ctx context.Context, accountID string) (NotificationPagerDutyResponse, error)

ListPagerDutyNotificationDestinations will return the pagerduty destinations configured for an account.

API Reference: https://api.cloudflare.com/#notification-destinations-with-pagerduty-list-pagerduty-services

func (*API) ListPagesProjects ¶

func (api *API) ListPagesProjects(ctx context.Context, accountID string, pageOpts PaginationOptions) ([]PagesProject, ResultInfo, error)

ListPagesProjects returns all Pages projects for an account.

API reference: https://api.cloudflare.com/#pages-project-get-projects

func (*API) ListPerHostnameAuthenticatedOriginPullsCertificates ¶

func (api *API) ListPerHostnameAuthenticatedOriginPullsCertificates(ctx context.Context, zoneID string) ([]PerHostnameAuthenticatedOriginPullsDetails, error)

ListPerHostnameAuthenticatedOriginPullsCertificates will get all certificate under Per Hostname AuthenticatedOriginPulls zone.

API reference: https://api.cloudflare.com/#per-hostname-authenticated-origin-pull-list-certificates

func (*API) ListPerZoneAuthenticatedOriginPullsCertificates ¶

func (api *API) ListPerZoneAuthenticatedOriginPullsCertificates(ctx context.Context, zoneID string) ([]PerZoneAuthenticatedOriginPullsCertificateDetails, error)

ListPerZoneAuthenticatedOriginPullsCertificates returns a list of all user uploaded client certificates to Per Zone AuthenticatedOriginPulls.

API reference: https://api.cloudflare.com/#zone-level-authenticated-origin-pulls-list-certificates

func (*API) ListPrefixes ¶

func (api *API) ListPrefixes(ctx context.Context) ([]IPPrefix, error)

ListPrefixes lists all IP prefixes for a given account

API reference: https://api.cloudflare.com/#ip-address-management-prefixes-list-prefixes

func (*API) ListRailguns ¶

func (api *API) ListRailguns(ctx context.Context, options RailgunListOptions) ([]Railgun, error)

ListRailguns lists Railguns connected to an account.

API reference: https://api.cloudflare.com/#railgun-list-railguns

func (*API) ListRateLimits ¶

func (api *API) ListRateLimits(ctx context.Context, zoneID string, pageOpts PaginationOptions) ([]RateLimit, ResultInfo, error)

ListRateLimits returns Rate Limits for a zone, paginated according to the provided options

API reference: https://api.cloudflare.com/#rate-limits-for-a-zone-list-rate-limits

api, err := cloudflare.New(apiKey, user)
if err != nil {
	log.Fatal(err)
}

zoneID, err := api.ZoneIDByName(domain)
if err != nil {
	log.Fatal(err)
}

pageOpts := cloudflare.PaginationOptions{
	PerPage: 5,
	Page:    1,
}
rateLimits, _, err := api.ListRateLimits(context.Background(), zoneID, pageOpts)
if err != nil {
	log.Fatal(err)
}

fmt.Printf("%+v\n", rateLimits)
for _, r := range rateLimits {
	fmt.Printf("%+v\n", r)
}

func (*API) ListSSL ¶

func (api *API) ListSSL(ctx context.Context, zoneID string) ([]ZoneCustomSSL, error)

ListSSL lists the custom certificates for the given zone.

API reference: https://api.cloudflare.com/#custom-ssl-for-a-zone-list-ssl-configurations

func (*API) ListSecondaryDNSPrimaries ¶

func (api *API) ListSecondaryDNSPrimaries(ctx context.Context, accountID string) ([]SecondaryDNSPrimary, error)

ListSecondaryDNSPrimaries returns all secondary DNS primaries for an account.

API reference: https://api.cloudflare.com/#secondary-dns-primary--list-primaries

func (*API) ListSecondaryDNSTSIGs ¶

func (api *API) ListSecondaryDNSTSIGs(ctx context.Context, accountID string) ([]SecondaryDNSTSIG, error)

ListSecondaryDNSTSIGs gets all account level TSIG for a secondary DNS configuration.

API reference: https://api.cloudflare.com/#secondary-dns-tsig--list-tsigs

func (*API) ListSplitTunnels ¶

func (api *API) ListSplitTunnels(ctx context.Context, accountID string, mode string) ([]SplitTunnel, error)

ListSplitTunnel returns all include or exclude split tunnel within an account.

API reference for include: https://api.cloudflare.com/#device-policy-get-split-tunnel-include-list API reference for exclude: https://api.cloudflare.com/#device-policy-get-split-tunnel-exclude-list

func (*API) ListUserAccessRules ¶

func (api *API) ListUserAccessRules(ctx context.Context, accessRule AccessRule, page int) (*AccessRuleListResponse, error)

ListUserAccessRules returns a slice of access rules for the logged-in user.

This takes an AccessRule to allow filtering of the results returned.

API reference: https://api.cloudflare.com/#user-level-firewall-access-rule-list-access-rules

func (*API) ListUserAgentRules ¶

func (api *API) ListUserAgentRules(ctx context.Context, zoneID string, page int) (*UserAgentRuleListResponse, error)

ListUserAgentRules retrieves a list of User-Agent Block rules for a given zone ID by page number.

API reference: https://api.cloudflare.com/#user-agent-blocking-rules-list-useragent-rules

package main

import (
	"context"
	"fmt"
	"log"

	cloudflare "github.com/grafana/cloudflare-go"
)

func main() {
	api, err := cloudflare.New("deadbeef", "test@example.org")
	if err != nil {
		log.Fatal(err)
	}

	zoneID, err := api.ZoneIDByName("example.com")
	if err != nil {
		log.Fatal(err)
	}

	// Fetch all Zone Lockdown rules for a zone, by page.
	rules, err := api.ListUserAgentRules(context.Background(), zoneID, 1)
	if err != nil {
		log.Fatal(err)
	}

	for _, r := range rules.Result {
		fmt.Printf("%s: %s\n", r.Configuration.Target, r.Configuration.Value)
	}
}

Output:

func (*API) ListVirtualDNS ¶

func (api *API) ListVirtualDNS(ctx context.Context) ([]*VirtualDNS, error)

ListVirtualDNS lists the virtual DNS clusters associated with an account.

API reference: https://api.cloudflare.com/#virtual-dns-users--get-virtual-dns-clusters

func (*API) ListWAFGroups ¶

func (api *API) ListWAFGroups(ctx context.Context, zoneID, packageID string) ([]WAFGroup, error)

ListWAFGroups returns a slice of the WAF groups for the given WAF package.

API Reference: https://api.cloudflare.com/#waf-rule-groups-list-rule-groups

func (*API) ListWAFOverrides ¶

func (api *API) ListWAFOverrides(ctx context.Context, zoneID string) ([]WAFOverride, error)

ListWAFOverrides returns a slice of the WAF overrides.

API Reference: https://api.cloudflare.com/#waf-overrides-list-uri-controlled-waf-configurations

func (*API) ListWAFPackages ¶

func (api *API) ListWAFPackages(ctx context.Context, zoneID string) ([]WAFPackage, error)

ListWAFPackages returns a slice of the WAF packages for the given zone.

API Reference: https://api.cloudflare.com/#waf-rule-packages-list-firewall-packages

func (*API) ListWAFRules ¶

func (api *API) ListWAFRules(ctx context.Context, zoneID, packageID string) ([]WAFRule, error)

ListWAFRules returns a slice of the WAF rules for the given WAF package.

API Reference: https://api.cloudflare.com/#waf-rules-list-rules

func (*API) ListWaitingRooms ¶

func (api *API) ListWaitingRooms(ctx context.Context, zoneID string) ([]WaitingRoom, error)

ListWaitingRooms returns all Waiting Room for a zone.

API reference: https://api.cloudflare.com/#waiting-room-list-waiting-rooms

func (*API) ListWorkerBindings ¶

func (api *API) ListWorkerBindings(ctx context.Context, requestParams *WorkerRequestParams) (WorkerBindingListResponse, error)

ListWorkerBindings returns all the bindings for a particular worker

func (*API) ListWorkerCronTriggers ¶

func (api *API) ListWorkerCronTriggers(ctx context.Context, scriptName string) ([]WorkerCronTrigger, error)

ListWorkerCronTriggers fetches all available cron triggers for a single Worker script.

API reference: https://api.cloudflare.com/#worker-cron-trigger-get-cron-triggers

func (*API) ListWorkerRoutes ¶

func (api *API) ListWorkerRoutes(ctx context.Context, zoneID string) (WorkerRoutesResponse, error)

ListWorkerRoutes returns list of worker routes

API reference: https://api.cloudflare.com/#worker-filters-list-filters, https://api.cloudflare.com/#worker-routes-list-routes

api, err := cloudflare.New(apiKey, user)
if err != nil {
	log.Fatal(err)
}

zoneID, err := api.ZoneIDByName(domain)
if err != nil {
	log.Fatal(err)
}
res, err := api.ListWorkerRoutes(context.Background(), zoneID)
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v", res)

func (*API) ListWorkerScripts ¶