Documentation
¶
Index ¶
- Constants
- type ASN
- type ASNParam
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type CertificateCA
- type CertificateRequestType
- type CloudflareTunnel
- type CloudflareTunnelConfigSrc
- type CloudflareTunnelConnection
- type CloudflareTunnelStatus
- type CloudflareTunnelTunType
- type DMARCReportEditParams
- type DMARCReportEditResponse
- type DMARCReportEditResponseApprovedSource
- type DMARCReportEditResponseEnvelope
- type DMARCReportEditResponseEnvelopeErrors
- type DMARCReportEditResponseEnvelopeErrorsSource
- type DMARCReportEditResponseEnvelopeMessages
- type DMARCReportEditResponseEnvelopeMessagesSource
- type DMARCReportEditResponseEnvelopeSuccess
- type DMARCReportEditResponseRecords
- type DMARCReportEditResponseRecordsBimiRecord
- type DMARCReportEditResponseRecordsCnamedkimRecord
- type DMARCReportEditResponseRecordsCnamedmarcRecord
- type DMARCReportEditResponseRecordsCnamespfRecord
- type DMARCReportEditResponseRecordsDKIMRecord
- type DMARCReportEditResponseRecordsDMARCRecord
- type DMARCReportEditResponseRecordsSPFRecord
- type DMARCReportEditResponseStatus
- type DMARCReportGetParams
- type DMARCReportGetResponse
- type DMARCReportGetResponseApprovedSource
- type DMARCReportGetResponseEnvelope
- type DMARCReportGetResponseEnvelopeErrors
- type DMARCReportGetResponseEnvelopeErrorsSource
- type DMARCReportGetResponseEnvelopeMessages
- type DMARCReportGetResponseEnvelopeMessagesSource
- type DMARCReportGetResponseEnvelopeSuccess
- type DMARCReportGetResponseRecords
- type DMARCReportGetResponseRecordsBimiRecord
- type DMARCReportGetResponseRecordsCnamedkimRecord
- type DMARCReportGetResponseRecordsCnamedmarcRecord
- type DMARCReportGetResponseRecordsCnamespfRecord
- type DMARCReportGetResponseRecordsDKIMRecord
- type DMARCReportGetResponseRecordsDMARCRecord
- type DMARCReportGetResponseRecordsSPFRecord
- type DMARCReportGetResponseStatus
- type DMARCReportService
- type EmailAuthService
- type Error
- type ErrorData
- type ErrorDataSource
- type Member
- type MemberPoliciesAccess
- type MemberPoliciesPermissionGroup
- type MemberPoliciesPermissionGroupsMeta
- type MemberPoliciesResourceGroup
- type MemberPoliciesResourceGroupsMeta
- type MemberPoliciesResourceGroupsScope
- type MemberPoliciesResourceGroupsScopeObject
- type MemberPolicy
- type MemberStatus
- type MemberUser
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type RatePlan
- type RatePlanID
- type RatePlanParam
- type ResponseInfo
- type ResponseInfoSource
- type Role
- type RoleParam
- type RolePermissions
- type RolePermissionsParam
- type SPFInspectGetParams
- type SPFInspectGetResponse
- type SPFInspectGetResponseEnvelope
- type SPFInspectGetResponseEnvelopeErrors
- type SPFInspectGetResponseEnvelopeErrorsSource
- type SPFInspectGetResponseEnvelopeMessages
- type SPFInspectGetResponseEnvelopeMessagesSource
- type SPFInspectGetResponseEnvelopeSuccess
- type SPFInspectGetResponseError
- type SPFInspectService
- type SPFService
- type SortDirection
- type Subscription
- type SubscriptionFrequency
- type SubscriptionParam
- type SubscriptionState
- type Token
- type TokenCondition
- type TokenConditionCIDRList
- type TokenConditionCIDRListParam
- type TokenConditionParam
- type TokenConditionRequestIP
- type TokenConditionRequestIPParam
- type TokenParam
- type TokenPolicy
- type TokenPolicyEffect
- type TokenPolicyParam
- type TokenPolicyPermissionGroup
- type TokenPolicyPermissionGroupParam
- type TokenPolicyPermissionGroupsMeta
- type TokenPolicyPermissionGroupsMetaParam
- type TokenPolicyResourcesIAMResourcesTypeObjectNested
- type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam
- type TokenPolicyResourcesIAMResourcesTypeObjectString
- type TokenPolicyResourcesIAMResourcesTypeObjectStringParam
- type TokenPolicyResourcesUnion
- type TokenPolicyResourcesUnionParam
- type TokenStatus
- type TokenValue
Constants ¶
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin
This is an alias to an internal value.
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare
This is an alias to an internal value.
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser
This is an alias to an internal value.
const CertificateCADigicert = shared.CertificateCADigicert
This is an alias to an internal value.
const CertificateCAGoogle = shared.CertificateCAGoogle
This is an alias to an internal value.
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt
This is an alias to an internal value.
const CertificateCASSLCom = shared.CertificateCASSLCom
This is an alias to an internal value.
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate
This is an alias to an internal value.
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC
This is an alias to an internal value.
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA
This is an alias to an internal value.
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare
This is an alias to an internal value.
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal
This is an alias to an internal value.
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded
This is an alias to an internal value.
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown
This is an alias to an internal value.
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy
This is an alias to an internal value.
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive
This is an alias to an internal value.
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI
This is an alias to an internal value.
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel
This is an alias to an internal value.
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE
This is an alias to an internal value.
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec
This is an alias to an internal value.
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector
This is an alias to an internal value.
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow
This is an alias to an internal value.
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny
This is an alias to an internal value.
const MemberStatusAccepted = shared.MemberStatusAccepted
This is an alias to an internal value.
const MemberStatusPending = shared.MemberStatusPending
This is an alias to an internal value.
const RatePlanIDBusiness = shared.RatePlanIDBusiness
This is an alias to an internal value.
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise
This is an alias to an internal value.
const RatePlanIDFree = shared.RatePlanIDFree
This is an alias to an internal value.
const RatePlanIDLite = shared.RatePlanIDLite
This is an alias to an internal value.
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness
This is an alias to an internal value.
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise
This is an alias to an internal value.
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree
This is an alias to an internal value.
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro
This is an alias to an internal value.
const RatePlanIDPro = shared.RatePlanIDPro
This is an alias to an internal value.
const RatePlanIDProPlus = shared.RatePlanIDProPlus
This is an alias to an internal value.
const SortDirectionAsc = shared.SortDirectionAsc
This is an alias to an internal value.
const SortDirectionDesc = shared.SortDirectionDesc
This is an alias to an internal value.
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly
This is an alias to an internal value.
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly
This is an alias to an internal value.
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly
This is an alias to an internal value.
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly
This is an alias to an internal value.
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment
This is an alias to an internal value.
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled
This is an alias to an internal value.
const SubscriptionStateExpired = shared.SubscriptionStateExpired
This is an alias to an internal value.
const SubscriptionStateFailed = shared.SubscriptionStateFailed
This is an alias to an internal value.
const SubscriptionStatePaid = shared.SubscriptionStatePaid
This is an alias to an internal value.
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned
This is an alias to an internal value.
const SubscriptionStateTrial = shared.SubscriptionStateTrial
This is an alias to an internal value.
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow
This is an alias to an internal value.
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny
This is an alias to an internal value.
const TokenStatusActive = shared.TokenStatusActive
This is an alias to an internal value.
const TokenStatusDisabled = shared.TokenStatusDisabled
This is an alias to an internal value.
const TokenStatusExpired = shared.TokenStatusExpired
This is an alias to an internal value.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
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 DMARCReportEditParams ¶
type DMARCReportEditParams struct {
// Identifier.
ZoneID param.Field[string] `path:"zone_id" api:"required"`
// Enable or disable DMARC reports for this zone
Enabled param.Field[bool] `json:"enabled"`
// Skip the DMARC setup wizard
SkipWizard param.Field[bool] `json:"skip_wizard"`
}
func (DMARCReportEditParams) MarshalJSON ¶
func (r DMARCReportEditParams) MarshalJSON() (data []byte, err error)
type DMARCReportEditResponse ¶
type DMARCReportEditResponse struct {
// List of approved sending sources (omitted when empty)
ApprovedSources []DMARCReportEditResponseApprovedSource `json:"approved_sources"`
// Deprecated, use created_at
//
// Deprecated: Use `created_at` instead.
Created time.Time `json:"created" format:"date-time"`
// Creation timestamp
CreatedAt time.Time `json:"created_at" format:"date-time"`
// Whether DMARC reports are enabled
Enabled bool `json:"enabled"`
// Deprecated, use modified_at
//
// Deprecated: Use `modified_at` instead.
Modified time.Time `json:"modified" format:"date-time"`
// Last modification timestamp
ModifiedAt time.Time `json:"modified_at" format:"date-time"`
// Live DNS records for the zone, grouped by type
Records DMARCReportEditResponseRecords `json:"records"`
// Prefix for DMARC RUA addresses (32-char hex string)
RuaPrefix string `json:"rua_prefix"`
// Whether to skip the setup wizard
SkipWizard bool `json:"skip_wizard"`
// DMARC configuration status
Status DMARCReportEditResponseStatus `json:"status"`
// Use `zone_id` instead
//
// Deprecated: Use `zone_id` instead.
Tag string `json:"tag"`
// Zone identifier
ZoneID string `json:"zone_id"`
JSON dmarcReportEditResponseJSON `json:"-"`
}
Response for GET/PATCH /dmarc-reports
func (*DMARCReportEditResponse) UnmarshalJSON ¶
func (r *DMARCReportEditResponse) UnmarshalJSON(data []byte) (err error)
type DMARCReportEditResponseApprovedSource ¶
type DMARCReportEditResponseApprovedSource struct {
// Deprecated, use created_at
//
// Deprecated: Use `created_at` instead.
Created time.Time `json:"created" format:"date-time"`
// Creation timestamp
CreatedAt time.Time `json:"created_at" format:"date-time"`
// The source domain
Domain string `json:"domain"`
// Resolved IP addresses from SPF
IPs []string `json:"ips"`
// Deprecated, use modified_at
//
// Deprecated: Use `modified_at` instead.
Modified time.Time `json:"modified" format:"date-time"`
// Last modification timestamp
ModifiedAt time.Time `json:"modified_at" format:"date-time"`
// Source name (typically same as domain)
Name string `json:"name"`
// URL-friendly identifier
Slug string `json:"slug"`
// Source UUID
Tag string `json:"tag"`
JSON dmarcReportEditResponseApprovedSourceJSON `json:"-"`
}
A single approved sending source
func (*DMARCReportEditResponseApprovedSource) UnmarshalJSON ¶
func (r *DMARCReportEditResponseApprovedSource) UnmarshalJSON(data []byte) (err error)
type DMARCReportEditResponseEnvelope ¶
type DMARCReportEditResponseEnvelope struct {
Errors []DMARCReportEditResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []DMARCReportEditResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success DMARCReportEditResponseEnvelopeSuccess `json:"success" api:"required"`
// Response for GET/PATCH /dmarc-reports
Result DMARCReportEditResponse `json:"result"`
JSON dmarcReportEditResponseEnvelopeJSON `json:"-"`
}
func (*DMARCReportEditResponseEnvelope) UnmarshalJSON ¶
func (r *DMARCReportEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DMARCReportEditResponseEnvelopeErrors ¶
type DMARCReportEditResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source DMARCReportEditResponseEnvelopeErrorsSource `json:"source"`
JSON dmarcReportEditResponseEnvelopeErrorsJSON `json:"-"`
}
func (*DMARCReportEditResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *DMARCReportEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type DMARCReportEditResponseEnvelopeErrorsSource ¶
type DMARCReportEditResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON dmarcReportEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*DMARCReportEditResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *DMARCReportEditResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type DMARCReportEditResponseEnvelopeMessages ¶
type DMARCReportEditResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source DMARCReportEditResponseEnvelopeMessagesSource `json:"source"`
JSON dmarcReportEditResponseEnvelopeMessagesJSON `json:"-"`
}
func (*DMARCReportEditResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *DMARCReportEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type DMARCReportEditResponseEnvelopeMessagesSource ¶
type DMARCReportEditResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON dmarcReportEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*DMARCReportEditResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *DMARCReportEditResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type DMARCReportEditResponseEnvelopeSuccess ¶
type DMARCReportEditResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
DMARCReportEditResponseEnvelopeSuccessTrue DMARCReportEditResponseEnvelopeSuccess = true
)
func (DMARCReportEditResponseEnvelopeSuccess) IsKnown ¶
func (r DMARCReportEditResponseEnvelopeSuccess) IsKnown() bool
type DMARCReportEditResponseRecords ¶
type DMARCReportEditResponseRecords struct {
// BIMI TXT records
BimiRecords []DMARCReportEditResponseRecordsBimiRecord `json:"bimi_records"`
// CNAME records for DKIM
CNAMEDKIMRecords []DMARCReportEditResponseRecordsCnamedkimRecord `json:"cname_dkim_records"`
// CNAME records at \_dmarc (problematic)
CNAMEDMARCRecords []DMARCReportEditResponseRecordsCnamedmarcRecord `json:"cname_dmarc_records"`
// CNAME records for SPF
CNAMESPFRecords []DMARCReportEditResponseRecordsCnamespfRecord `json:"cname_spf_records"`
// DKIM TXT records
DKIMRecords []DMARCReportEditResponseRecordsDKIMRecord `json:"dkim_records"`
// DMARC TXT records
DMARCRecords []DMARCReportEditResponseRecordsDMARCRecord `json:"dmarc_records"`
// SPF TXT records
SPFRecords []DMARCReportEditResponseRecordsSPFRecord `json:"spf_records"`
JSON dmarcReportEditResponseRecordsJSON `json:"-"`
}
Live DNS records for the zone, grouped by type
func (*DMARCReportEditResponseRecords) UnmarshalJSON ¶
func (r *DMARCReportEditResponseRecords) UnmarshalJSON(data []byte) (err error)
type DMARCReportEditResponseRecordsBimiRecord ¶
type DMARCReportEditResponseRecordsBimiRecord struct {
// DNS record ID
ID string `json:"id"`
// Record content
Content string `json:"content"`
// DNS record name
Name string `json:"name"`
// Time to live in seconds
TTL int64 `json:"ttl"`
// Record type
Type string `json:"type"`
JSON dmarcReportEditResponseRecordsBimiRecordJSON `json:"-"`
}
Summary of a single DNS record
func (*DMARCReportEditResponseRecordsBimiRecord) UnmarshalJSON ¶
func (r *DMARCReportEditResponseRecordsBimiRecord) UnmarshalJSON(data []byte) (err error)
type DMARCReportEditResponseRecordsCnamedkimRecord ¶
type DMARCReportEditResponseRecordsCnamedkimRecord struct {
// DNS record ID
ID string `json:"id"`
// Record content
Content string `json:"content"`
// DNS record name
Name string `json:"name"`
// Time to live in seconds
TTL int64 `json:"ttl"`
// Record type
Type string `json:"type"`
JSON dmarcReportEditResponseRecordsCnamedkimRecordJSON `json:"-"`
}
Summary of a single DNS record
func (*DMARCReportEditResponseRecordsCnamedkimRecord) UnmarshalJSON ¶
func (r *DMARCReportEditResponseRecordsCnamedkimRecord) UnmarshalJSON(data []byte) (err error)
type DMARCReportEditResponseRecordsCnamedmarcRecord ¶
type DMARCReportEditResponseRecordsCnamedmarcRecord struct {
// DNS record ID
ID string `json:"id"`
// Record content
Content string `json:"content"`
// DNS record name
Name string `json:"name"`
// Time to live in seconds
TTL int64 `json:"ttl"`
// Record type
Type string `json:"type"`
JSON dmarcReportEditResponseRecordsCnamedmarcRecordJSON `json:"-"`
}
Summary of a single DNS record
func (*DMARCReportEditResponseRecordsCnamedmarcRecord) UnmarshalJSON ¶
func (r *DMARCReportEditResponseRecordsCnamedmarcRecord) UnmarshalJSON(data []byte) (err error)
type DMARCReportEditResponseRecordsCnamespfRecord ¶
type DMARCReportEditResponseRecordsCnamespfRecord struct {
// DNS record ID
ID string `json:"id"`
// Record content
Content string `json:"content"`
// DNS record name
Name string `json:"name"`
// Time to live in seconds
TTL int64 `json:"ttl"`
// Record type
Type string `json:"type"`
JSON dmarcReportEditResponseRecordsCnamespfRecordJSON `json:"-"`
}
Summary of a single DNS record
func (*DMARCReportEditResponseRecordsCnamespfRecord) UnmarshalJSON ¶
func (r *DMARCReportEditResponseRecordsCnamespfRecord) UnmarshalJSON(data []byte) (err error)
type DMARCReportEditResponseRecordsDKIMRecord ¶
type DMARCReportEditResponseRecordsDKIMRecord struct {
// DNS record ID
ID string `json:"id"`
// Record content
Content string `json:"content"`
// DNS record name
Name string `json:"name"`
// Time to live in seconds
TTL int64 `json:"ttl"`
// Record type
Type string `json:"type"`
JSON dmarcReportEditResponseRecordsDKIMRecordJSON `json:"-"`
}
Summary of a single DNS record
func (*DMARCReportEditResponseRecordsDKIMRecord) UnmarshalJSON ¶
func (r *DMARCReportEditResponseRecordsDKIMRecord) UnmarshalJSON(data []byte) (err error)
type DMARCReportEditResponseRecordsDMARCRecord ¶
type DMARCReportEditResponseRecordsDMARCRecord struct {
// DNS record ID
ID string `json:"id"`
// Record content
Content string `json:"content"`
// DNS record name
Name string `json:"name"`
// Time to live in seconds
TTL int64 `json:"ttl"`
// Record type
Type string `json:"type"`
JSON dmarcReportEditResponseRecordsDMARCRecordJSON `json:"-"`
}
Summary of a single DNS record
func (*DMARCReportEditResponseRecordsDMARCRecord) UnmarshalJSON ¶
func (r *DMARCReportEditResponseRecordsDMARCRecord) UnmarshalJSON(data []byte) (err error)
type DMARCReportEditResponseRecordsSPFRecord ¶
type DMARCReportEditResponseRecordsSPFRecord struct {
// DNS record ID
ID string `json:"id"`
// Record content
Content string `json:"content"`
// DNS record name
Name string `json:"name"`
// Time to live in seconds
TTL int64 `json:"ttl"`
// Record type
Type string `json:"type"`
JSON dmarcReportEditResponseRecordsSPFRecordJSON `json:"-"`
}
Summary of a single DNS record
func (*DMARCReportEditResponseRecordsSPFRecord) UnmarshalJSON ¶
func (r *DMARCReportEditResponseRecordsSPFRecord) UnmarshalJSON(data []byte) (err error)
type DMARCReportEditResponseStatus ¶
type DMARCReportEditResponseStatus string
DMARC configuration status
const ( DMARCReportEditResponseStatusMissingDMARCReport DMARCReportEditResponseStatus = "missing-dmarc-report" DMARCReportEditResponseStatusMultipleDMARCReports DMARCReportEditResponseStatus = "multiple-dmarc-reports" DMARCReportEditResponseStatusMissingDMARCRua DMARCReportEditResponseStatus = "missing-dmarc-rua" DMARCReportEditResponseStatusCNAMEOnDMARCRecord DMARCReportEditResponseStatus = "cname-on-dmarc-record" )
func (DMARCReportEditResponseStatus) IsKnown ¶
func (r DMARCReportEditResponseStatus) IsKnown() bool
type DMARCReportGetParams ¶
type DMARCReportGetResponse ¶
type DMARCReportGetResponse struct {
// List of approved sending sources (omitted when empty)
ApprovedSources []DMARCReportGetResponseApprovedSource `json:"approved_sources"`
// Deprecated, use created_at
//
// Deprecated: Use `created_at` instead.
Created time.Time `json:"created" format:"date-time"`
// Creation timestamp
CreatedAt time.Time `json:"created_at" format:"date-time"`
// Whether DMARC reports are enabled
Enabled bool `json:"enabled"`
// Deprecated, use modified_at
//
// Deprecated: Use `modified_at` instead.
Modified time.Time `json:"modified" format:"date-time"`
// Last modification timestamp
ModifiedAt time.Time `json:"modified_at" format:"date-time"`
// Live DNS records for the zone, grouped by type
Records DMARCReportGetResponseRecords `json:"records"`
// Prefix for DMARC RUA addresses (32-char hex string)
RuaPrefix string `json:"rua_prefix"`
// Whether to skip the setup wizard
SkipWizard bool `json:"skip_wizard"`
// DMARC configuration status
Status DMARCReportGetResponseStatus `json:"status"`
// Use `zone_id` instead
//
// Deprecated: Use `zone_id` instead.
Tag string `json:"tag"`
// Zone identifier
ZoneID string `json:"zone_id"`
JSON dmarcReportGetResponseJSON `json:"-"`
}
Response for GET/PATCH /dmarc-reports
func (*DMARCReportGetResponse) UnmarshalJSON ¶
func (r *DMARCReportGetResponse) UnmarshalJSON(data []byte) (err error)
type DMARCReportGetResponseApprovedSource ¶
type DMARCReportGetResponseApprovedSource struct {
// Deprecated, use created_at
//
// Deprecated: Use `created_at` instead.
Created time.Time `json:"created" format:"date-time"`
// Creation timestamp
CreatedAt time.Time `json:"created_at" format:"date-time"`
// The source domain
Domain string `json:"domain"`
// Resolved IP addresses from SPF
IPs []string `json:"ips"`
// Deprecated, use modified_at
//
// Deprecated: Use `modified_at` instead.
Modified time.Time `json:"modified" format:"date-time"`
// Last modification timestamp
ModifiedAt time.Time `json:"modified_at" format:"date-time"`
// Source name (typically same as domain)
Name string `json:"name"`
// URL-friendly identifier
Slug string `json:"slug"`
// Source UUID
Tag string `json:"tag"`
JSON dmarcReportGetResponseApprovedSourceJSON `json:"-"`
}
A single approved sending source
func (*DMARCReportGetResponseApprovedSource) UnmarshalJSON ¶
func (r *DMARCReportGetResponseApprovedSource) UnmarshalJSON(data []byte) (err error)
type DMARCReportGetResponseEnvelope ¶
type DMARCReportGetResponseEnvelope struct {
Errors []DMARCReportGetResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []DMARCReportGetResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success DMARCReportGetResponseEnvelopeSuccess `json:"success" api:"required"`
// Response for GET/PATCH /dmarc-reports
Result DMARCReportGetResponse `json:"result"`
JSON dmarcReportGetResponseEnvelopeJSON `json:"-"`
}
func (*DMARCReportGetResponseEnvelope) UnmarshalJSON ¶
func (r *DMARCReportGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DMARCReportGetResponseEnvelopeErrors ¶
type DMARCReportGetResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source DMARCReportGetResponseEnvelopeErrorsSource `json:"source"`
JSON dmarcReportGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*DMARCReportGetResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *DMARCReportGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type DMARCReportGetResponseEnvelopeErrorsSource ¶
type DMARCReportGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON dmarcReportGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*DMARCReportGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *DMARCReportGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type DMARCReportGetResponseEnvelopeMessages ¶
type DMARCReportGetResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source DMARCReportGetResponseEnvelopeMessagesSource `json:"source"`
JSON dmarcReportGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*DMARCReportGetResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *DMARCReportGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type DMARCReportGetResponseEnvelopeMessagesSource ¶
type DMARCReportGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON dmarcReportGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*DMARCReportGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *DMARCReportGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type DMARCReportGetResponseEnvelopeSuccess ¶
type DMARCReportGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
DMARCReportGetResponseEnvelopeSuccessTrue DMARCReportGetResponseEnvelopeSuccess = true
)
func (DMARCReportGetResponseEnvelopeSuccess) IsKnown ¶
func (r DMARCReportGetResponseEnvelopeSuccess) IsKnown() bool
type DMARCReportGetResponseRecords ¶
type DMARCReportGetResponseRecords struct {
// BIMI TXT records
BimiRecords []DMARCReportGetResponseRecordsBimiRecord `json:"bimi_records"`
// CNAME records for DKIM
CNAMEDKIMRecords []DMARCReportGetResponseRecordsCnamedkimRecord `json:"cname_dkim_records"`
// CNAME records at \_dmarc (problematic)
CNAMEDMARCRecords []DMARCReportGetResponseRecordsCnamedmarcRecord `json:"cname_dmarc_records"`
// CNAME records for SPF
CNAMESPFRecords []DMARCReportGetResponseRecordsCnamespfRecord `json:"cname_spf_records"`
// DKIM TXT records
DKIMRecords []DMARCReportGetResponseRecordsDKIMRecord `json:"dkim_records"`
// DMARC TXT records
DMARCRecords []DMARCReportGetResponseRecordsDMARCRecord `json:"dmarc_records"`
// SPF TXT records
SPFRecords []DMARCReportGetResponseRecordsSPFRecord `json:"spf_records"`
JSON dmarcReportGetResponseRecordsJSON `json:"-"`
}
Live DNS records for the zone, grouped by type
func (*DMARCReportGetResponseRecords) UnmarshalJSON ¶
func (r *DMARCReportGetResponseRecords) UnmarshalJSON(data []byte) (err error)
type DMARCReportGetResponseRecordsBimiRecord ¶
type DMARCReportGetResponseRecordsBimiRecord struct {
// DNS record ID
ID string `json:"id"`
// Record content
Content string `json:"content"`
// DNS record name
Name string `json:"name"`
// Time to live in seconds
TTL int64 `json:"ttl"`
// Record type
Type string `json:"type"`
JSON dmarcReportGetResponseRecordsBimiRecordJSON `json:"-"`
}
Summary of a single DNS record
func (*DMARCReportGetResponseRecordsBimiRecord) UnmarshalJSON ¶
func (r *DMARCReportGetResponseRecordsBimiRecord) UnmarshalJSON(data []byte) (err error)
type DMARCReportGetResponseRecordsCnamedkimRecord ¶
type DMARCReportGetResponseRecordsCnamedkimRecord struct {
// DNS record ID
ID string `json:"id"`
// Record content
Content string `json:"content"`
// DNS record name
Name string `json:"name"`
// Time to live in seconds
TTL int64 `json:"ttl"`
// Record type
Type string `json:"type"`
JSON dmarcReportGetResponseRecordsCnamedkimRecordJSON `json:"-"`
}
Summary of a single DNS record
func (*DMARCReportGetResponseRecordsCnamedkimRecord) UnmarshalJSON ¶
func (r *DMARCReportGetResponseRecordsCnamedkimRecord) UnmarshalJSON(data []byte) (err error)
type DMARCReportGetResponseRecordsCnamedmarcRecord ¶
type DMARCReportGetResponseRecordsCnamedmarcRecord struct {
// DNS record ID
ID string `json:"id"`
// Record content
Content string `json:"content"`
// DNS record name
Name string `json:"name"`
// Time to live in seconds
TTL int64 `json:"ttl"`
// Record type
Type string `json:"type"`
JSON dmarcReportGetResponseRecordsCnamedmarcRecordJSON `json:"-"`
}
Summary of a single DNS record
func (*DMARCReportGetResponseRecordsCnamedmarcRecord) UnmarshalJSON ¶
func (r *DMARCReportGetResponseRecordsCnamedmarcRecord) UnmarshalJSON(data []byte) (err error)
type DMARCReportGetResponseRecordsCnamespfRecord ¶
type DMARCReportGetResponseRecordsCnamespfRecord struct {
// DNS record ID
ID string `json:"id"`
// Record content
Content string `json:"content"`
// DNS record name
Name string `json:"name"`
// Time to live in seconds
TTL int64 `json:"ttl"`
// Record type
Type string `json:"type"`
JSON dmarcReportGetResponseRecordsCnamespfRecordJSON `json:"-"`
}
Summary of a single DNS record
func (*DMARCReportGetResponseRecordsCnamespfRecord) UnmarshalJSON ¶
func (r *DMARCReportGetResponseRecordsCnamespfRecord) UnmarshalJSON(data []byte) (err error)
type DMARCReportGetResponseRecordsDKIMRecord ¶
type DMARCReportGetResponseRecordsDKIMRecord struct {
// DNS record ID
ID string `json:"id"`
// Record content
Content string `json:"content"`
// DNS record name
Name string `json:"name"`
// Time to live in seconds
TTL int64 `json:"ttl"`
// Record type
Type string `json:"type"`
JSON dmarcReportGetResponseRecordsDKIMRecordJSON `json:"-"`
}
Summary of a single DNS record
func (*DMARCReportGetResponseRecordsDKIMRecord) UnmarshalJSON ¶
func (r *DMARCReportGetResponseRecordsDKIMRecord) UnmarshalJSON(data []byte) (err error)
type DMARCReportGetResponseRecordsDMARCRecord ¶
type DMARCReportGetResponseRecordsDMARCRecord struct {
// DNS record ID
ID string `json:"id"`
// Record content
Content string `json:"content"`
// DNS record name
Name string `json:"name"`
// Time to live in seconds
TTL int64 `json:"ttl"`
// Record type
Type string `json:"type"`
JSON dmarcReportGetResponseRecordsDMARCRecordJSON `json:"-"`
}
Summary of a single DNS record
func (*DMARCReportGetResponseRecordsDMARCRecord) UnmarshalJSON ¶
func (r *DMARCReportGetResponseRecordsDMARCRecord) UnmarshalJSON(data []byte) (err error)
type DMARCReportGetResponseRecordsSPFRecord ¶
type DMARCReportGetResponseRecordsSPFRecord struct {
// DNS record ID
ID string `json:"id"`
// Record content
Content string `json:"content"`
// DNS record name
Name string `json:"name"`
// Time to live in seconds
TTL int64 `json:"ttl"`
// Record type
Type string `json:"type"`
JSON dmarcReportGetResponseRecordsSPFRecordJSON `json:"-"`
}
Summary of a single DNS record
func (*DMARCReportGetResponseRecordsSPFRecord) UnmarshalJSON ¶
func (r *DMARCReportGetResponseRecordsSPFRecord) UnmarshalJSON(data []byte) (err error)
type DMARCReportGetResponseStatus ¶
type DMARCReportGetResponseStatus string
DMARC configuration status
const ( DMARCReportGetResponseStatusMissingDMARCReport DMARCReportGetResponseStatus = "missing-dmarc-report" DMARCReportGetResponseStatusMultipleDMARCReports DMARCReportGetResponseStatus = "multiple-dmarc-reports" DMARCReportGetResponseStatusMissingDMARCRua DMARCReportGetResponseStatus = "missing-dmarc-rua" DMARCReportGetResponseStatusCNAMEOnDMARCRecord DMARCReportGetResponseStatus = "cname-on-dmarc-record" )
func (DMARCReportGetResponseStatus) IsKnown ¶
func (r DMARCReportGetResponseStatus) IsKnown() bool
type DMARCReportService ¶
type DMARCReportService struct {
Options []option.RequestOption
}
DMARCReportService 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 NewDMARCReportService method instead.
func NewDMARCReportService ¶
func NewDMARCReportService(opts ...option.RequestOption) (r *DMARCReportService)
NewDMARCReportService 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 (*DMARCReportService) Edit ¶
func (r *DMARCReportService) Edit(ctx context.Context, params DMARCReportEditParams, opts ...option.RequestOption) (res *DMARCReportEditResponse, err error)
Updates the DMARC report configuration for a zone. At least one of `enabled` or `skip_wizard` must be provided. When enabling, the handler will ensure the DMARC RUA record exists in DNS.
func (*DMARCReportService) Get ¶
func (r *DMARCReportService) Get(ctx context.Context, query DMARCReportGetParams, opts ...option.RequestOption) (res *DMARCReportGetResponse, err error)
Retrieves the current DMARC report configuration and status for a zone. Returns the RUA prefix, enabled status, approved sources, and DNS records.
type EmailAuthService ¶
type EmailAuthService struct {
Options []option.RequestOption
DMARCReports *DMARCReportService
SPF *SPFService
}
EmailAuthService 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 NewEmailAuthService method instead.
func NewEmailAuthService ¶
func NewEmailAuthService(opts ...option.RequestOption) (r *EmailAuthService)
NewEmailAuthService 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 ErrorDataSource ¶
type ErrorDataSource = shared.ErrorDataSource
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 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 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 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 ResponseInfoSource ¶
type ResponseInfoSource = shared.ResponseInfoSource
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 SPFInspectGetParams ¶
type SPFInspectGetParams struct {
// Identifier.
ZoneID param.Field[string] `path:"zone_id" api:"required"`
// DNS record ID (rec_tag) to inspect
ID param.Field[string] `query:"id" api:"required"`
}
func (SPFInspectGetParams) URLQuery ¶
func (r SPFInspectGetParams) URLQuery() (v url.Values)
URLQuery serializes SPFInspectGetParams's query parameters as `url.Values`.
type SPFInspectGetResponse ¶
type SPFInspectGetResponse struct {
// Parsed SPF components (mechanisms)
Components []interface{} `json:"components" api:"required"`
// Domain being inspected
Domain string `json:"domain" api:"required"`
// Raw SPF record content
Record string `json:"record" api:"required"`
// Total number of DNS lookups performed across all includes
TotalLookups int64 `json:"total_lookups" api:"required"`
// All errors encountered during inspection, collected from the entire tree. This
// includes errors from nested includes at any depth, providing a quick overview of
// all issues without needing to traverse the nested structure. Each error includes
// a `domain` field to identify where it occurred. Empty array if no errors
// (omitted from JSON when empty).
Errors []SPFInspectGetResponseError `json:"errors"`
JSON spfInspectGetResponseJSON `json:"-"`
}
Recursive SPF inspection tree
func (*SPFInspectGetResponse) UnmarshalJSON ¶
func (r *SPFInspectGetResponse) UnmarshalJSON(data []byte) (err error)
type SPFInspectGetResponseEnvelope ¶
type SPFInspectGetResponseEnvelope struct {
Errors []SPFInspectGetResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []SPFInspectGetResponseEnvelopeMessages `json:"messages" api:"required"`
// Whether the API call was successful.
Success SPFInspectGetResponseEnvelopeSuccess `json:"success" api:"required"`
// Recursive SPF inspection tree
Result SPFInspectGetResponse `json:"result"`
JSON spfInspectGetResponseEnvelopeJSON `json:"-"`
}
func (*SPFInspectGetResponseEnvelope) UnmarshalJSON ¶
func (r *SPFInspectGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SPFInspectGetResponseEnvelopeErrors ¶
type SPFInspectGetResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source SPFInspectGetResponseEnvelopeErrorsSource `json:"source"`
JSON spfInspectGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*SPFInspectGetResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *SPFInspectGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type SPFInspectGetResponseEnvelopeErrorsSource ¶
type SPFInspectGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON spfInspectGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*SPFInspectGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *SPFInspectGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type SPFInspectGetResponseEnvelopeMessages ¶
type SPFInspectGetResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source SPFInspectGetResponseEnvelopeMessagesSource `json:"source"`
JSON spfInspectGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*SPFInspectGetResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *SPFInspectGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type SPFInspectGetResponseEnvelopeMessagesSource ¶
type SPFInspectGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON spfInspectGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*SPFInspectGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *SPFInspectGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type SPFInspectGetResponseEnvelopeSuccess ¶
type SPFInspectGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
SPFInspectGetResponseEnvelopeSuccessTrue SPFInspectGetResponseEnvelopeSuccess = true
)
func (SPFInspectGetResponseEnvelopeSuccess) IsKnown ¶
func (r SPFInspectGetResponseEnvelopeSuccess) IsKnown() bool
type SPFInspectGetResponseError ¶
type SPFInspectGetResponseError struct {
// Error code. Known values:
//
// - `lookup_failed` — DNS TXT lookup failed
// - `spf_not_found` — no SPF record found
// - `invalid_spf` — record does not start with `v=spf1`
// - `invalid_domain` — PSL validation failed
// - `loop_detected` — include/redirect cycle detected
// - `invalid_mechanism` — unrecognised or malformed mechanism
// - `resource_limit_exceeded` — internal resource protection limits exceeded
// (recursion depth or query budget)
// - `max_lookups` — RFC 7208 10-lookup limit exceeded
Code string `json:"code" api:"required"`
// Domain where the error occurred
Domain string `json:"domain" api:"required"`
// Human-readable error message
Message string `json:"message" api:"required"`
// Additional error-specific details (optional).
//
// - For `invalid_domain` errors: the invalid domain string
// - For `invalid_mechanism` errors: the invalid mechanism text (e.g.,
// "invalidmech123")
// - For `loop_detected` errors: the domain that caused the loop
// - For other error types: not present
Details string `json:"details"`
JSON spfInspectGetResponseErrorJSON `json:"-"`
}
An error encountered during SPF inspection
func (*SPFInspectGetResponseError) UnmarshalJSON ¶
func (r *SPFInspectGetResponseError) UnmarshalJSON(data []byte) (err error)
type SPFInspectService ¶
type SPFInspectService struct {
Options []option.RequestOption
}
SPFInspectService 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 NewSPFInspectService method instead.
func NewSPFInspectService ¶
func NewSPFInspectService(opts ...option.RequestOption) (r *SPFInspectService)
NewSPFInspectService 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 (*SPFInspectService) Get ¶
func (r *SPFInspectService) Get(ctx context.Context, params SPFInspectGetParams, opts ...option.RequestOption) (res *SPFInspectGetResponse, err error)
Inspects a specific SPF TXT record and returns a parsed tree structure in the spflimit-worker format.
The record ID must be provided via the `id` query parameter.
Returns a recursive tree showing:
- Parsed components with their qualifiers and types - Nested includes recursively resolved within components - Per-component and total lookup counts - Detailed error information with context
type SPFService ¶
type SPFService struct {
Options []option.RequestOption
Inspect *SPFInspectService
}
SPFService 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 NewSPFService method instead.
func NewSPFService ¶
func NewSPFService(opts ...option.RequestOption) (r *SPFService)
NewSPFService 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 SortDirection ¶
type SortDirection = shared.SortDirection
Direction to order DNS records in.
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 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 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.