logs

package
v7.7.0 Latest Latest
Warning

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

Go to latest
Published: Jul 9, 2026 License: Apache-2.0 Imports: 19 Imported by: 0

Documentation

Index

Constants

View Source
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source
const CertificateCASSLCom = shared.CertificateCASSLCom

This is an alias to an internal value.

View Source
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare

This is an alias to an internal value.

View Source
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow

This is an alias to an internal value.

View Source
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny

This is an alias to an internal value.

View Source
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source
const RatePlanIDBusiness = shared.RatePlanIDBusiness

This is an alias to an internal value.

View Source
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise

This is an alias to an internal value.

View Source
const RatePlanIDFree = shared.RatePlanIDFree

This is an alias to an internal value.

View Source
const RatePlanIDLite = shared.RatePlanIDLite

This is an alias to an internal value.

View Source
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness

This is an alias to an internal value.

View Source
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise

This is an alias to an internal value.

View Source
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree

This is an alias to an internal value.

View Source
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro

This is an alias to an internal value.

View Source
const RatePlanIDPro = shared.RatePlanIDPro

This is an alias to an internal value.

View Source
const RatePlanIDProPlus = shared.RatePlanIDProPlus

This is an alias to an internal value.

View Source
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

View Source
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

View Source
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow

This is an alias to an internal value.

View Source
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny

This is an alias to an internal value.

View Source
const TokenStatusActive = shared.TokenStatusActive

This is an alias to an internal value.

View Source
const TokenStatusDisabled = shared.TokenStatusDisabled

This is an alias to an internal value.

View Source
const TokenStatusExpired = shared.TokenStatusExpired

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType

type AuditLogActorType = shared.AuditLogActorType

The type of actor, whether a User, Cloudflare Admin, or an Automated System.

This is an alias to an internal type.

type AuditLogOwner

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type AvailableDataset added in v7.7.0

type AvailableDataset struct {
	// Dataset type name (e.g. `http_requests`).
	Dataset string `json:"dataset" api:"required"`
	// Whether this dataset type is account-scoped or zone-scoped.
	ObjectType AvailableDatasetObjectType `json:"object_type" api:"required"`
	// JSON Schema that describes the fields this dataset exposes.
	Schema AvailableDatasetSchema `json:"schema" api:"required"`
	// The primary timestamp field name for this dataset.
	TimestampField string               `json:"timestamp_field" api:"required"`
	JSON           availableDatasetJSON `json:"-"`
}

A dataset type that the account or zone can create.

func (*AvailableDataset) UnmarshalJSON added in v7.7.0

func (r *AvailableDataset) UnmarshalJSON(data []byte) (err error)

type AvailableDatasetObjectType added in v7.7.0

type AvailableDatasetObjectType string

Whether this dataset type is account-scoped or zone-scoped.

const (
	AvailableDatasetObjectTypeAccount AvailableDatasetObjectType = "account"
	AvailableDatasetObjectTypeZone    AvailableDatasetObjectType = "zone"
)

func (AvailableDatasetObjectType) IsKnown added in v7.7.0

func (r AvailableDatasetObjectType) IsKnown() bool

type AvailableDatasetSchema added in v7.7.0

type AvailableDatasetSchema struct {
	Properties map[string]interface{}     `json:"properties"`
	Required   []string                   `json:"required"`
	Type       AvailableDatasetSchemaType `json:"type"`
	JSON       availableDatasetSchemaJSON `json:"-"`
}

JSON Schema that describes the fields this dataset exposes.

func (*AvailableDatasetSchema) UnmarshalJSON added in v7.7.0

func (r *AvailableDatasetSchema) UnmarshalJSON(data []byte) (err error)

type AvailableDatasetSchemaType added in v7.7.0

type AvailableDatasetSchemaType string
const (
	AvailableDatasetSchemaTypeObject AvailableDatasetSchemaType = "object"
)

func (AvailableDatasetSchemaType) IsKnown added in v7.7.0

func (r AvailableDatasetSchemaType) IsKnown() bool

type AvailableList added in v7.7.0

type AvailableList struct {
	Errors   []shared.ResponseInfo `json:"errors" api:"required"`
	Messages []string              `json:"messages" api:"required"`
	Success  bool                  `json:"success" api:"required"`
	Result   []AvailableDataset    `json:"result" api:"nullable"`
	JSON     availableListJSON     `json:"-"`
}

func (*AvailableList) UnmarshalJSON added in v7.7.0

func (r *AvailableList) UnmarshalJSON(data []byte) (err error)

type CertificateCA

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate.

This is an alias to an internal type.

type CertificateRequestType

type CertificateRequestType = shared.CertificateRequestType

Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).

This is an alias to an internal type.

type CloudflareTunnel

type CloudflareTunnel = shared.CloudflareTunnel

A Cloudflare Tunnel that connects your origin to Cloudflare's edge.

This is an alias to an internal type.

type CloudflareTunnelConfigSrc

type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc

Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard.

This is an alias to an internal type.

type CloudflareTunnelConnection

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

This is an alias to an internal type.

type CloudflareTunnelTunType

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type CmbConfig

type CmbConfig struct {
	// Allow out of region access
	AllowOutOfRegionAccess bool `json:"allow_out_of_region_access"`
	// Name of the region.
	Regions string        `json:"regions"`
	JSON    cmbConfigJSON `json:"-"`
}

func (*CmbConfig) UnmarshalJSON

func (r *CmbConfig) UnmarshalJSON(data []byte) (err error)

type CmbConfigParam

type CmbConfigParam struct {
	// Allow out of region access
	AllowOutOfRegionAccess param.Field[bool] `json:"allow_out_of_region_access"`
	// Name of the region.
	Regions param.Field[string] `json:"regions"`
}

func (CmbConfigParam) MarshalJSON

func (r CmbConfigParam) MarshalJSON() (data []byte, err error)

type ControlCmbConfigDeleteParams

type ControlCmbConfigDeleteParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ControlCmbConfigDeleteResponse

type ControlCmbConfigDeleteResponse = interface{}

type ControlCmbConfigDeleteResponseEnvelope

type ControlCmbConfigDeleteResponseEnvelope struct {
	Errors   []ControlCmbConfigDeleteResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ControlCmbConfigDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success ControlCmbConfigDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  ControlCmbConfigDeleteResponse                `json:"result" api:"nullable"`
	JSON    controlCmbConfigDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*ControlCmbConfigDeleteResponseEnvelope) UnmarshalJSON

func (r *ControlCmbConfigDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type ControlCmbConfigDeleteResponseEnvelopeErrors

type ControlCmbConfigDeleteResponseEnvelopeErrors struct {
	Code             int64                                              `json:"code" api:"required"`
	Message          string                                             `json:"message" api:"required"`
	DocumentationURL string                                             `json:"documentation_url"`
	Source           ControlCmbConfigDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             controlCmbConfigDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ControlCmbConfigDeleteResponseEnvelopeErrors) UnmarshalJSON

func (r *ControlCmbConfigDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type ControlCmbConfigDeleteResponseEnvelopeErrorsSource

type ControlCmbConfigDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                                 `json:"pointer"`
	JSON    controlCmbConfigDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ControlCmbConfigDeleteResponseEnvelopeErrorsSource) UnmarshalJSON

func (r *ControlCmbConfigDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type ControlCmbConfigDeleteResponseEnvelopeMessages

type ControlCmbConfigDeleteResponseEnvelopeMessages struct {
	Code             int64                                                `json:"code" api:"required"`
	Message          string                                               `json:"message" api:"required"`
	DocumentationURL string                                               `json:"documentation_url"`
	Source           ControlCmbConfigDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             controlCmbConfigDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ControlCmbConfigDeleteResponseEnvelopeMessages) UnmarshalJSON

func (r *ControlCmbConfigDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type ControlCmbConfigDeleteResponseEnvelopeMessagesSource

type ControlCmbConfigDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                                   `json:"pointer"`
	JSON    controlCmbConfigDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ControlCmbConfigDeleteResponseEnvelopeMessagesSource) UnmarshalJSON

func (r *ControlCmbConfigDeleteResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type ControlCmbConfigDeleteResponseEnvelopeSuccess

type ControlCmbConfigDeleteResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ControlCmbConfigDeleteResponseEnvelopeSuccessTrue ControlCmbConfigDeleteResponseEnvelopeSuccess = true
)

func (ControlCmbConfigDeleteResponseEnvelopeSuccess) IsKnown

type ControlCmbConfigGetParams

type ControlCmbConfigGetParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type ControlCmbConfigGetResponseEnvelope

type ControlCmbConfigGetResponseEnvelope struct {
	Errors   []ControlCmbConfigGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ControlCmbConfigGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success ControlCmbConfigGetResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  CmbConfig                                  `json:"result" api:"nullable"`
	JSON    controlCmbConfigGetResponseEnvelopeJSON    `json:"-"`
}

func (*ControlCmbConfigGetResponseEnvelope) UnmarshalJSON

func (r *ControlCmbConfigGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type ControlCmbConfigGetResponseEnvelopeErrors

type ControlCmbConfigGetResponseEnvelopeErrors struct {
	Code             int64                                           `json:"code" api:"required"`
	Message          string                                          `json:"message" api:"required"`
	DocumentationURL string                                          `json:"documentation_url"`
	Source           ControlCmbConfigGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             controlCmbConfigGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ControlCmbConfigGetResponseEnvelopeErrors) UnmarshalJSON

func (r *ControlCmbConfigGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type ControlCmbConfigGetResponseEnvelopeErrorsSource

type ControlCmbConfigGetResponseEnvelopeErrorsSource struct {
	Pointer string                                              `json:"pointer"`
	JSON    controlCmbConfigGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ControlCmbConfigGetResponseEnvelopeErrorsSource) UnmarshalJSON

func (r *ControlCmbConfigGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type ControlCmbConfigGetResponseEnvelopeMessages

type ControlCmbConfigGetResponseEnvelopeMessages struct {
	Code             int64                                             `json:"code" api:"required"`
	Message          string                                            `json:"message" api:"required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           ControlCmbConfigGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             controlCmbConfigGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ControlCmbConfigGetResponseEnvelopeMessages) UnmarshalJSON

func (r *ControlCmbConfigGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type ControlCmbConfigGetResponseEnvelopeMessagesSource

type ControlCmbConfigGetResponseEnvelopeMessagesSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    controlCmbConfigGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ControlCmbConfigGetResponseEnvelopeMessagesSource) UnmarshalJSON

func (r *ControlCmbConfigGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type ControlCmbConfigGetResponseEnvelopeSuccess

type ControlCmbConfigGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ControlCmbConfigGetResponseEnvelopeSuccessTrue ControlCmbConfigGetResponseEnvelopeSuccess = true
)

func (ControlCmbConfigGetResponseEnvelopeSuccess) IsKnown

type ControlCmbConfigNewParams

type ControlCmbConfigNewParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	CmbConfig CmbConfigParam      `json:"cmb_config" api:"required"`
}

func (ControlCmbConfigNewParams) MarshalJSON

func (r ControlCmbConfigNewParams) MarshalJSON() (data []byte, err error)

type ControlCmbConfigNewResponseEnvelope

type ControlCmbConfigNewResponseEnvelope struct {
	Errors   []ControlCmbConfigNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ControlCmbConfigNewResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success ControlCmbConfigNewResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  CmbConfig                                  `json:"result" api:"nullable"`
	JSON    controlCmbConfigNewResponseEnvelopeJSON    `json:"-"`
}

func (*ControlCmbConfigNewResponseEnvelope) UnmarshalJSON

func (r *ControlCmbConfigNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type ControlCmbConfigNewResponseEnvelopeErrors

type ControlCmbConfigNewResponseEnvelopeErrors struct {
	Code             int64                                           `json:"code" api:"required"`
	Message          string                                          `json:"message" api:"required"`
	DocumentationURL string                                          `json:"documentation_url"`
	Source           ControlCmbConfigNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             controlCmbConfigNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ControlCmbConfigNewResponseEnvelopeErrors) UnmarshalJSON

func (r *ControlCmbConfigNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type ControlCmbConfigNewResponseEnvelopeErrorsSource

type ControlCmbConfigNewResponseEnvelopeErrorsSource struct {
	Pointer string                                              `json:"pointer"`
	JSON    controlCmbConfigNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ControlCmbConfigNewResponseEnvelopeErrorsSource) UnmarshalJSON

func (r *ControlCmbConfigNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type ControlCmbConfigNewResponseEnvelopeMessages

type ControlCmbConfigNewResponseEnvelopeMessages struct {
	Code             int64                                             `json:"code" api:"required"`
	Message          string                                            `json:"message" api:"required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           ControlCmbConfigNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             controlCmbConfigNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ControlCmbConfigNewResponseEnvelopeMessages) UnmarshalJSON

func (r *ControlCmbConfigNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type ControlCmbConfigNewResponseEnvelopeMessagesSource

type ControlCmbConfigNewResponseEnvelopeMessagesSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    controlCmbConfigNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ControlCmbConfigNewResponseEnvelopeMessagesSource) UnmarshalJSON

func (r *ControlCmbConfigNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type ControlCmbConfigNewResponseEnvelopeSuccess

type ControlCmbConfigNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ControlCmbConfigNewResponseEnvelopeSuccessTrue ControlCmbConfigNewResponseEnvelopeSuccess = true
)

func (ControlCmbConfigNewResponseEnvelopeSuccess) IsKnown

type ControlCmbConfigService

type ControlCmbConfigService struct {
	Options []option.RequestOption
}

ControlCmbConfigService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewControlCmbConfigService method instead.

func NewControlCmbConfigService

func NewControlCmbConfigService(opts ...option.RequestOption) (r *ControlCmbConfigService)

NewControlCmbConfigService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*ControlCmbConfigService) Delete

Deletes CMB config.

func (*ControlCmbConfigService) Get

Gets CMB config.

func (*ControlCmbConfigService) New

Updates CMB config.

type ControlCmbService

type ControlCmbService struct {
	Options []option.RequestOption
	Config  *ControlCmbConfigService
}

ControlCmbService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewControlCmbService method instead.

func NewControlCmbService

func NewControlCmbService(opts ...option.RequestOption) (r *ControlCmbService)

NewControlCmbService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type ControlRetentionGetParams

type ControlRetentionGetParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id" api:"required"`
}

type ControlRetentionGetResponse

type ControlRetentionGetResponse struct {
	// The log retention flag for Logpull API.
	Flag bool                            `json:"flag"`
	JSON controlRetentionGetResponseJSON `json:"-"`
}

func (*ControlRetentionGetResponse) UnmarshalJSON

func (r *ControlRetentionGetResponse) UnmarshalJSON(data []byte) (err error)

type ControlRetentionGetResponseEnvelope

type ControlRetentionGetResponseEnvelope struct {
	Errors   []ControlRetentionGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ControlRetentionGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success ControlRetentionGetResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  ControlRetentionGetResponse                `json:"result" api:"nullable"`
	JSON    controlRetentionGetResponseEnvelopeJSON    `json:"-"`
}

func (*ControlRetentionGetResponseEnvelope) UnmarshalJSON

func (r *ControlRetentionGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type ControlRetentionGetResponseEnvelopeErrors

type ControlRetentionGetResponseEnvelopeErrors struct {
	Code             int64                                           `json:"code" api:"required"`
	Message          string                                          `json:"message" api:"required"`
	DocumentationURL string                                          `json:"documentation_url"`
	Source           ControlRetentionGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             controlRetentionGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ControlRetentionGetResponseEnvelopeErrors) UnmarshalJSON

func (r *ControlRetentionGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type ControlRetentionGetResponseEnvelopeErrorsSource

type ControlRetentionGetResponseEnvelopeErrorsSource struct {
	Pointer string                                              `json:"pointer"`
	JSON    controlRetentionGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ControlRetentionGetResponseEnvelopeErrorsSource) UnmarshalJSON

func (r *ControlRetentionGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type ControlRetentionGetResponseEnvelopeMessages

type ControlRetentionGetResponseEnvelopeMessages struct {
	Code             int64                                             `json:"code" api:"required"`
	Message          string                                            `json:"message" api:"required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           ControlRetentionGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             controlRetentionGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ControlRetentionGetResponseEnvelopeMessages) UnmarshalJSON

func (r *ControlRetentionGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type ControlRetentionGetResponseEnvelopeMessagesSource

type ControlRetentionGetResponseEnvelopeMessagesSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    controlRetentionGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ControlRetentionGetResponseEnvelopeMessagesSource) UnmarshalJSON

func (r *ControlRetentionGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type ControlRetentionGetResponseEnvelopeSuccess

type ControlRetentionGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ControlRetentionGetResponseEnvelopeSuccessTrue ControlRetentionGetResponseEnvelopeSuccess = true
)

func (ControlRetentionGetResponseEnvelopeSuccess) IsKnown

type ControlRetentionNewParams

type ControlRetentionNewParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id" api:"required"`
	// The log retention flag for Logpull API.
	Flag param.Field[bool] `json:"flag"`
}

func (ControlRetentionNewParams) MarshalJSON

func (r ControlRetentionNewParams) MarshalJSON() (data []byte, err error)

type ControlRetentionNewResponse

type ControlRetentionNewResponse struct {
	// The log retention flag for Logpull API.
	Flag bool                            `json:"flag"`
	JSON controlRetentionNewResponseJSON `json:"-"`
}

func (*ControlRetentionNewResponse) UnmarshalJSON

func (r *ControlRetentionNewResponse) UnmarshalJSON(data []byte) (err error)

type ControlRetentionNewResponseEnvelope

type ControlRetentionNewResponseEnvelope struct {
	Errors   []ControlRetentionNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ControlRetentionNewResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success ControlRetentionNewResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  ControlRetentionNewResponse                `json:"result" api:"nullable"`
	JSON    controlRetentionNewResponseEnvelopeJSON    `json:"-"`
}

func (*ControlRetentionNewResponseEnvelope) UnmarshalJSON

func (r *ControlRetentionNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type ControlRetentionNewResponseEnvelopeErrors

type ControlRetentionNewResponseEnvelopeErrors struct {
	Code             int64                                           `json:"code" api:"required"`
	Message          string                                          `json:"message" api:"required"`
	DocumentationURL string                                          `json:"documentation_url"`
	Source           ControlRetentionNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             controlRetentionNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ControlRetentionNewResponseEnvelopeErrors) UnmarshalJSON

func (r *ControlRetentionNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type ControlRetentionNewResponseEnvelopeErrorsSource

type ControlRetentionNewResponseEnvelopeErrorsSource struct {
	Pointer string                                              `json:"pointer"`
	JSON    controlRetentionNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ControlRetentionNewResponseEnvelopeErrorsSource) UnmarshalJSON

func (r *ControlRetentionNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type ControlRetentionNewResponseEnvelopeMessages

type ControlRetentionNewResponseEnvelopeMessages struct {
	Code             int64                                             `json:"code" api:"required"`
	Message          string                                            `json:"message" api:"required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           ControlRetentionNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             controlRetentionNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ControlRetentionNewResponseEnvelopeMessages) UnmarshalJSON

func (r *ControlRetentionNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type ControlRetentionNewResponseEnvelopeMessagesSource

type ControlRetentionNewResponseEnvelopeMessagesSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    controlRetentionNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ControlRetentionNewResponseEnvelopeMessagesSource) UnmarshalJSON

func (r *ControlRetentionNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type ControlRetentionNewResponseEnvelopeSuccess

type ControlRetentionNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ControlRetentionNewResponseEnvelopeSuccessTrue ControlRetentionNewResponseEnvelopeSuccess = true
)

func (ControlRetentionNewResponseEnvelopeSuccess) IsKnown

type ControlRetentionService

type ControlRetentionService struct {
	Options []option.RequestOption
}

ControlRetentionService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewControlRetentionService method instead.

func NewControlRetentionService

func NewControlRetentionService(opts ...option.RequestOption) (r *ControlRetentionService)

NewControlRetentionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*ControlRetentionService) Get

Gets log retention flag for Logpull API.

func (*ControlRetentionService) New

Updates log retention flag for Logpull API.

type ControlService

type ControlService struct {
	Options   []option.RequestOption
	Retention *ControlRetentionService
	Cmb       *ControlCmbService
}

ControlService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewControlService method instead.

func NewControlService

func NewControlService(opts ...option.RequestOption) (r *ControlService)

NewControlService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type CreateRequestFieldParam added in v7.7.0

type CreateRequestFieldParam struct {
	// Whether the API includes this field in log ingest.
	Enabled param.Field[bool] `json:"enabled" api:"required"`
	// Field name in lowercase.
	Name param.Field[string] `json:"name" api:"required"`
}

func (CreateRequestFieldParam) MarshalJSON added in v7.7.0

func (r CreateRequestFieldParam) MarshalJSON() (data []byte, err error)

type CreateRequestParam added in v7.7.0

type CreateRequestParam struct {
	// Dataset type name to create (e.g. `http_requests`).
	Dataset param.Field[string] `json:"dataset" api:"required"`
	// Controls which fields the API ingests. Defaults to all available fields when
	// absent.
	Fields param.Field[[]CreateRequestFieldParam] `json:"fields"`
}

func (CreateRequestParam) MarshalJSON added in v7.7.0

func (r CreateRequestParam) MarshalJSON() (data []byte, err error)

type Dataset added in v7.7.0

type Dataset struct {
	// RFC3339 timestamp recording when the API created this dataset.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Dataset type name (e.g. `http_requests`).
	Dataset string `json:"dataset" api:"required"`
	// Unique dataset ID.
	DatasetID string `json:"dataset_id" api:"required"`
	// Whether log ingest is currently active for this dataset.
	Enabled bool `json:"enabled" api:"required"`
	// Public ID of the account or zone that owns this dataset.
	ObjectID string `json:"object_id" api:"required"`
	// Whether this dataset belongs to an account or a zone.
	ObjectType DatasetObjectType `json:"object_type" api:"required"`
	// RFC3339 timestamp recording when the API last updated this dataset.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// The field configuration for this dataset.
	Fields []DatasetField `json:"fields"`
	JSON   datasetJSON    `json:"-"`
}

A Log Explorer dataset summary. List endpoints return this type and omit field configuration; use the single-dataset endpoint to retrieve it.

func (*Dataset) UnmarshalJSON added in v7.7.0

func (r *Dataset) UnmarshalJSON(data []byte) (err error)

type DatasetField added in v7.7.0

type DatasetField struct {
	// Whether the API includes this field in log ingest.
	Enabled bool `json:"enabled" api:"required"`
	// Field name in lowercase.
	Name string           `json:"name" api:"required"`
	JSON datasetFieldJSON `json:"-"`
}

func (*DatasetField) UnmarshalJSON added in v7.7.0

func (r *DatasetField) UnmarshalJSON(data []byte) (err error)

type DatasetObjectType added in v7.7.0

type DatasetObjectType string

Whether this dataset belongs to an account or a zone.

const (
	DatasetObjectTypeAccount DatasetObjectType = "account"
	DatasetObjectTypeZone    DatasetObjectType = "zone"
)

func (DatasetObjectType) IsKnown added in v7.7.0

func (r DatasetObjectType) IsKnown() bool

type DatasetSummary added in v7.7.0

type DatasetSummary struct {
	// RFC3339 timestamp recording when the API created this dataset.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Dataset type name (e.g. `http_requests`).
	Dataset string `json:"dataset" api:"required"`
	// Unique dataset ID.
	DatasetID string `json:"dataset_id" api:"required"`
	// Whether log ingest is currently active for this dataset.
	Enabled bool `json:"enabled" api:"required"`
	// Public ID of the account or zone that owns this dataset.
	ObjectID string `json:"object_id" api:"required"`
	// Whether this dataset belongs to an account or a zone.
	ObjectType DatasetSummaryObjectType `json:"object_type" api:"required"`
	// RFC3339 timestamp recording when the API last updated this dataset.
	UpdatedAt time.Time          `json:"updated_at" api:"required" format:"date-time"`
	JSON      datasetSummaryJSON `json:"-"`
}

A Log Explorer dataset summary. List endpoints return this type and omit field configuration; use the single-dataset endpoint to retrieve it.

func (*DatasetSummary) UnmarshalJSON added in v7.7.0

func (r *DatasetSummary) UnmarshalJSON(data []byte) (err error)

type DatasetSummaryObjectType added in v7.7.0

type DatasetSummaryObjectType string

Whether this dataset belongs to an account or a zone.

const (
	DatasetSummaryObjectTypeAccount DatasetSummaryObjectType = "account"
	DatasetSummaryObjectTypeZone    DatasetSummaryObjectType = "zone"
)

func (DatasetSummaryObjectType) IsKnown added in v7.7.0

func (r DatasetSummaryObjectType) IsKnown() bool

type Error

type Error = apierror.Error

type ErrorData

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type LogExplorerDatasetAvailableListParams added in v7.7.0

type LogExplorerDatasetAvailableListParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type LogExplorerDatasetAvailableService added in v7.7.0

type LogExplorerDatasetAvailableService struct {
	Options []option.RequestOption
}

LogExplorerDatasetAvailableService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewLogExplorerDatasetAvailableService method instead.

func NewLogExplorerDatasetAvailableService added in v7.7.0

func NewLogExplorerDatasetAvailableService(opts ...option.RequestOption) (r *LogExplorerDatasetAvailableService)

NewLogExplorerDatasetAvailableService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*LogExplorerDatasetAvailableService) List added in v7.7.0

Returns all dataset types that this account or zone can create. Each entry includes the dataset schema and timestamp field.

The schema shows all possible fields for a dataset. However, not all fields may be available for your account or zone. When creating or updating a dataset, only fields available to your account or zone can be enabled. If you request a field that is not available, you will receive an error.

func (*LogExplorerDatasetAvailableService) ListAutoPaging added in v7.7.0

Returns all dataset types that this account or zone can create. Each entry includes the dataset schema and timestamp field.

The schema shows all possible fields for a dataset. However, not all fields may be available for your account or zone. When creating or updating a dataset, only fields available to your account or zone can be enabled. If you request a field that is not available, you will receive an error.

type LogExplorerDatasetGetParams added in v7.7.0

type LogExplorerDatasetGetParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type LogExplorerDatasetGetResponseEnvelope added in v7.7.0

type LogExplorerDatasetGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors" api:"required"`
	Messages []string              `json:"messages" api:"required"`
	Success  bool                  `json:"success" api:"required"`
	// A Log Explorer dataset summary. List endpoints return this type and omit field
	// configuration; use the single-dataset endpoint to retrieve it.
	Result Dataset                                   `json:"result"`
	JSON   logExplorerDatasetGetResponseEnvelopeJSON `json:"-"`
}

func (*LogExplorerDatasetGetResponseEnvelope) UnmarshalJSON added in v7.7.0

func (r *LogExplorerDatasetGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type LogExplorerDatasetListParams added in v7.7.0

type LogExplorerDatasetListParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
	// Set to true to include zone-scoped datasets belonging to this account.
	IncludeZones param.Field[bool] `query:"include_zones"`
}

func (LogExplorerDatasetListParams) URLQuery added in v7.7.0

func (r LogExplorerDatasetListParams) URLQuery() (v url.Values)

URLQuery serializes LogExplorerDatasetListParams's query parameters as `url.Values`.

type LogExplorerDatasetNewParams added in v7.7.0

type LogExplorerDatasetNewParams struct {
	CreateRequest CreateRequestParam `json:"create_request" api:"required"`
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

func (LogExplorerDatasetNewParams) MarshalJSON added in v7.7.0

func (r LogExplorerDatasetNewParams) MarshalJSON() (data []byte, err error)

type LogExplorerDatasetNewResponseEnvelope added in v7.7.0

type LogExplorerDatasetNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors" api:"required"`
	Messages []string              `json:"messages" api:"required"`
	Success  bool                  `json:"success" api:"required"`
	// A Log Explorer dataset summary. List endpoints return this type and omit field
	// configuration; use the single-dataset endpoint to retrieve it.
	Result Dataset                                   `json:"result"`
	JSON   logExplorerDatasetNewResponseEnvelopeJSON `json:"-"`
}

func (*LogExplorerDatasetNewResponseEnvelope) UnmarshalJSON added in v7.7.0

func (r *LogExplorerDatasetNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type LogExplorerDatasetService added in v7.7.0

type LogExplorerDatasetService struct {
	Options   []option.RequestOption
	Available *LogExplorerDatasetAvailableService
}

LogExplorerDatasetService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewLogExplorerDatasetService method instead.

func NewLogExplorerDatasetService added in v7.7.0

func NewLogExplorerDatasetService(opts ...option.RequestOption) (r *LogExplorerDatasetService)

NewLogExplorerDatasetService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*LogExplorerDatasetService) Get added in v7.7.0

Retrieve a single Log Explorer dataset by ID for the account or zone.

func (*LogExplorerDatasetService) List added in v7.7.0

Returns all Log Explorer datasets configured for the account or zone.

Pass `include_zones=true` to also include zone-level datasets that belong to this account or zone. List responses omit the `fields` property; use the single-dataset endpoint to retrieve field configuration.

func (*LogExplorerDatasetService) ListAutoPaging added in v7.7.0

Returns all Log Explorer datasets configured for the account or zone.

Pass `include_zones=true` to also include zone-level datasets that belong to this account or zone. List responses omit the `fields` property; use the single-dataset endpoint to retrieve field configuration.

func (*LogExplorerDatasetService) New added in v7.7.0

Create a new Log Explorer dataset for the account or zone.

Use the `/account or zones/{account or zone_id}/logs/explorer/datasets/available` endpoint to list dataset types you can create along with their available fields.

The `fields` property is optional. If not specified, all available fields will be enabled.

For zone-level datasets use the zone-scoped endpoint: POST /zones/{zone_id}/logs/explorer/datasets

For dataset field definitions, see: https://developers.cloudflare.com/logs/logpush/logpush-job/datasets/

func (*LogExplorerDatasetService) Update added in v7.7.0

func (r *LogExplorerDatasetService) Update(ctx context.Context, datasetID string, params LogExplorerDatasetUpdateParams, opts ...option.RequestOption) (res *Dataset, err error)

Updates the enabled state and/or field configuration of an account or zone dataset.

type LogExplorerDatasetUpdateParams added in v7.7.0

type LogExplorerDatasetUpdateParams struct {
	UpdateRequest UpdateRequestParam `json:"update_request" api:"required"`
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

func (LogExplorerDatasetUpdateParams) MarshalJSON added in v7.7.0

func (r LogExplorerDatasetUpdateParams) MarshalJSON() (data []byte, err error)

type LogExplorerDatasetUpdateResponseEnvelope added in v7.7.0

type LogExplorerDatasetUpdateResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors" api:"required"`
	Messages []string              `json:"messages" api:"required"`
	Success  bool                  `json:"success" api:"required"`
	// A Log Explorer dataset summary. List endpoints return this type and omit field
	// configuration; use the single-dataset endpoint to retrieve it.
	Result Dataset                                      `json:"result"`
	JSON   logExplorerDatasetUpdateResponseEnvelopeJSON `json:"-"`
}

func (*LogExplorerDatasetUpdateResponseEnvelope) UnmarshalJSON added in v7.7.0

func (r *LogExplorerDatasetUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type LogExplorerQueryService added in v7.7.0

type LogExplorerQueryService struct {
	Options []option.RequestOption
}

LogExplorerQueryService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewLogExplorerQueryService method instead.

func NewLogExplorerQueryService added in v7.7.0

func NewLogExplorerQueryService(opts ...option.RequestOption) (r *LogExplorerQueryService)

NewLogExplorerQueryService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*LogExplorerQueryService) Sql added in v7.7.0

Run a SQL query against account or zone-level datasets.

Timestamp fields are RFC3339 strings. Filter with: WHERE {timestamp_field} >= now() - INTERVAL '30' DAY WHERE {timestamp_field} >= '2026-04-01T00:00:00Z' WHERE {timestamp_field} BETWEEN '2026-04-01T00:00:00Z' AND '2026-04-30T23:59:59Z'

Check /account or zones/{account or zone_id}/logs/explorer/datasets to see enabled account or zone level datasets. Zone-level datasets will not appear here. Check /account or zones/{account or zone_id}/logs/explorer/datasets/available for the schemas, and the name of the timestamp fields.

For zone-level datasets use the zone-scoped endpoint: POST /zones/{zone_id}/logs/explorer/query/sql

For more information about the datasets, and the meaning of each field, check out https://developers.cloudflare.com/logs/logpush/logpush-job/datasets/

func (*LogExplorerQueryService) SqlAutoPaging added in v7.7.0

Run a SQL query against account or zone-level datasets.

Timestamp fields are RFC3339 strings. Filter with: WHERE {timestamp_field} >= now() - INTERVAL '30' DAY WHERE {timestamp_field} >= '2026-04-01T00:00:00Z' WHERE {timestamp_field} BETWEEN '2026-04-01T00:00:00Z' AND '2026-04-30T23:59:59Z'

Check /account or zones/{account or zone_id}/logs/explorer/datasets to see enabled account or zone level datasets. Zone-level datasets will not appear here. Check /account or zones/{account or zone_id}/logs/explorer/datasets/available for the schemas, and the name of the timestamp fields.

For zone-level datasets use the zone-scoped endpoint: POST /zones/{zone_id}/logs/explorer/query/sql

For more information about the datasets, and the meaning of each field, check out https://developers.cloudflare.com/logs/logpush/logpush-job/datasets/

type LogExplorerQuerySqlParams added in v7.7.0

type LogExplorerQuerySqlParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

func (LogExplorerQuerySqlParams) MarshalMultipart added in v7.7.0

func (r LogExplorerQuerySqlParams) MarshalMultipart() (data []byte, contentType string, err error)

type LogExplorerQuerySqlResponse added in v7.7.0

type LogExplorerQuerySqlResponse map[string]interface{}

type LogExplorerService added in v7.7.0

type LogExplorerService struct {
	Options  []option.RequestOption
	Query    *LogExplorerQueryService
	Datasets *LogExplorerDatasetService
}

LogExplorerService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewLogExplorerService method instead.

func NewLogExplorerService added in v7.7.0

func NewLogExplorerService(opts ...option.RequestOption) (r *LogExplorerService)

NewLogExplorerService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type LogService

type LogService struct {
	Options     []option.RequestOption
	LogExplorer *LogExplorerService
	Control     *ControlService
	RayID       *RayIDService
	Received    *ReceivedService
}

LogService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewLogService method instead.

func NewLogService

func NewLogService(opts ...option.RequestOption) (r *LogService)

NewLogService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type Member

type Member = shared.Member

This is an alias to an internal type.

type MemberPoliciesAccess

type MemberPoliciesAccess = shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroup

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroupsMeta

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type MemberPoliciesResourceGroup

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsMeta

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScope

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

A scope is a combination of scope objects which provides additional context.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScopeObject

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

A scope object represents any resource that can have actions applied against invite.

This is an alias to an internal type.

type MemberPolicy

type MemberPolicy = shared.MemberPolicy

This is an alias to an internal type.

type MemberStatus

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUser

type MemberUser = shared.MemberUser

Details of the user associated to the membership.

This is an alias to an internal type.

type Permission

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type RatePlan

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanID

type RatePlanID = shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

type RatePlanParam

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type RayIDGetParams

type RayIDGetParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id" api:"required"`
	// The `/received` route by default returns a limited set of fields, and allows
	// customers to override the default field set by specifying individual fields. The
	// reasons for this are: 1. Most customers require only a small subset of fields,
	// but that subset varies from customer to customer; 2. Flat schema is much easier
	// to work with downstream (importing into BigTable etc); 3. Performance (time to
	// process, file size). If `?fields=` is not specified, default field set is
	// returned. This default field set may change at any time. When `?fields=` is
	// provided, each record is returned with the specified fields. `fields` must be
	// specified as a comma separated list without any whitespaces, and all fields must
	// exist. The order in which fields are specified does not matter, and the order of
	// fields in the response is not specified.
	Fields param.Field[string] `query:"fields"`
	// By default, timestamps in responses are returned as Unix nanosecond integers.
	// The `?timestamps=` argument can be set to change the format in which response
	// timestamps are returned. Possible values are: `unix`, `unixnano`, `rfc3339`.
	// Note that `unix` and `unixnano` return timestamps as integers; `rfc3339` returns
	// timestamps as strings.
	Timestamps param.Field[RayIDGetParamsTimestamps] `query:"timestamps"`
}

func (RayIDGetParams) URLQuery

func (r RayIDGetParams) URLQuery() (v url.Values)

URLQuery serializes RayIDGetParams's query parameters as `url.Values`.

type RayIDGetParamsTimestamps

type RayIDGetParamsTimestamps string

By default, timestamps in responses are returned as Unix nanosecond integers. The `?timestamps=` argument can be set to change the format in which response timestamps are returned. Possible values are: `unix`, `unixnano`, `rfc3339`. Note that `unix` and `unixnano` return timestamps as integers; `rfc3339` returns timestamps as strings.

const (
	RayIDGetParamsTimestampsUnix     RayIDGetParamsTimestamps = "unix"
	RayIDGetParamsTimestampsUnixnano RayIDGetParamsTimestamps = "unixnano"
	RayIDGetParamsTimestampsRfc3339  RayIDGetParamsTimestamps = "rfc3339"
)

func (RayIDGetParamsTimestamps) IsKnown

func (r RayIDGetParamsTimestamps) IsKnown() bool

type RayIDService

type RayIDService struct {
	Options []option.RequestOption
}

RayIDService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewRayIDService method instead.

func NewRayIDService

func NewRayIDService(opts ...option.RequestOption) (r *RayIDService)

NewRayIDService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*RayIDService) Get

func (r *RayIDService) Get(ctx context.Context, RayID string, params RayIDGetParams, opts ...option.RequestOption) (res *interface{}, err error)

The `/rayids` api route allows lookups by specific rayid. The rayids route will return zero, one, or more records (ray ids are not unique).

type ReceivedFieldGetParams

type ReceivedFieldGetParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id" api:"required"`
}

type ReceivedFieldGetResponse

type ReceivedFieldGetResponse struct {
	Key  string                       `json:"key"`
	JSON receivedFieldGetResponseJSON `json:"-"`
}

func (*ReceivedFieldGetResponse) UnmarshalJSON

func (r *ReceivedFieldGetResponse) UnmarshalJSON(data []byte) (err error)

type ReceivedFieldService

type ReceivedFieldService struct {
	Options []option.RequestOption
}

ReceivedFieldService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewReceivedFieldService method instead.

func NewReceivedFieldService

func NewReceivedFieldService(opts ...option.RequestOption) (r *ReceivedFieldService)

NewReceivedFieldService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*ReceivedFieldService) Get

Lists all fields available. The response is json object with key-value pairs, where keys are field names, and values are descriptions.

type ReceivedGetParams

type ReceivedGetParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id" api:"required"`
	// Sets the (exclusive) end of the requested time frame. This can be a unix
	// timestamp (in seconds or nanoseconds), or an absolute timestamp that conforms to
	// RFC 3339. `end` must be at least five minutes earlier than now and must be later
	// than `start`. Difference between `start` and `end` must be not greater than one
	// hour.
	End param.Field[ReceivedGetParamsEndUnion] `query:"end" api:"required"`
	// When `?count=` is provided, the response will contain up to `count` results.
	// Since results are not sorted, you are likely to get different data for repeated
	// requests. `count` must be an integer > 0.
	Count param.Field[int64] `query:"count"`
	// The `/received` route by default returns a limited set of fields, and allows
	// customers to override the default field set by specifying individual fields. The
	// reasons for this are: 1. Most customers require only a small subset of fields,
	// but that subset varies from customer to customer; 2. Flat schema is much easier
	// to work with downstream (importing into BigTable etc); 3. Performance (time to
	// process, file size). If `?fields=` is not specified, default field set is
	// returned. This default field set may change at any time. When `?fields=` is
	// provided, each record is returned with the specified fields. `fields` must be
	// specified as a comma separated list without any whitespaces, and all fields must
	// exist. The order in which fields are specified does not matter, and the order of
	// fields in the response is not specified.
	Fields param.Field[string] `query:"fields"`
	// When `?sample=` is provided, a sample of matching records is returned. If
	// `sample=0.1` then 10% of records will be returned. Sampling is random: repeated
	// calls will not only return different records, but likely will also vary slightly
	// in number of returned records. When `?count=` is also specified, `count` is
	// applied to the number of returned records, not the sampled records. So, with
	// `sample=0.05` and `count=7`, when there is a total of 100 records available,
	// approximately five will be returned. When there are 1000 records, seven will be
	// returned. When there are 10,000 records, seven will be returned.
	Sample param.Field[float64] `query:"sample"`
	// Sets the (inclusive) beginning of the requested time frame. This can be a unix
	// timestamp (in seconds or nanoseconds), or an absolute timestamp that conforms to
	// RFC 3339. At this point in time, it cannot exceed a time in the past greater
	// than seven days.
	Start param.Field[ReceivedGetParamsStartUnion] `query:"start"`
	// By default, timestamps in responses are returned as Unix nanosecond integers.
	// The `?timestamps=` argument can be set to change the format in which response
	// timestamps are returned. Possible values are: `unix`, `unixnano`, `rfc3339`.
	// Note that `unix` and `unixnano` return timestamps as integers; `rfc3339` returns
	// timestamps as strings.
	Timestamps param.Field[ReceivedGetParamsTimestamps] `query:"timestamps"`
}

func (ReceivedGetParams) URLQuery

func (r ReceivedGetParams) URLQuery() (v url.Values)

URLQuery serializes ReceivedGetParams's query parameters as `url.Values`.

type ReceivedGetParamsEndUnion

type ReceivedGetParamsEndUnion interface {
	ImplementsReceivedGetParamsEndUnion()
}

Sets the (exclusive) end of the requested time frame. This can be a unix timestamp (in seconds or nanoseconds), or an absolute timestamp that conforms to RFC 3339. `end` must be at least five minutes earlier than now and must be later than `start`. Difference between `start` and `end` must be not greater than one hour.

Satisfied by shared.UnionString, shared.UnionInt.

type ReceivedGetParamsStartUnion

type ReceivedGetParamsStartUnion interface {
	ImplementsReceivedGetParamsStartUnion()
}

Sets the (inclusive) beginning of the requested time frame. This can be a unix timestamp (in seconds or nanoseconds), or an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than seven days.

Satisfied by shared.UnionString, shared.UnionInt.

type ReceivedGetParamsTimestamps

type ReceivedGetParamsTimestamps string

By default, timestamps in responses are returned as Unix nanosecond integers. The `?timestamps=` argument can be set to change the format in which response timestamps are returned. Possible values are: `unix`, `unixnano`, `rfc3339`. Note that `unix` and `unixnano` return timestamps as integers; `rfc3339` returns timestamps as strings.

const (
	ReceivedGetParamsTimestampsUnix     ReceivedGetParamsTimestamps = "unix"
	ReceivedGetParamsTimestampsUnixnano ReceivedGetParamsTimestamps = "unixnano"
	ReceivedGetParamsTimestampsRfc3339  ReceivedGetParamsTimestamps = "rfc3339"
)

func (ReceivedGetParamsTimestamps) IsKnown

func (r ReceivedGetParamsTimestamps) IsKnown() bool

type ReceivedService

type ReceivedService struct {
	Options []option.RequestOption
	Fields  *ReceivedFieldService
}

ReceivedService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewReceivedService method instead.

func NewReceivedService

func NewReceivedService(opts ...option.RequestOption) (r *ReceivedService)

NewReceivedService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*ReceivedService) Get

func (r *ReceivedService) Get(ctx context.Context, params ReceivedGetParams, opts ...option.RequestOption) (res *interface{}, err error)

The `/received` api route allows customers to retrieve their edge HTTP logs. The basic access pattern is "give me all the logs for zone Z for minute M", where the minute M refers to the time records were received at Cloudflare's central data center. `start` is inclusive, and `end` is exclusive. Because of that, to get all data, at minutely cadence, starting at 10AM, the proper values are: `start=2018-05-20T10:00:00Z&end=2018-05-20T10:01:00Z`, then `start=2018-05-20T10:01:00Z&end=2018-05-20T10:02:00Z` and so on; the overlap will be handled properly.

type ResponseInfo

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type ResponseInfoSource

type ResponseInfoSource = shared.ResponseInfoSource

This is an alias to an internal type.

type Role

type Role = shared.Role

This is an alias to an internal type.

type RoleParam

type RoleParam = shared.RoleParam

This is an alias to an internal type.

type RolePermissions

type RolePermissions = shared.RolePermissions

This is an alias to an internal type.

type RolePermissionsParam

type RolePermissionsParam = shared.RolePermissionsParam

This is an alias to an internal type.

type SortDirection

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type Subscription

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type Token

type Token = shared.Token

This is an alias to an internal type.

type TokenCondition

type TokenCondition = shared.TokenCondition

This is an alias to an internal type.

type TokenConditionCIDRList

type TokenConditionCIDRList = shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionCIDRListParam

type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionParam

type TokenConditionParam = shared.TokenConditionParam

This is an alias to an internal type.

type TokenConditionRequestIP

type TokenConditionRequestIP = shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

type TokenConditionRequestIPParam

type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

type TokenParam

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy

type TokenPolicy = shared.TokenPolicy

This is an alias to an internal type.

type TokenPolicyEffect

type TokenPolicyEffect = shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

type TokenPolicyParam

type TokenPolicyParam = shared.TokenPolicyParam

This is an alias to an internal type.

type TokenPolicyPermissionGroup

type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupParam

type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMeta

type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMetaParam

type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNested

type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectString

type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesUnion

type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenPolicyResourcesUnionParam

type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenStatus

type TokenStatus = shared.TokenStatus

Status of the token.

This is an alias to an internal type.

type TokenValue

type TokenValue = shared.TokenValue

The token value.

This is an alias to an internal type.

type UpdateRequestFieldParam added in v7.7.0

type UpdateRequestFieldParam struct {
	// Whether the API includes this field in log ingest.
	Enabled param.Field[bool] `json:"enabled" api:"required"`
	// Field name in lowercase.
	Name param.Field[string] `json:"name" api:"required"`
}

func (UpdateRequestFieldParam) MarshalJSON added in v7.7.0

func (r UpdateRequestFieldParam) MarshalJSON() (data []byte, err error)

type UpdateRequestParam added in v7.7.0

type UpdateRequestParam struct {
	// Whether to enable or disable log ingest for this dataset.
	Enabled param.Field[bool] `json:"enabled" api:"required"`
	// Controls which fields the API ingests after the update. Defaults to all
	// available fields when absent.
	Fields param.Field[[]UpdateRequestFieldParam] `json:"fields"`
}

func (UpdateRequestParam) MarshalJSON added in v7.7.0

func (r UpdateRequestParam) MarshalJSON() (data []byte, err error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL