cloudflare

package
v0.22.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 25, 2026 License: Apache-2.0 Imports: 23 Imported by: 0

Documentation

Index

Constants

View Source 
const CreateMonitorPayloadType = "cloudflare.monitor.created"

CreateMonitorPayloadType is the emitted execution payload type (dash0-style: integration.resource.operation).

View Source 
const CreateTunnelPayloadType = "cloudflare.tunnel.created"
View Source 
const DNSRecordPayloadType = "cloudflare.dnsRecord"
View Source 
const DeleteCertificatePackPayloadType = "cloudflare.certificate_pack.deleted"
View Source 
const DeleteMonitorPayloadType = "cloudflare.monitor.deleted"

DeleteMonitorPayloadType is the emitted execution payload type (dash0-style: integration.resource.operation).

View Source 
const DeleteTunnelPayloadType = "cloudflare.tunnel.deleted"
View Source 
const GetMonitorPayloadType = "cloudflare.monitor.fetched"
View Source 
const GetTunnelPayloadType = "cloudflare.tunnel.fetched"
View Source 
const LoadBalancingHealthAlertPayloadType = "cloudflare.loadBalancing.healthAlert"
View Source 
const OrderCertificatePackPayloadType = "cloudflare.certificate_pack.ordered"
View Source 
const PurgeCachePayloadType = "cloudflare.cache.purged"
View Source 
const TunnelHealthEventPayloadType = "cloudflare.tunnel.healthEvent"
View Source 
const UpdateMonitorPayloadType = "cloudflare.monitor.updated"

Variables

This section is empty.

Functions

This section is empty.

Types

type AlertingWebhookDestination added in v0.21.0 

type AlertingWebhookDestination struct {
	ID   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
	URL  string `json:"url,omitempty"`
}

type CFDTunnel added in v0.21.0 

type CFDTunnel struct {
	ID         string `json:"id,omitempty"`
	AccountTag string `json:"account_tag,omitempty"`
	Name       string `json:"name,omitempty"`
	Status     string `json:"status,omitempty"`
	ConfigSrc  string `json:"config_src,omitempty"`
	CreatedAt  string `json:"created_at,omitempty"`
	DeletedAt  string `json:"deleted_at,omitempty"`
	// Metadata is an object in list/get responses; use RawMessage so unmarshaling accepts any JSON shape.
	Metadata json.RawMessage `json:"metadata,omitempty"`
	// Token is returned only when creating a tunnel; treat as sensitive.
	Token string `json:"token,omitempty"`
}

CFDTunnel is a Cloudflare Tunnel (cloudflared) returned by the account-scoped cfd_tunnel API.

type CertificatePack added in v0.21.0 

type CertificatePack struct {
	ID                   string   `json:"id,omitempty"`
	CertificateAuthority string   `json:"certificate_authority,omitempty"`
	Hosts                []string `json:"hosts,omitempty"`
	Status               string   `json:"status,omitempty"`
	Type                 string   `json:"type,omitempty"`
	ValidationMethod     string   `json:"validation_method,omitempty"`
	ValidityDays         int      `json:"validity_days,omitempty"`
}

type Client 

type Client struct {
	Token string

	BaseURL string
	// contains filtered or unexported fields
}

func NewClient 

func NewClient(http core.HTTPContext, ctx core.IntegrationContext) (*Client, error)

func (*Client) CreateAlertingWebhookDestination added in v0.21.0 

func (c *Client) CreateAlertingWebhookDestination(
	accountID string,
	req CreateAlertingWebhookDestinationRequest,
) (*AlertingWebhookDestination, error)

func (*Client) CreateCFDTunnel added in v0.21.0 

func (c *Client) CreateCFDTunnel(accountID string, req CreateCFDTunnelRequest) (*CFDTunnel, error)

CreateCFDTunnel creates a new Cloudflare Tunnel.

func (*Client) CreateDNSRecord added in v0.6.0 

func (c *Client) CreateDNSRecord(zoneID string, req CreateDNSRecordRequest) (*DNSRecord, error)

func (*Client) CreateKVNamespace added in v0.20.0 

func (c *Client) CreateKVNamespace(accountID string, req CreateKVNamespaceRequest) (*KVNamespace, error)

CreateKVNamespace creates a new Workers KV namespace under a Cloudflare account

func (*Client) CreateLoadBalancer added in v0.21.0 

func (c *Client) CreateLoadBalancer(zoneID string, req CreateLoadBalancerRequest) (*LoadBalancer, error)

CreateLoadBalancer creates a new load balancer under a zone

func (*Client) CreateMonitor added in v0.21.0 

func (c *Client) CreateMonitor(accountID string, req CreateMonitorRequest) (*Monitor, error)

func (*Client) CreateNotificationPolicy added in v0.21.0 

func (c *Client) CreateNotificationPolicy(
	accountID string,
	req CreateNotificationPolicyRequest,
) (*NotificationPolicyResponse, error)

func (*Client) CreateOriginRule added in v0.20.0 

func (c *Client) CreateOriginRule(zoneID, rulesetID string, req OriginRule) (*OriginRule, error)

func (*Client) CreateOriginRuleset added in v0.20.0 

func (c *Client) CreateOriginRuleset(zoneID string, req CreateOriginRulesetRequest) (*OriginRuleset, error)

func (*Client) CreatePool added in v0.20.0 

func (c *Client) CreatePool(accountID string, req CreatePoolRequest) (*Pool, error)

CreatePool creates a new origin pool under a Cloudflare account

func (*Client) CreateRedirectRule 

func (c *Client) CreateRedirectRule(zoneID, rulesetID string, req CreateRedirectRuleRequest) (*RedirectRule, error)

CreateRedirectRule creates a new redirect rule in a zone's ruleset

func (*Client) CreateWorkerDeployment added in v0.21.0 

func (c *Client) CreateWorkerDeployment(accountID, scriptName, versionID string, annotations map[string]string) (map[string]any, error)

CreateWorkerDeployment creates a deployment so the given version serves traffic.

func (*Client) CreateWorkerResource added in v0.21.0 

func (c *Client) CreateWorkerResource(accountID string, body map[string]any) (map[string]any, error)

CreateWorkerResource provisions a Worker via POST .../workers/workers before the first script upload.

func (*Client) CreateWorkerRoute added in v0.21.0 

func (c *Client) CreateWorkerRoute(zoneID, pattern, script string) (*WorkerRoute, error)

CreateWorkerRoute creates a zone route for a Worker.

func (*Client) DeleteAlertingWebhookDestination added in v0.21.0 

func (c *Client) DeleteAlertingWebhookDestination(accountID, webhookID string) error

func (*Client) DeleteCFDTunnel added in v0.21.0 

func (c *Client) DeleteCFDTunnel(accountID, tunnelID string) error

DeleteCFDTunnel permanently deletes a tunnel.

func (*Client) DeleteCertificatePack added in v0.21.0 

func (c *Client) DeleteCertificatePack(zoneID, packID string) error

func (*Client) DeleteDNSRecord added in v0.6.0 

func (c *Client) DeleteDNSRecord(zoneID, recordID string) (*DNSRecord, error)

DeleteDNSRecord deletes a DNS record by its ID within a zone. It returns the deleted DNS record (Cloudflare API returns it in result).

func (*Client) DeleteKVNamespace added in v0.20.0 

func (c *Client) DeleteKVNamespace(accountID, namespaceID string) error

DeleteKVNamespace deletes a Workers KV namespace

func (*Client) DeleteKVValue added in v0.20.0 

func (c *Client) DeleteKVValue(accountID, namespaceID, key string) error

DeleteKVValue deletes a key-value pair from a Workers KV namespace

func (*Client) DeleteLoadBalancer added in v0.21.0 

func (c *Client) DeleteLoadBalancer(zoneID, lbID string) error

DeleteLoadBalancer deletes a load balancer by ID from a zone

func (*Client) DeleteMonitor added in v0.21.0 

func (c *Client) DeleteMonitor(accountID, monitorID string) (*DeleteMonitorResponse, error)

func (*Client) DeleteNotificationPolicy added in v0.21.0 

func (c *Client) DeleteNotificationPolicy(accountID, policyID string) error

func (*Client) DeleteOriginRule added in v0.20.0 

func (c *Client) DeleteOriginRule(zoneID, rulesetID, ruleID string) (*OriginRule, error)

func (*Client) DeletePool added in v0.20.0 

func (c *Client) DeletePool(accountID, poolID string) error

DeletePool deletes an origin pool by ID for a given account

func (*Client) DeleteWorkerScript added in v0.21.0 

func (c *Client) DeleteWorkerScript(accountID, scriptName string, force bool) error

DeleteWorkerScript deletes a Worker script from the account.

func (*Client) GetCFDTunnel added in v0.21.0 

func (c *Client) GetCFDTunnel(accountID, tunnelID string) (*CFDTunnel, error)

GetCFDTunnel retrieves a tunnel by ID.

func (*Client) GetDNSRecord added in v0.6.0 

func (c *Client) GetDNSRecord(zoneID, recordID string) (*DNSRecord, error)

GetDNSRecord retrieves a DNS record by ID from a zone

func (*Client) GetKVNamespace added in v0.20.0 

func (c *Client) GetKVNamespace(accountID, namespaceID string) (*KVNamespace, error)

GetKVNamespace retrieves a single Workers KV namespace by ID

func (*Client) GetKVValue added in v0.20.0 

func (c *Client) GetKVValue(accountID, namespaceID, key string) (string, error)

GetKVValue retrieves the value for a key from a Workers KV namespace. The Cloudflare API returns the raw value as the response body (not a JSON envelope).

func (*Client) GetLoadBalancer added in v0.21.0 

func (c *Client) GetLoadBalancer(zoneID, lbID string) (*LoadBalancer, error)

GetLoadBalancer retrieves a load balancer by ID for a given zone

func (*Client) GetMonitor added in v0.21.0 

func (c *Client) GetMonitor(accountID, monitorID string) (*Monitor, error)

func (*Client) GetOriginRulesetForPhase added in v0.20.0 

func (c *Client) GetOriginRulesetForPhase(zoneID string) (*OriginRuleset, error)

func (*Client) GetPool added in v0.20.0 

func (c *Client) GetPool(accountID, poolID string) (*Pool, error)

GetPool retrieves an origin pool by ID for a given account

func (*Client) GetRulesetForPhase 

func (c *Client) GetRulesetForPhase(zoneID, phase string) (*Ruleset, error)

GetRulesetForPhase gets the ruleset ID for a specific phase in a zone

func (*Client) GetWorkerSettings added in v0.21.0 

func (c *Client) GetWorkerSettings(accountID, scriptName string) (map[string]any, error)

GetWorkerSettings returns script settings (bindings, compatibility, etc.).

func (*Client) ListCFDTunnels added in v0.21.0 

func (c *Client) ListCFDTunnels(accountID string) ([]CFDTunnel, error)

ListCFDTunnels lists Cloudflare Tunnels for an account (non-deleted by default).

func (*Client) ListCertificatePacks added in v0.21.0 

func (c *Client) ListCertificatePacks(zoneID string) ([]CertificatePack, error)

func (*Client) ListDNSRecords added in v0.6.0 

func (c *Client) ListDNSRecords(zoneID string) ([]DNSRecord, error)

ListDNSRecords retrieves all DNS records for a zone

func (*Client) ListKVKeys added in v0.20.0 

func (c *Client) ListKVKeys(accountID, namespaceID string) ([]KVKey, error)

ListKVKeys returns all keys in a Workers KV namespace

func (*Client) ListKVNamespaces added in v0.20.0 

func (c *Client) ListKVNamespaces(accountID string) ([]KVNamespace, error)

ListKVNamespaces returns all Workers KV namespaces for an account

func (*Client) ListLoadBalancers added in v0.21.0 

func (c *Client) ListLoadBalancers(zoneID string) ([]LoadBalancer, error)

ListLoadBalancers lists all load balancers for a given zone

func (*Client) ListMonitorReferences added in v0.21.0 

func (c *Client) ListMonitorReferences(accountID, monitorID string) ([]MonitorReference, error)

func (*Client) ListMonitors added in v0.20.0 

func (c *Client) ListMonitors(accountID string) ([]Monitor, error)

func (*Client) ListOriginRules added in v0.20.0 

func (c *Client) ListOriginRules(zoneID string) ([]OriginRule, error)

func (*Client) ListPools added in v0.20.0 

func (c *Client) ListPools(accountID string) ([]Pool, error)

func (*Client) ListRedirectRules 

func (c *Client) ListRedirectRules(zoneID string) ([]RedirectRule, error)

ListRedirectRules retrieves all redirect rules for a zone

func (*Client) ListWorkerDeployments added in v0.21.0 

func (c *Client) ListWorkerDeployments(accountID, scriptName string) ([]map[string]any, error)

ListWorkerDeployments returns deployments for a script (newest first per API).

func (*Client) ListWorkerScripts added in v0.21.0 

func (c *Client) ListWorkerScripts(accountID string) ([]WorkerScriptSummary, error)

ListWorkerScripts lists uploaded Worker scripts for an account.

func (*Client) ListZones 

func (c *Client) ListZones() ([]Zone, error)

ListZones retrieves all zones accessible with the API token

func (*Client) OrderCertificatePack added in v0.21.0 

func (c *Client) OrderCertificatePack(zoneID string, req OrderCertificatePackRequest) (*CertificatePack, error)

func (*Client) PatchPoolMonitor added in v0.21.0 

func (c *Client) PatchPoolMonitor(accountID, poolID, monitorID string) (*Pool, error)

func (*Client) PurgeCache added in v0.21.0 

func (c *Client) PurgeCache(zoneID string, req PurgeCacheRequest) (*PurgeCacheResult, error)

func (*Client) PutKVValue added in v0.20.0 

func (c *Client) PutKVValue(accountID, namespaceID, key, value string, expirationTTL *int) error

PutKVValue writes a key-value pair to a Workers KV namespace using multipart/form-data

func (*Client) UpdateDNSRecord added in v0.6.0 

func (c *Client) UpdateDNSRecord(zoneID, recordID string, req UpdateDNSRecordRequest) (*DNSRecord, error)

UpdateDNSRecord updates an existing DNS record in a zone.

func (*Client) UpdateLoadBalancer added in v0.21.0 

func (c *Client) UpdateLoadBalancer(zoneID, lbID string, req UpdateLoadBalancerRequest) (*LoadBalancer, error)

UpdateLoadBalancer patches an existing load balancer

func (*Client) UpdateMonitor added in v0.21.0 

func (c *Client) UpdateMonitor(accountID, monitorID string, req CreateMonitorRequest) (*Monitor, error)

func (*Client) UpdateOriginRule added in v0.20.0 

func (c *Client) UpdateOriginRule(zoneID, rulesetID, ruleID string, req OriginRule) (*OriginRule, error)

func (*Client) UpdatePool added in v0.20.0 

func (c *Client) UpdatePool(accountID, poolID string, req UpdatePoolRequest) (*Pool, error)

UpdatePool updates an existing origin pool under a Cloudflare account

func (*Client) UpdateRedirectRule 

func (c *Client) UpdateRedirectRule(zoneID, rulesetID, ruleID string, req UpdateRedirectRuleRequest) (*RedirectRule, error)

UpdateRedirectRule updates a specific redirect rule in a zone's ruleset

func (*Client) UpdateWorkerRoute added in v0.21.0 

func (c *Client) UpdateWorkerRoute(zoneID, routeID, pattern, script string) (*WorkerRoute, error)

UpdateWorkerRoute updates an existing zone route.

func (*Client) UploadWorkerScriptVersion added in v0.21.0 

func (c *Client) UploadWorkerScriptVersion(accountID, scriptName string, metadata map[string]any, moduleContent string) (string, error)

UploadWorkerScriptVersion uploads a new Worker version using multipart/form-data (POST .../versions).

type Cloudflare 

type Cloudflare struct{}

func (*Cloudflare) Actions added in v0.6.0 

func (c *Cloudflare) Actions() []core.Action

func (*Cloudflare) Cleanup added in v0.6.0 

func (c *Cloudflare) Cleanup(ctx core.IntegrationCleanupContext) error

func (*Cloudflare) Configuration 

func (c *Cloudflare) Configuration() []configuration.Field

func (*Cloudflare) Description 

func (c *Cloudflare) Description() string

func (*Cloudflare) HandleHook added in v0.18.0 

func (c *Cloudflare) HandleHook(ctx core.IntegrationHookContext) error

func (*Cloudflare) HandleRequest 

func (c *Cloudflare) HandleRequest(ctx core.HTTPRequestContext)

func (*Cloudflare) Hooks added in v0.18.0 

func (c *Cloudflare) Hooks() []core.Hook

func (*Cloudflare) Icon 

func (c *Cloudflare) Icon() string

func (*Cloudflare) Instructions 

func (c *Cloudflare) Instructions() string

func (*Cloudflare) Label 

func (c *Cloudflare) Label() string

func (*Cloudflare) ListResources 

func (c *Cloudflare) ListResources(resourceType string, ctx core.ListResourcesContext) ([]core.IntegrationResource, error)

func (*Cloudflare) Name 

func (c *Cloudflare) Name() string

func (*Cloudflare) Sync 

func (c *Cloudflare) Sync(ctx core.SyncContext) error

func (*Cloudflare) Triggers 

func (c *Cloudflare) Triggers() []core.Trigger

type CloudflareAPIError added in v0.6.0 

type CloudflareAPIError struct {
	StatusCode int
	Errors     []CloudflareError
	Body       []byte
}

func (*CloudflareAPIError) Error added in v0.6.0 

func (e *CloudflareAPIError) Error() string

type CloudflareError added in v0.6.0 

type CloudflareError struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
}

type CloudflareWebhookHandler added in v0.21.0 

type CloudflareWebhookHandler struct{}

func (*CloudflareWebhookHandler) Cleanup added in v0.21.0 

func (h *CloudflareWebhookHandler) Cleanup(ctx core.WebhookHandlerContext) error

func (*CloudflareWebhookHandler) CompareConfig added in v0.21.0 

func (h *CloudflareWebhookHandler) CompareConfig(a, b any) (bool, error)

func (*CloudflareWebhookHandler) Merge added in v0.21.0 

func (h *CloudflareWebhookHandler) Merge(current, requested any) (any, bool, error)

func (*CloudflareWebhookHandler) Setup added in v0.21.0 

func (h *CloudflareWebhookHandler) Setup(ctx core.WebhookHandlerContext) (any, error)

type CloudflareWebhookMetadata added in v0.21.0 

type CloudflareWebhookMetadata struct {
	AccountID            string `json:"accountId" mapstructure:"accountId"`
	DestinationID        string `json:"destinationId" mapstructure:"destinationId"`
	NotificationPolicyID string `json:"notificationPolicyId" mapstructure:"notificationPolicyId"`
}

type Configuration 

type Configuration struct {
	APIToken  string `json:"apiToken"`
	AccountID string `json:"accountId"`
}

type Coordinates added in v0.20.0 

type Coordinates struct {
	Latitude  float64 `json:"latitude"`
	Longitude float64 `json:"longitude"`
}

Coordinates holds geographic coordinates used for proximity steering

type CoordinatesSpec added in v0.20.0 

type CoordinatesSpec struct {
	Latitude  float64 `json:"latitude"`
	Longitude float64 `json:"longitude"`
}

type CreateAlertingWebhookDestinationRequest added in v0.21.0 

type CreateAlertingWebhookDestinationRequest struct {
	Name   string `json:"name"`
	URL    string `json:"url"`
	Secret string `json:"secret,omitempty"`
}

type CreateCFDTunnelRequest added in v0.21.0 

type CreateCFDTunnelRequest struct {
	Name      string `json:"name"`
	ConfigSrc string `json:"config_src,omitempty"`
}

CreateCFDTunnelRequest is the payload for POST /accounts/{account_id}/cfd_tunnel

type CreateDNSRecord added in v0.6.0 

type CreateDNSRecord struct{}

func (*CreateDNSRecord) Cancel added in v0.6.0 

func (c *CreateDNSRecord) Cancel(ctx core.ExecutionContext) error

func (*CreateDNSRecord) Cleanup added in v0.7.0 

func (c *CreateDNSRecord) Cleanup(ctx core.SetupContext) error

func (*CreateDNSRecord) Color added in v0.6.0 

func (c *CreateDNSRecord) Color() string

func (*CreateDNSRecord) Configuration added in v0.6.0 

func (c *CreateDNSRecord) Configuration() []configuration.Field

func (*CreateDNSRecord) Description added in v0.6.0 

func (c *CreateDNSRecord) Description() string

func (*CreateDNSRecord) Documentation added in v0.6.0 

func (c *CreateDNSRecord) Documentation() string

func (*CreateDNSRecord) ExampleOutput added in v0.6.0 

func (c *CreateDNSRecord) ExampleOutput() map[string]any

func (*CreateDNSRecord) Execute added in v0.6.0 

func (c *CreateDNSRecord) Execute(ctx core.ExecutionContext) error

func (*CreateDNSRecord) HandleHook added in v0.18.0 

func (c *CreateDNSRecord) HandleHook(ctx core.ActionHookContext) error

func (*CreateDNSRecord) HandleWebhook added in v0.6.0 

func (c *CreateDNSRecord) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*CreateDNSRecord) Hooks added in v0.18.0 

func (c *CreateDNSRecord) Hooks() []core.Hook

func (*CreateDNSRecord) Icon added in v0.6.0 

func (c *CreateDNSRecord) Icon() string

func (*CreateDNSRecord) Label added in v0.6.0 

func (c *CreateDNSRecord) Label() string

func (*CreateDNSRecord) Name added in v0.6.0 

func (c *CreateDNSRecord) Name() string

func (*CreateDNSRecord) OutputChannels added in v0.6.0 

func (c *CreateDNSRecord) OutputChannels(configuration any) []core.OutputChannel

func (*CreateDNSRecord) ProcessQueueItem added in v0.6.0 

func (c *CreateDNSRecord) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*CreateDNSRecord) Setup added in v0.6.0 

func (c *CreateDNSRecord) Setup(ctx core.SetupContext) error

type CreateDNSRecordRequest added in v0.6.0 

type CreateDNSRecordRequest struct {
	Type     string `json:"type"`
	Name     string `json:"name"`
	Content  string `json:"content"`
	TTL      *int   `json:"ttl,omitempty"`
	Proxied  *bool  `json:"proxied,omitempty"`
	Priority *int   `json:"priority,omitempty"`
}

type CreateDNSRecordSpec added in v0.6.0 

type CreateDNSRecordSpec struct {
	Zone     string `json:"zone"`
	Type     string `json:"type"`
	Name     string `json:"name"`
	Content  string `json:"content"`
	TTL      *int   `json:"ttl"`
	Proxied  *bool  `json:"proxied"`
	Priority *int   `json:"priority"`
}

type CreateKVNamespace added in v0.20.0 

type CreateKVNamespace struct{}

func (*CreateKVNamespace) Cancel added in v0.20.0 

func (c *CreateKVNamespace) Cancel(ctx core.ExecutionContext) error

func (*CreateKVNamespace) Cleanup added in v0.20.0 

func (c *CreateKVNamespace) Cleanup(ctx core.SetupContext) error

func (*CreateKVNamespace) Color added in v0.20.0 

func (c *CreateKVNamespace) Color() string

func (*CreateKVNamespace) Configuration added in v0.20.0 

func (c *CreateKVNamespace) Configuration() []configuration.Field

func (*CreateKVNamespace) Description added in v0.20.0 

func (c *CreateKVNamespace) Description() string

func (*CreateKVNamespace) Documentation added in v0.20.0 

func (c *CreateKVNamespace) Documentation() string

func (*CreateKVNamespace) ExampleOutput added in v0.20.0 

func (c *CreateKVNamespace) ExampleOutput() map[string]any

func (*CreateKVNamespace) Execute added in v0.20.0 

func (c *CreateKVNamespace) Execute(ctx core.ExecutionContext) error

func (*CreateKVNamespace) HandleHook added in v0.20.0 

func (c *CreateKVNamespace) HandleHook(ctx core.ActionHookContext) error

func (*CreateKVNamespace) HandleWebhook added in v0.20.0 

func (c *CreateKVNamespace) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*CreateKVNamespace) Hooks added in v0.20.0 

func (c *CreateKVNamespace) Hooks() []core.Hook

func (*CreateKVNamespace) Icon added in v0.20.0 

func (c *CreateKVNamespace) Icon() string

func (*CreateKVNamespace) Label added in v0.20.0 

func (c *CreateKVNamespace) Label() string

func (*CreateKVNamespace) Name added in v0.20.0 

func (c *CreateKVNamespace) Name() string

func (*CreateKVNamespace) OutputChannels added in v0.20.0 

func (c *CreateKVNamespace) OutputChannels(configuration any) []core.OutputChannel

func (*CreateKVNamespace) ProcessQueueItem added in v0.20.0 

func (c *CreateKVNamespace) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*CreateKVNamespace) Setup added in v0.20.0 

func (c *CreateKVNamespace) Setup(ctx core.SetupContext) error

type CreateKVNamespaceRequest added in v0.20.0 

type CreateKVNamespaceRequest struct {
	Title string `json:"title"`
}

CreateKVNamespaceRequest is the payload for creating a KV namespace

type CreateKVNamespaceSpec added in v0.20.0 

type CreateKVNamespaceSpec struct {
	AccountID string `json:"accountId"`
	Title     string `json:"title"`
}

type CreateLoadBalancer added in v0.21.0 

type CreateLoadBalancer struct{}

func (*CreateLoadBalancer) Cancel added in v0.21.0 

func (c *CreateLoadBalancer) Cancel(ctx core.ExecutionContext) error

func (*CreateLoadBalancer) Cleanup added in v0.21.0 

func (c *CreateLoadBalancer) Cleanup(ctx core.SetupContext) error

func (*CreateLoadBalancer) Color added in v0.21.0 

func (c *CreateLoadBalancer) Color() string

func (*CreateLoadBalancer) Configuration added in v0.21.0 

func (c *CreateLoadBalancer) Configuration() []configuration.Field

func (*CreateLoadBalancer) Description added in v0.21.0 

func (c *CreateLoadBalancer) Description() string

func (*CreateLoadBalancer) Documentation added in v0.21.0 

func (c *CreateLoadBalancer) Documentation() string

func (*CreateLoadBalancer) ExampleOutput added in v0.21.0 

func (c *CreateLoadBalancer) ExampleOutput() map[string]any

func (*CreateLoadBalancer) Execute added in v0.21.0 

func (c *CreateLoadBalancer) Execute(ctx core.ExecutionContext) error

func (*CreateLoadBalancer) HandleHook added in v0.21.0 

func (c *CreateLoadBalancer) HandleHook(ctx core.ActionHookContext) error

func (*CreateLoadBalancer) HandleWebhook added in v0.21.0 

func (c *CreateLoadBalancer) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*CreateLoadBalancer) Hooks added in v0.21.0 

func (c *CreateLoadBalancer) Hooks() []core.Hook

func (*CreateLoadBalancer) Icon added in v0.21.0 

func (c *CreateLoadBalancer) Icon() string

func (*CreateLoadBalancer) Label added in v0.21.0 

func (c *CreateLoadBalancer) Label() string

func (*CreateLoadBalancer) Name added in v0.21.0 

func (c *CreateLoadBalancer) Name() string

func (*CreateLoadBalancer) OutputChannels added in v0.21.0 

func (c *CreateLoadBalancer) OutputChannels(configuration any) []core.OutputChannel

func (*CreateLoadBalancer) ProcessQueueItem added in v0.21.0 

func (c *CreateLoadBalancer) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*CreateLoadBalancer) Setup added in v0.21.0 

func (c *CreateLoadBalancer) Setup(ctx core.SetupContext) error

type CreateLoadBalancerRequest added in v0.21.0 

type CreateLoadBalancerRequest struct {
	Name                      string                     `json:"name"`
	Description               string                     `json:"description,omitempty"`
	Enabled                   *bool                      `json:"enabled,omitempty"`
	Proxied                   bool                       `json:"proxied"`
	TTL                       int                        `json:"ttl,omitempty"`
	FallbackPool              string                     `json:"fallback_pool"`
	DefaultPools              []string                   `json:"default_pools"`
	SteeringPolicy            string                     `json:"steering_policy,omitempty"`
	SessionAffinity           string                     `json:"session_affinity,omitempty"`
	SessionAffinityTTL        *int                       `json:"session_affinity_ttl,omitempty"`
	SessionAffinityAttributes *SessionAffinityAttributes `json:"session_affinity_attributes,omitempty"`
	RandomSteering            *RandomSteering            `json:"random_steering,omitempty"`
	Networks                  []string                   `json:"networks,omitempty"`
	Rules                     []LBRule                   `json:"rules,omitempty"`
	Monitor                   string                     `json:"monitor,omitempty"`
}

CreateLoadBalancerRequest is the payload for creating a load balancer

type CreateLoadBalancerSpec added in v0.21.0 

type CreateLoadBalancerSpec struct {
	Zone               string           `json:"zone"`
	Name               string           `json:"name"`
	Description        string           `json:"description"`
	Enabled            *bool            `json:"enabled"`
	Proxied            bool             `json:"proxied"`
	TTL                int              `json:"ttl"`
	FallbackPool       string           `json:"fallbackPool"`
	DefaultPools       []string         `json:"defaultPools"`
	SteeringPolicy     string           `json:"steeringPolicy"`
	SessionAffinity    string           `json:"sessionAffinity"`
	SessionAffinityTTL *int             `json:"sessionAffinityTtl"`
	PoolWeights        []PoolWeightSpec `json:"poolWeights"`
	NetworkVisibility  string           `json:"networkVisibility"`
	Networks           []string         `json:"networks"`
	Monitor            string           `json:"monitor"`
	Rules              []LBRuleSpec     `json:"rules"`
}

type CreateMonitor added in v0.21.0 

type CreateMonitor struct{}

func (*CreateMonitor) Cancel added in v0.21.0 

func (c *CreateMonitor) Cancel(ctx core.ExecutionContext) error

func (*CreateMonitor) Cleanup added in v0.21.0 

func (c *CreateMonitor) Cleanup(ctx core.SetupContext) error

func (*CreateMonitor) Color added in v0.21.0 

func (c *CreateMonitor) Color() string

func (*CreateMonitor) Configuration added in v0.21.0 

func (c *CreateMonitor) Configuration() []configuration.Field

func (*CreateMonitor) Description added in v0.21.0 

func (c *CreateMonitor) Description() string

func (*CreateMonitor) Documentation added in v0.21.0 

func (c *CreateMonitor) Documentation() string

func (*CreateMonitor) ExampleOutput added in v0.21.0 

func (c *CreateMonitor) ExampleOutput() map[string]any

func (*CreateMonitor) Execute added in v0.21.0 

func (c *CreateMonitor) Execute(ctx core.ExecutionContext) error

func (*CreateMonitor) HandleHook added in v0.21.0 

func (c *CreateMonitor) HandleHook(ctx core.ActionHookContext) error

func (*CreateMonitor) HandleWebhook added in v0.21.0 

func (c *CreateMonitor) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*CreateMonitor) Hooks added in v0.21.0 

func (c *CreateMonitor) Hooks() []core.Hook

func (*CreateMonitor) Icon added in v0.21.0 

func (c *CreateMonitor) Icon() string

func (*CreateMonitor) Label added in v0.21.0 

func (c *CreateMonitor) Label() string

func (*CreateMonitor) Name added in v0.21.0 

func (c *CreateMonitor) Name() string

func (*CreateMonitor) OutputChannels added in v0.21.0 

func (c *CreateMonitor) OutputChannels(configuration any) []core.OutputChannel

func (*CreateMonitor) ProcessQueueItem added in v0.21.0 

func (c *CreateMonitor) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*CreateMonitor) Setup added in v0.21.0 

func (c *CreateMonitor) Setup(ctx core.SetupContext) error

type CreateMonitorAdvancedSpec added in v0.21.0 

type CreateMonitorAdvancedSpec struct {
	Method          string          `json:"method"`
	ExpectedCodes   string          `json:"expectedCodes"`
	ExpectedBody    string          `json:"expectedBody"`
	Headers         []MonitorHeader `json:"headers"`
	FollowRedirects *bool           `json:"followRedirects"`
	AllowInsecure   *bool           `json:"allowInsecure"`
	ProbeZone       string          `json:"probeZone"`
	Interval        *int            `json:"interval"`
	Timeout         *int            `json:"timeout"`
	Retries         *int            `json:"retries"`
	ConsecutiveUp   *int            `json:"consecutiveUp"`
	ConsecutiveDown *int            `json:"consecutiveDown"`
}

type CreateMonitorRequest added in v0.21.0 

type CreateMonitorRequest struct {
	AllowInsecure   *bool               `json:"allow_insecure,omitempty"`
	ConsecutiveDown *int                `json:"consecutive_down,omitempty"`
	ConsecutiveUp   *int                `json:"consecutive_up,omitempty"`
	Description     string              `json:"description,omitempty"`
	ExpectedBody    string              `json:"expected_body,omitempty"`
	ExpectedCodes   string              `json:"expected_codes,omitempty"`
	FollowRedirects *bool               `json:"follow_redirects,omitempty"`
	Header          map[string][]string `json:"header,omitempty"`
	Interval        *int                `json:"interval,omitempty"`
	Method          string              `json:"method,omitempty"`
	Path            string              `json:"path,omitempty"`
	Port            *int                `json:"port,omitempty"`
	ProbeZone       string              `json:"probe_zone,omitempty"`
	Retries         *int                `json:"retries,omitempty"`
	Timeout         *int                `json:"timeout,omitempty"`
	Type            string              `json:"type"`
}

type CreateMonitorSpec added in v0.21.0 

type CreateMonitorSpec struct {
	Type        string                     `json:"type"`
	Description string                     `json:"description"`
	Path        string                     `json:"path"`
	Port        *int                       `json:"port"`
	Advanced    *CreateMonitorAdvancedSpec `json:"advanced"`
	Pool        string                     `json:"pool"`
	// Flat timing/threshold fields from legacy workflows or alongside partial `advanced`
	// objects when nested pointers are unset.
	Interval        *int `json:"interval,omitempty"`
	Timeout         *int `json:"timeout,omitempty"`
	Retries         *int `json:"retries,omitempty"`
	ConsecutiveUp   *int `json:"consecutiveUp,omitempty"`
	ConsecutiveDown *int `json:"consecutiveDown,omitempty"`
}

type CreateNotificationPolicyRequest added in v0.21.0 

type CreateNotificationPolicyRequest struct {
	AlertType   string                       `json:"alert_type"`
	Enabled     bool                         `json:"enabled"`
	Mechanisms  NotificationPolicyMechanisms `json:"mechanisms"`
	Name        string                       `json:"name"`
	Description string                       `json:"description,omitempty"`
	Filters     NotificationPolicyFilters    `json:"filters,omitempty"`
}

type CreateOriginRule added in v0.20.0 

type CreateOriginRule struct{}

func (*CreateOriginRule) Cancel added in v0.20.0 

func (c *CreateOriginRule) Cancel(ctx core.ExecutionContext) error

func (*CreateOriginRule) Cleanup added in v0.20.0 

func (c *CreateOriginRule) Cleanup(ctx core.SetupContext) error

func (*CreateOriginRule) Color added in v0.20.0 

func (c *CreateOriginRule) Color() string

func (*CreateOriginRule) Configuration added in v0.20.0 

func (c *CreateOriginRule) Configuration() []configuration.Field

func (*CreateOriginRule) Description added in v0.20.0 

func (c *CreateOriginRule) Description() string

func (*CreateOriginRule) Documentation added in v0.20.0 

func (c *CreateOriginRule) Documentation() string

func (*CreateOriginRule) ExampleOutput added in v0.20.0 

func (c *CreateOriginRule) ExampleOutput() map[string]any

func (*CreateOriginRule) Execute added in v0.20.0 

func (c *CreateOriginRule) Execute(ctx core.ExecutionContext) error

func (*CreateOriginRule) HandleHook added in v0.20.0 

func (c *CreateOriginRule) HandleHook(ctx core.ActionHookContext) error

func (*CreateOriginRule) HandleWebhook added in v0.20.0 

func (c *CreateOriginRule) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*CreateOriginRule) Hooks added in v0.20.0 

func (c *CreateOriginRule) Hooks() []core.Hook

func (*CreateOriginRule) Icon added in v0.20.0 

func (c *CreateOriginRule) Icon() string

func (*CreateOriginRule) Label added in v0.20.0 

func (c *CreateOriginRule) Label() string

func (*CreateOriginRule) Name added in v0.20.0 

func (c *CreateOriginRule) Name() string

func (*CreateOriginRule) OutputChannels added in v0.20.0 

func (c *CreateOriginRule) OutputChannels(configuration any) []core.OutputChannel

func (*CreateOriginRule) ProcessQueueItem added in v0.20.0 

func (c *CreateOriginRule) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*CreateOriginRule) Setup added in v0.20.0 

func (c *CreateOriginRule) Setup(ctx core.SetupContext) error

type CreateOriginRuleSpec added in v0.20.0 

type CreateOriginRuleSpec struct {
	Zone        string                `json:"zone" mapstructure:"zone"`
	Description string                `json:"description" mapstructure:"description"`
	MatchMode   string                `json:"matchMode" mapstructure:"matchMode"`
	MatchRules  []OriginRuleMatchRule `json:"matchRules" mapstructure:"matchRules"`
	Expression  string                `json:"expression" mapstructure:"expression"`
	OriginHost  *string               `json:"originHost" mapstructure:"originHost"`
	OriginPort  *int                  `json:"originPort" mapstructure:"originPort"`
	HostHeader  *string               `json:"hostHeader" mapstructure:"hostHeader"`
	SNI         *string               `json:"sni" mapstructure:"sni"`
	Enabled     *bool                 `json:"enabled" mapstructure:"enabled"`
}

type CreateOriginRulesetRequest added in v0.20.0 

type CreateOriginRulesetRequest struct {
	Name        string       `json:"name"`
	Description string       `json:"description,omitempty"`
	Kind        string       `json:"kind"`
	Phase       string       `json:"phase"`
	Rules       []OriginRule `json:"rules,omitempty"`
}

type CreatePool added in v0.20.0 

type CreatePool struct{}

func (*CreatePool) Cancel added in v0.20.0 

func (c *CreatePool) Cancel(ctx core.ExecutionContext) error

func (*CreatePool) Cleanup added in v0.20.0 

func (c *CreatePool) Cleanup(ctx core.SetupContext) error

func (*CreatePool) Color added in v0.20.0 

func (c *CreatePool) Color() string

func (*CreatePool) Configuration added in v0.20.0 

func (c *CreatePool) Configuration() []configuration.Field

func (*CreatePool) Description added in v0.20.0 

func (c *CreatePool) Description() string

func (*CreatePool) Documentation added in v0.20.0 

func (c *CreatePool) Documentation() string

func (*CreatePool) ExampleOutput added in v0.20.0 

func (c *CreatePool) ExampleOutput() map[string]any

func (*CreatePool) Execute added in v0.20.0 

func (c *CreatePool) Execute(ctx core.ExecutionContext) error

func (*CreatePool) HandleHook added in v0.20.0 

func (c *CreatePool) HandleHook(ctx core.ActionHookContext) error

func (*CreatePool) HandleWebhook added in v0.20.0 

func (c *CreatePool) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*CreatePool) Hooks added in v0.20.0 

func (c *CreatePool) Hooks() []core.Hook

func (*CreatePool) Icon added in v0.20.0 

func (c *CreatePool) Icon() string

func (*CreatePool) Label added in v0.20.0 

func (c *CreatePool) Label() string

func (*CreatePool) Name added in v0.20.0 

func (c *CreatePool) Name() string

func (*CreatePool) OutputChannels added in v0.20.0 

func (c *CreatePool) OutputChannels(configuration any) []core.OutputChannel

func (*CreatePool) ProcessQueueItem added in v0.20.0 

func (c *CreatePool) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*CreatePool) Setup added in v0.20.0 

func (c *CreatePool) Setup(ctx core.SetupContext) error

type CreatePoolRequest added in v0.20.0 

type CreatePoolRequest struct {
	Name           string          `json:"name"`
	Description    string          `json:"description,omitempty"`
	Enabled        bool            `json:"enabled"`
	MinimumOrigins *int            `json:"minimum_origins,omitempty"`
	Monitor        string          `json:"monitor,omitempty"`
	Origins        []Origin        `json:"origins"`
	LoadShedding   *LoadShedding   `json:"load_shedding,omitempty"`
	OriginSteering *OriginSteering `json:"origin_steering,omitempty"`
}

CreatePoolRequest is the payload for creating a pool

type CreatePoolSpec added in v0.20.0 

type CreatePoolSpec struct {
	AccountID            string            `json:"accountId"`
	Name                 string            `json:"name"`
	Description          string            `json:"description"`
	Enabled              *bool             `json:"enabled"`
	MinimumOrigins       *int              `json:"minimumOrigins"`
	Monitor              string            `json:"monitor"`
	Origins              []OriginSpec      `json:"origins"`
	OriginSteeringPolicy string            `json:"originSteeringPolicy"`
	LoadShedding         *LoadSheddingSpec `json:"loadShedding"`
}

type CreateRedirectRuleRequest 

type CreateRedirectRuleRequest struct {
	Action      string              `json:"action"`
	Expression  string              `json:"expression"`
	Description string              `json:"description,omitempty"`
	Enabled     bool                `json:"enabled"`
	ActionParam *RedirectActionData `json:"action_parameters,omitempty"`
}

CreateRedirectRuleRequest is the payload for creating a new redirect rule

type CreateTunnel added in v0.21.0 

type CreateTunnel struct{}

func (*CreateTunnel) Cancel added in v0.21.0 

func (c *CreateTunnel) Cancel(ctx core.ExecutionContext) error

func (*CreateTunnel) Cleanup added in v0.21.0 

func (c *CreateTunnel) Cleanup(ctx core.SetupContext) error

func (*CreateTunnel) Color added in v0.21.0 

func (c *CreateTunnel) Color() string

func (*CreateTunnel) Configuration added in v0.21.0 

func (c *CreateTunnel) Configuration() []configuration.Field

func (*CreateTunnel) Description added in v0.21.0 

func (c *CreateTunnel) Description() string

func (*CreateTunnel) Documentation added in v0.21.0 

func (c *CreateTunnel) Documentation() string

func (*CreateTunnel) ExampleOutput added in v0.21.0 

func (c *CreateTunnel) ExampleOutput() map[string]any

func (*CreateTunnel) Execute added in v0.21.0 

func (c *CreateTunnel) Execute(ctx core.ExecutionContext) error

func (*CreateTunnel) HandleHook added in v0.21.0 

func (c *CreateTunnel) HandleHook(ctx core.ActionHookContext) error

func (*CreateTunnel) HandleWebhook added in v0.21.0 

func (c *CreateTunnel) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*CreateTunnel) Hooks added in v0.21.0 

func (c *CreateTunnel) Hooks() []core.Hook

func (*CreateTunnel) Icon added in v0.21.0 

func (c *CreateTunnel) Icon() string

func (*CreateTunnel) Label added in v0.21.0 

func (c *CreateTunnel) Label() string

func (*CreateTunnel) Name added in v0.21.0 

func (c *CreateTunnel) Name() string

func (*CreateTunnel) OutputChannels added in v0.21.0 

func (c *CreateTunnel) OutputChannels(configuration any) []core.OutputChannel

func (*CreateTunnel) ProcessQueueItem added in v0.21.0 

func (c *CreateTunnel) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*CreateTunnel) Setup added in v0.21.0 

func (c *CreateTunnel) Setup(ctx core.SetupContext) error

type CreateTunnelSpec added in v0.21.0 

type CreateTunnelSpec struct {
	AccountID string `json:"accountId"`
	Name      string `json:"name"`
	ConfigSrc string `json:"configSrc"`
}

type DNSRecord added in v0.6.0 

type DNSRecord struct {
	ID       string `json:"id"`
	Type     string `json:"type"`
	Name     string `json:"name"`
	Content  string `json:"content"`
	TTL      int    `json:"ttl"`
	Proxied  bool   `json:"proxied"`
	Priority *int   `json:"priority,omitempty"`
}

DNSRecord represents a Cloudflare DNS record

type DeleteCertificatePack added in v0.21.0 

type DeleteCertificatePack struct{}

func (*DeleteCertificatePack) Cancel added in v0.21.0 

func (c *DeleteCertificatePack) Cancel(ctx core.ExecutionContext) error

func (*DeleteCertificatePack) Cleanup added in v0.21.0 

func (c *DeleteCertificatePack) Cleanup(ctx core.SetupContext) error

func (*DeleteCertificatePack) Color added in v0.21.0 

func (c *DeleteCertificatePack) Color() string

func (*DeleteCertificatePack) Configuration added in v0.21.0 

func (c *DeleteCertificatePack) Configuration() []configuration.Field

func (*DeleteCertificatePack) Description added in v0.21.0 

func (c *DeleteCertificatePack) Description() string

func (*DeleteCertificatePack) Documentation added in v0.21.0 

func (c *DeleteCertificatePack) Documentation() string

func (*DeleteCertificatePack) ExampleOutput added in v0.21.0 

func (c *DeleteCertificatePack) ExampleOutput() map[string]any

func (*DeleteCertificatePack) Execute added in v0.21.0 

func (c *DeleteCertificatePack) Execute(ctx core.ExecutionContext) error

func (*DeleteCertificatePack) HandleHook added in v0.21.0 

func (c *DeleteCertificatePack) HandleHook(ctx core.ActionHookContext) error

func (*DeleteCertificatePack) HandleWebhook added in v0.21.0 

func (c *DeleteCertificatePack) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*DeleteCertificatePack) Hooks added in v0.21.0 

func (c *DeleteCertificatePack) Hooks() []core.Hook

func (*DeleteCertificatePack) Icon added in v0.21.0 

func (c *DeleteCertificatePack) Icon() string

func (*DeleteCertificatePack) Label added in v0.21.0 

func (c *DeleteCertificatePack) Label() string

func (*DeleteCertificatePack) Name added in v0.21.0 

func (c *DeleteCertificatePack) Name() string

func (*DeleteCertificatePack) OutputChannels added in v0.21.0 

func (c *DeleteCertificatePack) OutputChannels(configuration any) []core.OutputChannel

func (*DeleteCertificatePack) ProcessQueueItem added in v0.21.0 

func (c *DeleteCertificatePack) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*DeleteCertificatePack) Setup added in v0.21.0 

func (c *DeleteCertificatePack) Setup(ctx core.SetupContext) error

type DeleteCertificatePackSpec added in v0.21.0 

type DeleteCertificatePackSpec struct {
	CertificatePack string `json:"certificatePack"`
}

type DeleteDNSRecord added in v0.6.0 

type DeleteDNSRecord struct{}

func (*DeleteDNSRecord) Cancel added in v0.6.0 

func (c *DeleteDNSRecord) Cancel(ctx core.ExecutionContext) error

func (*DeleteDNSRecord) Cleanup added in v0.7.0 

func (c *DeleteDNSRecord) Cleanup(ctx core.SetupContext) error

func (*DeleteDNSRecord) Color added in v0.6.0 

func (c *DeleteDNSRecord) Color() string

func (*DeleteDNSRecord) Configuration added in v0.6.0 

func (c *DeleteDNSRecord) Configuration() []configuration.Field

func (*DeleteDNSRecord) Description added in v0.6.0 

func (c *DeleteDNSRecord) Description() string

func (*DeleteDNSRecord) Documentation added in v0.6.0 

func (c *DeleteDNSRecord) Documentation() string

func (*DeleteDNSRecord) ExampleOutput added in v0.6.0 

func (c *DeleteDNSRecord) ExampleOutput() map[string]any

func (*DeleteDNSRecord) Execute added in v0.6.0 

func (c *DeleteDNSRecord) Execute(ctx core.ExecutionContext) error

func (*DeleteDNSRecord) HandleHook added in v0.18.0 

func (c *DeleteDNSRecord) HandleHook(ctx core.ActionHookContext) error

func (*DeleteDNSRecord) HandleWebhook added in v0.6.0 

func (c *DeleteDNSRecord) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*DeleteDNSRecord) Hooks added in v0.18.0 

func (c *DeleteDNSRecord) Hooks() []core.Hook

func (*DeleteDNSRecord) Icon added in v0.6.0 

func (c *DeleteDNSRecord) Icon() string

func (*DeleteDNSRecord) Label added in v0.6.0 

func (c *DeleteDNSRecord) Label() string

func (*DeleteDNSRecord) Name added in v0.6.0 

func (c *DeleteDNSRecord) Name() string

func (*DeleteDNSRecord) OutputChannels added in v0.6.0 

func (c *DeleteDNSRecord) OutputChannels(configuration any) []core.OutputChannel

func (*DeleteDNSRecord) ProcessQueueItem added in v0.6.0 

func (c *DeleteDNSRecord) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*DeleteDNSRecord) Setup added in v0.6.0 

func (c *DeleteDNSRecord) Setup(ctx core.SetupContext) error

type DeleteDNSRecordSpec added in v0.6.0 

type DeleteDNSRecordSpec struct {
	Record string `json:"record"`
}

type DeleteKVNamespace added in v0.20.0 

type DeleteKVNamespace struct{}

func (*DeleteKVNamespace) Cancel added in v0.20.0 

func (c *DeleteKVNamespace) Cancel(ctx core.ExecutionContext) error

func (*DeleteKVNamespace) Cleanup added in v0.20.0 

func (c *DeleteKVNamespace) Cleanup(ctx core.SetupContext) error

func (*DeleteKVNamespace) Color added in v0.20.0 

func (c *DeleteKVNamespace) Color() string

func (*DeleteKVNamespace) Configuration added in v0.20.0 

func (c *DeleteKVNamespace) Configuration() []configuration.Field

func (*DeleteKVNamespace) Description added in v0.20.0 

func (c *DeleteKVNamespace) Description() string

func (*DeleteKVNamespace) Documentation added in v0.20.0 

func (c *DeleteKVNamespace) Documentation() string

func (*DeleteKVNamespace) ExampleOutput added in v0.20.0 

func (c *DeleteKVNamespace) ExampleOutput() map[string]any

func (*DeleteKVNamespace) Execute added in v0.20.0 

func (c *DeleteKVNamespace) Execute(ctx core.ExecutionContext) error

func (*DeleteKVNamespace) HandleHook added in v0.20.0 

func (c *DeleteKVNamespace) HandleHook(ctx core.ActionHookContext) error

func (*DeleteKVNamespace) HandleWebhook added in v0.20.0 

func (c *DeleteKVNamespace) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*DeleteKVNamespace) Hooks added in v0.20.0 

func (c *DeleteKVNamespace) Hooks() []core.Hook

func (*DeleteKVNamespace) Icon added in v0.20.0 

func (c *DeleteKVNamespace) Icon() string

func (*DeleteKVNamespace) Label added in v0.20.0 

func (c *DeleteKVNamespace) Label() string

func (*DeleteKVNamespace) Name added in v0.20.0 

func (c *DeleteKVNamespace) Name() string

func (*DeleteKVNamespace) OutputChannels added in v0.20.0 

func (c *DeleteKVNamespace) OutputChannels(configuration any) []core.OutputChannel

func (*DeleteKVNamespace) ProcessQueueItem added in v0.20.0 

func (c *DeleteKVNamespace) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*DeleteKVNamespace) Setup added in v0.20.0 

func (c *DeleteKVNamespace) Setup(ctx core.SetupContext) error

type DeleteKVNamespaceSpec added in v0.20.0 

type DeleteKVNamespaceSpec struct {
	AccountID string `json:"accountId"`
	Namespace string `json:"namespace"`
}

type DeleteKVValue added in v0.20.0 

type DeleteKVValue struct{}

func (*DeleteKVValue) Cancel added in v0.20.0 

func (c *DeleteKVValue) Cancel(ctx core.ExecutionContext) error

func (*DeleteKVValue) Cleanup added in v0.20.0 

func (c *DeleteKVValue) Cleanup(ctx core.SetupContext) error

func (*DeleteKVValue) Color added in v0.20.0 

func (c *DeleteKVValue) Color() string

func (*DeleteKVValue) Configuration added in v0.20.0 

func (c *DeleteKVValue) Configuration() []configuration.Field

func (*DeleteKVValue) Description added in v0.20.0 

func (c *DeleteKVValue) Description() string

func (*DeleteKVValue) Documentation added in v0.20.0 

func (c *DeleteKVValue) Documentation() string

func (*DeleteKVValue) ExampleOutput added in v0.20.0 

func (c *DeleteKVValue) ExampleOutput() map[string]any

func (*DeleteKVValue) Execute added in v0.20.0 

func (c *DeleteKVValue) Execute(ctx core.ExecutionContext) error

func (*DeleteKVValue) HandleHook added in v0.20.0 

func (c *DeleteKVValue) HandleHook(ctx core.ActionHookContext) error

func (*DeleteKVValue) HandleWebhook added in v0.20.0 

func (c *DeleteKVValue) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*DeleteKVValue) Hooks added in v0.20.0 

func (c *DeleteKVValue) Hooks() []core.Hook

func (*DeleteKVValue) Icon added in v0.20.0 

func (c *DeleteKVValue) Icon() string

func (*DeleteKVValue) Label added in v0.20.0 

func (c *DeleteKVValue) Label() string

func (*DeleteKVValue) Name added in v0.20.0 

func (c *DeleteKVValue) Name() string

func (*DeleteKVValue) OutputChannels added in v0.20.0 

func (c *DeleteKVValue) OutputChannels(configuration any) []core.OutputChannel

func (*DeleteKVValue) ProcessQueueItem added in v0.20.0 

func (c *DeleteKVValue) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*DeleteKVValue) Setup added in v0.20.0 

func (c *DeleteKVValue) Setup(ctx core.SetupContext) error

type DeleteKVValueSpec added in v0.20.0 

type DeleteKVValueSpec struct {
	AccountID string `json:"accountId"`
	Namespace string `json:"namespace"`
	KVKey     string `json:"kvKey"`
}

type DeleteLoadBalancer added in v0.21.0 

type DeleteLoadBalancer struct{}

func (*DeleteLoadBalancer) Cancel added in v0.21.0 

func (c *DeleteLoadBalancer) Cancel(ctx core.ExecutionContext) error

func (*DeleteLoadBalancer) Cleanup added in v0.21.0 

func (c *DeleteLoadBalancer) Cleanup(ctx core.SetupContext) error

func (*DeleteLoadBalancer) Color added in v0.21.0 

func (c *DeleteLoadBalancer) Color() string

func (*DeleteLoadBalancer) Configuration added in v0.21.0 

func (c *DeleteLoadBalancer) Configuration() []configuration.Field

func (*DeleteLoadBalancer) Description added in v0.21.0 

func (c *DeleteLoadBalancer) Description() string

func (*DeleteLoadBalancer) Documentation added in v0.21.0 

func (c *DeleteLoadBalancer) Documentation() string

func (*DeleteLoadBalancer) ExampleOutput added in v0.21.0 

func (c *DeleteLoadBalancer) ExampleOutput() map[string]any

func (*DeleteLoadBalancer) Execute added in v0.21.0 

func (c *DeleteLoadBalancer) Execute(ctx core.ExecutionContext) error

func (*DeleteLoadBalancer) HandleHook added in v0.21.0 

func (c *DeleteLoadBalancer) HandleHook(ctx core.ActionHookContext) error

func (*DeleteLoadBalancer) HandleWebhook added in v0.21.0 

func (c *DeleteLoadBalancer) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*DeleteLoadBalancer) Hooks added in v0.21.0 

func (c *DeleteLoadBalancer) Hooks() []core.Hook

func (*DeleteLoadBalancer) Icon added in v0.21.0 

func (c *DeleteLoadBalancer) Icon() string

func (*DeleteLoadBalancer) Label added in v0.21.0 

func (c *DeleteLoadBalancer) Label() string

func (*DeleteLoadBalancer) Name added in v0.21.0 

func (c *DeleteLoadBalancer) Name() string

func (*DeleteLoadBalancer) OutputChannels added in v0.21.0 

func (c *DeleteLoadBalancer) OutputChannels(configuration any) []core.OutputChannel

func (*DeleteLoadBalancer) ProcessQueueItem added in v0.21.0 

func (c *DeleteLoadBalancer) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*DeleteLoadBalancer) Setup added in v0.21.0 

func (c *DeleteLoadBalancer) Setup(ctx core.SetupContext) error

type DeleteLoadBalancerSpec added in v0.21.0 

type DeleteLoadBalancerSpec struct {
	LoadBalancer string `json:"loadBalancer"`
}

type DeleteMonitor added in v0.21.0 

type DeleteMonitor struct{}

func (*DeleteMonitor) Cancel added in v0.21.0 

func (c *DeleteMonitor) Cancel(ctx core.ExecutionContext) error

func (*DeleteMonitor) Cleanup added in v0.21.0 

func (c *DeleteMonitor) Cleanup(ctx core.SetupContext) error

func (*DeleteMonitor) Color added in v0.21.0 

func (c *DeleteMonitor) Color() string

func (*DeleteMonitor) Configuration added in v0.21.0 

func (c *DeleteMonitor) Configuration() []configuration.Field

func (*DeleteMonitor) Description added in v0.21.0 

func (c *DeleteMonitor) Description() string

func (*DeleteMonitor) Documentation added in v0.21.0 

func (c *DeleteMonitor) Documentation() string

func (*DeleteMonitor) ExampleOutput added in v0.21.0 

func (c *DeleteMonitor) ExampleOutput() map[string]any

func (*DeleteMonitor) Execute added in v0.21.0 

func (c *DeleteMonitor) Execute(ctx core.ExecutionContext) error

func (*DeleteMonitor) HandleHook added in v0.21.0 

func (c *DeleteMonitor) HandleHook(ctx core.ActionHookContext) error

func (*DeleteMonitor) HandleWebhook added in v0.21.0 

func (c *DeleteMonitor) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*DeleteMonitor) Hooks added in v0.21.0 

func (c *DeleteMonitor) Hooks() []core.Hook

func (*DeleteMonitor) Icon added in v0.21.0 

func (c *DeleteMonitor) Icon() string

func (*DeleteMonitor) Label added in v0.21.0 

func (c *DeleteMonitor) Label() string

func (*DeleteMonitor) Name added in v0.21.0 

func (c *DeleteMonitor) Name() string

func (*DeleteMonitor) OutputChannels added in v0.21.0 

func (c *DeleteMonitor) OutputChannels(configuration any) []core.OutputChannel

func (*DeleteMonitor) ProcessQueueItem added in v0.21.0 

func (c *DeleteMonitor) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*DeleteMonitor) Setup added in v0.21.0 

func (c *DeleteMonitor) Setup(ctx core.SetupContext) error

type DeleteMonitorResponse added in v0.21.0 

type DeleteMonitorResponse struct {
	ID string `json:"id,omitempty"`
}

type DeleteMonitorSpec added in v0.21.0 

type DeleteMonitorSpec struct {
	Monitor string `json:"monitor"`
	Force   bool   `json:"force"`
}

type DeleteOriginRule added in v0.20.0 

type DeleteOriginRule struct{}

func (*DeleteOriginRule) Cancel added in v0.20.0 

func (c *DeleteOriginRule) Cancel(ctx core.ExecutionContext) error

func (*DeleteOriginRule) Cleanup added in v0.20.0 

func (c *DeleteOriginRule) Cleanup(ctx core.SetupContext) error

func (*DeleteOriginRule) Color added in v0.20.0 

func (c *DeleteOriginRule) Color() string

func (*DeleteOriginRule) Configuration added in v0.20.0 

func (c *DeleteOriginRule) Configuration() []configuration.Field

func (*DeleteOriginRule) Description added in v0.20.0 

func (c *DeleteOriginRule) Description() string

func (*DeleteOriginRule) Documentation added in v0.20.0 

func (c *DeleteOriginRule) Documentation() string

func (*DeleteOriginRule) ExampleOutput added in v0.20.0 

func (c *DeleteOriginRule) ExampleOutput() map[string]any

func (*DeleteOriginRule) Execute added in v0.20.0 

func (c *DeleteOriginRule) Execute(ctx core.ExecutionContext) error

func (*DeleteOriginRule) HandleHook added in v0.20.0 

func (c *DeleteOriginRule) HandleHook(ctx core.ActionHookContext) error

func (*DeleteOriginRule) HandleWebhook added in v0.20.0 

func (c *DeleteOriginRule) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*DeleteOriginRule) Hooks added in v0.20.0 

func (c *DeleteOriginRule) Hooks() []core.Hook

func (*DeleteOriginRule) Icon added in v0.20.0 

func (c *DeleteOriginRule) Icon() string

func (*DeleteOriginRule) Label added in v0.20.0 

func (c *DeleteOriginRule) Label() string

func (*DeleteOriginRule) Name added in v0.20.0 

func (c *DeleteOriginRule) Name() string

func (*DeleteOriginRule) OutputChannels added in v0.20.0 

func (c *DeleteOriginRule) OutputChannels(configuration any) []core.OutputChannel

func (*DeleteOriginRule) ProcessQueueItem added in v0.20.0 

func (c *DeleteOriginRule) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*DeleteOriginRule) Setup added in v0.20.0 

func (c *DeleteOriginRule) Setup(ctx core.SetupContext) error

type DeleteOriginRuleSpec added in v0.20.0 

type DeleteOriginRuleSpec struct {
	Rule string `json:"rule"`
}

type DeletePool added in v0.20.0 

type DeletePool struct{}

func (*DeletePool) Cancel added in v0.20.0 

func (c *DeletePool) Cancel(ctx core.ExecutionContext) error

func (*DeletePool) Cleanup added in v0.20.0 

func (c *DeletePool) Cleanup(ctx core.SetupContext) error

func (*DeletePool) Color added in v0.20.0 

func (c *DeletePool) Color() string

func (*DeletePool) Configuration added in v0.20.0 

func (c *DeletePool) Configuration() []configuration.Field

func (*DeletePool) Description added in v0.20.0 

func (c *DeletePool) Description() string

func (*DeletePool) Documentation added in v0.20.0 

func (c *DeletePool) Documentation() string

func (*DeletePool) ExampleOutput added in v0.20.0 

func (c *DeletePool) ExampleOutput() map[string]any

func (*DeletePool) Execute added in v0.20.0 

func (c *DeletePool) Execute(ctx core.ExecutionContext) error

func (*DeletePool) HandleHook added in v0.20.0 

func (c *DeletePool) HandleHook(ctx core.ActionHookContext) error

func (*DeletePool) HandleWebhook added in v0.20.0 

func (c *DeletePool) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*DeletePool) Hooks added in v0.20.0 

func (c *DeletePool) Hooks() []core.Hook

func (*DeletePool) Icon added in v0.20.0 

func (c *DeletePool) Icon() string

func (*DeletePool) Label added in v0.20.0 

func (c *DeletePool) Label() string

func (*DeletePool) Name added in v0.20.0 

func (c *DeletePool) Name() string

func (*DeletePool) OutputChannels added in v0.20.0 

func (c *DeletePool) OutputChannels(configuration any) []core.OutputChannel

func (*DeletePool) ProcessQueueItem added in v0.20.0 

func (c *DeletePool) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*DeletePool) Setup added in v0.20.0 

func (c *DeletePool) Setup(ctx core.SetupContext) error

type DeletePoolSpec added in v0.20.0 

type DeletePoolSpec struct {
	AccountID string `json:"accountId"`
	Pool      string `json:"pool"`
}

type DeleteTunnel added in v0.21.0 

type DeleteTunnel struct{}

func (*DeleteTunnel) Cancel added in v0.21.0 

func (c *DeleteTunnel) Cancel(ctx core.ExecutionContext) error

func (*DeleteTunnel) Cleanup added in v0.21.0 

func (c *DeleteTunnel) Cleanup(ctx core.SetupContext) error

func (*DeleteTunnel) Color added in v0.21.0 

func (c *DeleteTunnel) Color() string

func (*DeleteTunnel) Configuration added in v0.21.0 

func (c *DeleteTunnel) Configuration() []configuration.Field

func (*DeleteTunnel) Description added in v0.21.0 

func (c *DeleteTunnel) Description() string

func (*DeleteTunnel) Documentation added in v0.21.0 

func (c *DeleteTunnel) Documentation() string

func (*DeleteTunnel) ExampleOutput added in v0.21.0 

func (c *DeleteTunnel) ExampleOutput() map[string]any

func (*DeleteTunnel) Execute added in v0.21.0 

func (c *DeleteTunnel) Execute(ctx core.ExecutionContext) error

func (*DeleteTunnel) HandleHook added in v0.21.0 

func (c *DeleteTunnel) HandleHook(ctx core.ActionHookContext) error

func (*DeleteTunnel) HandleWebhook added in v0.21.0 

func (c *DeleteTunnel) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*DeleteTunnel) Hooks added in v0.21.0 

func (c *DeleteTunnel) Hooks() []core.Hook

func (*DeleteTunnel) Icon added in v0.21.0 

func (c *DeleteTunnel) Icon() string

func (*DeleteTunnel) Label added in v0.21.0 

func (c *DeleteTunnel) Label() string

func (*DeleteTunnel) Name added in v0.21.0 

func (c *DeleteTunnel) Name() string

func (*DeleteTunnel) OutputChannels added in v0.21.0 

func (c *DeleteTunnel) OutputChannels(configuration any) []core.OutputChannel

func (*DeleteTunnel) ProcessQueueItem added in v0.21.0 

func (c *DeleteTunnel) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*DeleteTunnel) Setup added in v0.21.0 

func (c *DeleteTunnel) Setup(ctx core.SetupContext) error

type DeleteTunnelSpec added in v0.21.0 

type DeleteTunnelSpec struct {
	AccountID string `json:"accountId"`
	Tunnel    string `json:"tunnel"`
}

type DeleteWorker added in v0.21.0 

type DeleteWorker struct{}

func (*DeleteWorker) Cancel added in v0.21.0 

func (d *DeleteWorker) Cancel(ctx core.ExecutionContext) error

func (*DeleteWorker) Cleanup added in v0.21.0 

func (d *DeleteWorker) Cleanup(ctx core.SetupContext) error

func (*DeleteWorker) Color added in v0.21.0 

func (d *DeleteWorker) Color() string

func (*DeleteWorker) Configuration added in v0.21.0 

func (d *DeleteWorker) Configuration() []configuration.Field

func (*DeleteWorker) Description added in v0.21.0 

func (d *DeleteWorker) Description() string

func (*DeleteWorker) Documentation added in v0.21.0 

func (d *DeleteWorker) Documentation() string

func (*DeleteWorker) ExampleOutput added in v0.21.0 

func (d *DeleteWorker) ExampleOutput() map[string]any

func (*DeleteWorker) Execute added in v0.21.0 

func (d *DeleteWorker) Execute(ctx core.ExecutionContext) error

func (*DeleteWorker) HandleHook added in v0.21.0 

func (d *DeleteWorker) HandleHook(ctx core.ActionHookContext) error

func (*DeleteWorker) HandleWebhook added in v0.21.0 

func (d *DeleteWorker) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*DeleteWorker) Hooks added in v0.21.0 

func (d *DeleteWorker) Hooks() []core.Hook

func (*DeleteWorker) Icon added in v0.21.0 

func (d *DeleteWorker) Icon() string

func (*DeleteWorker) Label added in v0.21.0 

func (d *DeleteWorker) Label() string

func (*DeleteWorker) Name added in v0.21.0 

func (d *DeleteWorker) Name() string

func (*DeleteWorker) OutputChannels added in v0.21.0 

func (d *DeleteWorker) OutputChannels(configuration any) []core.OutputChannel

func (*DeleteWorker) ProcessQueueItem added in v0.21.0 

func (d *DeleteWorker) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*DeleteWorker) Setup added in v0.21.0 

func (d *DeleteWorker) Setup(ctx core.SetupContext) error

type DeleteWorkerSpec added in v0.21.0 

type DeleteWorkerSpec struct {
	AccountID    string `json:"accountId"`
	WorkerScript string `json:"workerScript"`
	Force        *bool  `json:"force"`
}

type DeployWorker added in v0.21.0 

type DeployWorker struct{}

func (*DeployWorker) Cancel added in v0.21.0 

func (d *DeployWorker) Cancel(ctx core.ExecutionContext) error

func (*DeployWorker) Cleanup added in v0.21.0 

func (d *DeployWorker) Cleanup(ctx core.SetupContext) error

func (*DeployWorker) Color added in v0.21.0 

func (d *DeployWorker) Color() string

func (*DeployWorker) Configuration added in v0.21.0 

func (d *DeployWorker) Configuration() []configuration.Field

func (*DeployWorker) Description added in v0.21.0 

func (d *DeployWorker) Description() string

func (*DeployWorker) Documentation added in v0.21.0 

func (d *DeployWorker) Documentation() string

func (*DeployWorker) ExampleOutput added in v0.21.0 

func (d *DeployWorker) ExampleOutput() map[string]any

func (*DeployWorker) Execute added in v0.21.0 

func (d *DeployWorker) Execute(ctx core.ExecutionContext) error

func (*DeployWorker) HandleHook added in v0.21.0 

func (d *DeployWorker) HandleHook(ctx core.ActionHookContext) error

func (*DeployWorker) HandleWebhook added in v0.21.0 

func (d *DeployWorker) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*DeployWorker) Hooks added in v0.21.0 

func (d *DeployWorker) Hooks() []core.Hook

func (*DeployWorker) Icon added in v0.21.0 

func (d *DeployWorker) Icon() string

func (*DeployWorker) Label added in v0.21.0 

func (d *DeployWorker) Label() string

func (*DeployWorker) Name added in v0.21.0 

func (d *DeployWorker) Name() string

func (*DeployWorker) OutputChannels added in v0.21.0 

func (d *DeployWorker) OutputChannels(configuration any) []core.OutputChannel

func (*DeployWorker) ProcessQueueItem added in v0.21.0 

func (d *DeployWorker) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*DeployWorker) Setup added in v0.21.0 

func (d *DeployWorker) Setup(ctx core.SetupContext) error

type DeployWorkerProvision added in v0.21.0 

type DeployWorkerProvision struct {
	Tags                          string `json:"tags"`
	Logpush                       *bool  `json:"logpush"`
	ObservabilityEnabled          *bool  `json:"observabilityEnabled"`
	ObservabilityHeadSamplingRate string `json:"observabilityHeadSamplingRate"`
	SubdomainEnabled              *bool  `json:"subdomainEnabled"`
	SubdomainPreviewsEnabled      *bool  `json:"subdomainPreviewsEnabled"`
	TailConsumers                 string `json:"tailConsumers"`
}

DeployWorkerProvision holds optional Create Worker metadata when provision runs.

type DeployWorkerSpec added in v0.21.0 

type DeployWorkerSpec struct {
	AccountID          string                 `json:"accountId"`
	ScriptName         string                 `json:"scriptName"`
	ProvisionIfMissing *bool                  `json:"provisionIfMissing"`
	Provision          *DeployWorkerProvision `json:"provision"`
	Source             string                 `json:"source"`
	InlineCode         *string                `json:"inlineCode,omitempty"`
	ScriptURL          *string                `json:"scriptUrl,omitempty"`
	CompatibilityDate  string                 `json:"compatibilityDate"`
	CompatibilityFlags string                 `json:"compatibilityFlags"`
	DeploymentMessage  string                 `json:"deploymentMessage"`
}

type GetKVValue added in v0.20.0 

type GetKVValue struct{}

func (*GetKVValue) Cancel added in v0.20.0 

func (c *GetKVValue) Cancel(ctx core.ExecutionContext) error

func (*GetKVValue) Cleanup added in v0.20.0 

func (c *GetKVValue) Cleanup(ctx core.SetupContext) error

func (*GetKVValue) Color added in v0.20.0 

func (c *GetKVValue) Color() string

func (*GetKVValue) Configuration added in v0.20.0 

func (c *GetKVValue) Configuration() []configuration.Field

func (*GetKVValue) Description added in v0.20.0 

func (c *GetKVValue) Description() string

func (*GetKVValue) Documentation added in v0.20.0 

func (c *GetKVValue) Documentation() string

func (*GetKVValue) ExampleOutput added in v0.20.0 

func (c *GetKVValue) ExampleOutput() map[string]any

func (*GetKVValue) Execute added in v0.20.0 

func (c *GetKVValue) Execute(ctx core.ExecutionContext) error

func (*GetKVValue) HandleHook added in v0.20.0 

func (c *GetKVValue) HandleHook(ctx core.ActionHookContext) error

func (*GetKVValue) HandleWebhook added in v0.20.0 

func (c *GetKVValue) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*GetKVValue) Hooks added in v0.20.0 

func (c *GetKVValue) Hooks() []core.Hook

func (*GetKVValue) Icon added in v0.20.0 

func (c *GetKVValue) Icon() string

func (*GetKVValue) Label added in v0.20.0 

func (c *GetKVValue) Label() string

func (*GetKVValue) Name added in v0.20.0 

func (c *GetKVValue) Name() string

func (*GetKVValue) OutputChannels added in v0.20.0 

func (c *GetKVValue) OutputChannels(configuration any) []core.OutputChannel

func (*GetKVValue) ProcessQueueItem added in v0.20.0 

func (c *GetKVValue) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*GetKVValue) Setup added in v0.20.0 

func (c *GetKVValue) Setup(ctx core.SetupContext) error

type GetKVValueSpec added in v0.20.0 

type GetKVValueSpec struct {
	AccountID string `json:"accountId"`
	Namespace string `json:"namespace"`
	KVKey     string `json:"kvKey"`
}

type GetLoadBalancer added in v0.21.0 

type GetLoadBalancer struct{}

func (*GetLoadBalancer) Cancel added in v0.21.0 

func (c *GetLoadBalancer) Cancel(ctx core.ExecutionContext) error

func (*GetLoadBalancer) Cleanup added in v0.21.0 

func (c *GetLoadBalancer) Cleanup(ctx core.SetupContext) error

func (*GetLoadBalancer) Color added in v0.21.0 

func (c *GetLoadBalancer) Color() string

func (*GetLoadBalancer) Configuration added in v0.21.0 

func (c *GetLoadBalancer) Configuration() []configuration.Field

func (*GetLoadBalancer) Description added in v0.21.0 

func (c *GetLoadBalancer) Description() string

func (*GetLoadBalancer) Documentation added in v0.21.0 

func (c *GetLoadBalancer) Documentation() string

func (*GetLoadBalancer) ExampleOutput added in v0.21.0 

func (c *GetLoadBalancer) ExampleOutput() map[string]any

func (*GetLoadBalancer) Execute added in v0.21.0 

func (c *GetLoadBalancer) Execute(ctx core.ExecutionContext) error

func (*GetLoadBalancer) HandleHook added in v0.21.0 

func (c *GetLoadBalancer) HandleHook(ctx core.ActionHookContext) error

func (*GetLoadBalancer) HandleWebhook added in v0.21.0 

func (c *GetLoadBalancer) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*GetLoadBalancer) Hooks added in v0.21.0 

func (c *GetLoadBalancer) Hooks() []core.Hook

func (*GetLoadBalancer) Icon added in v0.21.0 

func (c *GetLoadBalancer) Icon() string

func (*GetLoadBalancer) Label added in v0.21.0 

func (c *GetLoadBalancer) Label() string

func (*GetLoadBalancer) Name added in v0.21.0 

func (c *GetLoadBalancer) Name() string

func (*GetLoadBalancer) OutputChannels added in v0.21.0 

func (c *GetLoadBalancer) OutputChannels(configuration any) []core.OutputChannel

func (*GetLoadBalancer) ProcessQueueItem added in v0.21.0 

func (c *GetLoadBalancer) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*GetLoadBalancer) Setup added in v0.21.0 

func (c *GetLoadBalancer) Setup(ctx core.SetupContext) error

type GetLoadBalancerSpec added in v0.21.0 

type GetLoadBalancerSpec struct {
	LoadBalancer string `json:"loadBalancer"` // composite "zoneId/lbId"
}

type GetMonitor added in v0.21.0 

type GetMonitor struct{}

func (*GetMonitor) Cancel added in v0.21.0 

func (c *GetMonitor) Cancel(ctx core.ExecutionContext) error

func (*GetMonitor) Cleanup added in v0.21.0 

func (c *GetMonitor) Cleanup(ctx core.SetupContext) error

func (*GetMonitor) Color added in v0.21.0 

func (c *GetMonitor) Color() string

func (*GetMonitor) Configuration added in v0.21.0 

func (c *GetMonitor) Configuration() []configuration.Field

func (*GetMonitor) Description added in v0.21.0 

func (c *GetMonitor) Description() string

func (*GetMonitor) Documentation added in v0.21.0 

func (c *GetMonitor) Documentation() string

func (*GetMonitor) ExampleOutput added in v0.21.0 

func (c *GetMonitor) ExampleOutput() map[string]any

func (*GetMonitor) Execute added in v0.21.0 

func (c *GetMonitor) Execute(ctx core.ExecutionContext) error

func (*GetMonitor) HandleHook added in v0.21.0 

func (c *GetMonitor) HandleHook(ctx core.ActionHookContext) error

func (*GetMonitor) HandleWebhook added in v0.21.0 

func (c *GetMonitor) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*GetMonitor) Hooks added in v0.21.0 

func (c *GetMonitor) Hooks() []core.Hook

func (*GetMonitor) Icon added in v0.21.0 

func (c *GetMonitor) Icon() string

func (*GetMonitor) Label added in v0.21.0 

func (c *GetMonitor) Label() string

func (*GetMonitor) Name added in v0.21.0 

func (c *GetMonitor) Name() string

func (*GetMonitor) OutputChannels added in v0.21.0 

func (c *GetMonitor) OutputChannels(configuration any) []core.OutputChannel

func (*GetMonitor) ProcessQueueItem added in v0.21.0 

func (c *GetMonitor) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*GetMonitor) Setup added in v0.21.0 

func (c *GetMonitor) Setup(ctx core.SetupContext) error

type GetMonitorSpec added in v0.21.0 

type GetMonitorSpec struct {
	Monitor string `json:"monitor"`
}

type GetPool added in v0.20.0 

type GetPool struct{}

func (*GetPool) Cancel added in v0.20.0 

func (c *GetPool) Cancel(ctx core.ExecutionContext) error

func (*GetPool) Cleanup added in v0.20.0 

func (c *GetPool) Cleanup(ctx core.SetupContext) error

func (*GetPool) Color added in v0.20.0 

func (c *GetPool) Color() string

func (*GetPool) Configuration added in v0.20.0 

func (c *GetPool) Configuration() []configuration.Field

func (*GetPool) Description added in v0.20.0 

func (c *GetPool) Description() string

func (*GetPool) Documentation added in v0.20.0 

func (c *GetPool) Documentation() string

func (*GetPool) ExampleOutput added in v0.20.0 

func (c *GetPool) ExampleOutput() map[string]any

func (*GetPool) Execute added in v0.20.0 

func (c *GetPool) Execute(ctx core.ExecutionContext) error

func (*GetPool) HandleHook added in v0.20.0 

func (c *GetPool) HandleHook(ctx core.ActionHookContext) error

func (*GetPool) HandleWebhook added in v0.20.0 

func (c *GetPool) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*GetPool) Hooks added in v0.20.0 

func (c *GetPool) Hooks() []core.Hook

func (*GetPool) Icon added in v0.20.0 

func (c *GetPool) Icon() string

func (*GetPool) Label added in v0.20.0 

func (c *GetPool) Label() string

func (*GetPool) Name added in v0.20.0 

func (c *GetPool) Name() string

func (*GetPool) OutputChannels added in v0.20.0 

func (c *GetPool) OutputChannels(configuration any) []core.OutputChannel

func (*GetPool) ProcessQueueItem added in v0.20.0 

func (c *GetPool) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*GetPool) Setup added in v0.20.0 

func (c *GetPool) Setup(ctx core.SetupContext) error

type GetPoolSpec added in v0.20.0 

type GetPoolSpec struct {
	AccountID string `json:"accountId"`
	Pool      string `json:"pool"`
}

type GetTunnel added in v0.21.0 

type GetTunnel struct{}

func (*GetTunnel) Cancel added in v0.21.0 

func (c *GetTunnel) Cancel(ctx core.ExecutionContext) error

func (*GetTunnel) Cleanup added in v0.21.0 

func (c *GetTunnel) Cleanup(ctx core.SetupContext) error

func (*GetTunnel) Color added in v0.21.0 

func (c *GetTunnel) Color() string

func (*GetTunnel) Configuration added in v0.21.0 

func (c *GetTunnel) Configuration() []configuration.Field

func (*GetTunnel) Description added in v0.21.0 

func (c *GetTunnel) Description() string

func (*GetTunnel) Documentation added in v0.21.0 

func (c *GetTunnel) Documentation() string

func (*GetTunnel) ExampleOutput added in v0.21.0 

func (c *GetTunnel) ExampleOutput() map[string]any

func (*GetTunnel) Execute added in v0.21.0 

func (c *GetTunnel) Execute(ctx core.ExecutionContext) error

func (*GetTunnel) HandleHook added in v0.21.0 

func (c *GetTunnel) HandleHook(ctx core.ActionHookContext) error

func (*GetTunnel) HandleWebhook added in v0.21.0 

func (c *GetTunnel) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*GetTunnel) Hooks added in v0.21.0 

func (c *GetTunnel) Hooks() []core.Hook

func (*GetTunnel) Icon added in v0.21.0 

func (c *GetTunnel) Icon() string

func (*GetTunnel) Label added in v0.21.0 

func (c *GetTunnel) Label() string

func (*GetTunnel) Name added in v0.21.0 

func (c *GetTunnel) Name() string

func (*GetTunnel) OutputChannels added in v0.21.0 

func (c *GetTunnel) OutputChannels(configuration any) []core.OutputChannel

func (*GetTunnel) ProcessQueueItem added in v0.21.0 

func (c *GetTunnel) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*GetTunnel) Setup added in v0.21.0 

func (c *GetTunnel) Setup(ctx core.SetupContext) error

type GetTunnelSpec added in v0.21.0 

type GetTunnelSpec struct {
	AccountID string `json:"accountId"`
	Tunnel    string `json:"tunnel"`
}

type GetWorker added in v0.21.0 

type GetWorker struct{}

func (*GetWorker) Cancel added in v0.21.0 

func (g *GetWorker) Cancel(ctx core.ExecutionContext) error

func (*GetWorker) Cleanup added in v0.21.0 

func (g *GetWorker) Cleanup(ctx core.SetupContext) error

func (*GetWorker) Color added in v0.21.0 

func (g *GetWorker) Color() string

func (*GetWorker) Configuration added in v0.21.0 

func (g *GetWorker) Configuration() []configuration.Field

func (*GetWorker) Description added in v0.21.0 

func (g *GetWorker) Description() string

func (*GetWorker) Documentation added in v0.21.0 

func (g *GetWorker) Documentation() string

func (*GetWorker) ExampleOutput added in v0.21.0 

func (g *GetWorker) ExampleOutput() map[string]any

func (*GetWorker) Execute added in v0.21.0 

func (g *GetWorker) Execute(ctx core.ExecutionContext) error

func (*GetWorker) HandleHook added in v0.21.0 

func (g *GetWorker) HandleHook(ctx core.ActionHookContext) error

func (*GetWorker) HandleWebhook added in v0.21.0 

func (g *GetWorker) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*GetWorker) Hooks added in v0.21.0 

func (g *GetWorker) Hooks() []core.Hook

func (*GetWorker) Icon added in v0.21.0 

func (g *GetWorker) Icon() string

func (*GetWorker) Label added in v0.21.0 

func (g *GetWorker) Label() string

func (*GetWorker) Name added in v0.21.0 

func (g *GetWorker) Name() string

func (*GetWorker) OutputChannels added in v0.21.0 

func (g *GetWorker) OutputChannels(configuration any) []core.OutputChannel

func (*GetWorker) ProcessQueueItem added in v0.21.0 

func (g *GetWorker) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*GetWorker) Setup added in v0.21.0 

func (g *GetWorker) Setup(ctx core.SetupContext) error

type GetWorkerSpec added in v0.21.0 

type GetWorkerSpec struct {
	AccountID    string `json:"accountId"`
	WorkerScript string `json:"workerScript"`
}

type KVKey added in v0.20.0 

type KVKey struct {
	Name string `json:"name"`
}

KVKey represents a single key in a Workers KV namespace

type KVNamespace added in v0.20.0 

type KVNamespace struct {
	ID                  string `json:"id"`
	Title               string `json:"title"`
	SupportsURLEncoding *bool  `json:"supports_url_encoding,omitempty"`
}

KVNamespace represents a Cloudflare Workers KV namespace

type KVNodeMetadata added in v0.20.0 

type KVNodeMetadata struct {
	NamespaceName string `json:"namespaceName"`
	KeyName       string `json:"keyName"`
}

type LBRule added in v0.21.0 

type LBRule struct {
	Name      string          `json:"name"`
	Condition string          `json:"condition"`
	Disabled  bool            `json:"disabled,omitempty"`
	Priority  int             `json:"priority,omitempty"`
	Overrides LBRuleOverrides `json:"overrides"`
}

LBRule defines a conditional override rule on a load balancer

type LBRuleOverrides added in v0.21.0 

type LBRuleOverrides struct {
	SteeringPolicy     string          `json:"steering_policy,omitempty"`
	FallbackPool       string          `json:"fallback_pool,omitempty"`
	DefaultPools       []string        `json:"default_pools,omitempty"`
	SessionAffinity    string          `json:"session_affinity,omitempty"`
	SessionAffinityTTL *int            `json:"session_affinity_ttl,omitempty"`
	RandomSteering     *RandomSteering `json:"random_steering,omitempty"`
}

LBRuleOverrides defines the overrides applied when an LB rule condition is met

type LBRuleOverridesSpec added in v0.21.0 

type LBRuleOverridesSpec struct {
	SteeringPolicy     string           `json:"steeringPolicy"`
	FallbackPool       string           `json:"fallbackPool"`
	DefaultPools       []string         `json:"defaultPools"`
	SessionAffinity    string           `json:"sessionAffinity"`
	SessionAffinityTTL *int             `json:"sessionAffinityTtl"`
	PoolWeights        []PoolWeightSpec `json:"poolWeights"`
}

type LBRuleSpec added in v0.21.0 

type LBRuleSpec struct {
	Name      string              `json:"name"`
	Condition string              `json:"condition"`
	Disabled  bool                `json:"disabled"`
	Priority  int                 `json:"priority"`
	Overrides LBRuleOverridesSpec `json:"overrides"`
}

type LoadBalancer added in v0.21.0 

type LoadBalancer struct {
	ID                        string                     `json:"id"`
	Name                      string                     `json:"name"`
	Description               string                     `json:"description,omitempty"`
	Enabled                   *bool                      `json:"enabled,omitempty"`
	Proxied                   bool                       `json:"proxied"`
	TTL                       int                        `json:"ttl,omitempty"`
	FallbackPool              string                     `json:"fallback_pool"`
	DefaultPools              []string                   `json:"default_pools"`
	SteeringPolicy            string                     `json:"steering_policy,omitempty"`
	SessionAffinity           string                     `json:"session_affinity,omitempty"`
	SessionAffinityTTL        *int                       `json:"session_affinity_ttl,omitempty"`
	SessionAffinityAttributes *SessionAffinityAttributes `json:"session_affinity_attributes,omitempty"`
	RandomSteering            *RandomSteering            `json:"random_steering,omitempty"`
	Networks                  []string                   `json:"networks,omitempty"`
	Rules                     []LBRule                   `json:"rules,omitempty"`
	Monitor                   string                     `json:"monitor,omitempty"`
}

LoadBalancer represents a Cloudflare Load Balancer

type LoadBalancerNodeMetadata added in v0.21.0 

type LoadBalancerNodeMetadata struct {
	LoadBalancerName string `json:"loadBalancerName"`
}

type LoadShedding added in v0.20.0 

type LoadShedding struct {
	DefaultPercent float64 `json:"default_percent"`
	DefaultPolicy  string  `json:"default_policy"`
	SessionPercent float64 `json:"session_percent"`
	SessionPolicy  string  `json:"session_policy"`
}

LoadShedding configures load shedding behaviour for a pool

type LoadSheddingSpec added in v0.20.0 

type LoadSheddingSpec struct {
	DefaultPercent float64 `json:"defaultPercent"`
	DefaultPolicy  string  `json:"defaultPolicy"`
	SessionPercent float64 `json:"sessionPercent"`
	SessionPolicy  string  `json:"sessionPolicy"`
}

type Metadata 

type Metadata struct {
	Zones     []Zone `json:"zones"`
	AccountID string `json:"accountId"`
}

type Monitor added in v0.21.0 

type Monitor struct {
	ID              string              `json:"id,omitempty"`
	AllowInsecure   *bool               `json:"allow_insecure,omitempty"`
	ConsecutiveDown *int                `json:"consecutive_down,omitempty"`
	ConsecutiveUp   *int                `json:"consecutive_up,omitempty"`
	CreatedOn       string              `json:"created_on,omitempty"`
	Description     string              `json:"description,omitempty"`
	ExpectedBody    string              `json:"expected_body,omitempty"`
	ExpectedCodes   string              `json:"expected_codes,omitempty"`
	FollowRedirects *bool               `json:"follow_redirects,omitempty"`
	Header          map[string][]string `json:"header,omitempty"`
	Interval        *int                `json:"interval,omitempty"`
	Method          string              `json:"method,omitempty"`
	ModifiedOn      string              `json:"modified_on,omitempty"`
	Path            string              `json:"path,omitempty"`
	Port            *int                `json:"port,omitempty"`
	ProbeZone       string              `json:"probe_zone,omitempty"`
	Retries         *int                `json:"retries,omitempty"`
	Timeout         *int                `json:"timeout,omitempty"`
	Type            string              `json:"type,omitempty"`
}

type MonitorHeader added in v0.21.0 

type MonitorHeader struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type MonitorNodeMetadata added in v0.21.0 

type MonitorNodeMetadata struct {
	MonitorID          string `json:"monitorId" mapstructure:"monitorId"`
	MonitorDescription string `json:"monitorDescription" mapstructure:"monitorDescription"`
}

MonitorNodeMetadata stores the resolved monitor identity for workflow canvas UI.

type MonitorReference added in v0.21.0 

type MonitorReference struct {
	ReferenceType string `json:"reference_type,omitempty"`
	ResourceID    string `json:"resource_id,omitempty"`
	ResourceName  string `json:"resource_name,omitempty"`
	ResourceType  string `json:"resource_type,omitempty"`
}

type NotificationMechanism added in v0.21.0 

type NotificationMechanism struct {
	ID string `json:"id,omitempty"`
}

type NotificationPolicyFilters added in v0.21.0 

type NotificationPolicyFilters struct {
	PoolID      []string `json:"pool_id,omitempty"`
	NewHealth   []string `json:"new_health,omitempty"`
	EventSource []string `json:"event_source,omitempty"`
	TunnelID    []string `json:"tunnel_id,omitempty"`
	NewStatus   []string `json:"new_status,omitempty"`
}

type NotificationPolicyMechanisms added in v0.21.0 

type NotificationPolicyMechanisms struct {
	Email     []NotificationMechanism `json:"email,omitempty"`
	PagerDuty []NotificationMechanism `json:"pagerduty,omitempty"`
	Webhooks  []NotificationMechanism `json:"webhooks,omitempty"`
}

type NotificationPolicyResponse added in v0.21.0 

type NotificationPolicyResponse struct {
	ID string `json:"id,omitempty"`
}

type OnLoadBalancingHealthAlert added in v0.21.0 

type OnLoadBalancingHealthAlert struct{}

func (*OnLoadBalancingHealthAlert) Cleanup added in v0.21.0 

func (t *OnLoadBalancingHealthAlert) Cleanup(ctx core.TriggerContext) error

func (*OnLoadBalancingHealthAlert) Color added in v0.21.0 

func (t *OnLoadBalancingHealthAlert) Color() string

func (*OnLoadBalancingHealthAlert) Configuration added in v0.21.0 

func (t *OnLoadBalancingHealthAlert) Configuration() []configuration.Field

func (*OnLoadBalancingHealthAlert) Description added in v0.21.0 

func (t *OnLoadBalancingHealthAlert) Description() string

func (*OnLoadBalancingHealthAlert) Documentation added in v0.21.0 

func (t *OnLoadBalancingHealthAlert) Documentation() string

func (*OnLoadBalancingHealthAlert) ExampleData added in v0.21.0 

func (t *OnLoadBalancingHealthAlert) ExampleData() map[string]any

func (*OnLoadBalancingHealthAlert) HandleHook added in v0.21.0 

func (t *OnLoadBalancingHealthAlert) HandleHook(ctx core.TriggerHookContext) (map[string]any, error)

func (*OnLoadBalancingHealthAlert) HandleWebhook added in v0.21.0 

func (t *OnLoadBalancingHealthAlert) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*OnLoadBalancingHealthAlert) Hooks added in v0.21.0 

func (t *OnLoadBalancingHealthAlert) Hooks() []core.Hook

func (*OnLoadBalancingHealthAlert) Icon added in v0.21.0 

func (t *OnLoadBalancingHealthAlert) Icon() string

func (*OnLoadBalancingHealthAlert) Label added in v0.21.0 

func (t *OnLoadBalancingHealthAlert) Label() string

func (*OnLoadBalancingHealthAlert) Name added in v0.21.0 

func (t *OnLoadBalancingHealthAlert) Name() string

func (*OnLoadBalancingHealthAlert) Setup added in v0.21.0 

func (t *OnLoadBalancingHealthAlert) Setup(ctx core.TriggerContext) error

type OnLoadBalancingHealthAlertSpec added in v0.21.0 

type OnLoadBalancingHealthAlertSpec struct {
	Pool        string   `json:"pool"`
	NewHealth   []string `json:"newHealth"`
	EventSource []string `json:"eventSource"`
}

type OnTunnelHealth added in v0.21.0 

type OnTunnelHealth struct{}

func (*OnTunnelHealth) Cleanup added in v0.21.0 

func (t *OnTunnelHealth) Cleanup(ctx core.TriggerContext) error

func (*OnTunnelHealth) Color added in v0.21.0 

func (t *OnTunnelHealth) Color() string

func (*OnTunnelHealth) Configuration added in v0.21.0 

func (t *OnTunnelHealth) Configuration() []configuration.Field

func (*OnTunnelHealth) Description added in v0.21.0 

func (t *OnTunnelHealth) Description() string

func (*OnTunnelHealth) Documentation added in v0.21.0 

func (t *OnTunnelHealth) Documentation() string

func (*OnTunnelHealth) ExampleData added in v0.21.0 

func (t *OnTunnelHealth) ExampleData() map[string]any

func (*OnTunnelHealth) HandleHook added in v0.21.0 

func (t *OnTunnelHealth) HandleHook(ctx core.TriggerHookContext) (map[string]any, error)

func (*OnTunnelHealth) HandleWebhook added in v0.21.0 

func (t *OnTunnelHealth) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*OnTunnelHealth) Hooks added in v0.21.0 

func (t *OnTunnelHealth) Hooks() []core.Hook

func (*OnTunnelHealth) Icon added in v0.21.0 

func (t *OnTunnelHealth) Icon() string

func (*OnTunnelHealth) Label added in v0.21.0 

func (t *OnTunnelHealth) Label() string

func (*OnTunnelHealth) Name added in v0.21.0 

func (t *OnTunnelHealth) Name() string

func (*OnTunnelHealth) Setup added in v0.21.0 

func (t *OnTunnelHealth) Setup(ctx core.TriggerContext) error

type OnTunnelHealthSpec added in v0.21.0 

type OnTunnelHealthSpec struct {
	Tunnel    string   `json:"tunnel"`
	NewStatus []string `json:"newStatus"`
}

type OrderCertificatePack added in v0.21.0 

type OrderCertificatePack struct{}

func (*OrderCertificatePack) Cancel added in v0.21.0 

func (c *OrderCertificatePack) Cancel(ctx core.ExecutionContext) error

func (*OrderCertificatePack) Cleanup added in v0.21.0 

func (c *OrderCertificatePack) Cleanup(ctx core.SetupContext) error

func (*OrderCertificatePack) Color added in v0.21.0 

func (c *OrderCertificatePack) Color() string

func (*OrderCertificatePack) Configuration added in v0.21.0 

func (c *OrderCertificatePack) Configuration() []configuration.Field

func (*OrderCertificatePack) Description added in v0.21.0 

func (c *OrderCertificatePack) Description() string

func (*OrderCertificatePack) Documentation added in v0.21.0 

func (c *OrderCertificatePack) Documentation() string

func (*OrderCertificatePack) ExampleOutput added in v0.21.0 

func (c *OrderCertificatePack) ExampleOutput() map[string]any

func (*OrderCertificatePack) Execute added in v0.21.0 

func (c *OrderCertificatePack) Execute(ctx core.ExecutionContext) error

func (*OrderCertificatePack) HandleHook added in v0.21.0 

func (c *OrderCertificatePack) HandleHook(ctx core.ActionHookContext) error

func (*OrderCertificatePack) HandleWebhook added in v0.21.0 

func (c *OrderCertificatePack) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*OrderCertificatePack) Hooks added in v0.21.0 

func (c *OrderCertificatePack) Hooks() []core.Hook

func (*OrderCertificatePack) Icon added in v0.21.0 

func (c *OrderCertificatePack) Icon() string

func (*OrderCertificatePack) Label added in v0.21.0 

func (c *OrderCertificatePack) Label() string

func (*OrderCertificatePack) Name added in v0.21.0 

func (c *OrderCertificatePack) Name() string

func (*OrderCertificatePack) OutputChannels added in v0.21.0 

func (c *OrderCertificatePack) OutputChannels(configuration any) []core.OutputChannel

func (*OrderCertificatePack) ProcessQueueItem added in v0.21.0 

func (c *OrderCertificatePack) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*OrderCertificatePack) Setup added in v0.21.0 

func (c *OrderCertificatePack) Setup(ctx core.SetupContext) error

type OrderCertificatePackRequest added in v0.21.0 

type OrderCertificatePackRequest struct {
	CertificateAuthority string   `json:"certificate_authority"`
	Hosts                []string `json:"hosts"`
	Type                 string   `json:"type"`
	ValidationMethod     string   `json:"validation_method"`
	ValidityDays         *int     `json:"validity_days,omitempty"`
	CloudflareBranding   *bool    `json:"cloudflare_branding,omitempty"`
}

type OrderCertificatePackSpec added in v0.21.0 

type OrderCertificatePackSpec struct {
	Zone                 string   `json:"zone"`
	Hosts                []string `json:"hosts"`
	CertificateAuthority string   `json:"certificateAuthority"`
	ValidationMethod     string   `json:"validationMethod"`
	ValidityDays         string   `json:"validityDays,omitempty"`
	CloudflareBranding   *bool    `json:"cloudflareBranding,omitempty"`
}

type Origin added in v0.20.0 

type Origin struct {
	Name        string       `json:"name"`
	Address     string       `json:"address"`
	Enabled     bool         `json:"enabled"`
	Weight      float64      `json:"weight"`
	Port        int          `json:"port,omitempty"`
	Coordinates *Coordinates `json:"coordinates,omitempty"`
}

Origin represents a single origin server in a pool

type OriginActionParameters added in v0.20.0 

type OriginActionParameters struct {
	HostHeader string         `json:"host_header,omitempty"`
	Origin     *RouteOrigin   `json:"origin,omitempty"`
	SNI        *RouteSNIValue `json:"sni,omitempty"`
}

type OriginRule added in v0.20.0 

type OriginRule struct {
	ID          string                  `json:"id,omitempty"`
	Action      string                  `json:"action"`
	Expression  string                  `json:"expression"`
	Description string                  `json:"description,omitempty"`
	Enabled     bool                    `json:"enabled"`
	ActionParam *OriginActionParameters `json:"action_parameters,omitempty"`
}

OriginRule represents a single origin rule in a ruleset.

type OriginRuleMatchRule added in v0.20.0 

type OriginRuleMatchRule struct {
	Field       string `json:"field" mapstructure:"field"`
	Operator    string `json:"operator" mapstructure:"operator"`
	Value       string `json:"value" mapstructure:"value"`
	Conjunction string `json:"conjunction" mapstructure:"conjunction"`
}

type OriginRuleNodeMetadata added in v0.20.0 

type OriginRuleNodeMetadata struct {
	Zone        string   `json:"zone,omitempty"`
	ZoneName    string   `json:"zoneName,omitempty"`
	Rule        string   `json:"rule,omitempty"`
	Description string   `json:"description,omitempty"`
	MatchMode   string   `json:"matchMode,omitempty"`
	Expression  string   `json:"expression,omitempty"`
	OriginHost  string   `json:"originHost,omitempty"`
	OriginPort  *int     `json:"originPort,omitempty"`
	HostHeader  string   `json:"hostHeader,omitempty"`
	SNI         string   `json:"sni,omitempty"`
	Enabled     *bool    `json:"enabled,omitempty"`
	Rewrites    []string `json:"rewrites,omitempty"`
}

type OriginRuleset added in v0.20.0 

type OriginRuleset struct {
	ID          string       `json:"id"`
	Name        string       `json:"name"`
	Description string       `json:"description"`
	Kind        string       `json:"kind"`
	Phase       string       `json:"phase"`
	Rules       []OriginRule `json:"rules"`
}

type OriginSpec added in v0.20.0 

type OriginSpec struct {
	Name        string           `json:"name"`
	Address     string           `json:"address"`
	Enabled     *bool            `json:"enabled"`
	Weight      *float64         `json:"weight"`
	Port        int              `json:"port"`
	Coordinates *CoordinatesSpec `json:"coordinates"`
}

type OriginSteering added in v0.20.0 

type OriginSteering struct {
	// Policy is one of: "random", "hash", "least_outstanding_requests", "least_connections"
	Policy string `json:"policy,omitempty"`
}

OriginSteering configures how origins within a pool are selected

type Pool added in v0.20.0 

type Pool struct {
	ID          string `json:"id,omitempty"`
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
	// Enabled must not use omitempty: disabled pools must still serialize enabled:false.
	Enabled bool `json:"enabled"`
	// MinimumOrigins must not use omitempty: 0 is a valid value and must serialize as minimum_origins:0.
	MinimumOrigins int             `json:"minimum_origins"`
	Monitor        string          `json:"monitor,omitempty"`
	Origins        []Origin        `json:"origins,omitempty"`
	LoadShedding   *LoadShedding   `json:"load_shedding,omitempty"`
	OriginSteering *OriginSteering `json:"origin_steering,omitempty"`
}

type PoolNodeMetadata added in v0.20.0 

type PoolNodeMetadata struct {
	PoolName string `json:"poolName"`
}

type PoolWeightSpec added in v0.21.0 

type PoolWeightSpec struct {
	Pool   string  `json:"pool"`
	Weight float64 `json:"weight"`
}

type PurgeCache added in v0.21.0 

type PurgeCache struct{}

func (*PurgeCache) Cancel added in v0.21.0 

func (c *PurgeCache) Cancel(ctx core.ExecutionContext) error

func (*PurgeCache) Cleanup added in v0.21.0 

func (c *PurgeCache) Cleanup(ctx core.SetupContext) error

func (*PurgeCache) Color added in v0.21.0 

func (c *PurgeCache) Color() string

func (*PurgeCache) Configuration added in v0.21.0 

func (c *PurgeCache) Configuration() []configuration.Field

func (*PurgeCache) Description added in v0.21.0 

func (c *PurgeCache) Description() string

func (*PurgeCache) Documentation added in v0.21.0 

func (c *PurgeCache) Documentation() string

func (*PurgeCache) ExampleOutput added in v0.21.0 

func (c *PurgeCache) ExampleOutput() map[string]any

func (*PurgeCache) Execute added in v0.21.0 

func (c *PurgeCache) Execute(ctx core.ExecutionContext) error

func (*PurgeCache) HandleHook added in v0.21.0 

func (c *PurgeCache) HandleHook(ctx core.ActionHookContext) error

func (*PurgeCache) HandleWebhook added in v0.21.0 

func (c *PurgeCache) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*PurgeCache) Hooks added in v0.21.0 

func (c *PurgeCache) Hooks() []core.Hook

func (*PurgeCache) Icon added in v0.21.0 

func (c *PurgeCache) Icon() string

func (*PurgeCache) Label added in v0.21.0 

func (c *PurgeCache) Label() string

func (*PurgeCache) Name added in v0.21.0 

func (c *PurgeCache) Name() string

func (*PurgeCache) OutputChannels added in v0.21.0 

func (c *PurgeCache) OutputChannels(configuration any) []core.OutputChannel

func (*PurgeCache) ProcessQueueItem added in v0.21.0 

func (c *PurgeCache) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*PurgeCache) Setup added in v0.21.0 

func (c *PurgeCache) Setup(ctx core.SetupContext) error

type PurgeCacheRequest added in v0.21.0 

type PurgeCacheRequest struct {
	PurgeEverything bool     `json:"purge_everything,omitempty"`
	Files           []string `json:"files,omitempty"`
	Tags            []string `json:"tags,omitempty"`
	Hosts           []string `json:"hosts,omitempty"`
	Prefixes        []string `json:"prefixes,omitempty"`
}

type PurgeCacheResult added in v0.21.0 

type PurgeCacheResult struct {
	ID string `json:"id,omitempty"`
}

type PurgeCacheSpec added in v0.21.0 

type PurgeCacheSpec struct {
	Zone     string   `json:"zone"`
	Mode     string   `json:"mode"`
	Files    []string `json:"files"`
	Tags     []string `json:"tags"`
	Hosts    []string `json:"hosts"`
	Prefixes []string `json:"prefixes"`
}

type PutKVValue added in v0.20.0 

type PutKVValue struct{}

func (*PutKVValue) Cancel added in v0.20.0 

func (c *PutKVValue) Cancel(ctx core.ExecutionContext) error

func (*PutKVValue) Cleanup added in v0.20.0 

func (c *PutKVValue) Cleanup(ctx core.SetupContext) error

func (*PutKVValue) Color added in v0.20.0 

func (c *PutKVValue) Color() string

func (*PutKVValue) Configuration added in v0.20.0 

func (c *PutKVValue) Configuration() []configuration.Field

func (*PutKVValue) Description added in v0.20.0 

func (c *PutKVValue) Description() string

func (*PutKVValue) Documentation added in v0.20.0 

func (c *PutKVValue) Documentation() string

func (*PutKVValue) ExampleOutput added in v0.20.0 

func (c *PutKVValue) ExampleOutput() map[string]any

func (*PutKVValue) Execute added in v0.20.0 

func (c *PutKVValue) Execute(ctx core.ExecutionContext) error

func (*PutKVValue) HandleHook added in v0.20.0 

func (c *PutKVValue) HandleHook(ctx core.ActionHookContext) error

func (*PutKVValue) HandleWebhook added in v0.20.0 

func (c *PutKVValue) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*PutKVValue) Hooks added in v0.20.0 

func (c *PutKVValue) Hooks() []core.Hook

func (*PutKVValue) Icon added in v0.20.0 

func (c *PutKVValue) Icon() string

func (*PutKVValue) Label added in v0.20.0 

func (c *PutKVValue) Label() string

func (*PutKVValue) Name added in v0.20.0 

func (c *PutKVValue) Name() string

func (*PutKVValue) OutputChannels added in v0.20.0 

func (c *PutKVValue) OutputChannels(configuration any) []core.OutputChannel

func (*PutKVValue) ProcessQueueItem added in v0.20.0 

func (c *PutKVValue) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*PutKVValue) Setup added in v0.20.0 

func (c *PutKVValue) Setup(ctx core.SetupContext) error

type PutKVValueSpec added in v0.20.0 

type PutKVValueSpec struct {
	AccountID     string `json:"accountId"`
	Namespace     string `json:"namespace"`
	Key           string `json:"key"`
	Value         string `json:"value"`
	ExpirationTTL *int   `json:"expirationTtl"`
}

type RandomSteering added in v0.21.0 

type RandomSteering struct {
	DefaultWeight float64            `json:"default_weight,omitempty"`
	PoolWeights   map[string]float64 `json:"pool_weights,omitempty"`
}

RandomSteering holds per-pool weights used by the random steering policy

type RedirectActionData 

type RedirectActionData struct {
	FromValue *RedirectFromValue `json:"from_value,omitempty"`
}

RedirectActionData contains the redirect configuration

type RedirectFromValue 

type RedirectFromValue struct {
	StatusCode       int                `json:"status_code"`
	TargetURL        *RedirectTargetURL `json:"target_url,omitempty"`
	PreserveQueryStr bool               `json:"preserve_query_string,omitempty"`
}

RedirectFromValue defines the redirect target

type RedirectRule 

type RedirectRule struct {
	ID          string              `json:"id,omitempty"`
	Action      string              `json:"action"`
	Expression  string              `json:"expression"`
	Description string              `json:"description,omitempty"`
	Enabled     bool                `json:"enabled"`
	ActionParam *RedirectActionData `json:"action_parameters,omitempty"`
}

RedirectRule represents a single redirect rule in a ruleset

type RedirectTargetURL 

type RedirectTargetURL struct {
	Value      string `json:"value,omitempty"`
	Expression string `json:"expression,omitempty"`
}

RedirectTargetURL defines the target URL for redirect

type RouteOrigin added in v0.20.0 

type RouteOrigin struct {
	Host string `json:"host,omitempty"`
	Port *int   `json:"port,omitempty"`
}

type RouteSNIValue added in v0.20.0 

type RouteSNIValue struct {
	Value string `json:"value,omitempty"`
}

type Ruleset 

type Ruleset struct {
	ID          string         `json:"id"`
	Name        string         `json:"name"`
	Description string         `json:"description"`
	Kind        string         `json:"kind"`
	Phase       string         `json:"phase"`
	Rules       []RedirectRule `json:"rules"`
}

Ruleset represents a Cloudflare ruleset

type SessionAffinityAttributes added in v0.21.0 

type SessionAffinityAttributes struct {
	SameSite     string `json:"samesite,omitempty"`
	Secure       string `json:"secure,omitempty"`
	ZeroDowntime string `json:"zero_downtime_failover,omitempty"`
}

SessionAffinityAttributes holds extra session affinity options

type TunnelNodeMetadata added in v0.21.0 

type TunnelNodeMetadata struct {
	TunnelName string `json:"tunnelName"`
}

type UpdateDNSRecord added in v0.6.0 

type UpdateDNSRecord struct{}

func (*UpdateDNSRecord) Cancel added in v0.6.0 

func (c *UpdateDNSRecord) Cancel(ctx core.ExecutionContext) error

func (*UpdateDNSRecord) Cleanup added in v0.7.0 

func (c *UpdateDNSRecord) Cleanup(ctx core.SetupContext) error

func (*UpdateDNSRecord) Color added in v0.6.0 

func (c *UpdateDNSRecord) Color() string

func (*UpdateDNSRecord) Configuration added in v0.6.0 

func (c *UpdateDNSRecord) Configuration() []configuration.Field

func (*UpdateDNSRecord) Description added in v0.6.0 

func (c *UpdateDNSRecord) Description() string

func (*UpdateDNSRecord) Documentation added in v0.6.0 

func (c *UpdateDNSRecord) Documentation() string

func (*UpdateDNSRecord) ExampleOutput added in v0.6.0 

func (c *UpdateDNSRecord) ExampleOutput() map[string]any

func (*UpdateDNSRecord) Execute added in v0.6.0 

func (c *UpdateDNSRecord) Execute(ctx core.ExecutionContext) error

func (*UpdateDNSRecord) HandleHook added in v0.18.0 

func (c *UpdateDNSRecord) HandleHook(ctx core.ActionHookContext) error

func (*UpdateDNSRecord) HandleWebhook added in v0.6.0 

func (c *UpdateDNSRecord) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*UpdateDNSRecord) Hooks added in v0.18.0 

func (c *UpdateDNSRecord) Hooks() []core.Hook

func (*UpdateDNSRecord) Icon added in v0.6.0 

func (c *UpdateDNSRecord) Icon() string

func (*UpdateDNSRecord) Label added in v0.6.0 

func (c *UpdateDNSRecord) Label() string

func (*UpdateDNSRecord) Name added in v0.6.0 

func (c *UpdateDNSRecord) Name() string

func (*UpdateDNSRecord) OutputChannels added in v0.6.0 

func (c *UpdateDNSRecord) OutputChannels(configuration any) []core.OutputChannel

func (*UpdateDNSRecord) ProcessQueueItem added in v0.6.0 

func (c *UpdateDNSRecord) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*UpdateDNSRecord) Setup added in v0.6.0 

func (c *UpdateDNSRecord) Setup(ctx core.SetupContext) error

type UpdateDNSRecordRequest added in v0.6.0 

type UpdateDNSRecordRequest struct {
	Type    string `json:"type"`
	Name    string `json:"name"`
	Content string `json:"content"`
	TTL     int    `json:"ttl"`
	Proxied bool   `json:"proxied"`
}

UpdateDNSRecordRequest is the payload for updating a DNS record. Cloudflare's Update DNS Record endpoint expects a full record object (type, name, content, ttl, proxied).

type UpdateDNSRecordSpec added in v0.6.0 

type UpdateDNSRecordSpec struct {
	Record string `json:"record"`

	Content string `json:"content"`
	TTL     int    `json:"ttl"`
	Proxied bool   `json:"proxied"`
}

type UpdateLoadBalancer added in v0.21.0 

type UpdateLoadBalancer struct{}

func (*UpdateLoadBalancer) Cancel added in v0.21.0 

func (c *UpdateLoadBalancer) Cancel(ctx core.ExecutionContext) error

func (*UpdateLoadBalancer) Cleanup added in v0.21.0 

func (c *UpdateLoadBalancer) Cleanup(ctx core.SetupContext) error

func (*UpdateLoadBalancer) Color added in v0.21.0 

func (c *UpdateLoadBalancer) Color() string

func (*UpdateLoadBalancer) Configuration added in v0.21.0 

func (c *UpdateLoadBalancer) Configuration() []configuration.Field

func (*UpdateLoadBalancer) Description added in v0.21.0 

func (c *UpdateLoadBalancer) Description() string

func (*UpdateLoadBalancer) Documentation added in v0.21.0 

func (c *UpdateLoadBalancer) Documentation() string

func (*UpdateLoadBalancer) ExampleOutput added in v0.21.0 

func (c *UpdateLoadBalancer) ExampleOutput() map[string]any

func (*UpdateLoadBalancer) Execute added in v0.21.0 

func (c *UpdateLoadBalancer) Execute(ctx core.ExecutionContext) error

func (*UpdateLoadBalancer) HandleHook added in v0.21.0 

func (c *UpdateLoadBalancer) HandleHook(ctx core.ActionHookContext) error

func (*UpdateLoadBalancer) HandleWebhook added in v0.21.0 

func (c *UpdateLoadBalancer) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*UpdateLoadBalancer) Hooks added in v0.21.0 

func (c *UpdateLoadBalancer) Hooks() []core.Hook

func (*UpdateLoadBalancer) Icon added in v0.21.0 

func (c *UpdateLoadBalancer) Icon() string

func (*UpdateLoadBalancer) Label added in v0.21.0 

func (c *UpdateLoadBalancer) Label() string

func (*UpdateLoadBalancer) Name added in v0.21.0 

func (c *UpdateLoadBalancer) Name() string

func (*UpdateLoadBalancer) OutputChannels added in v0.21.0 

func (c *UpdateLoadBalancer) OutputChannels(configuration any) []core.OutputChannel

func (*UpdateLoadBalancer) ProcessQueueItem added in v0.21.0 

func (c *UpdateLoadBalancer) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*UpdateLoadBalancer) Setup added in v0.21.0 

func (c *UpdateLoadBalancer) Setup(ctx core.SetupContext) error

type UpdateLoadBalancerRequest added in v0.21.0 

type UpdateLoadBalancerRequest struct {
	Name                      string                     `json:"name,omitempty"`
	Description               string                     `json:"description,omitempty"`
	Enabled                   *bool                      `json:"enabled,omitempty"`
	SteeringPolicy            string                     `json:"steering_policy,omitempty"`
	SessionAffinity           string                     `json:"session_affinity,omitempty"`
	SessionAffinityTTL        *int                       `json:"session_affinity_ttl,omitempty"`
	SessionAffinityAttributes *SessionAffinityAttributes `json:"session_affinity_attributes,omitempty"`
	RandomSteering            *RandomSteering            `json:"random_steering,omitempty"`
	FallbackPool              string                     `json:"fallback_pool,omitempty"`
	DefaultPools              []string                   `json:"default_pools,omitempty"`
}

UpdateLoadBalancerRequest is the payload for patching a load balancer

type UpdateLoadBalancerSpec added in v0.21.0 

type UpdateLoadBalancerSpec struct {
	LoadBalancer       string           `json:"loadBalancer"`
	Name               string           `json:"name"`
	Description        string           `json:"description"`
	SteeringPolicy     string           `json:"steeringPolicy"`
	SessionAffinity    string           `json:"sessionAffinity"`
	SessionAffinityTTL *int             `json:"sessionAffinityTtl"`
	PoolWeights        []PoolWeightSpec `json:"poolWeights"`
	FallbackPool       string           `json:"fallbackPool"`
	DefaultPools       []string         `json:"defaultPools"`
	Enabled            *bool            `json:"enabled"`
}

type UpdateMonitor added in v0.21.0 

type UpdateMonitor struct{}

func (*UpdateMonitor) Cancel added in v0.21.0 

func (c *UpdateMonitor) Cancel(ctx core.ExecutionContext) error

func (*UpdateMonitor) Cleanup added in v0.21.0 

func (c *UpdateMonitor) Cleanup(ctx core.SetupContext) error

func (*UpdateMonitor) Color added in v0.21.0 

func (c *UpdateMonitor) Color() string

func (*UpdateMonitor) Configuration added in v0.21.0 

func (c *UpdateMonitor) Configuration() []configuration.Field

func (*UpdateMonitor) Description added in v0.21.0 

func (c *UpdateMonitor) Description() string

func (*UpdateMonitor) Documentation added in v0.21.0 

func (c *UpdateMonitor) Documentation() string

func (*UpdateMonitor) ExampleOutput added in v0.21.0 

func (c *UpdateMonitor) ExampleOutput() map[string]any

func (*UpdateMonitor) Execute added in v0.21.0 

func (c *UpdateMonitor) Execute(ctx core.ExecutionContext) error

func (*UpdateMonitor) HandleHook added in v0.21.0 

func (c *UpdateMonitor) HandleHook(ctx core.ActionHookContext) error

func (*UpdateMonitor) HandleWebhook added in v0.21.0 

func (c *UpdateMonitor) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*UpdateMonitor) Hooks added in v0.21.0 

func (c *UpdateMonitor) Hooks() []core.Hook

func (*UpdateMonitor) Icon added in v0.21.0 

func (c *UpdateMonitor) Icon() string

func (*UpdateMonitor) Label added in v0.21.0 

func (c *UpdateMonitor) Label() string

func (*UpdateMonitor) Name added in v0.21.0 

func (c *UpdateMonitor) Name() string

func (*UpdateMonitor) OutputChannels added in v0.21.0 

func (c *UpdateMonitor) OutputChannels(configuration any) []core.OutputChannel

func (*UpdateMonitor) ProcessQueueItem added in v0.21.0 

func (c *UpdateMonitor) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*UpdateMonitor) Setup added in v0.21.0 

func (c *UpdateMonitor) Setup(ctx core.SetupContext) error

type UpdateMonitorSpec added in v0.21.0 

type UpdateMonitorSpec struct {
	Monitor     string                     `json:"monitor"`
	Type        string                     `json:"type"`
	Description string                     `json:"description"`
	Path        *string                    `json:"path,omitempty"`
	Port        *int                       `json:"port,omitempty"`
	Advanced    *CreateMonitorAdvancedSpec `json:"advanced,omitempty"`
}

type UpdateOriginRule added in v0.20.0 

type UpdateOriginRule struct{}

func (*UpdateOriginRule) Cancel added in v0.20.0 

func (c *UpdateOriginRule) Cancel(ctx core.ExecutionContext) error

func (*UpdateOriginRule) Cleanup added in v0.20.0 

func (c *UpdateOriginRule) Cleanup(ctx core.SetupContext) error

func (*UpdateOriginRule) Color added in v0.20.0 

func (c *UpdateOriginRule) Color() string

func (*UpdateOriginRule) Configuration added in v0.20.0 

func (c *UpdateOriginRule) Configuration() []configuration.Field

func (*UpdateOriginRule) Description added in v0.20.0 

func (c *UpdateOriginRule) Description() string

func (*UpdateOriginRule) Documentation added in v0.20.0 

func (c *UpdateOriginRule) Documentation() string

func (*UpdateOriginRule) ExampleOutput added in v0.20.0 

func (c *UpdateOriginRule) ExampleOutput() map[string]any

func (*UpdateOriginRule) Execute added in v0.20.0 

func (c *UpdateOriginRule) Execute(ctx core.ExecutionContext) error

func (*UpdateOriginRule) HandleHook added in v0.20.0 

func (c *UpdateOriginRule) HandleHook(ctx core.ActionHookContext) error

func (*UpdateOriginRule) HandleWebhook added in v0.20.0 

func (c *UpdateOriginRule) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*UpdateOriginRule) Hooks added in v0.20.0 

func (c *UpdateOriginRule) Hooks() []core.Hook

func (*UpdateOriginRule) Icon added in v0.20.0 

func (c *UpdateOriginRule) Icon() string

func (*UpdateOriginRule) Label added in v0.20.0 

func (c *UpdateOriginRule) Label() string

func (*UpdateOriginRule) Name added in v0.20.0 

func (c *UpdateOriginRule) Name() string

func (*UpdateOriginRule) OutputChannels added in v0.20.0 

func (c *UpdateOriginRule) OutputChannels(configuration any) []core.OutputChannel

func (*UpdateOriginRule) ProcessQueueItem added in v0.20.0 

func (c *UpdateOriginRule) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*UpdateOriginRule) Setup added in v0.20.0 

func (c *UpdateOriginRule) Setup(ctx core.SetupContext) error

type UpdateOriginRuleSpec added in v0.20.0 

type UpdateOriginRuleSpec struct {
	Rule        string                `json:"rule" mapstructure:"rule"`
	Description *string               `json:"description" mapstructure:"description"`
	MatchMode   string                `json:"matchMode" mapstructure:"matchMode"`
	MatchRules  []OriginRuleMatchRule `json:"matchRules" mapstructure:"matchRules"`
	Expression  string                `json:"expression" mapstructure:"expression"`
	OriginHost  *string               `json:"originHost" mapstructure:"originHost"`
	OriginPort  *int                  `json:"originPort" mapstructure:"originPort"`
	HostHeader  *string               `json:"hostHeader" mapstructure:"hostHeader"`
	SNI         *string               `json:"sni" mapstructure:"sni"`
	Enabled     *bool                 `json:"enabled" mapstructure:"enabled"`
}

type UpdatePool added in v0.20.0 

type UpdatePool struct{}

func (*UpdatePool) Cancel added in v0.20.0 

func (c *UpdatePool) Cancel(ctx core.ExecutionContext) error

func (*UpdatePool) Cleanup added in v0.20.0 

func (c *UpdatePool) Cleanup(ctx core.SetupContext) error

func (*UpdatePool) Color added in v0.20.0 

func (c *UpdatePool) Color() string

func (*UpdatePool) Configuration added in v0.20.0 

func (c *UpdatePool) Configuration() []configuration.Field

func (*UpdatePool) Description added in v0.20.0 

func (c *UpdatePool) Description() string

func (*UpdatePool) Documentation added in v0.20.0 

func (c *UpdatePool) Documentation() string

func (*UpdatePool) ExampleOutput added in v0.20.0 

func (c *UpdatePool) ExampleOutput() map[string]any

func (*UpdatePool) Execute added in v0.20.0 

func (c *UpdatePool) Execute(ctx core.ExecutionContext) error

func (*UpdatePool) HandleHook added in v0.20.0 

func (c *UpdatePool) HandleHook(ctx core.ActionHookContext) error

func (*UpdatePool) HandleWebhook added in v0.20.0 

func (c *UpdatePool) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*UpdatePool) Hooks added in v0.20.0 

func (c *UpdatePool) Hooks() []core.Hook

func (*UpdatePool) Icon added in v0.20.0 

func (c *UpdatePool) Icon() string

func (*UpdatePool) Label added in v0.20.0 

func (c *UpdatePool) Label() string

func (*UpdatePool) Name added in v0.20.0 

func (c *UpdatePool) Name() string

func (*UpdatePool) OutputChannels added in v0.20.0 

func (c *UpdatePool) OutputChannels(configuration any) []core.OutputChannel

func (*UpdatePool) ProcessQueueItem added in v0.20.0 

func (c *UpdatePool) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*UpdatePool) Setup added in v0.20.0 

func (c *UpdatePool) Setup(ctx core.SetupContext) error

type UpdatePoolRequest added in v0.20.0 

type UpdatePoolRequest struct {
	Name           string          `json:"name,omitempty"`
	Description    string          `json:"description,omitempty"`
	Enabled        *bool           `json:"enabled,omitempty"`
	MinimumOrigins *int            `json:"minimum_origins,omitempty"`
	Monitor        string          `json:"monitor,omitempty"`
	Origins        []Origin        `json:"origins,omitempty"`
	LoadShedding   *LoadShedding   `json:"load_shedding,omitempty"`
	OriginSteering *OriginSteering `json:"origin_steering,omitempty"`
}

UpdatePoolRequest is the payload for updating an origin pool

type UpdatePoolSpec added in v0.20.0 

type UpdatePoolSpec struct {
	AccountID            string            `json:"accountId"`
	Pool                 string            `json:"pool"`
	Name                 string            `json:"name"`
	Description          string            `json:"description"`
	Enabled              *bool             `json:"enabled"`
	MinimumOrigins       *int              `json:"minimumOrigins"`
	Monitor              string            `json:"monitor"`
	Origins              []OriginSpec      `json:"origins"`
	OriginSteeringPolicy string            `json:"originSteeringPolicy"`
	LoadShedding         *LoadSheddingSpec `json:"loadShedding"`
}

type UpdateRedirectRule 

type UpdateRedirectRule struct{}

func (*UpdateRedirectRule) Cancel 

func (c *UpdateRedirectRule) Cancel(ctx core.ExecutionContext) error

func (*UpdateRedirectRule) Cleanup added in v0.7.0 

func (c *UpdateRedirectRule) Cleanup(ctx core.SetupContext) error

func (*UpdateRedirectRule) Color 

func (c *UpdateRedirectRule) Color() string

func (*UpdateRedirectRule) Configuration 

func (c *UpdateRedirectRule) Configuration() []configuration.Field

func (*UpdateRedirectRule) Description 

func (c *UpdateRedirectRule) Description() string

func (*UpdateRedirectRule) Documentation 

func (c *UpdateRedirectRule) Documentation() string

func (*UpdateRedirectRule) ExampleOutput 

func (c *UpdateRedirectRule) ExampleOutput() map[string]any

func (*UpdateRedirectRule) Execute 

func (c *UpdateRedirectRule) Execute(ctx core.ExecutionContext) error

func (*UpdateRedirectRule) HandleHook added in v0.18.0 

func (c *UpdateRedirectRule) HandleHook(ctx core.ActionHookContext) error

func (*UpdateRedirectRule) HandleWebhook 

func (c *UpdateRedirectRule) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*UpdateRedirectRule) Hooks added in v0.18.0 

func (c *UpdateRedirectRule) Hooks() []core.Hook

func (*UpdateRedirectRule) Icon 

func (c *UpdateRedirectRule) Icon() string

func (*UpdateRedirectRule) Label 

func (c *UpdateRedirectRule) Label() string

func (*UpdateRedirectRule) Name 

func (c *UpdateRedirectRule) Name() string

func (*UpdateRedirectRule) OutputChannels 

func (c *UpdateRedirectRule) OutputChannels(configuration any) []core.OutputChannel

func (*UpdateRedirectRule) ProcessQueueItem 

func (c *UpdateRedirectRule) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*UpdateRedirectRule) Setup 

func (c *UpdateRedirectRule) Setup(ctx core.SetupContext) error

type UpdateRedirectRuleMetadata 

type UpdateRedirectRuleMetadata struct {
	Zone *Zone `json:"zone"`
}

type UpdateRedirectRuleRequest 

type UpdateRedirectRuleRequest struct {
	Action      string              `json:"action"`
	Expression  string              `json:"expression"`
	Description string              `json:"description,omitempty"`
	Enabled     bool                `json:"enabled"`
	ActionParam *RedirectActionData `json:"action_parameters,omitempty"`
}

UpdateRedirectRuleRequest is the payload for updating a redirect rule

type UpdateRedirectRuleSpec 

type UpdateRedirectRuleSpec struct {
	Zone             string `json:"zone"`
	RuleID           string `json:"ruleId"`
	Description      string `json:"description"`
	MatchType        string `json:"matchType"`
	SourceURLPattern string `json:"sourceUrlPattern"`
	Expression       string `json:"expression"`
	TargetURL        string `json:"targetUrl"`
	StatusCode       string `json:"statusCode"`
	PreserveQueryStr bool   `json:"preserveQueryString"`
	Enabled          bool   `json:"enabled"`
}

type UpdateWorkerRoute added in v0.21.0 

type UpdateWorkerRoute struct{}

func (*UpdateWorkerRoute) Cancel added in v0.21.0 

func (u *UpdateWorkerRoute) Cancel(ctx core.ExecutionContext) error

func (*UpdateWorkerRoute) Cleanup added in v0.21.0 

func (u *UpdateWorkerRoute) Cleanup(ctx core.SetupContext) error

func (*UpdateWorkerRoute) Color added in v0.21.0 

func (u *UpdateWorkerRoute) Color() string

func (*UpdateWorkerRoute) Configuration added in v0.21.0 

func (u *UpdateWorkerRoute) Configuration() []configuration.Field

func (*UpdateWorkerRoute) Description added in v0.21.0 

func (u *UpdateWorkerRoute) Description() string

func (*UpdateWorkerRoute) Documentation added in v0.21.0 

func (u *UpdateWorkerRoute) Documentation() string

func (*UpdateWorkerRoute) ExampleOutput added in v0.21.0 

func (u *UpdateWorkerRoute) ExampleOutput() map[string]any

func (*UpdateWorkerRoute) Execute added in v0.21.0 

func (u *UpdateWorkerRoute) Execute(ctx core.ExecutionContext) error

func (*UpdateWorkerRoute) HandleHook added in v0.21.0 

func (u *UpdateWorkerRoute) HandleHook(ctx core.ActionHookContext) error

func (*UpdateWorkerRoute) HandleWebhook added in v0.21.0 

func (u *UpdateWorkerRoute) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*UpdateWorkerRoute) Hooks added in v0.21.0 

func (u *UpdateWorkerRoute) Hooks() []core.Hook

func (*UpdateWorkerRoute) Icon added in v0.21.0 

func (u *UpdateWorkerRoute) Icon() string

func (*UpdateWorkerRoute) Label added in v0.21.0 

func (u *UpdateWorkerRoute) Label() string

func (*UpdateWorkerRoute) Name added in v0.21.0 

func (u *UpdateWorkerRoute) Name() string

func (*UpdateWorkerRoute) OutputChannels added in v0.21.0 

func (u *UpdateWorkerRoute) OutputChannels(configuration any) []core.OutputChannel

func (*UpdateWorkerRoute) ProcessQueueItem added in v0.21.0 

func (u *UpdateWorkerRoute) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*UpdateWorkerRoute) Setup added in v0.21.0 

func (u *UpdateWorkerRoute) Setup(ctx core.SetupContext) error

type UpdateWorkerRouteSpec added in v0.21.0 

type UpdateWorkerRouteSpec struct {
	AccountID    string `json:"accountId"`
	Zone         string `json:"zone"`
	RouteID      string `json:"routeId"`
	Pattern      string `json:"pattern"`
	WorkerScript string `json:"workerScript"`
}

type WorkerRoute added in v0.21.0 

type WorkerRoute struct {
	ID      string `json:"id"`
	Pattern string `json:"pattern"`
	Script  string `json:"script,omitempty"`
}

WorkerRoute is a zone route mapping a pattern to a Worker script name.

type WorkerScriptNodeMetadata added in v0.21.0 

type WorkerScriptNodeMetadata struct {
	ScriptDisplayName string `json:"scriptDisplayName"`
}

WorkerScriptNodeMetadata stores a display label for Worker script integration resources (picker value is script ID).

type WorkerScriptSummary added in v0.21.0 

type WorkerScriptSummary struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

WorkerScriptSummary is one script from GET .../workers/scripts (ID is the script name used in upload and route URLs).

type Zone 

type Zone struct {
	ID     string `json:"id"`
	Name   string `json:"name"`
	Status string `json:"status"`
}

Zone represents a Cloudflare zone

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.