intel

package
v7.9.0 Latest Latest
Warning

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

Go to latest
Published: Aug 20, 2026 License: Apache-2.0 Imports: 18 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 ASNGetParams

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

type ASNGetResponseEnvelope

type ASNGetResponseEnvelope struct {
	Errors   []ASNGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ASNGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success ASNGetResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  shared.ASN                    `json:"result"`
	JSON    asnGetResponseEnvelopeJSON    `json:"-"`
}

func (*ASNGetResponseEnvelope) UnmarshalJSON

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

type ASNGetResponseEnvelopeErrors

type ASNGetResponseEnvelopeErrors struct {
	Code             int64                              `json:"code" api:"required"`
	Message          string                             `json:"message" api:"required"`
	DocumentationURL string                             `json:"documentation_url"`
	Source           ASNGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             asnGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ASNGetResponseEnvelopeErrors) UnmarshalJSON

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

type ASNGetResponseEnvelopeErrorsSource

type ASNGetResponseEnvelopeErrorsSource struct {
	Pointer string                                 `json:"pointer"`
	JSON    asnGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ASNGetResponseEnvelopeErrorsSource) UnmarshalJSON

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

type ASNGetResponseEnvelopeMessages

type ASNGetResponseEnvelopeMessages struct {
	Code             int64                                `json:"code" api:"required"`
	Message          string                               `json:"message" api:"required"`
	DocumentationURL string                               `json:"documentation_url"`
	Source           ASNGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             asnGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ASNGetResponseEnvelopeMessages) UnmarshalJSON

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

type ASNGetResponseEnvelopeMessagesSource

type ASNGetResponseEnvelopeMessagesSource struct {
	Pointer string                                   `json:"pointer"`
	JSON    asnGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ASNGetResponseEnvelopeMessagesSource) UnmarshalJSON

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

type ASNGetResponseEnvelopeSuccess

type ASNGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ASNGetResponseEnvelopeSuccessTrue ASNGetResponseEnvelopeSuccess = true
)

func (ASNGetResponseEnvelopeSuccess) IsKnown

func (r ASNGetResponseEnvelopeSuccess) IsKnown() bool

type ASNParam

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type ASNService

type ASNService struct {
	Options []option.RequestOption
	Subnets *ASNSubnetService
}

ASNService 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 NewASNService method instead.

func NewASNService

func NewASNService(opts ...option.RequestOption) (r *ASNService)

NewASNService 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 (*ASNService) Get

func (r *ASNService) Get(ctx context.Context, asn shared.ASNParam, query ASNGetParams, opts ...option.RequestOption) (res *shared.ASN, err error)

Gets an overview of the Autonomous System Number (ASN) and a list of subnets for it.

type ASNSubnetGetParams

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

type ASNSubnetGetResponse

type ASNSubnetGetResponse struct {
	ASN shared.ASN `json:"asn"`
	// Total results returned based on your search parameters.
	Count        float64 `json:"count"`
	IPCountTotal int64   `json:"ip_count_total"`
	// Current page within paginated list of results.
	Page float64 `json:"page"`
	// Number of results per page of results.
	PerPage float64                  `json:"per_page"`
	Subnets []string                 `json:"subnets"`
	JSON    asnSubnetGetResponseJSON `json:"-"`
}

func (*ASNSubnetGetResponse) UnmarshalJSON

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

type ASNSubnetService

type ASNSubnetService struct {
	Options []option.RequestOption
}

ASNSubnetService 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 NewASNSubnetService method instead.

func NewASNSubnetService

func NewASNSubnetService(opts ...option.RequestOption) (r *ASNSubnetService)

NewASNSubnetService 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 (*ASNSubnetService) Get

Get ASN Subnets.

type AttackSurfaceReportIssueClassParams

type AttackSurfaceReportIssueClassParams struct {
	// Identifier.
	AccountID     param.Field[string]               `path:"account_id" api:"required"`
	Dismissed     param.Field[bool]                 `query:"dismissed"`
	IssueClass    param.Field[[]string]             `query:"issue_class"`
	IssueClassNeq param.Field[[]string]             `query:"issue_class~neq"`
	IssueType     param.Field[[]IssueType]          `query:"issue_type"`
	IssueTypeNeq  param.Field[[]IssueType]          `query:"issue_type~neq"`
	Product       param.Field[[]string]             `query:"product"`
	ProductNeq    param.Field[[]string]             `query:"product~neq"`
	Severity      param.Field[[]SeverityQueryParam] `query:"severity"`
	SeverityNeq   param.Field[[]SeverityQueryParam] `query:"severity~neq"`
	Subject       param.Field[[]string]             `query:"subject"`
	SubjectNeq    param.Field[[]string]             `query:"subject~neq"`
}

func (AttackSurfaceReportIssueClassParams) URLQuery

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

type AttackSurfaceReportIssueClassResponse

type AttackSurfaceReportIssueClassResponse struct {
	Count int64                                     `json:"count"`
	Value string                                    `json:"value"`
	JSON  attackSurfaceReportIssueClassResponseJSON `json:"-"`
}

func (*AttackSurfaceReportIssueClassResponse) UnmarshalJSON

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

type AttackSurfaceReportIssueClassResponseEnvelope

type AttackSurfaceReportIssueClassResponseEnvelope struct {
	Errors   []AttackSurfaceReportIssueClassResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []AttackSurfaceReportIssueClassResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success AttackSurfaceReportIssueClassResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  []AttackSurfaceReportIssueClassResponse              `json:"result"`
	JSON    attackSurfaceReportIssueClassResponseEnvelopeJSON    `json:"-"`
}

func (*AttackSurfaceReportIssueClassResponseEnvelope) UnmarshalJSON

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

type AttackSurfaceReportIssueClassResponseEnvelopeErrors

type AttackSurfaceReportIssueClassResponseEnvelopeErrors struct {
	Code             int64                                                     `json:"code" api:"required"`
	Message          string                                                    `json:"message" api:"required"`
	DocumentationURL string                                                    `json:"documentation_url"`
	Source           AttackSurfaceReportIssueClassResponseEnvelopeErrorsSource `json:"source"`
	JSON             attackSurfaceReportIssueClassResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*AttackSurfaceReportIssueClassResponseEnvelopeErrors) UnmarshalJSON

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

type AttackSurfaceReportIssueClassResponseEnvelopeErrorsSource

type AttackSurfaceReportIssueClassResponseEnvelopeErrorsSource struct {
	Pointer string                                                        `json:"pointer"`
	JSON    attackSurfaceReportIssueClassResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*AttackSurfaceReportIssueClassResponseEnvelopeErrorsSource) UnmarshalJSON

type AttackSurfaceReportIssueClassResponseEnvelopeMessages

type AttackSurfaceReportIssueClassResponseEnvelopeMessages struct {
	Code             int64                                                       `json:"code" api:"required"`
	Message          string                                                      `json:"message" api:"required"`
	DocumentationURL string                                                      `json:"documentation_url"`
	Source           AttackSurfaceReportIssueClassResponseEnvelopeMessagesSource `json:"source"`
	JSON             attackSurfaceReportIssueClassResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*AttackSurfaceReportIssueClassResponseEnvelopeMessages) UnmarshalJSON

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

type AttackSurfaceReportIssueClassResponseEnvelopeMessagesSource

type AttackSurfaceReportIssueClassResponseEnvelopeMessagesSource struct {
	Pointer string                                                          `json:"pointer"`
	JSON    attackSurfaceReportIssueClassResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*AttackSurfaceReportIssueClassResponseEnvelopeMessagesSource) UnmarshalJSON

type AttackSurfaceReportIssueClassResponseEnvelopeSuccess

type AttackSurfaceReportIssueClassResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	AttackSurfaceReportIssueClassResponseEnvelopeSuccessTrue AttackSurfaceReportIssueClassResponseEnvelopeSuccess = true
)

func (AttackSurfaceReportIssueClassResponseEnvelopeSuccess) IsKnown

type AttackSurfaceReportIssueListParams

type AttackSurfaceReportIssueListParams struct {
	// Identifier.
	AccountID     param.Field[string]      `path:"account_id" api:"required"`
	Dismissed     param.Field[bool]        `query:"dismissed"`
	IssueClass    param.Field[[]string]    `query:"issue_class"`
	IssueClassNeq param.Field[[]string]    `query:"issue_class~neq"`
	IssueType     param.Field[[]IssueType] `query:"issue_type"`
	IssueTypeNeq  param.Field[[]IssueType] `query:"issue_type~neq"`
	// Specifies the current page within paginated list of results.
	Page param.Field[int64] `query:"page"`
	// Sets the number of results per page of results.
	PerPage     param.Field[int64]                `query:"per_page"`
	Product     param.Field[[]string]             `query:"product"`
	ProductNeq  param.Field[[]string]             `query:"product~neq"`
	Severity    param.Field[[]SeverityQueryParam] `query:"severity"`
	SeverityNeq param.Field[[]SeverityQueryParam] `query:"severity~neq"`
	Subject     param.Field[[]string]             `query:"subject"`
	SubjectNeq  param.Field[[]string]             `query:"subject~neq"`
}

func (AttackSurfaceReportIssueListParams) URLQuery

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

type AttackSurfaceReportIssueListResponse

type AttackSurfaceReportIssueListResponse struct {
	// Indicates the total number of results.
	Count  int64                                       `json:"count"`
	Issues []AttackSurfaceReportIssueListResponseIssue `json:"issues"`
	// Specifies the current page within paginated list of results.
	Page int64 `json:"page"`
	// Sets the number of results per page of results.
	PerPage int64                                    `json:"per_page"`
	JSON    attackSurfaceReportIssueListResponseJSON `json:"-"`
}

func (*AttackSurfaceReportIssueListResponse) UnmarshalJSON

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

type AttackSurfaceReportIssueListResponseIssue

type AttackSurfaceReportIssueListResponseIssue struct {
	ID        string `json:"id"`
	Dismissed bool   `json:"dismissed"`
	// Indicates whether the insight has a large payload that requires fetching via the
	// context endpoint.
	HasExtendedContext bool                                               `json:"has_extended_context"`
	IssueClass         string                                             `json:"issue_class"`
	IssueType          IssueType                                          `json:"issue_type"`
	Payload            AttackSurfaceReportIssueListResponseIssuesPayload  `json:"payload"`
	ResolveLink        string                                             `json:"resolve_link"`
	ResolveText        string                                             `json:"resolve_text"`
	Severity           AttackSurfaceReportIssueListResponseIssuesSeverity `json:"severity"`
	Since              time.Time                                          `json:"since" format:"date-time"`
	// The current status of the insight.
	Status    AttackSurfaceReportIssueListResponseIssuesStatus `json:"status"`
	Subject   string                                           `json:"subject"`
	Timestamp time.Time                                        `json:"timestamp" format:"date-time"`
	// User-defined classification for the insight. Can be 'false_positive',
	// 'accept_risk', 'other', or null.
	UserClassification AttackSurfaceReportIssueListResponseIssuesUserClassification `json:"user_classification" api:"nullable"`
	JSON               attackSurfaceReportIssueListResponseIssueJSON                `json:"-"`
}

func (*AttackSurfaceReportIssueListResponseIssue) UnmarshalJSON

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

type AttackSurfaceReportIssueListResponseIssuesPayload

type AttackSurfaceReportIssueListResponseIssuesPayload struct {
	// Describes the method used to detect insight.
	DetectionMethod string                                                `json:"detection_method"`
	ZoneTag         string                                                `json:"zone_tag"`
	JSON            attackSurfaceReportIssueListResponseIssuesPayloadJSON `json:"-"`
}

func (*AttackSurfaceReportIssueListResponseIssuesPayload) UnmarshalJSON

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

type AttackSurfaceReportIssueListResponseIssuesSeverity

type AttackSurfaceReportIssueListResponseIssuesSeverity string
const (
	AttackSurfaceReportIssueListResponseIssuesSeverityLow      AttackSurfaceReportIssueListResponseIssuesSeverity = "Low"
	AttackSurfaceReportIssueListResponseIssuesSeverityModerate AttackSurfaceReportIssueListResponseIssuesSeverity = "Moderate"
	AttackSurfaceReportIssueListResponseIssuesSeverityCritical AttackSurfaceReportIssueListResponseIssuesSeverity = "Critical"
)

func (AttackSurfaceReportIssueListResponseIssuesSeverity) IsKnown

type AttackSurfaceReportIssueListResponseIssuesStatus

type AttackSurfaceReportIssueListResponseIssuesStatus string

The current status of the insight.

const (
	AttackSurfaceReportIssueListResponseIssuesStatusActive   AttackSurfaceReportIssueListResponseIssuesStatus = "active"
	AttackSurfaceReportIssueListResponseIssuesStatusResolved AttackSurfaceReportIssueListResponseIssuesStatus = "resolved"
)

func (AttackSurfaceReportIssueListResponseIssuesStatus) IsKnown

type AttackSurfaceReportIssueListResponseIssuesUserClassification

type AttackSurfaceReportIssueListResponseIssuesUserClassification string

User-defined classification for the insight. Can be 'false_positive', 'accept_risk', 'other', or null.

const (
	AttackSurfaceReportIssueListResponseIssuesUserClassificationFalsePositive AttackSurfaceReportIssueListResponseIssuesUserClassification = "false_positive"
	AttackSurfaceReportIssueListResponseIssuesUserClassificationAcceptRisk    AttackSurfaceReportIssueListResponseIssuesUserClassification = "accept_risk"
	AttackSurfaceReportIssueListResponseIssuesUserClassificationOther         AttackSurfaceReportIssueListResponseIssuesUserClassification = "other"
)

func (AttackSurfaceReportIssueListResponseIssuesUserClassification) IsKnown

type AttackSurfaceReportIssueService

type AttackSurfaceReportIssueService struct {
	Options []option.RequestOption
}

AttackSurfaceReportIssueService 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 NewAttackSurfaceReportIssueService method instead.

func NewAttackSurfaceReportIssueService

func NewAttackSurfaceReportIssueService(opts ...option.RequestOption) (r *AttackSurfaceReportIssueService)

NewAttackSurfaceReportIssueService 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 (*AttackSurfaceReportIssueService) Class deprecated

Retrieves Security Center issue counts aggregated by classification class.

Deprecated: deprecated

func (*AttackSurfaceReportIssueService) List deprecated

Lists all Security Center issues for the account, showing active security problems requiring attention.

Deprecated: deprecated

func (*AttackSurfaceReportIssueService) ListAutoPaging deprecated

Lists all Security Center issues for the account, showing active security problems requiring attention.

Deprecated: deprecated

func (*AttackSurfaceReportIssueService) Severity deprecated

Retrieves Security Center issue counts aggregated by severity level.

Deprecated: deprecated

func (*AttackSurfaceReportIssueService) Type deprecated

Retrieves Security Center issue counts aggregated by issue type.

Deprecated: deprecated

type AttackSurfaceReportIssueSeverityParams

type AttackSurfaceReportIssueSeverityParams struct {
	// Identifier.
	AccountID     param.Field[string]               `path:"account_id" api:"required"`
	Dismissed     param.Field[bool]                 `query:"dismissed"`
	IssueClass    param.Field[[]string]             `query:"issue_class"`
	IssueClassNeq param.Field[[]string]             `query:"issue_class~neq"`
	IssueType     param.Field[[]IssueType]          `query:"issue_type"`
	IssueTypeNeq  param.Field[[]IssueType]          `query:"issue_type~neq"`
	Product       param.Field[[]string]             `query:"product"`
	ProductNeq    param.Field[[]string]             `query:"product~neq"`
	Severity      param.Field[[]SeverityQueryParam] `query:"severity"`
	SeverityNeq   param.Field[[]SeverityQueryParam] `query:"severity~neq"`
	Subject       param.Field[[]string]             `query:"subject"`
	SubjectNeq    param.Field[[]string]             `query:"subject~neq"`
}

func (AttackSurfaceReportIssueSeverityParams) URLQuery

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

type AttackSurfaceReportIssueSeverityResponse

type AttackSurfaceReportIssueSeverityResponse struct {
	Count int64                                        `json:"count"`
	Value string                                       `json:"value"`
	JSON  attackSurfaceReportIssueSeverityResponseJSON `json:"-"`
}

func (*AttackSurfaceReportIssueSeverityResponse) UnmarshalJSON

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

type AttackSurfaceReportIssueSeverityResponseEnvelope

type AttackSurfaceReportIssueSeverityResponseEnvelope struct {
	Errors   []AttackSurfaceReportIssueSeverityResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []AttackSurfaceReportIssueSeverityResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success AttackSurfaceReportIssueSeverityResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  []AttackSurfaceReportIssueSeverityResponse              `json:"result"`
	JSON    attackSurfaceReportIssueSeverityResponseEnvelopeJSON    `json:"-"`
}

func (*AttackSurfaceReportIssueSeverityResponseEnvelope) UnmarshalJSON

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

type AttackSurfaceReportIssueSeverityResponseEnvelopeErrors

type AttackSurfaceReportIssueSeverityResponseEnvelopeErrors struct {
	Code             int64                                                        `json:"code" api:"required"`
	Message          string                                                       `json:"message" api:"required"`
	DocumentationURL string                                                       `json:"documentation_url"`
	Source           AttackSurfaceReportIssueSeverityResponseEnvelopeErrorsSource `json:"source"`
	JSON             attackSurfaceReportIssueSeverityResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*AttackSurfaceReportIssueSeverityResponseEnvelopeErrors) UnmarshalJSON

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

type AttackSurfaceReportIssueSeverityResponseEnvelopeErrorsSource

type AttackSurfaceReportIssueSeverityResponseEnvelopeErrorsSource struct {
	Pointer string                                                           `json:"pointer"`
	JSON    attackSurfaceReportIssueSeverityResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*AttackSurfaceReportIssueSeverityResponseEnvelopeErrorsSource) UnmarshalJSON

type AttackSurfaceReportIssueSeverityResponseEnvelopeMessages

type AttackSurfaceReportIssueSeverityResponseEnvelopeMessages struct {
	Code             int64                                                          `json:"code" api:"required"`
	Message          string                                                         `json:"message" api:"required"`
	DocumentationURL string                                                         `json:"documentation_url"`
	Source           AttackSurfaceReportIssueSeverityResponseEnvelopeMessagesSource `json:"source"`
	JSON             attackSurfaceReportIssueSeverityResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*AttackSurfaceReportIssueSeverityResponseEnvelopeMessages) UnmarshalJSON

type AttackSurfaceReportIssueSeverityResponseEnvelopeMessagesSource

type AttackSurfaceReportIssueSeverityResponseEnvelopeMessagesSource struct {
	Pointer string                                                             `json:"pointer"`
	JSON    attackSurfaceReportIssueSeverityResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*AttackSurfaceReportIssueSeverityResponseEnvelopeMessagesSource) UnmarshalJSON

type AttackSurfaceReportIssueSeverityResponseEnvelopeSuccess

type AttackSurfaceReportIssueSeverityResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	AttackSurfaceReportIssueSeverityResponseEnvelopeSuccessTrue AttackSurfaceReportIssueSeverityResponseEnvelopeSuccess = true
)

func (AttackSurfaceReportIssueSeverityResponseEnvelopeSuccess) IsKnown

type AttackSurfaceReportIssueTypeGetParams

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

type AttackSurfaceReportIssueTypeParams

type AttackSurfaceReportIssueTypeParams struct {
	// Identifier.
	AccountID     param.Field[string]               `path:"account_id" api:"required"`
	Dismissed     param.Field[bool]                 `query:"dismissed"`
	IssueClass    param.Field[[]string]             `query:"issue_class"`
	IssueClassNeq param.Field[[]string]             `query:"issue_class~neq"`
	IssueType     param.Field[[]IssueType]          `query:"issue_type"`
	IssueTypeNeq  param.Field[[]IssueType]          `query:"issue_type~neq"`
	Product       param.Field[[]string]             `query:"product"`
	ProductNeq    param.Field[[]string]             `query:"product~neq"`
	Severity      param.Field[[]SeverityQueryParam] `query:"severity"`
	SeverityNeq   param.Field[[]SeverityQueryParam] `query:"severity~neq"`
	Subject       param.Field[[]string]             `query:"subject"`
	SubjectNeq    param.Field[[]string]             `query:"subject~neq"`
}

func (AttackSurfaceReportIssueTypeParams) URLQuery

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

type AttackSurfaceReportIssueTypeResponse

type AttackSurfaceReportIssueTypeResponse struct {
	Count int64                                    `json:"count"`
	Value string                                   `json:"value"`
	JSON  attackSurfaceReportIssueTypeResponseJSON `json:"-"`
}

func (*AttackSurfaceReportIssueTypeResponse) UnmarshalJSON

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

type AttackSurfaceReportIssueTypeResponseEnvelope

type AttackSurfaceReportIssueTypeResponseEnvelope struct {
	Errors   []AttackSurfaceReportIssueTypeResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []AttackSurfaceReportIssueTypeResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success AttackSurfaceReportIssueTypeResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  []AttackSurfaceReportIssueTypeResponse              `json:"result"`
	JSON    attackSurfaceReportIssueTypeResponseEnvelopeJSON    `json:"-"`
}

func (*AttackSurfaceReportIssueTypeResponseEnvelope) UnmarshalJSON

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

type AttackSurfaceReportIssueTypeResponseEnvelopeErrors

type AttackSurfaceReportIssueTypeResponseEnvelopeErrors struct {
	Code             int64                                                    `json:"code" api:"required"`
	Message          string                                                   `json:"message" api:"required"`
	DocumentationURL string                                                   `json:"documentation_url"`
	Source           AttackSurfaceReportIssueTypeResponseEnvelopeErrorsSource `json:"source"`
	JSON             attackSurfaceReportIssueTypeResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*AttackSurfaceReportIssueTypeResponseEnvelopeErrors) UnmarshalJSON

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

type AttackSurfaceReportIssueTypeResponseEnvelopeErrorsSource

type AttackSurfaceReportIssueTypeResponseEnvelopeErrorsSource struct {
	Pointer string                                                       `json:"pointer"`
	JSON    attackSurfaceReportIssueTypeResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*AttackSurfaceReportIssueTypeResponseEnvelopeErrorsSource) UnmarshalJSON

type AttackSurfaceReportIssueTypeResponseEnvelopeMessages

type AttackSurfaceReportIssueTypeResponseEnvelopeMessages struct {
	Code             int64                                                      `json:"code" api:"required"`
	Message          string                                                     `json:"message" api:"required"`
	DocumentationURL string                                                     `json:"documentation_url"`
	Source           AttackSurfaceReportIssueTypeResponseEnvelopeMessagesSource `json:"source"`
	JSON             attackSurfaceReportIssueTypeResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*AttackSurfaceReportIssueTypeResponseEnvelopeMessages) UnmarshalJSON

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

type AttackSurfaceReportIssueTypeResponseEnvelopeMessagesSource

type AttackSurfaceReportIssueTypeResponseEnvelopeMessagesSource struct {
	Pointer string                                                         `json:"pointer"`
	JSON    attackSurfaceReportIssueTypeResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*AttackSurfaceReportIssueTypeResponseEnvelopeMessagesSource) UnmarshalJSON

type AttackSurfaceReportIssueTypeResponseEnvelopeSuccess

type AttackSurfaceReportIssueTypeResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	AttackSurfaceReportIssueTypeResponseEnvelopeSuccessTrue AttackSurfaceReportIssueTypeResponseEnvelopeSuccess = true
)

func (AttackSurfaceReportIssueTypeResponseEnvelopeSuccess) IsKnown

type AttackSurfaceReportIssueTypeService

type AttackSurfaceReportIssueTypeService struct {
	Options []option.RequestOption
}

AttackSurfaceReportIssueTypeService 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 NewAttackSurfaceReportIssueTypeService method instead.

func NewAttackSurfaceReportIssueTypeService

func NewAttackSurfaceReportIssueTypeService(opts ...option.RequestOption) (r *AttackSurfaceReportIssueTypeService)

NewAttackSurfaceReportIssueTypeService 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 (*AttackSurfaceReportIssueTypeService) Get

Lists all available issue types in Security Center, describing categories of security issues.

func (*AttackSurfaceReportIssueTypeService) GetAutoPaging

Lists all available issue types in Security Center, describing categories of security issues.

type AttackSurfaceReportService

type AttackSurfaceReportService struct {
	Options    []option.RequestOption
	IssueTypes *AttackSurfaceReportIssueTypeService
	Issues     *AttackSurfaceReportIssueService
}

AttackSurfaceReportService 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 NewAttackSurfaceReportService method instead.

func NewAttackSurfaceReportService

func NewAttackSurfaceReportService(opts ...option.RequestOption) (r *AttackSurfaceReportService)

NewAttackSurfaceReportService 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 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 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 DNS

type DNS struct {
	// Total results returned based on your search parameters.
	Count float64 `json:"count"`
	// Current page within paginated list of results.
	Page float64 `json:"page"`
	// Number of results per page of results.
	PerPage float64 `json:"per_page"`
	// Reverse DNS look-ups observed during the time period.
	ReverseRecords []DNSReverseRecord `json:"reverse_records"`
	JSON           dnsJSON            `json:"-"`
}

func (*DNS) UnmarshalJSON

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

type DNSListParams

type DNSListParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	IPV4      param.Field[string] `query:"ipv4"`
	// Requested page within paginated list of results.
	Page param.Field[float64] `query:"page"`
	// Maximum number of results requested.
	PerPage        param.Field[float64]                     `query:"per_page"`
	StartEndParams param.Field[DNSListParamsStartEndParams] `query:"start_end_params"`
}

func (DNSListParams) URLQuery

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

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

type DNSListParamsStartEndParams

type DNSListParamsStartEndParams struct {
	// Defaults to the current date.
	End param.Field[time.Time] `query:"end" format:"date"`
	// Defaults to 30 days before the end parameter value.
	Start param.Field[time.Time] `query:"start" format:"date"`
}

func (DNSListParamsStartEndParams) URLQuery

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

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

type DNSReverseRecord

type DNSReverseRecord struct {
	// First seen date of the DNS record during the time period.
	FirstSeen time.Time `json:"first_seen" format:"date"`
	// Hostname that the IP was observed resolving to.
	Hostname string `json:"hostname"`
	// Last seen date of the DNS record during the time period.
	LastSeen time.Time            `json:"last_seen" format:"date"`
	JSON     dnsReverseRecordJSON `json:"-"`
}

func (*DNSReverseRecord) UnmarshalJSON

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

type DNSService

type DNSService struct {
	Options []option.RequestOption
}

DNSService 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 NewDNSService method instead.

func NewDNSService

func NewDNSService(opts ...option.RequestOption) (r *DNSService)

NewDNSService 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 (*DNSService) List

func (r *DNSService) List(ctx context.Context, params DNSListParams, opts ...option.RequestOption) (res *pagination.V4PagePagination[DNS], err error)

Gets a list of all the domains that have resolved to a specific IP address.

func (*DNSService) ListAutoPaging

Gets a list of all the domains that have resolved to a specific IP address.

type Domain

type Domain struct {
	// Additional information related to the host name.
	AdditionalInformation DomainAdditionalInformation `json:"additional_information"`
	// Application that the hostname belongs to.
	Application                DomainApplication                `json:"application"`
	ContentCategories          []DomainContentCategory          `json:"content_categories"`
	Domain                     string                           `json:"domain"`
	InheritedContentCategories []DomainInheritedContentCategory `json:"inherited_content_categories"`
	// Domain from which `inherited_content_categories` and `inherited_risk_types` are
	// inherited, if applicable.
	InheritedFrom      string                    `json:"inherited_from"`
	InheritedRiskTypes []DomainInheritedRiskType `json:"inherited_risk_types"`
	// Global Cloudflare 100k ranking for the last 30 days, if available for the
	// hostname. The top ranked domain is 1, the lowest ranked domain is 100,000.
	PopularityRank int64 `json:"popularity_rank"`
	// Specifies a list of references to one or more IP addresses or domain names that
	// the domain name currently resolves to.
	ResolvesToRefs []DomainResolvesToRef `json:"resolves_to_refs"`
	// Hostname risk score, which is a value between 0 (lowest risk) to 1 (highest
	// risk).
	RiskScore float64          `json:"risk_score"`
	RiskTypes []DomainRiskType `json:"risk_types"`
	JSON      domainJSON       `json:"-"`
}

func (*Domain) UnmarshalJSON

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

type DomainAdditionalInformation

type DomainAdditionalInformation struct {
	// Suspected DGA malware family.
	SuspectedMalwareFamily string                          `json:"suspected_malware_family"`
	JSON                   domainAdditionalInformationJSON `json:"-"`
}

Additional information related to the host name.

func (*DomainAdditionalInformation) UnmarshalJSON

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

type DomainApplication

type DomainApplication struct {
	ID   int64                 `json:"id"`
	Name string                `json:"name"`
	JSON domainApplicationJSON `json:"-"`
}

Application that the hostname belongs to.

func (*DomainApplication) UnmarshalJSON

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

type DomainBulkGetParams

type DomainBulkGetParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Accepts multiple values like `?domain=cloudflare.com&domain=example.com`.
	Domain param.Field[[]string] `query:"domain"`
	// Whether to include domain ranking data in the response. Defaults to `false` —
	// ranking lookups are expensive at bulk scale and most callers do not need them.
	// Set to `true` to opt in. This parameter replaces the deprecated `skip_ranking`
	// (see below).
	IncludeRanking param.Field[bool] `query:"include_ranking"`
	// **Deprecated.** Previously controlled whether the ranking lookup was skipped
	// (defaulted to `false`, meaning ranking ran). The endpoint's default behavior is
	// being flipped — ranking is now opt-in via `include_ranking=true` — and this
	// parameter will be silently ignored. Remove it from your callers and use
	// `include_ranking` instead.
	SkipRanking param.Field[bool] `query:"skip_ranking"`
}

func (DomainBulkGetParams) URLQuery

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

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

type DomainBulkGetResponse

type DomainBulkGetResponse struct {
	// Additional information related to the host name.
	AdditionalInformation DomainBulkGetResponseAdditionalInformation `json:"additional_information"`
	// Application that the hostname belongs to.
	Application                DomainBulkGetResponseApplication                `json:"application"`
	ContentCategories          []DomainBulkGetResponseContentCategory          `json:"content_categories"`
	Domain                     string                                          `json:"domain"`
	InheritedContentCategories []DomainBulkGetResponseInheritedContentCategory `json:"inherited_content_categories"`
	// Domain from which `inherited_content_categories` and `inherited_risk_types` are
	// inherited, if applicable.
	InheritedFrom      string                                   `json:"inherited_from"`
	InheritedRiskTypes []DomainBulkGetResponseInheritedRiskType `json:"inherited_risk_types"`
	// Global Cloudflare 100k ranking for the last 30 days, if available for the
	// hostname. The top ranked domain is 1, the lowest ranked domain is 100,000.
	PopularityRank int64 `json:"popularity_rank"`
	// Hostname risk score, which is a value between 0 (lowest risk) to 1 (highest
	// risk).
	RiskScore float64                         `json:"risk_score"`
	RiskTypes []DomainBulkGetResponseRiskType `json:"risk_types"`
	JSON      domainBulkGetResponseJSON       `json:"-"`
}

func (*DomainBulkGetResponse) UnmarshalJSON

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

type DomainBulkGetResponseAdditionalInformation

type DomainBulkGetResponseAdditionalInformation struct {
	// Suspected DGA malware family.
	SuspectedMalwareFamily string                                         `json:"suspected_malware_family"`
	JSON                   domainBulkGetResponseAdditionalInformationJSON `json:"-"`
}

Additional information related to the host name.

func (*DomainBulkGetResponseAdditionalInformation) UnmarshalJSON

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

type DomainBulkGetResponseApplication

type DomainBulkGetResponseApplication struct {
	ID   int64                                `json:"id"`
	Name string                               `json:"name"`
	JSON domainBulkGetResponseApplicationJSON `json:"-"`
}

Application that the hostname belongs to.

func (*DomainBulkGetResponseApplication) UnmarshalJSON

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

type DomainBulkGetResponseContentCategory

type DomainBulkGetResponseContentCategory struct {
	ID              int64                                    `json:"id"`
	Name            string                                   `json:"name"`
	SuperCategoryID int64                                    `json:"super_category_id"`
	JSON            domainBulkGetResponseContentCategoryJSON `json:"-"`
}

Current content categories.

func (*DomainBulkGetResponseContentCategory) UnmarshalJSON

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

type DomainBulkGetResponseEnvelope

type DomainBulkGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo   `json:"errors" api:"required"`
	Messages []shared.ResponseInfo   `json:"messages" api:"required"`
	Result   []DomainBulkGetResponse `json:"result" api:"required,nullable"`
	// Whether the API call was successful.
	Success    DomainBulkGetResponseEnvelopeSuccess    `json:"success" api:"required"`
	ResultInfo DomainBulkGetResponseEnvelopeResultInfo `json:"result_info"`
	JSON       domainBulkGetResponseEnvelopeJSON       `json:"-"`
}

func (*DomainBulkGetResponseEnvelope) UnmarshalJSON

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

type DomainBulkGetResponseEnvelopeResultInfo

type DomainBulkGetResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service.
	Count float64 `json:"count"`
	// Current page within paginated list of results.
	Page float64 `json:"page"`
	// Number of results per page of results.
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters.
	TotalCount float64                                     `json:"total_count"`
	JSON       domainBulkGetResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DomainBulkGetResponseEnvelopeResultInfo) UnmarshalJSON

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

type DomainBulkGetResponseEnvelopeSuccess

type DomainBulkGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	DomainBulkGetResponseEnvelopeSuccessTrue DomainBulkGetResponseEnvelopeSuccess = true
)

func (DomainBulkGetResponseEnvelopeSuccess) IsKnown

type DomainBulkGetResponseInheritedContentCategory

type DomainBulkGetResponseInheritedContentCategory struct {
	ID              int64                                             `json:"id"`
	Name            string                                            `json:"name"`
	SuperCategoryID int64                                             `json:"super_category_id"`
	JSON            domainBulkGetResponseInheritedContentCategoryJSON `json:"-"`
}

func (*DomainBulkGetResponseInheritedContentCategory) UnmarshalJSON

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

type DomainBulkGetResponseInheritedRiskType

type DomainBulkGetResponseInheritedRiskType struct {
	ID              int64                                      `json:"id"`
	Name            string                                     `json:"name"`
	SuperCategoryID int64                                      `json:"super_category_id"`
	JSON            domainBulkGetResponseInheritedRiskTypeJSON `json:"-"`
}

func (*DomainBulkGetResponseInheritedRiskType) UnmarshalJSON

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

type DomainBulkGetResponseRiskType

type DomainBulkGetResponseRiskType struct {
	ID              int64                             `json:"id"`
	Name            string                            `json:"name"`
	SuperCategoryID int64                             `json:"super_category_id"`
	JSON            domainBulkGetResponseRiskTypeJSON `json:"-"`
}

func (*DomainBulkGetResponseRiskType) UnmarshalJSON

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

type DomainBulkService

type DomainBulkService struct {
	Options []option.RequestOption
}

DomainBulkService 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 NewDomainBulkService method instead.

func NewDomainBulkService

func NewDomainBulkService(opts ...option.RequestOption) (r *DomainBulkService)

NewDomainBulkService 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 (*DomainBulkService) Get

Returns security details and statistics about multiple domains in a single request.

**Behavior change — domain ranking is becoming opt-in.** This endpoint previously included domain ranking data in every response and accepted a `skip_ranking=true` query parameter to opt out. That parameter is being deprecated and ranking will no longer be returned by default. Callers that want ranking data must pass `include_ranking=true`. The `skip_ranking` parameter will be silently ignored once the change ships.

type DomainContentCategory

type DomainContentCategory struct {
	ID              int64                     `json:"id"`
	Name            string                    `json:"name"`
	SuperCategoryID int64                     `json:"super_category_id"`
	JSON            domainContentCategoryJSON `json:"-"`
}

Current content categories.

func (*DomainContentCategory) UnmarshalJSON

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

type DomainGetParams

type DomainGetParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	Domain    param.Field[string] `query:"domain"`
	// Skip DNS resolution lookups for faster response.
	SkipDNS param.Field[bool] `query:"skip_dns"`
	// Skip the domain ranking lookup for faster responses. Defaults to `false`
	// (ranking is included). Set to `true` to opt out — primarily used by callers like
	// Cloudflare Radar that need to avoid a circular dependency when building the
	// domain details page. Note: the bulk endpoint (`/intel/domain/bulk`) uses
	// opposite defaults — see `include_ranking` there.
	SkipRanking param.Field[bool] `query:"skip_ranking"`
}

func (DomainGetParams) URLQuery

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

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

type DomainGetResponseEnvelope

type DomainGetResponseEnvelope struct {
	Errors   []DomainGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []DomainGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success DomainGetResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  Domain                           `json:"result"`
	JSON    domainGetResponseEnvelopeJSON    `json:"-"`
}

func (*DomainGetResponseEnvelope) UnmarshalJSON

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

type DomainGetResponseEnvelopeErrors

type DomainGetResponseEnvelopeErrors struct {
	Code             int64                                 `json:"code" api:"required"`
	Message          string                                `json:"message" api:"required"`
	DocumentationURL string                                `json:"documentation_url"`
	Source           DomainGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             domainGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*DomainGetResponseEnvelopeErrors) UnmarshalJSON

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

type DomainGetResponseEnvelopeErrorsSource

type DomainGetResponseEnvelopeErrorsSource struct {
	Pointer string                                    `json:"pointer"`
	JSON    domainGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*DomainGetResponseEnvelopeErrorsSource) UnmarshalJSON

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

type DomainGetResponseEnvelopeMessages

type DomainGetResponseEnvelopeMessages struct {
	Code             int64                                   `json:"code" api:"required"`
	Message          string                                  `json:"message" api:"required"`
	DocumentationURL string                                  `json:"documentation_url"`
	Source           DomainGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             domainGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*DomainGetResponseEnvelopeMessages) UnmarshalJSON

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

type DomainGetResponseEnvelopeMessagesSource

type DomainGetResponseEnvelopeMessagesSource struct {
	Pointer string                                      `json:"pointer"`
	JSON    domainGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*DomainGetResponseEnvelopeMessagesSource) UnmarshalJSON

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

type DomainGetResponseEnvelopeSuccess

type DomainGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	DomainGetResponseEnvelopeSuccessTrue DomainGetResponseEnvelopeSuccess = true
)

func (DomainGetResponseEnvelopeSuccess) IsKnown

type DomainHistory

type DomainHistory struct {
	Categorizations []DomainHistoryCategorization `json:"categorizations"`
	Domain          string                        `json:"domain"`
	JSON            domainHistoryJSON             `json:"-"`
}

func (*DomainHistory) UnmarshalJSON

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

type DomainHistoryCategorization

type DomainHistoryCategorization struct {
	Categories []DomainHistoryCategorizationsCategory `json:"categories"`
	End        time.Time                              `json:"end" format:"date"`
	Start      time.Time                              `json:"start" format:"date"`
	JSON       domainHistoryCategorizationJSON        `json:"-"`
}

func (*DomainHistoryCategorization) UnmarshalJSON

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

type DomainHistoryCategorizationsCategory

type DomainHistoryCategorizationsCategory struct {
	ID   int64                                    `json:"id"`
	Name string                                   `json:"name"`
	JSON domainHistoryCategorizationsCategoryJSON `json:"-"`
}

func (*DomainHistoryCategorizationsCategory) UnmarshalJSON

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

type DomainHistoryGetParams

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

func (DomainHistoryGetParams) URLQuery

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

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

type DomainHistoryGetResponseEnvelope

type DomainHistoryGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors" api:"required"`
	Messages []shared.ResponseInfo `json:"messages" api:"required"`
	Result   []DomainHistory       `json:"result" api:"required,nullable"`
	// Whether the API call was successful.
	Success    DomainHistoryGetResponseEnvelopeSuccess    `json:"success" api:"required"`
	ResultInfo DomainHistoryGetResponseEnvelopeResultInfo `json:"result_info"`
	JSON       domainHistoryGetResponseEnvelopeJSON       `json:"-"`
}

func (*DomainHistoryGetResponseEnvelope) UnmarshalJSON

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

type DomainHistoryGetResponseEnvelopeResultInfo

type DomainHistoryGetResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service.
	Count float64 `json:"count"`
	// Current page within paginated list of results.
	Page float64 `json:"page"`
	// Number of results per page of results.
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters.
	TotalCount float64                                        `json:"total_count"`
	JSON       domainHistoryGetResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*DomainHistoryGetResponseEnvelopeResultInfo) UnmarshalJSON

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

type DomainHistoryGetResponseEnvelopeSuccess

type DomainHistoryGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	DomainHistoryGetResponseEnvelopeSuccessTrue DomainHistoryGetResponseEnvelopeSuccess = true
)

func (DomainHistoryGetResponseEnvelopeSuccess) IsKnown

type DomainHistoryService

type DomainHistoryService struct {
	Options []option.RequestOption
}

DomainHistoryService 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 NewDomainHistoryService method instead.

func NewDomainHistoryService

func NewDomainHistoryService(opts ...option.RequestOption) (r *DomainHistoryService)

NewDomainHistoryService 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 (*DomainHistoryService) Get

Gets historical security threat and content categories currently and previously assigned to a domain.

type DomainInheritedContentCategory

type DomainInheritedContentCategory struct {
	ID              int64                              `json:"id"`
	Name            string                             `json:"name"`
	SuperCategoryID int64                              `json:"super_category_id"`
	JSON            domainInheritedContentCategoryJSON `json:"-"`
}

func (*DomainInheritedContentCategory) UnmarshalJSON

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

type DomainInheritedRiskType

type DomainInheritedRiskType struct {
	ID              int64                       `json:"id"`
	Name            string                      `json:"name"`
	SuperCategoryID int64                       `json:"super_category_id"`
	JSON            domainInheritedRiskTypeJSON `json:"-"`
}

func (*DomainInheritedRiskType) UnmarshalJSON

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

type DomainResolvesToRef

type DomainResolvesToRef struct {
	// STIX 2.1 identifier:
	// https://docs.oasis-open.org/cti/stix/v2.1/cs02/stix-v2.1-cs02.html#_64yvzeku5a5c.
	ID string `json:"id"`
	// IP address or domain name.
	Value string                  `json:"value"`
	JSON  domainResolvesToRefJSON `json:"-"`
}

func (*DomainResolvesToRef) UnmarshalJSON

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

type DomainRiskType

type DomainRiskType struct {
	ID              int64              `json:"id"`
	Name            string             `json:"name"`
	SuperCategoryID int64              `json:"super_category_id"`
	JSON            domainRiskTypeJSON `json:"-"`
}

func (*DomainRiskType) UnmarshalJSON

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

type DomainService

type DomainService struct {
	Options []option.RequestOption
	Bulks   *DomainBulkService
}

DomainService 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 NewDomainService method instead.

func NewDomainService

func NewDomainService(opts ...option.RequestOption) (r *DomainService)

NewDomainService 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 (*DomainService) Get

func (r *DomainService) Get(ctx context.Context, params DomainGetParams, opts ...option.RequestOption) (res *Domain, err error)

Gets security details and statistics about a domain.

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 IP

type IP struct {
	// Specifies a reference to the autonomous systems (AS) that the IP address belongs
	// to.
	BelongsToRef IPBelongsToRef `json:"belongs_to_ref"`
	IP           string         `json:"ip" format:"ipv4"`
	RiskTypes    []IPRiskType   `json:"risk_types"`
	JSON         ipJSON         `json:"-"`
}

func (*IP) UnmarshalJSON

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

type IPBelongsToRef

type IPBelongsToRef struct {
	ID          string `json:"id"`
	Country     string `json:"country"`
	Description string `json:"description"`
	// Infrastructure type of this ASN.
	Type  IPBelongsToRefType `json:"type"`
	Value string             `json:"value"`
	JSON  ipBelongsToRefJSON `json:"-"`
}

Specifies a reference to the autonomous systems (AS) that the IP address belongs to.

func (*IPBelongsToRef) UnmarshalJSON

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

type IPBelongsToRefType

type IPBelongsToRefType string

Infrastructure type of this ASN.

const (
	IPBelongsToRefTypeHostingProvider IPBelongsToRefType = "hosting_provider"
	IPBelongsToRefTypeISP             IPBelongsToRefType = "isp"
	IPBelongsToRefTypeOrganization    IPBelongsToRefType = "organization"
)

func (IPBelongsToRefType) IsKnown

func (r IPBelongsToRefType) IsKnown() bool

type IPGetParams

type IPGetParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	IPV4      param.Field[string] `query:"ipv4"`
	IPV6      param.Field[string] `query:"ipv6"`
}

func (IPGetParams) URLQuery

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

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

type IPGetResponseEnvelope

type IPGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors" api:"required"`
	Messages []shared.ResponseInfo `json:"messages" api:"required"`
	Result   []IP                  `json:"result" api:"required,nullable"`
	// Whether the API call was successful.
	Success    IPGetResponseEnvelopeSuccess    `json:"success" api:"required"`
	ResultInfo IPGetResponseEnvelopeResultInfo `json:"result_info"`
	JSON       ipGetResponseEnvelopeJSON       `json:"-"`
}

func (*IPGetResponseEnvelope) UnmarshalJSON

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

type IPGetResponseEnvelopeResultInfo

type IPGetResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service.
	Count float64 `json:"count"`
	// Current page within paginated list of results.
	Page float64 `json:"page"`
	// Number of results per page of results.
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters.
	TotalCount float64                             `json:"total_count"`
	JSON       ipGetResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*IPGetResponseEnvelopeResultInfo) UnmarshalJSON

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

type IPGetResponseEnvelopeSuccess

type IPGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	IPGetResponseEnvelopeSuccessTrue IPGetResponseEnvelopeSuccess = true
)

func (IPGetResponseEnvelopeSuccess) IsKnown

func (r IPGetResponseEnvelopeSuccess) IsKnown() bool

type IPListService

type IPListService struct {
	Options []option.RequestOption
}

IPListService 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 NewIPListService method instead.

func NewIPListService

func NewIPListService(opts ...option.RequestOption) (r *IPListService)

NewIPListService 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 IPRiskType

type IPRiskType struct {
	ID              float64        `json:"id"`
	Name            string         `json:"name"`
	SuperCategoryID float64        `json:"super_category_id"`
	JSON            ipRiskTypeJSON `json:"-"`
}

func (*IPRiskType) UnmarshalJSON

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

type IPService

type IPService struct {
	Options []option.RequestOption
}

IPService 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 NewIPService method instead.

func NewIPService

func NewIPService(opts ...option.RequestOption) (r *IPService)

NewIPService 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 (*IPService) Get

func (r *IPService) Get(ctx context.Context, params IPGetParams, opts ...option.RequestOption) (res *[]IP, err error)

Gets the geolocation, ASN, infrastructure type of the ASN, and any security threat categories of an IP address. **Must provide ip query parameters.** For example, `/intel/ip?ipv4=1.1.1.1` or `/intel/ip?ipv6=2001:db8::1`.

type IndicatorFeedDataParams

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

type IndicatorFeedDownloadService

type IndicatorFeedDownloadService struct {
	Options []option.RequestOption
}

IndicatorFeedDownloadService 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 NewIndicatorFeedDownloadService method instead.

func NewIndicatorFeedDownloadService

func NewIndicatorFeedDownloadService(opts ...option.RequestOption) (r *IndicatorFeedDownloadService)

NewIndicatorFeedDownloadService 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 IndicatorFeedGetParams

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

type IndicatorFeedGetResponse

type IndicatorFeedGetResponse struct {
	// The unique identifier for the indicator feed
	ID int64 `json:"id"`
	// The date and time when the data entry was created
	CreatedOn time.Time `json:"created_on" format:"date-time"`
	// The description of the example test
	Description string `json:"description"`
	// Whether the indicator feed can be attributed to a provider
	IsAttributable bool `json:"is_attributable"`
	// Whether the indicator feed can be downloaded
	IsDownloadable bool `json:"is_downloadable"`
	// Whether the indicator feed is exposed to customers
	IsPublic bool `json:"is_public"`
	// Summary of indicator counts from the last successful upload to this feed.
	// Populated by the custom-threat-feeds loader at the end of each successful load.
	// Absent (omitted) when no upload has completed successfully or the upload errored
	// before the summary write. Surfaces silent-failure paths so operators can see
	// when their indicators were dropped (popularity allowlist, expired valid_until,
	// etc.) without reading loader logs.
	LastUploadSummary IndicatorFeedGetResponseLastUploadSummary `json:"last_upload_summary"`
	// Human-readable error message describing why the latest upload failed. Populated
	// only when `latest_upload_status` is `Error`. Returns one of a small fixed set of
	// category-level messages (invalid domain / IP / URL entries, malformed row or
	// header, invalid valid_until timestamp, etc.) or the generic `Upload failed` for
	// unknown or infrastructure-level errors. Never echoes raw error text from the
	// underlying loader. Intel accounts receive the verbatim loader/API error text
	// (including specific offending values) instead of these category-level messages.
	LatestUploadError string `json:"latest_upload_error"`
	// Status of the latest snapshot uploaded
	LatestUploadStatus IndicatorFeedGetResponseLatestUploadStatus `json:"latest_upload_status"`
	// The date and time when the data entry was last modified
	ModifiedOn time.Time `json:"modified_on" format:"date-time"`
	// The name of the indicator feed
	Name string `json:"name"`
	// The unique identifier for the provider
	ProviderID int64 `json:"provider_id"`
	// The provider of the indicator feed
	ProviderName string                       `json:"provider_name"`
	JSON         indicatorFeedGetResponseJSON `json:"-"`
}

func (*IndicatorFeedGetResponse) UnmarshalJSON

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

type IndicatorFeedGetResponseEnvelope

type IndicatorFeedGetResponseEnvelope struct {
	Errors   []IndicatorFeedGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []IndicatorFeedGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success IndicatorFeedGetResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  IndicatorFeedGetResponse                `json:"result"`
	JSON    indicatorFeedGetResponseEnvelopeJSON    `json:"-"`
}

func (*IndicatorFeedGetResponseEnvelope) UnmarshalJSON

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

type IndicatorFeedGetResponseEnvelopeErrors

type IndicatorFeedGetResponseEnvelopeErrors struct {
	Code             int64                                        `json:"code" api:"required"`
	Message          string                                       `json:"message" api:"required"`
	DocumentationURL string                                       `json:"documentation_url"`
	Source           IndicatorFeedGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             indicatorFeedGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*IndicatorFeedGetResponseEnvelopeErrors) UnmarshalJSON

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

type IndicatorFeedGetResponseEnvelopeErrorsSource

type IndicatorFeedGetResponseEnvelopeErrorsSource struct {
	Pointer string                                           `json:"pointer"`
	JSON    indicatorFeedGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*IndicatorFeedGetResponseEnvelopeErrorsSource) UnmarshalJSON

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

type IndicatorFeedGetResponseEnvelopeMessages

type IndicatorFeedGetResponseEnvelopeMessages struct {
	Code             int64                                          `json:"code" api:"required"`
	Message          string                                         `json:"message" api:"required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           IndicatorFeedGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             indicatorFeedGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*IndicatorFeedGetResponseEnvelopeMessages) UnmarshalJSON

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

type IndicatorFeedGetResponseEnvelopeMessagesSource

type IndicatorFeedGetResponseEnvelopeMessagesSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    indicatorFeedGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*IndicatorFeedGetResponseEnvelopeMessagesSource) UnmarshalJSON

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

type IndicatorFeedGetResponseEnvelopeSuccess

type IndicatorFeedGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	IndicatorFeedGetResponseEnvelopeSuccessTrue IndicatorFeedGetResponseEnvelopeSuccess = true
)

func (IndicatorFeedGetResponseEnvelopeSuccess) IsKnown

type IndicatorFeedGetResponseLastUploadSummary

type IndicatorFeedGetResponseLastUploadSummary struct {
	// Net delta applied to feed indicators by this upload. Snapshot uploads emit both
	// _\_added and _\_removed; delta-add emits only _\_added; delta-remove emits only
	// _\_removed.
	Persisted IndicatorFeedGetResponseLastUploadSummaryPersisted `json:"persisted"`
	// Counts of indicators that were uploaded but did not reach QuickSilver, broken
	// down by reason.
	Skipped IndicatorFeedGetResponseLastUploadSummarySkipped `json:"skipped"`
	// Indicator counts from the unified file the loader received
	Uploaded IndicatorFeedGetResponseLastUploadSummaryUploaded `json:"uploaded"`
	JSON     indicatorFeedGetResponseLastUploadSummaryJSON     `json:"-"`
}

Summary of indicator counts from the last successful upload to this feed. Populated by the custom-threat-feeds loader at the end of each successful load. Absent (omitted) when no upload has completed successfully or the upload errored before the summary write. Surfaces silent-failure paths so operators can see when their indicators were dropped (popularity allowlist, expired valid_until, etc.) without reading loader logs.

func (*IndicatorFeedGetResponseLastUploadSummary) UnmarshalJSON

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

type IndicatorFeedGetResponseLastUploadSummaryPersisted

type IndicatorFeedGetResponseLastUploadSummaryPersisted struct {
	DomainsAdded   int64                                                  `json:"domains_added"`
	DomainsRemoved int64                                                  `json:"domains_removed"`
	IPsAdded       int64                                                  `json:"ips_added"`
	IPsRemoved     int64                                                  `json:"ips_removed"`
	URLsAdded      int64                                                  `json:"urls_added"`
	URLsRemoved    int64                                                  `json:"urls_removed"`
	JSON           indicatorFeedGetResponseLastUploadSummaryPersistedJSON `json:"-"`
}

Net delta applied to feed indicators by this upload. Snapshot uploads emit both _\_added and _\_removed; delta-add emits only _\_added; delta-remove emits only _\_removed.

func (*IndicatorFeedGetResponseLastUploadSummaryPersisted) UnmarshalJSON

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

type IndicatorFeedGetResponseLastUploadSummarySkipped

type IndicatorFeedGetResponseLastUploadSummarySkipped struct {
	// Domains filtered by the global popularity allowlist at QS provisioning time.
	// Popular domains (bing.com, naver.com, etc.) are protected from
	// custom-threat-feed enforcement.
	AllowlistedDomains int64 `json:"allowlisted_domains"`
	// Indicators in the upload whose valid_until is already in the past. These are not
	// added to QS; the expiration cron handles cleanup.
	ExpiredIndicators int64 `json:"expired_indicators"`
	// Reserved for future use. Currently always 0 — the unifier aborts the entire
	// upload on a single bad indicator.
	InvalidIndicators int64                                                `json:"invalid_indicators"`
	JSON              indicatorFeedGetResponseLastUploadSummarySkippedJSON `json:"-"`
}

Counts of indicators that were uploaded but did not reach QuickSilver, broken down by reason.

func (*IndicatorFeedGetResponseLastUploadSummarySkipped) UnmarshalJSON

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

type IndicatorFeedGetResponseLastUploadSummaryUploaded

type IndicatorFeedGetResponseLastUploadSummaryUploaded struct {
	// Number of domain indicators in the upload
	Domains int64 `json:"domains"`
	// Number of IP indicators in the upload
	IPs int64 `json:"ips"`
	// Number of URL indicators in the upload
	URLs int64                                                 `json:"urls"`
	JSON indicatorFeedGetResponseLastUploadSummaryUploadedJSON `json:"-"`
}

Indicator counts from the unified file the loader received

func (*IndicatorFeedGetResponseLastUploadSummaryUploaded) UnmarshalJSON

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

type IndicatorFeedGetResponseLatestUploadStatus

type IndicatorFeedGetResponseLatestUploadStatus string

Status of the latest snapshot uploaded

const (
	IndicatorFeedGetResponseLatestUploadStatusMirroring    IndicatorFeedGetResponseLatestUploadStatus = "Mirroring"
	IndicatorFeedGetResponseLatestUploadStatusUnifying     IndicatorFeedGetResponseLatestUploadStatus = "Unifying"
	IndicatorFeedGetResponseLatestUploadStatusLoading      IndicatorFeedGetResponseLatestUploadStatus = "Loading"
	IndicatorFeedGetResponseLatestUploadStatusProvisioning IndicatorFeedGetResponseLatestUploadStatus = "Provisioning"
	IndicatorFeedGetResponseLatestUploadStatusComplete     IndicatorFeedGetResponseLatestUploadStatus = "Complete"
	IndicatorFeedGetResponseLatestUploadStatusError        IndicatorFeedGetResponseLatestUploadStatus = "Error"
)

func (IndicatorFeedGetResponseLatestUploadStatus) IsKnown

type IndicatorFeedListParams

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

type IndicatorFeedListResponse

type IndicatorFeedListResponse struct {
	// The unique identifier for the indicator feed
	ID int64 `json:"id"`
	// The date and time when the data entry was created
	CreatedOn time.Time `json:"created_on" format:"date-time"`
	// The description of the example test
	Description string `json:"description"`
	// Whether the indicator feed can be attributed to a provider
	IsAttributable bool `json:"is_attributable"`
	// Whether the indicator feed can be downloaded
	IsDownloadable bool `json:"is_downloadable"`
	// Whether the indicator feed is exposed to customers
	IsPublic bool `json:"is_public"`
	// The date and time when the data entry was last modified
	ModifiedOn time.Time `json:"modified_on" format:"date-time"`
	// The name of the indicator feed
	Name string                        `json:"name"`
	JSON indicatorFeedListResponseJSON `json:"-"`
}

func (*IndicatorFeedListResponse) UnmarshalJSON

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

type IndicatorFeedNewParams

type IndicatorFeedNewParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// The description of the example test
	Description param.Field[string] `json:"description"`
	// The name of the indicator feed
	Name param.Field[string] `json:"name"`
}

func (IndicatorFeedNewParams) MarshalJSON

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

type IndicatorFeedNewResponse

type IndicatorFeedNewResponse struct {
	// The unique identifier for the indicator feed
	ID int64 `json:"id"`
	// The date and time when the data entry was created
	CreatedOn time.Time `json:"created_on" format:"date-time"`
	// The description of the example test
	Description string `json:"description"`
	// Whether the indicator feed can be attributed to a provider
	IsAttributable bool `json:"is_attributable"`
	// Whether the indicator feed can be downloaded
	IsDownloadable bool `json:"is_downloadable"`
	// Whether the indicator feed is exposed to customers
	IsPublic bool `json:"is_public"`
	// The date and time when the data entry was last modified
	ModifiedOn time.Time `json:"modified_on" format:"date-time"`
	// The name of the indicator feed
	Name string                       `json:"name"`
	JSON indicatorFeedNewResponseJSON `json:"-"`
}

func (*IndicatorFeedNewResponse) UnmarshalJSON

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

type IndicatorFeedNewResponseEnvelope

type IndicatorFeedNewResponseEnvelope struct {
	Errors   []IndicatorFeedNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []IndicatorFeedNewResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success IndicatorFeedNewResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  IndicatorFeedNewResponse                `json:"result"`
	JSON    indicatorFeedNewResponseEnvelopeJSON    `json:"-"`
}

func (*IndicatorFeedNewResponseEnvelope) UnmarshalJSON

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

type IndicatorFeedNewResponseEnvelopeErrors

type IndicatorFeedNewResponseEnvelopeErrors struct {
	Code             int64                                        `json:"code" api:"required"`
	Message          string                                       `json:"message" api:"required"`
	DocumentationURL string                                       `json:"documentation_url"`
	Source           IndicatorFeedNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             indicatorFeedNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*IndicatorFeedNewResponseEnvelopeErrors) UnmarshalJSON

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

type IndicatorFeedNewResponseEnvelopeErrorsSource

type IndicatorFeedNewResponseEnvelopeErrorsSource struct {
	Pointer string                                           `json:"pointer"`
	JSON    indicatorFeedNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*IndicatorFeedNewResponseEnvelopeErrorsSource) UnmarshalJSON

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

type IndicatorFeedNewResponseEnvelopeMessages

type IndicatorFeedNewResponseEnvelopeMessages struct {
	Code             int64                                          `json:"code" api:"required"`
	Message          string                                         `json:"message" api:"required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           IndicatorFeedNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             indicatorFeedNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*IndicatorFeedNewResponseEnvelopeMessages) UnmarshalJSON

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

type IndicatorFeedNewResponseEnvelopeMessagesSource

type IndicatorFeedNewResponseEnvelopeMessagesSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    indicatorFeedNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*IndicatorFeedNewResponseEnvelopeMessagesSource) UnmarshalJSON

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

type IndicatorFeedNewResponseEnvelopeSuccess

type IndicatorFeedNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	IndicatorFeedNewResponseEnvelopeSuccessTrue IndicatorFeedNewResponseEnvelopeSuccess = true
)

func (IndicatorFeedNewResponseEnvelopeSuccess) IsKnown

type IndicatorFeedPermissionDeleteParams

type IndicatorFeedPermissionDeleteParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// The Cloudflare account tag of the account to change permissions on
	AccountTag param.Field[string] `json:"account_tag"`
	// The ID of the feed to add/remove permissions on
	FeedID param.Field[int64] `json:"feed_id"`
}

func (IndicatorFeedPermissionDeleteParams) MarshalJSON

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

type IndicatorFeedPermissionDeleteResponse

type IndicatorFeedPermissionDeleteResponse struct {
	// Whether the update succeeded or not
	Success bool                                      `json:"success"`
	JSON    indicatorFeedPermissionDeleteResponseJSON `json:"-"`
}

func (*IndicatorFeedPermissionDeleteResponse) UnmarshalJSON

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

type IndicatorFeedPermissionDeleteResponseEnvelope

type IndicatorFeedPermissionDeleteResponseEnvelope struct {
	Errors   []IndicatorFeedPermissionDeleteResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []IndicatorFeedPermissionDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success IndicatorFeedPermissionDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  IndicatorFeedPermissionDeleteResponse                `json:"result"`
	JSON    indicatorFeedPermissionDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*IndicatorFeedPermissionDeleteResponseEnvelope) UnmarshalJSON

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

type IndicatorFeedPermissionDeleteResponseEnvelopeErrors

type IndicatorFeedPermissionDeleteResponseEnvelopeErrors struct {
	Code             int64                                                     `json:"code" api:"required"`
	Message          string                                                    `json:"message" api:"required"`
	DocumentationURL string                                                    `json:"documentation_url"`
	Source           IndicatorFeedPermissionDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             indicatorFeedPermissionDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*IndicatorFeedPermissionDeleteResponseEnvelopeErrors) UnmarshalJSON

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

type IndicatorFeedPermissionDeleteResponseEnvelopeErrorsSource

type IndicatorFeedPermissionDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                                        `json:"pointer"`
	JSON    indicatorFeedPermissionDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*IndicatorFeedPermissionDeleteResponseEnvelopeErrorsSource) UnmarshalJSON

type IndicatorFeedPermissionDeleteResponseEnvelopeMessages

type IndicatorFeedPermissionDeleteResponseEnvelopeMessages struct {
	Code             int64                                                       `json:"code" api:"required"`
	Message          string                                                      `json:"message" api:"required"`
	DocumentationURL string                                                      `json:"documentation_url"`
	Source           IndicatorFeedPermissionDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             indicatorFeedPermissionDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*IndicatorFeedPermissionDeleteResponseEnvelopeMessages) UnmarshalJSON

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

type IndicatorFeedPermissionDeleteResponseEnvelopeMessagesSource

type IndicatorFeedPermissionDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                                          `json:"pointer"`
	JSON    indicatorFeedPermissionDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*IndicatorFeedPermissionDeleteResponseEnvelopeMessagesSource) UnmarshalJSON

type IndicatorFeedPermissionDeleteResponseEnvelopeSuccess

type IndicatorFeedPermissionDeleteResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	IndicatorFeedPermissionDeleteResponseEnvelopeSuccessTrue IndicatorFeedPermissionDeleteResponseEnvelopeSuccess = true
)

func (IndicatorFeedPermissionDeleteResponseEnvelopeSuccess) IsKnown

type IndicatorFeedPermissionListParams

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

type IndicatorFeedPermissionListResponse

type IndicatorFeedPermissionListResponse struct {
	// The unique identifier for the indicator feed
	ID int64 `json:"id"`
	// The description of the example test
	Description string `json:"description"`
	// Whether the indicator feed can be attributed to a provider
	IsAttributable bool `json:"is_attributable"`
	// Whether the indicator feed can be downloaded
	IsDownloadable bool `json:"is_downloadable"`
	// Whether the indicator feed is exposed to customers
	IsPublic bool `json:"is_public"`
	// The name of the indicator feed
	Name string                                  `json:"name"`
	JSON indicatorFeedPermissionListResponseJSON `json:"-"`
}

func (*IndicatorFeedPermissionListResponse) UnmarshalJSON

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

type IndicatorFeedPermissionListResponseEnvelope

type IndicatorFeedPermissionListResponseEnvelope struct {
	Errors   []IndicatorFeedPermissionListResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []IndicatorFeedPermissionListResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success IndicatorFeedPermissionListResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  []IndicatorFeedPermissionListResponse              `json:"result"`
	JSON    indicatorFeedPermissionListResponseEnvelopeJSON    `json:"-"`
}

func (*IndicatorFeedPermissionListResponseEnvelope) UnmarshalJSON

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

type IndicatorFeedPermissionListResponseEnvelopeErrors

type IndicatorFeedPermissionListResponseEnvelopeErrors struct {
	Code             int64                                                   `json:"code" api:"required"`
	Message          string                                                  `json:"message" api:"required"`
	DocumentationURL string                                                  `json:"documentation_url"`
	Source           IndicatorFeedPermissionListResponseEnvelopeErrorsSource `json:"source"`
	JSON             indicatorFeedPermissionListResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*IndicatorFeedPermissionListResponseEnvelopeErrors) UnmarshalJSON

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

type IndicatorFeedPermissionListResponseEnvelopeErrorsSource

type IndicatorFeedPermissionListResponseEnvelopeErrorsSource struct {
	Pointer string                                                      `json:"pointer"`
	JSON    indicatorFeedPermissionListResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*IndicatorFeedPermissionListResponseEnvelopeErrorsSource) UnmarshalJSON

type IndicatorFeedPermissionListResponseEnvelopeMessages

type IndicatorFeedPermissionListResponseEnvelopeMessages struct {
	Code             int64                                                     `json:"code" api:"required"`
	Message          string                                                    `json:"message" api:"required"`
	DocumentationURL string                                                    `json:"documentation_url"`
	Source           IndicatorFeedPermissionListResponseEnvelopeMessagesSource `json:"source"`
	JSON             indicatorFeedPermissionListResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*IndicatorFeedPermissionListResponseEnvelopeMessages) UnmarshalJSON

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

type IndicatorFeedPermissionListResponseEnvelopeMessagesSource

type IndicatorFeedPermissionListResponseEnvelopeMessagesSource struct {
	Pointer string                                                        `json:"pointer"`
	JSON    indicatorFeedPermissionListResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*IndicatorFeedPermissionListResponseEnvelopeMessagesSource) UnmarshalJSON

type IndicatorFeedPermissionListResponseEnvelopeSuccess

type IndicatorFeedPermissionListResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	IndicatorFeedPermissionListResponseEnvelopeSuccessTrue IndicatorFeedPermissionListResponseEnvelopeSuccess = true
)

func (IndicatorFeedPermissionListResponseEnvelopeSuccess) IsKnown

type IndicatorFeedPermissionNewParams

type IndicatorFeedPermissionNewParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// The Cloudflare account tag of the account to change permissions on
	AccountTag param.Field[string] `json:"account_tag"`
	// The ID of the feed to add/remove permissions on
	FeedID param.Field[int64] `json:"feed_id"`
}

func (IndicatorFeedPermissionNewParams) MarshalJSON

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

type IndicatorFeedPermissionNewResponse

type IndicatorFeedPermissionNewResponse struct {
	// Whether the update succeeded or not
	Success bool                                   `json:"success"`
	JSON    indicatorFeedPermissionNewResponseJSON `json:"-"`
}

func (*IndicatorFeedPermissionNewResponse) UnmarshalJSON

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

type IndicatorFeedPermissionNewResponseEnvelope

type IndicatorFeedPermissionNewResponseEnvelope struct {
	Errors   []IndicatorFeedPermissionNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []IndicatorFeedPermissionNewResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success IndicatorFeedPermissionNewResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  IndicatorFeedPermissionNewResponse                `json:"result"`
	JSON    indicatorFeedPermissionNewResponseEnvelopeJSON    `json:"-"`
}

func (*IndicatorFeedPermissionNewResponseEnvelope) UnmarshalJSON

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

type IndicatorFeedPermissionNewResponseEnvelopeErrors

type IndicatorFeedPermissionNewResponseEnvelopeErrors struct {
	Code             int64                                                  `json:"code" api:"required"`
	Message          string                                                 `json:"message" api:"required"`
	DocumentationURL string                                                 `json:"documentation_url"`
	Source           IndicatorFeedPermissionNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             indicatorFeedPermissionNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*IndicatorFeedPermissionNewResponseEnvelopeErrors) UnmarshalJSON

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

type IndicatorFeedPermissionNewResponseEnvelopeErrorsSource

type IndicatorFeedPermissionNewResponseEnvelopeErrorsSource struct {
	Pointer string                                                     `json:"pointer"`
	JSON    indicatorFeedPermissionNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*IndicatorFeedPermissionNewResponseEnvelopeErrorsSource) UnmarshalJSON

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

type IndicatorFeedPermissionNewResponseEnvelopeMessages

type IndicatorFeedPermissionNewResponseEnvelopeMessages struct {
	Code             int64                                                    `json:"code" api:"required"`
	Message          string                                                   `json:"message" api:"required"`
	DocumentationURL string                                                   `json:"documentation_url"`
	Source           IndicatorFeedPermissionNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             indicatorFeedPermissionNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*IndicatorFeedPermissionNewResponseEnvelopeMessages) UnmarshalJSON

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

type IndicatorFeedPermissionNewResponseEnvelopeMessagesSource

type IndicatorFeedPermissionNewResponseEnvelopeMessagesSource struct {
	Pointer string                                                       `json:"pointer"`
	JSON    indicatorFeedPermissionNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*IndicatorFeedPermissionNewResponseEnvelopeMessagesSource) UnmarshalJSON

type IndicatorFeedPermissionNewResponseEnvelopeSuccess

type IndicatorFeedPermissionNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	IndicatorFeedPermissionNewResponseEnvelopeSuccessTrue IndicatorFeedPermissionNewResponseEnvelopeSuccess = true
)

func (IndicatorFeedPermissionNewResponseEnvelopeSuccess) IsKnown

type IndicatorFeedPermissionService

type IndicatorFeedPermissionService struct {
	Options []option.RequestOption
}

IndicatorFeedPermissionService 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 NewIndicatorFeedPermissionService method instead.

func NewIndicatorFeedPermissionService

func NewIndicatorFeedPermissionService(opts ...option.RequestOption) (r *IndicatorFeedPermissionService)

NewIndicatorFeedPermissionService 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 (*IndicatorFeedPermissionService) Delete

Revokes access permissions for a custom threat indicator feed.

func (*IndicatorFeedPermissionService) List

Lists current access permissions for custom threat indicator feeds.

func (*IndicatorFeedPermissionService) New

Grants access permissions for a custom threat indicator feed to other accounts.

type IndicatorFeedService

type IndicatorFeedService struct {
	Options     []option.RequestOption
	Snapshots   *IndicatorFeedSnapshotService
	Permissions *IndicatorFeedPermissionService
	Downloads   *IndicatorFeedDownloadService
}

IndicatorFeedService 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 NewIndicatorFeedService method instead.

func NewIndicatorFeedService

func NewIndicatorFeedService(opts ...option.RequestOption) (r *IndicatorFeedService)

NewIndicatorFeedService 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 (*IndicatorFeedService) Data

func (r *IndicatorFeedService) Data(ctx context.Context, feedID int64, query IndicatorFeedDataParams, opts ...option.RequestOption) (res *string, err error)

Retrieves the raw data entries in a custom threat indicator feed.

func (*IndicatorFeedService) Get

Retrieves details for a specific custom threat indicator feed.

func (*IndicatorFeedService) List

Retrieves details for all accessible custom threat indicator feeds.

func (*IndicatorFeedService) ListAutoPaging

Retrieves details for all accessible custom threat indicator feeds.

func (*IndicatorFeedService) New

Creates a new custom threat indicator feed for sharing threat intelligence data.

func (*IndicatorFeedService) Update

Revises details for a specific custom threat indicator feed.

type IndicatorFeedSnapshotService

type IndicatorFeedSnapshotService struct {
	Options []option.RequestOption
}

IndicatorFeedSnapshotService 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 NewIndicatorFeedSnapshotService method instead.

func NewIndicatorFeedSnapshotService

func NewIndicatorFeedSnapshotService(opts ...option.RequestOption) (r *IndicatorFeedSnapshotService)

NewIndicatorFeedSnapshotService 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 (*IndicatorFeedSnapshotService) Update

Revises the raw data entries in a custom threat indicator feed.

Accepts both plain and gzipped STIX2/CRDF bodies. Gzip is detected by RFC 1952 magic bytes (`0x1f 0x8b`) and/or a `.gz` filename suffix (case-insensitive) — either signal alone is sufficient to trigger the gzip path; if the body is not valid gzip, the upload fails fast. Customers are encouraged to gzip larger uploads — the api-gateway 500 MB body cap applies to the on-the-wire (compressed) size, so gzip lets a single upload carry several GiB of decompressed STIX.

type IndicatorFeedSnapshotUpdateParams

type IndicatorFeedSnapshotUpdateParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// The file to upload. Either a plain STIX2/CRDF body or a gzipped one (recognised
	// by `0x1f 0x8b` magic bytes or a `.gz` filename suffix).
	Source        param.Field[string]                                         `json:"source"`
	CfAsyncUpload param.Field[IndicatorFeedSnapshotUpdateParamsCfAsyncUpload] `header:"Cf-Async-Upload"`
}

func (IndicatorFeedSnapshotUpdateParams) MarshalMultipart

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

type IndicatorFeedSnapshotUpdateParamsCfAsyncUpload added in v7.9.0

type IndicatorFeedSnapshotUpdateParamsCfAsyncUpload string
const (
	IndicatorFeedSnapshotUpdateParamsCfAsyncUpload1 IndicatorFeedSnapshotUpdateParamsCfAsyncUpload = "1"
)

func (IndicatorFeedSnapshotUpdateParamsCfAsyncUpload) IsKnown added in v7.9.0

type IndicatorFeedSnapshotUpdateResponse

type IndicatorFeedSnapshotUpdateResponse struct {
	// Feed id
	FileID int64 `json:"file_id"`
	// Name of the file unified in our system
	Filename string `json:"filename"`
	// Account-relative polling path. Prepend `/accounts/{account_id}` using the same
	// account identifier and API host as the upload request. The path omits the
	// account segment because the service does not have your account identifier in
	// this context.
	PollURL string `json:"poll_url"`
	// Current status of the upload at the moment the request returned. This is NOT a
	// terminal state: the file is unified inline, but the durable loader has only
	// accepted it, so the upload is still `Unifying`. Poll `poll_url` until the status
	// reaches a terminal value (`Unified` or `Error`).
	Status string `json:"status"`
	// Identifier of the upload row, for polling this upload to a terminal state via
	// `poll_url`.
	UploadID int64                                   `json:"upload_id"`
	JSON     indicatorFeedSnapshotUpdateResponseJSON `json:"-"`
}

func (*IndicatorFeedSnapshotUpdateResponse) UnmarshalJSON

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

type IndicatorFeedSnapshotUpdateResponseEnvelope

type IndicatorFeedSnapshotUpdateResponseEnvelope struct {
	Errors   []IndicatorFeedSnapshotUpdateResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []IndicatorFeedSnapshotUpdateResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success IndicatorFeedSnapshotUpdateResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  IndicatorFeedSnapshotUpdateResponse                `json:"result"`
	JSON    indicatorFeedSnapshotUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*IndicatorFeedSnapshotUpdateResponseEnvelope) UnmarshalJSON

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

type IndicatorFeedSnapshotUpdateResponseEnvelopeErrors

type IndicatorFeedSnapshotUpdateResponseEnvelopeErrors struct {
	Code             int64                                                   `json:"code" api:"required"`
	Message          string                                                  `json:"message" api:"required"`
	DocumentationURL string                                                  `json:"documentation_url"`
	Source           IndicatorFeedSnapshotUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             indicatorFeedSnapshotUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*IndicatorFeedSnapshotUpdateResponseEnvelopeErrors) UnmarshalJSON

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

type IndicatorFeedSnapshotUpdateResponseEnvelopeErrorsSource

type IndicatorFeedSnapshotUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                                      `json:"pointer"`
	JSON    indicatorFeedSnapshotUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*IndicatorFeedSnapshotUpdateResponseEnvelopeErrorsSource) UnmarshalJSON

type IndicatorFeedSnapshotUpdateResponseEnvelopeMessages

type IndicatorFeedSnapshotUpdateResponseEnvelopeMessages struct {
	Code             int64                                                     `json:"code" api:"required"`
	Message          string                                                    `json:"message" api:"required"`
	DocumentationURL string                                                    `json:"documentation_url"`
	Source           IndicatorFeedSnapshotUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             indicatorFeedSnapshotUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*IndicatorFeedSnapshotUpdateResponseEnvelopeMessages) UnmarshalJSON

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

type IndicatorFeedSnapshotUpdateResponseEnvelopeMessagesSource

type IndicatorFeedSnapshotUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                                        `json:"pointer"`
	JSON    indicatorFeedSnapshotUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*IndicatorFeedSnapshotUpdateResponseEnvelopeMessagesSource) UnmarshalJSON

type IndicatorFeedSnapshotUpdateResponseEnvelopeSuccess

type IndicatorFeedSnapshotUpdateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	IndicatorFeedSnapshotUpdateResponseEnvelopeSuccessTrue IndicatorFeedSnapshotUpdateResponseEnvelopeSuccess = true
)

func (IndicatorFeedSnapshotUpdateResponseEnvelopeSuccess) IsKnown

type IndicatorFeedUpdateParams

type IndicatorFeedUpdateParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// The new description of the feed
	Description param.Field[string] `json:"description"`
	// The new is_attributable value of the feed
	IsAttributable param.Field[bool] `json:"is_attributable"`
	// The new is_downloadable value of the feed
	IsDownloadable param.Field[bool] `json:"is_downloadable"`
	// The new is_public value of the feed
	IsPublic param.Field[bool] `json:"is_public"`
	// The new name of the feed
	Name param.Field[string] `json:"name"`
}

func (IndicatorFeedUpdateParams) MarshalJSON

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

type IndicatorFeedUpdateResponse

type IndicatorFeedUpdateResponse struct {
	// The unique identifier for the indicator feed
	ID int64 `json:"id"`
	// The date and time when the data entry was created
	CreatedOn time.Time `json:"created_on" format:"date-time"`
	// The description of the example test
	Description string `json:"description"`
	// Whether the indicator feed can be attributed to a provider
	IsAttributable bool `json:"is_attributable"`
	// Whether the indicator feed can be downloaded
	IsDownloadable bool `json:"is_downloadable"`
	// Whether the indicator feed is exposed to customers
	IsPublic bool `json:"is_public"`
	// The date and time when the data entry was last modified
	ModifiedOn time.Time `json:"modified_on" format:"date-time"`
	// The name of the indicator feed
	Name string                          `json:"name"`
	JSON indicatorFeedUpdateResponseJSON `json:"-"`
}

func (*IndicatorFeedUpdateResponse) UnmarshalJSON

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

type IndicatorFeedUpdateResponseEnvelope

type IndicatorFeedUpdateResponseEnvelope struct {
	Errors   []IndicatorFeedUpdateResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []IndicatorFeedUpdateResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success IndicatorFeedUpdateResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  IndicatorFeedUpdateResponse                `json:"result"`
	JSON    indicatorFeedUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*IndicatorFeedUpdateResponseEnvelope) UnmarshalJSON

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

type IndicatorFeedUpdateResponseEnvelopeErrors

type IndicatorFeedUpdateResponseEnvelopeErrors struct {
	Code             int64                                           `json:"code" api:"required"`
	Message          string                                          `json:"message" api:"required"`
	DocumentationURL string                                          `json:"documentation_url"`
	Source           IndicatorFeedUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             indicatorFeedUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*IndicatorFeedUpdateResponseEnvelopeErrors) UnmarshalJSON

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

type IndicatorFeedUpdateResponseEnvelopeErrorsSource

type IndicatorFeedUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                              `json:"pointer"`
	JSON    indicatorFeedUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*IndicatorFeedUpdateResponseEnvelopeErrorsSource) UnmarshalJSON

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

type IndicatorFeedUpdateResponseEnvelopeMessages

type IndicatorFeedUpdateResponseEnvelopeMessages struct {
	Code             int64                                             `json:"code" api:"required"`
	Message          string                                            `json:"message" api:"required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           IndicatorFeedUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             indicatorFeedUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*IndicatorFeedUpdateResponseEnvelopeMessages) UnmarshalJSON

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

type IndicatorFeedUpdateResponseEnvelopeMessagesSource

type IndicatorFeedUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    indicatorFeedUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*IndicatorFeedUpdateResponseEnvelopeMessagesSource) UnmarshalJSON

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

type IndicatorFeedUpdateResponseEnvelopeSuccess

type IndicatorFeedUpdateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	IndicatorFeedUpdateResponseEnvelopeSuccessTrue IndicatorFeedUpdateResponseEnvelopeSuccess = true
)

func (IndicatorFeedUpdateResponseEnvelopeSuccess) IsKnown

type IntelService

type IntelService struct {
	Options             []option.RequestOption
	ASN                 *ASNService
	DNS                 *DNSService
	Domains             *DomainService
	DomainHistory       *DomainHistoryService
	IPs                 *IPService
	IPLists             *IPListService
	Miscategorizations  *MiscategorizationService
	Whois               *WhoisService
	URLs                *URLService
	IndicatorFeeds      *IndicatorFeedService
	Sinkholes           *SinkholeService
	AttackSurfaceReport *AttackSurfaceReportService
}

IntelService 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 NewIntelService method instead.

func NewIntelService

func NewIntelService(opts ...option.RequestOption) (r *IntelService)

NewIntelService 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 IssueType

type IssueType string
const (
	IssueTypeComplianceViolation     IssueType = "compliance_violation"
	IssueTypeEmailSecurity           IssueType = "email_security"
	IssueTypeExposedInfrastructure   IssueType = "exposed_infrastructure"
	IssueTypeInsecureConfiguration   IssueType = "insecure_configuration"
	IssueTypeWeakAuthentication      IssueType = "weak_authentication"
	IssueTypeConfigurationSuggestion IssueType = "configuration_suggestion"
)

func (IssueType) IsKnown

func (r IssueType) IsKnown() bool

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 MiscategorizationNewParams

type MiscategorizationNewParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Content category IDs to add.
	ContentAdds param.Field[[]int64] `json:"content_adds"`
	// Content category IDs to remove.
	ContentRemoves param.Field[[]int64]                                 `json:"content_removes"`
	IndicatorType  param.Field[MiscategorizationNewParamsIndicatorType] `json:"indicator_type"`
	// Provide only if indicator_type is `ipv4` or `ipv6`.
	IP param.Field[string] `json:"ip"`
	// Security category IDs to add.
	SecurityAdds param.Field[[]int64] `json:"security_adds"`
	// Security category IDs to remove.
	SecurityRemoves param.Field[[]int64] `json:"security_removes"`
	// Provide only if indicator_type is `domain` or `url`. Example if indicator_type
	// is `domain`: `example.com`. Example if indicator_type is `url`:
	// `https://example.com/news/`.
	URL param.Field[string] `json:"url"`
}

func (MiscategorizationNewParams) MarshalJSON

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

type MiscategorizationNewParamsIndicatorType

type MiscategorizationNewParamsIndicatorType string
const (
	MiscategorizationNewParamsIndicatorTypeDomain MiscategorizationNewParamsIndicatorType = "domain"
	MiscategorizationNewParamsIndicatorTypeIPV4   MiscategorizationNewParamsIndicatorType = "ipv4"
	MiscategorizationNewParamsIndicatorTypeIPV6   MiscategorizationNewParamsIndicatorType = "ipv6"
	MiscategorizationNewParamsIndicatorTypeURL    MiscategorizationNewParamsIndicatorType = "url"
)

func (MiscategorizationNewParamsIndicatorType) IsKnown

type MiscategorizationNewResponse

type MiscategorizationNewResponse struct {
	Errors   []MiscategorizationNewResponseError   `json:"errors" api:"required"`
	Messages []MiscategorizationNewResponseMessage `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success MiscategorizationNewResponseSuccess `json:"success" api:"required"`
	JSON    miscategorizationNewResponseJSON    `json:"-"`
}

func (*MiscategorizationNewResponse) UnmarshalJSON

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

type MiscategorizationNewResponseError

type MiscategorizationNewResponseError struct {
	Code             int64                                    `json:"code" api:"required"`
	Message          string                                   `json:"message" api:"required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           MiscategorizationNewResponseErrorsSource `json:"source"`
	JSON             miscategorizationNewResponseErrorJSON    `json:"-"`
}

func (*MiscategorizationNewResponseError) UnmarshalJSON

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

type MiscategorizationNewResponseErrorsSource

type MiscategorizationNewResponseErrorsSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    miscategorizationNewResponseErrorsSourceJSON `json:"-"`
}

func (*MiscategorizationNewResponseErrorsSource) UnmarshalJSON

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

type MiscategorizationNewResponseMessage

type MiscategorizationNewResponseMessage struct {
	Code             int64                                      `json:"code" api:"required"`
	Message          string                                     `json:"message" api:"required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           MiscategorizationNewResponseMessagesSource `json:"source"`
	JSON             miscategorizationNewResponseMessageJSON    `json:"-"`
}

func (*MiscategorizationNewResponseMessage) UnmarshalJSON

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

type MiscategorizationNewResponseMessagesSource

type MiscategorizationNewResponseMessagesSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    miscategorizationNewResponseMessagesSourceJSON `json:"-"`
}

func (*MiscategorizationNewResponseMessagesSource) UnmarshalJSON

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

type MiscategorizationNewResponseSuccess

type MiscategorizationNewResponseSuccess bool

Whether the API call was successful.

const (
	MiscategorizationNewResponseSuccessTrue MiscategorizationNewResponseSuccess = true
)

func (MiscategorizationNewResponseSuccess) IsKnown

type MiscategorizationService

type MiscategorizationService struct {
	Options []option.RequestOption
}

MiscategorizationService 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 NewMiscategorizationService method instead.

func NewMiscategorizationService

func NewMiscategorizationService(opts ...option.RequestOption) (r *MiscategorizationService)

NewMiscategorizationService 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 (*MiscategorizationService) New

Allows you to submit requests to change a domain’s category.

Requests that include category `169` (New Domains) or category `177` (Newly Seen) in any of `content_adds`, `content_removes`, `security_adds`, or `security_removes` will be rejected with a `400 Bad Request`. These categories are automatically managed and fall off 30 days after they are applied.

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 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 SeverityQueryParam

type SeverityQueryParam string
const (
	SeverityQueryParamLow      SeverityQueryParam = "low"
	SeverityQueryParamModerate SeverityQueryParam = "moderate"
	SeverityQueryParamCritical SeverityQueryParam = "critical"
)

func (SeverityQueryParam) IsKnown

func (r SeverityQueryParam) IsKnown() bool

type Sinkhole

type Sinkhole struct {
	// The unique identifier for the sinkhole.
	ID string `json:"id"`
	// The account tag that owns this sinkhole.
	AccountTag string `json:"account_tag"`
	// The date and time when the sinkhole was created.
	CreatedOn time.Time `json:"created_on" format:"date-time"`
	// The date and time when the sinkhole was last modified.
	ModifiedOn time.Time `json:"modified_on" format:"date-time"`
	// The name of the sinkhole.
	Name string `json:"name"`
	// The name of the R2 bucket to store results.
	R2Bucket string `json:"r2_bucket"`
	// The id of the R2 instance.
	R2ID string       `json:"r2_id"`
	JSON sinkholeJSON `json:"-"`
}

func (*Sinkhole) UnmarshalJSON

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

type SinkholeDeleteParams added in v7.9.0

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

type SinkholeDeleteResponse added in v7.9.0

type SinkholeDeleteResponse = interface{}

type SinkholeDeleteResponseEnvelope added in v7.9.0

type SinkholeDeleteResponseEnvelope struct {
	Errors   []SinkholeDeleteResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SinkholeDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SinkholeDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  SinkholeDeleteResponse                `json:"result"`
	JSON    sinkholeDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*SinkholeDeleteResponseEnvelope) UnmarshalJSON added in v7.9.0

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

type SinkholeDeleteResponseEnvelopeErrors added in v7.9.0

type SinkholeDeleteResponseEnvelopeErrors struct {
	Code             int64                                      `json:"code" api:"required"`
	Message          string                                     `json:"message" api:"required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           SinkholeDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             sinkholeDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SinkholeDeleteResponseEnvelopeErrors) UnmarshalJSON added in v7.9.0

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

type SinkholeDeleteResponseEnvelopeErrorsSource added in v7.9.0

type SinkholeDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    sinkholeDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SinkholeDeleteResponseEnvelopeErrorsSource) UnmarshalJSON added in v7.9.0

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

type SinkholeDeleteResponseEnvelopeMessages added in v7.9.0

type SinkholeDeleteResponseEnvelopeMessages struct {
	Code             int64                                        `json:"code" api:"required"`
	Message          string                                       `json:"message" api:"required"`
	DocumentationURL string                                       `json:"documentation_url"`
	Source           SinkholeDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             sinkholeDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SinkholeDeleteResponseEnvelopeMessages) UnmarshalJSON added in v7.9.0

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

type SinkholeDeleteResponseEnvelopeMessagesSource added in v7.9.0

type SinkholeDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                           `json:"pointer"`
	JSON    sinkholeDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SinkholeDeleteResponseEnvelopeMessagesSource) UnmarshalJSON added in v7.9.0

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

type SinkholeDeleteResponseEnvelopeSuccess added in v7.9.0

type SinkholeDeleteResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	SinkholeDeleteResponseEnvelopeSuccessTrue SinkholeDeleteResponseEnvelopeSuccess = true
)

func (SinkholeDeleteResponseEnvelopeSuccess) IsKnown added in v7.9.0

type SinkholeGetParams added in v7.9.0

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

type SinkholeGetResponseEnvelope added in v7.9.0

type SinkholeGetResponseEnvelope struct {
	Errors   []SinkholeGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SinkholeGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SinkholeGetResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  Sinkhole                           `json:"result"`
	JSON    sinkholeGetResponseEnvelopeJSON    `json:"-"`
}

func (*SinkholeGetResponseEnvelope) UnmarshalJSON added in v7.9.0

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

type SinkholeGetResponseEnvelopeErrors added in v7.9.0

type SinkholeGetResponseEnvelopeErrors struct {
	Code             int64                                   `json:"code" api:"required"`
	Message          string                                  `json:"message" api:"required"`
	DocumentationURL string                                  `json:"documentation_url"`
	Source           SinkholeGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             sinkholeGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SinkholeGetResponseEnvelopeErrors) UnmarshalJSON added in v7.9.0

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

type SinkholeGetResponseEnvelopeErrorsSource added in v7.9.0

type SinkholeGetResponseEnvelopeErrorsSource struct {
	Pointer string                                      `json:"pointer"`
	JSON    sinkholeGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SinkholeGetResponseEnvelopeErrorsSource) UnmarshalJSON added in v7.9.0

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

type SinkholeGetResponseEnvelopeMessages added in v7.9.0

type SinkholeGetResponseEnvelopeMessages struct {
	Code             int64                                     `json:"code" api:"required"`
	Message          string                                    `json:"message" api:"required"`
	DocumentationURL string                                    `json:"documentation_url"`
	Source           SinkholeGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             sinkholeGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SinkholeGetResponseEnvelopeMessages) UnmarshalJSON added in v7.9.0

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

type SinkholeGetResponseEnvelopeMessagesSource added in v7.9.0

type SinkholeGetResponseEnvelopeMessagesSource struct {
	Pointer string                                        `json:"pointer"`
	JSON    sinkholeGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SinkholeGetResponseEnvelopeMessagesSource) UnmarshalJSON added in v7.9.0

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

type SinkholeGetResponseEnvelopeSuccess added in v7.9.0

type SinkholeGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	SinkholeGetResponseEnvelopeSuccessTrue SinkholeGetResponseEnvelopeSuccess = true
)

func (SinkholeGetResponseEnvelopeSuccess) IsKnown added in v7.9.0

type SinkholeIngressDeleteParams added in v7.9.0

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

type SinkholeIngressDeleteResponse added in v7.9.0

type SinkholeIngressDeleteResponse = interface{}

type SinkholeIngressDeleteResponseEnvelope added in v7.9.0

type SinkholeIngressDeleteResponseEnvelope struct {
	Errors   []SinkholeIngressDeleteResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SinkholeIngressDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SinkholeIngressDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  SinkholeIngressDeleteResponse                `json:"result"`
	JSON    sinkholeIngressDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*SinkholeIngressDeleteResponseEnvelope) UnmarshalJSON added in v7.9.0

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

type SinkholeIngressDeleteResponseEnvelopeErrors added in v7.9.0

type SinkholeIngressDeleteResponseEnvelopeErrors struct {
	Code             int64                                             `json:"code" api:"required"`
	Message          string                                            `json:"message" api:"required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           SinkholeIngressDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             sinkholeIngressDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SinkholeIngressDeleteResponseEnvelopeErrors) UnmarshalJSON added in v7.9.0

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

type SinkholeIngressDeleteResponseEnvelopeErrorsSource added in v7.9.0

type SinkholeIngressDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    sinkholeIngressDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SinkholeIngressDeleteResponseEnvelopeErrorsSource) UnmarshalJSON added in v7.9.0

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

type SinkholeIngressDeleteResponseEnvelopeMessages added in v7.9.0

type SinkholeIngressDeleteResponseEnvelopeMessages struct {
	Code             int64                                               `json:"code" api:"required"`
	Message          string                                              `json:"message" api:"required"`
	DocumentationURL string                                              `json:"documentation_url"`
	Source           SinkholeIngressDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             sinkholeIngressDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SinkholeIngressDeleteResponseEnvelopeMessages) UnmarshalJSON added in v7.9.0

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

type SinkholeIngressDeleteResponseEnvelopeMessagesSource added in v7.9.0

type SinkholeIngressDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                                  `json:"pointer"`
	JSON    sinkholeIngressDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SinkholeIngressDeleteResponseEnvelopeMessagesSource) UnmarshalJSON added in v7.9.0

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

type SinkholeIngressDeleteResponseEnvelopeSuccess added in v7.9.0

type SinkholeIngressDeleteResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	SinkholeIngressDeleteResponseEnvelopeSuccessTrue SinkholeIngressDeleteResponseEnvelopeSuccess = true
)

func (SinkholeIngressDeleteResponseEnvelopeSuccess) IsKnown added in v7.9.0

type SinkholeIngressGetParams added in v7.9.0

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

type SinkholeIngressGetResponse added in v7.9.0

type SinkholeIngressGetResponse struct {
	// The unique identifier for the ingress rule.
	ID string `json:"id"`
	// The CIDR block for the ingress rule.
	CIDR string `json:"cidr"`
	// The date and time when the ingress rule was created.
	CreatedOn time.Time `json:"created_on" format:"date-time"`
	// The date and time when the ingress rule was last modified.
	ModifiedOn time.Time `json:"modified_on" format:"date-time"`
	// The sinkhole this ingress rule belongs to.
	SinkholeID string `json:"sinkhole_id"`
	// The zone tag associated with this ingress rule.
	ZoneTag string                         `json:"zone_tag"`
	JSON    sinkholeIngressGetResponseJSON `json:"-"`
}

func (*SinkholeIngressGetResponse) UnmarshalJSON added in v7.9.0

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

type SinkholeIngressGetResponseEnvelope added in v7.9.0

type SinkholeIngressGetResponseEnvelope struct {
	Errors   []SinkholeIngressGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SinkholeIngressGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SinkholeIngressGetResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  SinkholeIngressGetResponse                `json:"result"`
	JSON    sinkholeIngressGetResponseEnvelopeJSON    `json:"-"`
}

func (*SinkholeIngressGetResponseEnvelope) UnmarshalJSON added in v7.9.0

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

type SinkholeIngressGetResponseEnvelopeErrors added in v7.9.0

type SinkholeIngressGetResponseEnvelopeErrors struct {
	Code             int64                                          `json:"code" api:"required"`
	Message          string                                         `json:"message" api:"required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           SinkholeIngressGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             sinkholeIngressGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SinkholeIngressGetResponseEnvelopeErrors) UnmarshalJSON added in v7.9.0

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

type SinkholeIngressGetResponseEnvelopeErrorsSource added in v7.9.0

type SinkholeIngressGetResponseEnvelopeErrorsSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    sinkholeIngressGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SinkholeIngressGetResponseEnvelopeErrorsSource) UnmarshalJSON added in v7.9.0

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

type SinkholeIngressGetResponseEnvelopeMessages added in v7.9.0

type SinkholeIngressGetResponseEnvelopeMessages struct {
	Code             int64                                            `json:"code" api:"required"`
	Message          string                                           `json:"message" api:"required"`
	DocumentationURL string                                           `json:"documentation_url"`
	Source           SinkholeIngressGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             sinkholeIngressGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SinkholeIngressGetResponseEnvelopeMessages) UnmarshalJSON added in v7.9.0

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

type SinkholeIngressGetResponseEnvelopeMessagesSource added in v7.9.0

type SinkholeIngressGetResponseEnvelopeMessagesSource struct {
	Pointer string                                               `json:"pointer"`
	JSON    sinkholeIngressGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SinkholeIngressGetResponseEnvelopeMessagesSource) UnmarshalJSON added in v7.9.0

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

type SinkholeIngressGetResponseEnvelopeSuccess added in v7.9.0

type SinkholeIngressGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	SinkholeIngressGetResponseEnvelopeSuccessTrue SinkholeIngressGetResponseEnvelopeSuccess = true
)

func (SinkholeIngressGetResponseEnvelopeSuccess) IsKnown added in v7.9.0

type SinkholeIngressNewParams added in v7.9.0

type SinkholeIngressNewParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id" api:"required"`
	// The CIDR block for the ingress rule in IPv4 or IPv6 notation (e.g.,
	// 192.0.2.0/24). Must be a Cloudflare BYOIP associated with your account.
	CIDR param.Field[string] `json:"cidr" api:"required"`
}

func (SinkholeIngressNewParams) MarshalJSON added in v7.9.0

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

type SinkholeIngressNewResponse added in v7.9.0

type SinkholeIngressNewResponse struct {
	// The unique identifier for the ingress rule.
	ID string `json:"id"`
	// The CIDR block for the ingress rule.
	CIDR string `json:"cidr"`
	// The date and time when the ingress rule was created.
	CreatedOn time.Time `json:"created_on" format:"date-time"`
	// The date and time when the ingress rule was last modified.
	ModifiedOn time.Time `json:"modified_on" format:"date-time"`
	// The sinkhole this ingress rule belongs to.
	SinkholeID string `json:"sinkhole_id"`
	// The zone tag associated with this ingress rule.
	ZoneTag string                         `json:"zone_tag"`
	JSON    sinkholeIngressNewResponseJSON `json:"-"`
}

func (*SinkholeIngressNewResponse) UnmarshalJSON added in v7.9.0

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

type SinkholeIngressNewResponseEnvelope added in v7.9.0

type SinkholeIngressNewResponseEnvelope struct {
	Errors   []SinkholeIngressNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SinkholeIngressNewResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SinkholeIngressNewResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  SinkholeIngressNewResponse                `json:"result"`
	JSON    sinkholeIngressNewResponseEnvelopeJSON    `json:"-"`
}

func (*SinkholeIngressNewResponseEnvelope) UnmarshalJSON added in v7.9.0

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

type SinkholeIngressNewResponseEnvelopeErrors added in v7.9.0

type SinkholeIngressNewResponseEnvelopeErrors struct {
	Code             int64                                          `json:"code" api:"required"`
	Message          string                                         `json:"message" api:"required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           SinkholeIngressNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             sinkholeIngressNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SinkholeIngressNewResponseEnvelopeErrors) UnmarshalJSON added in v7.9.0

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

type SinkholeIngressNewResponseEnvelopeErrorsSource added in v7.9.0

type SinkholeIngressNewResponseEnvelopeErrorsSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    sinkholeIngressNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SinkholeIngressNewResponseEnvelopeErrorsSource) UnmarshalJSON added in v7.9.0

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

type SinkholeIngressNewResponseEnvelopeMessages added in v7.9.0

type SinkholeIngressNewResponseEnvelopeMessages struct {
	Code             int64                                            `json:"code" api:"required"`
	Message          string                                           `json:"message" api:"required"`
	DocumentationURL string                                           `json:"documentation_url"`
	Source           SinkholeIngressNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             sinkholeIngressNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SinkholeIngressNewResponseEnvelopeMessages) UnmarshalJSON added in v7.9.0

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

type SinkholeIngressNewResponseEnvelopeMessagesSource added in v7.9.0

type SinkholeIngressNewResponseEnvelopeMessagesSource struct {
	Pointer string                                               `json:"pointer"`
	JSON    sinkholeIngressNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SinkholeIngressNewResponseEnvelopeMessagesSource) UnmarshalJSON added in v7.9.0

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

type SinkholeIngressNewResponseEnvelopeSuccess added in v7.9.0

type SinkholeIngressNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	SinkholeIngressNewResponseEnvelopeSuccessTrue SinkholeIngressNewResponseEnvelopeSuccess = true
)

func (SinkholeIngressNewResponseEnvelopeSuccess) IsKnown added in v7.9.0

type SinkholeIngressService added in v7.9.0

type SinkholeIngressService struct {
	Options []option.RequestOption
}

SinkholeIngressService 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 NewSinkholeIngressService method instead.

func NewSinkholeIngressService added in v7.9.0

func NewSinkholeIngressService(opts ...option.RequestOption) (r *SinkholeIngressService)

NewSinkholeIngressService 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 (*SinkholeIngressService) Delete added in v7.9.0

Delete the specified ingress rule. The sinkhole must belong to the same account as the zone.

func (*SinkholeIngressService) Get added in v7.9.0

Get the specified ingress rule associated with a sinkhole. The sinkhole must belong to the same account as the zone.

func (*SinkholeIngressService) New added in v7.9.0

Create a new ingress rule for the specified sinkhole. The CIDR block must be a Cloudflare BYOIP associated with your account. The zone_id must be a zone with the ability to create Spectrum Apps. The sinkhole must belong to the same account as the zone.

func (*SinkholeIngressService) Update added in v7.9.0

Update the specified ingress rule. The sinkhole must belong to the same account as the zone.

type SinkholeIngressUpdateParams added in v7.9.0

type SinkholeIngressUpdateParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id" api:"required"`
	// The CIDR block for the ingress rule in IPv4 or IPv6 notation (e.g.,
	// 192.0.2.0/24). Must be a Cloudflare BYOIP associated with your account.
	CIDR param.Field[string] `json:"cidr" api:"required"`
}

func (SinkholeIngressUpdateParams) MarshalJSON added in v7.9.0

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

type SinkholeIngressUpdateResponse added in v7.9.0

type SinkholeIngressUpdateResponse = interface{}

type SinkholeIngressUpdateResponseEnvelope added in v7.9.0

type SinkholeIngressUpdateResponseEnvelope struct {
	Errors   []SinkholeIngressUpdateResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SinkholeIngressUpdateResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SinkholeIngressUpdateResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  SinkholeIngressUpdateResponse                `json:"result"`
	JSON    sinkholeIngressUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*SinkholeIngressUpdateResponseEnvelope) UnmarshalJSON added in v7.9.0

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

type SinkholeIngressUpdateResponseEnvelopeErrors added in v7.9.0

type SinkholeIngressUpdateResponseEnvelopeErrors struct {
	Code             int64                                             `json:"code" api:"required"`
	Message          string                                            `json:"message" api:"required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           SinkholeIngressUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             sinkholeIngressUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SinkholeIngressUpdateResponseEnvelopeErrors) UnmarshalJSON added in v7.9.0

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

type SinkholeIngressUpdateResponseEnvelopeErrorsSource added in v7.9.0

type SinkholeIngressUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    sinkholeIngressUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SinkholeIngressUpdateResponseEnvelopeErrorsSource) UnmarshalJSON added in v7.9.0

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

type SinkholeIngressUpdateResponseEnvelopeMessages added in v7.9.0

type SinkholeIngressUpdateResponseEnvelopeMessages struct {
	Code             int64                                               `json:"code" api:"required"`
	Message          string                                              `json:"message" api:"required"`
	DocumentationURL string                                              `json:"documentation_url"`
	Source           SinkholeIngressUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             sinkholeIngressUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SinkholeIngressUpdateResponseEnvelopeMessages) UnmarshalJSON added in v7.9.0

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

type SinkholeIngressUpdateResponseEnvelopeMessagesSource added in v7.9.0

type SinkholeIngressUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                                  `json:"pointer"`
	JSON    sinkholeIngressUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SinkholeIngressUpdateResponseEnvelopeMessagesSource) UnmarshalJSON added in v7.9.0

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

type SinkholeIngressUpdateResponseEnvelopeSuccess added in v7.9.0

type SinkholeIngressUpdateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	SinkholeIngressUpdateResponseEnvelopeSuccessTrue SinkholeIngressUpdateResponseEnvelopeSuccess = true
)

func (SinkholeIngressUpdateResponseEnvelopeSuccess) IsKnown added in v7.9.0

type SinkholeListParams

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

type SinkholeNewParams added in v7.9.0

type SinkholeNewParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// The name of the sinkhole.
	Name param.Field[string] `json:"name" api:"required"`
	// The name of the R2 bucket to store results. Required if you want to store large
	// request bodies in R2.
	R2Bucket param.Field[string] `json:"r2_bucket"`
	// The id of the R2 instance. Required if you want to store large request bodies in
	// R2.
	R2ID param.Field[string] `json:"r2_id"`
	// The secret key for the R2 API token. Required if you want to store large request
	// bodies in R2.
	R2Secret param.Field[string] `json:"r2_secret"`
}

func (SinkholeNewParams) MarshalJSON added in v7.9.0

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

type SinkholeNewResponseEnvelope added in v7.9.0

type SinkholeNewResponseEnvelope struct {
	Errors   []SinkholeNewResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SinkholeNewResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SinkholeNewResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  Sinkhole                           `json:"result"`
	JSON    sinkholeNewResponseEnvelopeJSON    `json:"-"`
}

func (*SinkholeNewResponseEnvelope) UnmarshalJSON added in v7.9.0

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

type SinkholeNewResponseEnvelopeErrors added in v7.9.0

type SinkholeNewResponseEnvelopeErrors struct {
	Code             int64                                   `json:"code" api:"required"`
	Message          string                                  `json:"message" api:"required"`
	DocumentationURL string                                  `json:"documentation_url"`
	Source           SinkholeNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             sinkholeNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SinkholeNewResponseEnvelopeErrors) UnmarshalJSON added in v7.9.0

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

type SinkholeNewResponseEnvelopeErrorsSource added in v7.9.0

type SinkholeNewResponseEnvelopeErrorsSource struct {
	Pointer string                                      `json:"pointer"`
	JSON    sinkholeNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SinkholeNewResponseEnvelopeErrorsSource) UnmarshalJSON added in v7.9.0

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

type SinkholeNewResponseEnvelopeMessages added in v7.9.0

type SinkholeNewResponseEnvelopeMessages struct {
	Code             int64                                     `json:"code" api:"required"`
	Message          string                                    `json:"message" api:"required"`
	DocumentationURL string                                    `json:"documentation_url"`
	Source           SinkholeNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             sinkholeNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SinkholeNewResponseEnvelopeMessages) UnmarshalJSON added in v7.9.0

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

type SinkholeNewResponseEnvelopeMessagesSource added in v7.9.0

type SinkholeNewResponseEnvelopeMessagesSource struct {
	Pointer string                                        `json:"pointer"`
	JSON    sinkholeNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SinkholeNewResponseEnvelopeMessagesSource) UnmarshalJSON added in v7.9.0

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

type SinkholeNewResponseEnvelopeSuccess added in v7.9.0

type SinkholeNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	SinkholeNewResponseEnvelopeSuccessTrue SinkholeNewResponseEnvelopeSuccess = true
)

func (SinkholeNewResponseEnvelopeSuccess) IsKnown added in v7.9.0

type SinkholeService

type SinkholeService struct {
	Options   []option.RequestOption
	Ingresses *SinkholeIngressService
}

SinkholeService 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 NewSinkholeService method instead.

func NewSinkholeService

func NewSinkholeService(opts ...option.RequestOption) (r *SinkholeService)

NewSinkholeService 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 (*SinkholeService) Delete added in v7.9.0

func (r *SinkholeService) Delete(ctx context.Context, sinkholeID string, body SinkholeDeleteParams, opts ...option.RequestOption) (res *SinkholeDeleteResponse, err error)

Delete the specified sinkhole. The sinkhole must not have any active ingress rules defined. A 409 response code indicates that this condition is not met.

func (*SinkholeService) Get added in v7.9.0

func (r *SinkholeService) Get(ctx context.Context, sinkholeID string, query SinkholeGetParams, opts ...option.RequestOption) (res *Sinkhole, err error)

Get the specified sinkhole by its unique identifier.

func (*SinkholeService) List

Lists sinkholes owned by the account for redirecting malicious traffic.

func (*SinkholeService) ListAutoPaging

Lists sinkholes owned by the account for redirecting malicious traffic.

func (*SinkholeService) New added in v7.9.0

func (r *SinkholeService) New(ctx context.Context, params SinkholeNewParams, opts ...option.RequestOption) (res *Sinkhole, err error)

Create a new sinkhole. Logs of large request bodies will be truncated, but the full request body can be recorded in R2. If you wish to record large request bodies in R2, include the R2 key ID, key secret, and bucket name in the request body.

func (*SinkholeService) Update added in v7.9.0

func (r *SinkholeService) Update(ctx context.Context, sinkholeID string, params SinkholeUpdateParams, opts ...option.RequestOption) (res *SinkholeUpdateResponse, err error)

Update the name or R2 configuration of the specified sinkhole.

type SinkholeUpdateParams added in v7.9.0

type SinkholeUpdateParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// The name of the sinkhole.
	Name param.Field[string] `json:"name" api:"required"`
	// The name of the R2 bucket to store results. Required if you want to store large
	// request bodies in R2.
	R2Bucket param.Field[string] `json:"r2_bucket"`
	// The id of the R2 instance. Required if you want to store large request bodies in
	// R2.
	R2ID param.Field[string] `json:"r2_id"`
	// The secret key for the R2 API token. Required if you want to store large request
	// bodies in R2.
	R2Secret param.Field[string] `json:"r2_secret"`
}

func (SinkholeUpdateParams) MarshalJSON added in v7.9.0

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

type SinkholeUpdateResponse added in v7.9.0

type SinkholeUpdateResponse = interface{}

type SinkholeUpdateResponseEnvelope added in v7.9.0

type SinkholeUpdateResponseEnvelope struct {
	Errors   []SinkholeUpdateResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []SinkholeUpdateResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success SinkholeUpdateResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  SinkholeUpdateResponse                `json:"result"`
	JSON    sinkholeUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*SinkholeUpdateResponseEnvelope) UnmarshalJSON added in v7.9.0

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

type SinkholeUpdateResponseEnvelopeErrors added in v7.9.0

type SinkholeUpdateResponseEnvelopeErrors struct {
	Code             int64                                      `json:"code" api:"required"`
	Message          string                                     `json:"message" api:"required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           SinkholeUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             sinkholeUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SinkholeUpdateResponseEnvelopeErrors) UnmarshalJSON added in v7.9.0

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

type SinkholeUpdateResponseEnvelopeErrorsSource added in v7.9.0

type SinkholeUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    sinkholeUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SinkholeUpdateResponseEnvelopeErrorsSource) UnmarshalJSON added in v7.9.0

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

type SinkholeUpdateResponseEnvelopeMessages added in v7.9.0

type SinkholeUpdateResponseEnvelopeMessages struct {
	Code             int64                                        `json:"code" api:"required"`
	Message          string                                       `json:"message" api:"required"`
	DocumentationURL string                                       `json:"documentation_url"`
	Source           SinkholeUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             sinkholeUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SinkholeUpdateResponseEnvelopeMessages) UnmarshalJSON added in v7.9.0

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

type SinkholeUpdateResponseEnvelopeMessagesSource added in v7.9.0

type SinkholeUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                           `json:"pointer"`
	JSON    sinkholeUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SinkholeUpdateResponseEnvelopeMessagesSource) UnmarshalJSON added in v7.9.0

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

type SinkholeUpdateResponseEnvelopeSuccess added in v7.9.0

type SinkholeUpdateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	SinkholeUpdateResponseEnvelopeSuccessTrue SinkholeUpdateResponseEnvelopeSuccess = true
)

func (SinkholeUpdateResponseEnvelopeSuccess) IsKnown added in v7.9.0

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 URL added in v7.9.0

type URL struct {
	// Content categories associated with this URL.
	ContentCategories []URLContentCategory `json:"content_categories" api:"required"`
	// The full URL that was looked up.
	FullURL string `json:"full_url" api:"required"`
	// The hostname of the URL.
	Hostname string `json:"hostname" api:"required"`
	// Security risk types associated with this URL.
	RiskType []URLRiskType `json:"risk_type" api:"required"`
	// The path component of the URL.
	URLPath string  `json:"url_path" api:"required"`
	JSON    urlJSON `json:"-"`
}

func (*URL) UnmarshalJSON added in v7.9.0

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

type URLContentCategory added in v7.9.0

type URLContentCategory struct {
	ID              int64                  `json:"id"`
	Name            string                 `json:"name"`
	SourceID        int64                  `json:"source_id"`
	SuperCategoryID int64                  `json:"super_category_id"`
	JSON            urlContentCategoryJSON `json:"-"`
}

func (*URLContentCategory) UnmarshalJSON added in v7.9.0

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

type URLGetParams added in v7.9.0

type URLGetParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// The URL to look up.
	URL param.Field[string] `query:"url" api:"required"`
}

func (URLGetParams) URLQuery added in v7.9.0

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

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

type URLGetResponseEnvelope added in v7.9.0

type URLGetResponseEnvelope struct {
	Errors   []URLGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []URLGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success URLGetResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  URL                           `json:"result"`
	JSON    urlGetResponseEnvelopeJSON    `json:"-"`
}

func (*URLGetResponseEnvelope) UnmarshalJSON added in v7.9.0

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

type URLGetResponseEnvelopeErrors added in v7.9.0

type URLGetResponseEnvelopeErrors struct {
	Code             int64                              `json:"code" api:"required"`
	Message          string                             `json:"message" api:"required"`
	DocumentationURL string                             `json:"documentation_url"`
	Source           URLGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             urlGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*URLGetResponseEnvelopeErrors) UnmarshalJSON added in v7.9.0

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

type URLGetResponseEnvelopeErrorsSource added in v7.9.0

type URLGetResponseEnvelopeErrorsSource struct {
	Pointer string                                 `json:"pointer"`
	JSON    urlGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*URLGetResponseEnvelopeErrorsSource) UnmarshalJSON added in v7.9.0

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

type URLGetResponseEnvelopeMessages added in v7.9.0

type URLGetResponseEnvelopeMessages struct {
	Code             int64                                `json:"code" api:"required"`
	Message          string                               `json:"message" api:"required"`
	DocumentationURL string                               `json:"documentation_url"`
	Source           URLGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             urlGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*URLGetResponseEnvelopeMessages) UnmarshalJSON added in v7.9.0

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

type URLGetResponseEnvelopeMessagesSource added in v7.9.0

type URLGetResponseEnvelopeMessagesSource struct {
	Pointer string                                   `json:"pointer"`
	JSON    urlGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*URLGetResponseEnvelopeMessagesSource) UnmarshalJSON added in v7.9.0

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

type URLGetResponseEnvelopeSuccess added in v7.9.0

type URLGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	URLGetResponseEnvelopeSuccessTrue URLGetResponseEnvelopeSuccess = true
)

func (URLGetResponseEnvelopeSuccess) IsKnown added in v7.9.0

func (r URLGetResponseEnvelopeSuccess) IsKnown() bool

type URLRiskType added in v7.9.0

type URLRiskType struct {
	ID              int64           `json:"id"`
	Name            string          `json:"name"`
	SourceID        int64           `json:"source_id"`
	SuperCategoryID int64           `json:"super_category_id"`
	JSON            urlRiskTypeJSON `json:"-"`
}

func (*URLRiskType) UnmarshalJSON added in v7.9.0

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

type URLService added in v7.9.0

type URLService struct {
	Options []option.RequestOption
}

URLService 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 NewURLService method instead.

func NewURLService added in v7.9.0

func NewURLService(opts ...option.RequestOption) (r *URLService)

NewURLService 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 (*URLService) Get added in v7.9.0

func (r *URLService) Get(ctx context.Context, params URLGetParams, opts ...option.RequestOption) (res *URL, err error)

Gets security information about a URL, including content categories and risk types. The URL must be provided as a query parameter.

type WhoisGetParams

type WhoisGetParams struct {
	// Use to uniquely identify or reference the resource.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	Domain    param.Field[string] `query:"domain"`
}

func (WhoisGetParams) URLQuery

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

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

type WhoisGetResponse

type WhoisGetResponse struct {
	DNSSEC                    bool                 `json:"dnssec" api:"required"`
	Domain                    string               `json:"domain" api:"required"`
	Extension                 string               `json:"extension" api:"required"`
	Found                     bool                 `json:"found" api:"required"`
	Nameservers               []string             `json:"nameservers" api:"required"`
	Punycode                  string               `json:"punycode" api:"required"`
	Registrant                string               `json:"registrant" api:"required"`
	Registrar                 string               `json:"registrar" api:"required"`
	ID                        string               `json:"id"`
	AdministrativeCity        string               `json:"administrative_city"`
	AdministrativeCountry     string               `json:"administrative_country"`
	AdministrativeEmail       string               `json:"administrative_email"`
	AdministrativeFax         string               `json:"administrative_fax"`
	AdministrativeFaxExt      string               `json:"administrative_fax_ext"`
	AdministrativeID          string               `json:"administrative_id"`
	AdministrativeName        string               `json:"administrative_name"`
	AdministrativeOrg         string               `json:"administrative_org"`
	AdministrativePhone       string               `json:"administrative_phone"`
	AdministrativePhoneExt    string               `json:"administrative_phone_ext"`
	AdministrativePostalCode  string               `json:"administrative_postal_code"`
	AdministrativeProvince    string               `json:"administrative_province"`
	AdministrativeReferralURL string               `json:"administrative_referral_url"`
	AdministrativeStreet      string               `json:"administrative_street"`
	BillingCity               string               `json:"billing_city"`
	BillingCountry            string               `json:"billing_country"`
	BillingEmail              string               `json:"billing_email"`
	BillingFax                string               `json:"billing_fax"`
	BillingFaxExt             string               `json:"billing_fax_ext"`
	BillingID                 string               `json:"billing_id"`
	BillingName               string               `json:"billing_name"`
	BillingOrg                string               `json:"billing_org"`
	BillingPhone              string               `json:"billing_phone"`
	BillingPhoneExt           string               `json:"billing_phone_ext"`
	BillingPostalCode         string               `json:"billing_postal_code"`
	BillingProvince           string               `json:"billing_province"`
	BillingReferralURL        string               `json:"billing_referral_url"`
	BillingStreet             string               `json:"billing_street"`
	CreatedDate               time.Time            `json:"created_date" format:"date-time"`
	CreatedDateRaw            string               `json:"created_date_raw"`
	ExpirationDate            time.Time            `json:"expiration_date" format:"date-time"`
	ExpirationDateRaw         string               `json:"expiration_date_raw"`
	RegistrantCity            string               `json:"registrant_city"`
	RegistrantCountry         string               `json:"registrant_country"`
	RegistrantEmail           string               `json:"registrant_email"`
	RegistrantFax             string               `json:"registrant_fax"`
	RegistrantFaxExt          string               `json:"registrant_fax_ext"`
	RegistrantID              string               `json:"registrant_id"`
	RegistrantName            string               `json:"registrant_name"`
	RegistrantOrg             string               `json:"registrant_org"`
	RegistrantPhone           string               `json:"registrant_phone"`
	RegistrantPhoneExt        string               `json:"registrant_phone_ext"`
	RegistrantPostalCode      string               `json:"registrant_postal_code"`
	RegistrantProvince        string               `json:"registrant_province"`
	RegistrantReferralURL     string               `json:"registrant_referral_url"`
	RegistrantStreet          string               `json:"registrant_street"`
	RegistrarCity             string               `json:"registrar_city"`
	RegistrarCountry          string               `json:"registrar_country"`
	RegistrarEmail            string               `json:"registrar_email"`
	RegistrarFax              string               `json:"registrar_fax"`
	RegistrarFaxExt           string               `json:"registrar_fax_ext"`
	RegistrarID               string               `json:"registrar_id"`
	RegistrarName             string               `json:"registrar_name"`
	RegistrarOrg              string               `json:"registrar_org"`
	RegistrarPhone            string               `json:"registrar_phone"`
	RegistrarPhoneExt         string               `json:"registrar_phone_ext"`
	RegistrarPostalCode       string               `json:"registrar_postal_code"`
	RegistrarProvince         string               `json:"registrar_province"`
	RegistrarReferralURL      string               `json:"registrar_referral_url"`
	RegistrarStreet           string               `json:"registrar_street"`
	Status                    []string             `json:"status"`
	TechnicalCity             string               `json:"technical_city"`
	TechnicalCountry          string               `json:"technical_country"`
	TechnicalEmail            string               `json:"technical_email"`
	TechnicalFax              string               `json:"technical_fax"`
	TechnicalFaxExt           string               `json:"technical_fax_ext"`
	TechnicalID               string               `json:"technical_id"`
	TechnicalName             string               `json:"technical_name"`
	TechnicalOrg              string               `json:"technical_org"`
	TechnicalPhone            string               `json:"technical_phone"`
	TechnicalPhoneExt         string               `json:"technical_phone_ext"`
	TechnicalPostalCode       string               `json:"technical_postal_code"`
	TechnicalProvince         string               `json:"technical_province"`
	TechnicalReferralURL      string               `json:"technical_referral_url"`
	TechnicalStreet           string               `json:"technical_street"`
	UpdatedDate               time.Time            `json:"updated_date" format:"date-time"`
	UpdatedDateRaw            string               `json:"updated_date_raw"`
	WhoisServer               string               `json:"whois_server"`
	JSON                      whoisGetResponseJSON `json:"-"`
}

func (*WhoisGetResponse) UnmarshalJSON

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

type WhoisGetResponseEnvelope

type WhoisGetResponseEnvelope struct {
	Errors   []WhoisGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []WhoisGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// Returns a boolean for the success/failure of the API call.
	Success WhoisGetResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  WhoisGetResponse                `json:"result"`
	JSON    whoisGetResponseEnvelopeJSON    `json:"-"`
}

func (*WhoisGetResponseEnvelope) UnmarshalJSON

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

type WhoisGetResponseEnvelopeErrors

type WhoisGetResponseEnvelopeErrors struct {
	Code             int64                                `json:"code" api:"required"`
	Message          string                               `json:"message" api:"required"`
	DocumentationURL string                               `json:"documentation_url"`
	Source           WhoisGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             whoisGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*WhoisGetResponseEnvelopeErrors) UnmarshalJSON

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

type WhoisGetResponseEnvelopeErrorsSource

type WhoisGetResponseEnvelopeErrorsSource struct {
	Pointer string                                   `json:"pointer"`
	JSON    whoisGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*WhoisGetResponseEnvelopeErrorsSource) UnmarshalJSON

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

type WhoisGetResponseEnvelopeMessages

type WhoisGetResponseEnvelopeMessages struct {
	Code             int64                                  `json:"code" api:"required"`
	Message          string                                 `json:"message" api:"required"`
	DocumentationURL string                                 `json:"documentation_url"`
	Source           WhoisGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             whoisGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*WhoisGetResponseEnvelopeMessages) UnmarshalJSON

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

type WhoisGetResponseEnvelopeMessagesSource

type WhoisGetResponseEnvelopeMessagesSource struct {
	Pointer string                                     `json:"pointer"`
	JSON    whoisGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*WhoisGetResponseEnvelopeMessagesSource) UnmarshalJSON

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

type WhoisGetResponseEnvelopeSuccess

type WhoisGetResponseEnvelopeSuccess bool

Returns a boolean for the success/failure of the API call.

const (
	WhoisGetResponseEnvelopeSuccessTrue WhoisGetResponseEnvelopeSuccess = true
)

func (WhoisGetResponseEnvelopeSuccess) IsKnown

type WhoisService

type WhoisService struct {
	Options []option.RequestOption
}

WhoisService 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 NewWhoisService method instead.

func NewWhoisService

func NewWhoisService(opts ...option.RequestOption) (r *WhoisService)

NewWhoisService 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 (*WhoisService) Get

func (r *WhoisService) Get(ctx context.Context, params WhoisGetParams, opts ...option.RequestOption) (res *WhoisGetResponse, err error)

Retrieves WHOIS registration data for a domain, including registrant and nameserver information.

Jump to

Keyboard shortcuts

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