Documentation
¶
Index ¶
- Constants
- type ASN
- type ASNGetParams
- type ASNGetResponseEnvelope
- type ASNGetResponseEnvelopeErrors
- type ASNGetResponseEnvelopeErrorsSource
- type ASNGetResponseEnvelopeMessages
- type ASNGetResponseEnvelopeMessagesSource
- type ASNGetResponseEnvelopeSuccess
- type ASNParam
- type ASNService
- type ASNSubnetGetParams
- type ASNSubnetGetResponse
- type ASNSubnetService
- type AttackSurfaceReportIssueClassParams
- type AttackSurfaceReportIssueClassResponse
- type AttackSurfaceReportIssueClassResponseEnvelope
- type AttackSurfaceReportIssueClassResponseEnvelopeErrors
- type AttackSurfaceReportIssueClassResponseEnvelopeErrorsSource
- type AttackSurfaceReportIssueClassResponseEnvelopeMessages
- type AttackSurfaceReportIssueClassResponseEnvelopeMessagesSource
- type AttackSurfaceReportIssueClassResponseEnvelopeSuccess
- type AttackSurfaceReportIssueDismissParams
- type AttackSurfaceReportIssueDismissResponse
- type AttackSurfaceReportIssueDismissResponseError
- type AttackSurfaceReportIssueDismissResponseErrorsSource
- type AttackSurfaceReportIssueDismissResponseMessage
- type AttackSurfaceReportIssueDismissResponseMessagesSource
- type AttackSurfaceReportIssueDismissResponseSuccess
- type AttackSurfaceReportIssueListParams
- type AttackSurfaceReportIssueListResponse
- type AttackSurfaceReportIssueListResponseIssue
- type AttackSurfaceReportIssueListResponseIssuesSeverity
- type AttackSurfaceReportIssueService
- func (r *AttackSurfaceReportIssueService) Class(ctx context.Context, params AttackSurfaceReportIssueClassParams, ...) (res *[]AttackSurfaceReportIssueClassResponse, err error)
- func (r *AttackSurfaceReportIssueService) Dismiss(ctx context.Context, issueID string, ...) (res *AttackSurfaceReportIssueDismissResponse, err error)
- func (r *AttackSurfaceReportIssueService) List(ctx context.Context, params AttackSurfaceReportIssueListParams, ...) (res *pagination.V4PagePagination[AttackSurfaceReportIssueListResponse], ...)
- func (r *AttackSurfaceReportIssueService) ListAutoPaging(ctx context.Context, params AttackSurfaceReportIssueListParams, ...) *pagination.V4PagePaginationAutoPager[AttackSurfaceReportIssueListResponse]
- func (r *AttackSurfaceReportIssueService) Severity(ctx context.Context, params AttackSurfaceReportIssueSeverityParams, ...) (res *[]AttackSurfaceReportIssueSeverityResponse, err error)
- func (r *AttackSurfaceReportIssueService) Type(ctx context.Context, params AttackSurfaceReportIssueTypeParams, ...) (res *[]AttackSurfaceReportIssueTypeResponse, err error)
- type AttackSurfaceReportIssueSeverityParams
- type AttackSurfaceReportIssueSeverityResponse
- type AttackSurfaceReportIssueSeverityResponseEnvelope
- type AttackSurfaceReportIssueSeverityResponseEnvelopeErrors
- type AttackSurfaceReportIssueSeverityResponseEnvelopeErrorsSource
- type AttackSurfaceReportIssueSeverityResponseEnvelopeMessages
- type AttackSurfaceReportIssueSeverityResponseEnvelopeMessagesSource
- type AttackSurfaceReportIssueSeverityResponseEnvelopeSuccess
- type AttackSurfaceReportIssueTypeGetParams
- type AttackSurfaceReportIssueTypeParams
- type AttackSurfaceReportIssueTypeResponse
- type AttackSurfaceReportIssueTypeResponseEnvelope
- type AttackSurfaceReportIssueTypeResponseEnvelopeErrors
- type AttackSurfaceReportIssueTypeResponseEnvelopeErrorsSource
- type AttackSurfaceReportIssueTypeResponseEnvelopeMessages
- type AttackSurfaceReportIssueTypeResponseEnvelopeMessagesSource
- type AttackSurfaceReportIssueTypeResponseEnvelopeSuccess
- type AttackSurfaceReportIssueTypeService
- func (r *AttackSurfaceReportIssueTypeService) Get(ctx context.Context, query AttackSurfaceReportIssueTypeGetParams, ...) (res *pagination.SinglePage[string], err error)
- func (r *AttackSurfaceReportIssueTypeService) GetAutoPaging(ctx context.Context, query AttackSurfaceReportIssueTypeGetParams, ...) *pagination.SinglePageAutoPager[string]
- type AttackSurfaceReportService
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type CertificateCA
- type CertificateRequestType
- type CloudflareTunnel
- type CloudflareTunnelConnection
- type CloudflareTunnelStatus
- type CloudflareTunnelTunType
- type DNS
- type DNSListParams
- type DNSListParamsStartEndParams
- type DNSReverseRecord
- type DNSService
- func (r *DNSService) List(ctx context.Context, params DNSListParams, opts ...option.RequestOption) (res *pagination.V4PagePagination[DNS], err error)
- func (r *DNSService) ListAutoPaging(ctx context.Context, params DNSListParams, opts ...option.RequestOption) *pagination.V4PagePaginationAutoPager[DNS]
- type Domain
- type DomainAdditionalInformation
- type DomainApplication
- type DomainBulkGetParams
- type DomainBulkGetResponse
- type DomainBulkGetResponseAdditionalInformation
- type DomainBulkGetResponseApplication
- type DomainBulkGetResponseContentCategory
- type DomainBulkGetResponseEnvelope
- type DomainBulkGetResponseEnvelopeResultInfo
- type DomainBulkGetResponseEnvelopeSuccess
- type DomainBulkGetResponseInheritedContentCategory
- type DomainBulkGetResponseInheritedRiskType
- type DomainBulkGetResponseRiskType
- type DomainBulkService
- type DomainContentCategory
- type DomainGetParams
- type DomainGetResponseEnvelope
- type DomainGetResponseEnvelopeErrors
- type DomainGetResponseEnvelopeErrorsSource
- type DomainGetResponseEnvelopeMessages
- type DomainGetResponseEnvelopeMessagesSource
- type DomainGetResponseEnvelopeSuccess
- type DomainHistory
- type DomainHistoryCategorization
- type DomainHistoryCategorizationsCategory
- type DomainHistoryGetParams
- type DomainHistoryGetResponseEnvelope
- type DomainHistoryGetResponseEnvelopeResultInfo
- type DomainHistoryGetResponseEnvelopeSuccess
- type DomainHistoryService
- type DomainInheritedContentCategory
- type DomainInheritedRiskType
- type DomainResolvesToRef
- type DomainRiskType
- type DomainService
- type Error
- type ErrorData
- type ErrorDataSource
- type IP
- type IPBelongsToRef
- type IPBelongsToRefType
- type IPGetParams
- type IPGetResponseEnvelope
- type IPGetResponseEnvelopeResultInfo
- type IPGetResponseEnvelopeSuccess
- type IPList
- type IPListGetParams
- type IPListService
- func (r *IPListService) Get(ctx context.Context, query IPListGetParams, opts ...option.RequestOption) (res *pagination.SinglePage[IPList], err error)
- func (r *IPListService) GetAutoPaging(ctx context.Context, query IPListGetParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[IPList]
- type IPRiskType
- type IPService
- type IndicatorFeedDataParams
- type IndicatorFeedDownloadGetParams
- type IndicatorFeedDownloadGetResponse
- type IndicatorFeedDownloadGetResponseEnvelope
- type IndicatorFeedDownloadGetResponseEnvelopeErrors
- type IndicatorFeedDownloadGetResponseEnvelopeErrorsSource
- type IndicatorFeedDownloadGetResponseEnvelopeMessages
- type IndicatorFeedDownloadGetResponseEnvelopeMessagesSource
- type IndicatorFeedDownloadGetResponseEnvelopeSuccess
- type IndicatorFeedDownloadService
- type IndicatorFeedGetParams
- type IndicatorFeedGetResponse
- type IndicatorFeedGetResponseEnvelope
- type IndicatorFeedGetResponseEnvelopeErrors
- type IndicatorFeedGetResponseEnvelopeErrorsSource
- type IndicatorFeedGetResponseEnvelopeMessages
- type IndicatorFeedGetResponseEnvelopeMessagesSource
- type IndicatorFeedGetResponseEnvelopeSuccess
- type IndicatorFeedGetResponseLatestUploadStatus
- type IndicatorFeedListParams
- type IndicatorFeedListResponse
- type IndicatorFeedNewParams
- type IndicatorFeedNewResponse
- type IndicatorFeedNewResponseEnvelope
- type IndicatorFeedNewResponseEnvelopeErrors
- type IndicatorFeedNewResponseEnvelopeErrorsSource
- type IndicatorFeedNewResponseEnvelopeMessages
- type IndicatorFeedNewResponseEnvelopeMessagesSource
- type IndicatorFeedNewResponseEnvelopeSuccess
- type IndicatorFeedPermissionDeleteParams
- type IndicatorFeedPermissionDeleteResponse
- type IndicatorFeedPermissionDeleteResponseEnvelope
- type IndicatorFeedPermissionDeleteResponseEnvelopeErrors
- type IndicatorFeedPermissionDeleteResponseEnvelopeErrorsSource
- type IndicatorFeedPermissionDeleteResponseEnvelopeMessages
- type IndicatorFeedPermissionDeleteResponseEnvelopeMessagesSource
- type IndicatorFeedPermissionDeleteResponseEnvelopeSuccess
- type IndicatorFeedPermissionListParams
- type IndicatorFeedPermissionListResponse
- type IndicatorFeedPermissionListResponseEnvelope
- type IndicatorFeedPermissionListResponseEnvelopeErrors
- type IndicatorFeedPermissionListResponseEnvelopeErrorsSource
- type IndicatorFeedPermissionListResponseEnvelopeMessages
- type IndicatorFeedPermissionListResponseEnvelopeMessagesSource
- type IndicatorFeedPermissionListResponseEnvelopeSuccess
- type IndicatorFeedPermissionNewParams
- type IndicatorFeedPermissionNewResponse
- type IndicatorFeedPermissionNewResponseEnvelope
- type IndicatorFeedPermissionNewResponseEnvelopeErrors
- type IndicatorFeedPermissionNewResponseEnvelopeErrorsSource
- type IndicatorFeedPermissionNewResponseEnvelopeMessages
- type IndicatorFeedPermissionNewResponseEnvelopeMessagesSource
- type IndicatorFeedPermissionNewResponseEnvelopeSuccess
- type IndicatorFeedPermissionService
- func (r *IndicatorFeedPermissionService) Delete(ctx context.Context, params IndicatorFeedPermissionDeleteParams, ...) (res *IndicatorFeedPermissionDeleteResponse, err error)
- func (r *IndicatorFeedPermissionService) List(ctx context.Context, query IndicatorFeedPermissionListParams, ...) (res *[]IndicatorFeedPermissionListResponse, err error)
- func (r *IndicatorFeedPermissionService) New(ctx context.Context, params IndicatorFeedPermissionNewParams, ...) (res *IndicatorFeedPermissionNewResponse, err error)
- type IndicatorFeedService
- func (r *IndicatorFeedService) Data(ctx context.Context, feedID int64, query IndicatorFeedDataParams, ...) (res *string, err error)
- func (r *IndicatorFeedService) Get(ctx context.Context, feedID int64, query IndicatorFeedGetParams, ...) (res *IndicatorFeedGetResponse, err error)
- func (r *IndicatorFeedService) List(ctx context.Context, query IndicatorFeedListParams, ...) (res *pagination.SinglePage[IndicatorFeedListResponse], err error)
- func (r *IndicatorFeedService) ListAutoPaging(ctx context.Context, query IndicatorFeedListParams, ...) *pagination.SinglePageAutoPager[IndicatorFeedListResponse]
- func (r *IndicatorFeedService) New(ctx context.Context, params IndicatorFeedNewParams, ...) (res *IndicatorFeedNewResponse, err error)
- func (r *IndicatorFeedService) Update(ctx context.Context, feedID int64, params IndicatorFeedUpdateParams, ...) (res *IndicatorFeedUpdateResponse, err error)
- type IndicatorFeedSnapshotService
- type IndicatorFeedSnapshotUpdateParams
- type IndicatorFeedSnapshotUpdateResponse
- type IndicatorFeedSnapshotUpdateResponseEnvelope
- type IndicatorFeedSnapshotUpdateResponseEnvelopeErrors
- type IndicatorFeedSnapshotUpdateResponseEnvelopeErrorsSource
- type IndicatorFeedSnapshotUpdateResponseEnvelopeMessages
- type IndicatorFeedSnapshotUpdateResponseEnvelopeMessagesSource
- type IndicatorFeedSnapshotUpdateResponseEnvelopeSuccess
- type IndicatorFeedUpdateParams
- type IndicatorFeedUpdateResponse
- type IndicatorFeedUpdateResponseEnvelope
- type IndicatorFeedUpdateResponseEnvelopeErrors
- type IndicatorFeedUpdateResponseEnvelopeErrorsSource
- type IndicatorFeedUpdateResponseEnvelopeMessages
- type IndicatorFeedUpdateResponseEnvelopeMessagesSource
- type IndicatorFeedUpdateResponseEnvelopeSuccess
- type IntelService
- type IssueType
- type Member
- type MemberPoliciesAccess
- type MemberPoliciesPermissionGroup
- type MemberPoliciesPermissionGroupsMeta
- type MemberPoliciesResourceGroup
- type MemberPoliciesResourceGroupsMeta
- type MemberPoliciesResourceGroupsScope
- type MemberPoliciesResourceGroupsScopeObject
- type MemberPolicy
- type MemberStatus
- type MemberUser
- type MiscategorizationNewParams
- type MiscategorizationNewParamsIndicatorType
- type MiscategorizationNewResponse
- type MiscategorizationNewResponseError
- type MiscategorizationNewResponseErrorsSource
- type MiscategorizationNewResponseMessage
- type MiscategorizationNewResponseMessagesSource
- type MiscategorizationNewResponseSuccess
- type MiscategorizationService
- 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 SeverityQueryParam
- type Sinkhole
- type SinkholeListParams
- type SinkholeService
- func (r *SinkholeService) List(ctx context.Context, query SinkholeListParams, opts ...option.RequestOption) (res *pagination.SinglePage[Sinkhole], err error)
- func (r *SinkholeService) ListAutoPaging(ctx context.Context, query SinkholeListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Sinkhole]
- 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 TokenStatus
- type TokenValue
- type WhoisGetParams
- type WhoisGetResponse
- type WhoisGetResponseEnvelope
- type WhoisGetResponseEnvelopeErrors
- type WhoisGetResponseEnvelopeErrorsSource
- type WhoisGetResponseEnvelopeMessages
- type WhoisGetResponseEnvelopeMessagesSource
- type WhoisGetResponseEnvelopeSuccess
- type WhoisService
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 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 ASNGetParams ¶
type ASNGetResponseEnvelope ¶
type ASNGetResponseEnvelope struct {
Errors []ASNGetResponseEnvelopeErrors `json:"errors,required"`
Messages []ASNGetResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success ASNGetResponseEnvelopeSuccess `json:"success,required"`
Result shared.ASN `json:"result"`
JSON asnGetResponseEnvelopeJSON `json:"-"`
}
func (*ASNGetResponseEnvelope) UnmarshalJSON ¶
func (r *ASNGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ASNGetResponseEnvelopeErrors ¶ added in v4.3.0
type ASNGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ASNGetResponseEnvelopeErrorsSource `json:"source"`
JSON asnGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ASNGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *ASNGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ASNGetResponseEnvelopeErrorsSource ¶ added in v4.3.0
type ASNGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON asnGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ASNGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *ASNGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ASNGetResponseEnvelopeMessages ¶ added in v4.3.0
type ASNGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ASNGetResponseEnvelopeMessagesSource `json:"source"`
JSON asnGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ASNGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *ASNGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ASNGetResponseEnvelopeMessagesSource ¶ added in v4.3.0
type ASNGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON asnGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ASNGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
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 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 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 ¶
func (r *ASNSubnetService) Get(ctx context.Context, asn shared.ASNParam, query ASNSubnetGetParams, opts ...option.RequestOption) (res *ASNSubnetGetResponse, err error)
Get ASN Subnets.
type AttackSurfaceReportIssueClassParams ¶
type AttackSurfaceReportIssueClassParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,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 ¶
func (r AttackSurfaceReportIssueClassParams) URLQuery() (v url.Values)
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,required"`
Messages []AttackSurfaceReportIssueClassResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success AttackSurfaceReportIssueClassResponseEnvelopeSuccess `json:"success,required"`
Result []AttackSurfaceReportIssueClassResponse `json:"result"`
JSON attackSurfaceReportIssueClassResponseEnvelopeJSON `json:"-"`
}
func (*AttackSurfaceReportIssueClassResponseEnvelope) UnmarshalJSON ¶
func (r *AttackSurfaceReportIssueClassResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type AttackSurfaceReportIssueClassResponseEnvelopeErrors ¶ added in v4.3.0
type AttackSurfaceReportIssueClassResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AttackSurfaceReportIssueClassResponseEnvelopeErrorsSource `json:"source"`
JSON attackSurfaceReportIssueClassResponseEnvelopeErrorsJSON `json:"-"`
}
func (*AttackSurfaceReportIssueClassResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *AttackSurfaceReportIssueClassResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type AttackSurfaceReportIssueClassResponseEnvelopeErrorsSource ¶ added in v4.3.0
type AttackSurfaceReportIssueClassResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON attackSurfaceReportIssueClassResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*AttackSurfaceReportIssueClassResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *AttackSurfaceReportIssueClassResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type AttackSurfaceReportIssueClassResponseEnvelopeMessages ¶ added in v4.3.0
type AttackSurfaceReportIssueClassResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AttackSurfaceReportIssueClassResponseEnvelopeMessagesSource `json:"source"`
JSON attackSurfaceReportIssueClassResponseEnvelopeMessagesJSON `json:"-"`
}
func (*AttackSurfaceReportIssueClassResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *AttackSurfaceReportIssueClassResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type AttackSurfaceReportIssueClassResponseEnvelopeMessagesSource ¶ added in v4.3.0
type AttackSurfaceReportIssueClassResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON attackSurfaceReportIssueClassResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*AttackSurfaceReportIssueClassResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *AttackSurfaceReportIssueClassResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type AttackSurfaceReportIssueClassResponseEnvelopeSuccess ¶
type AttackSurfaceReportIssueClassResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
AttackSurfaceReportIssueClassResponseEnvelopeSuccessTrue AttackSurfaceReportIssueClassResponseEnvelopeSuccess = true
)
func (AttackSurfaceReportIssueClassResponseEnvelopeSuccess) IsKnown ¶
func (r AttackSurfaceReportIssueClassResponseEnvelopeSuccess) IsKnown() bool
type AttackSurfaceReportIssueDismissParams ¶
type AttackSurfaceReportIssueDismissParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,required"`
Dismiss param.Field[bool] `json:"dismiss"`
}
func (AttackSurfaceReportIssueDismissParams) MarshalJSON ¶
func (r AttackSurfaceReportIssueDismissParams) MarshalJSON() (data []byte, err error)
type AttackSurfaceReportIssueDismissResponse ¶
type AttackSurfaceReportIssueDismissResponse struct {
Errors []AttackSurfaceReportIssueDismissResponseError `json:"errors,required"`
Messages []AttackSurfaceReportIssueDismissResponseMessage `json:"messages,required"`
// Whether the API call was successful.
Success AttackSurfaceReportIssueDismissResponseSuccess `json:"success,required"`
JSON attackSurfaceReportIssueDismissResponseJSON `json:"-"`
}
func (*AttackSurfaceReportIssueDismissResponse) UnmarshalJSON ¶
func (r *AttackSurfaceReportIssueDismissResponse) UnmarshalJSON(data []byte) (err error)
type AttackSurfaceReportIssueDismissResponseError ¶ added in v4.3.0
type AttackSurfaceReportIssueDismissResponseError struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AttackSurfaceReportIssueDismissResponseErrorsSource `json:"source"`
JSON attackSurfaceReportIssueDismissResponseErrorJSON `json:"-"`
}
func (*AttackSurfaceReportIssueDismissResponseError) UnmarshalJSON ¶ added in v4.3.0
func (r *AttackSurfaceReportIssueDismissResponseError) UnmarshalJSON(data []byte) (err error)
type AttackSurfaceReportIssueDismissResponseErrorsSource ¶ added in v4.3.0
type AttackSurfaceReportIssueDismissResponseErrorsSource struct {
Pointer string `json:"pointer"`
JSON attackSurfaceReportIssueDismissResponseErrorsSourceJSON `json:"-"`
}
func (*AttackSurfaceReportIssueDismissResponseErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *AttackSurfaceReportIssueDismissResponseErrorsSource) UnmarshalJSON(data []byte) (err error)
type AttackSurfaceReportIssueDismissResponseMessage ¶ added in v4.3.0
type AttackSurfaceReportIssueDismissResponseMessage struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AttackSurfaceReportIssueDismissResponseMessagesSource `json:"source"`
JSON attackSurfaceReportIssueDismissResponseMessageJSON `json:"-"`
}
func (*AttackSurfaceReportIssueDismissResponseMessage) UnmarshalJSON ¶ added in v4.3.0
func (r *AttackSurfaceReportIssueDismissResponseMessage) UnmarshalJSON(data []byte) (err error)
type AttackSurfaceReportIssueDismissResponseMessagesSource ¶ added in v4.3.0
type AttackSurfaceReportIssueDismissResponseMessagesSource struct {
Pointer string `json:"pointer"`
JSON attackSurfaceReportIssueDismissResponseMessagesSourceJSON `json:"-"`
}
func (*AttackSurfaceReportIssueDismissResponseMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *AttackSurfaceReportIssueDismissResponseMessagesSource) UnmarshalJSON(data []byte) (err error)
type AttackSurfaceReportIssueDismissResponseSuccess ¶
type AttackSurfaceReportIssueDismissResponseSuccess bool
Whether the API call was successful.
const (
AttackSurfaceReportIssueDismissResponseSuccessTrue AttackSurfaceReportIssueDismissResponseSuccess = true
)
func (AttackSurfaceReportIssueDismissResponseSuccess) IsKnown ¶
func (r AttackSurfaceReportIssueDismissResponseSuccess) IsKnown() bool
type AttackSurfaceReportIssueListParams ¶
type AttackSurfaceReportIssueListParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,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"`
// Current page within paginated list of results
Page param.Field[int64] `query:"page"`
// 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 ¶
func (r AttackSurfaceReportIssueListParams) URLQuery() (v url.Values)
URLQuery serializes AttackSurfaceReportIssueListParams's query parameters as `url.Values`.
type AttackSurfaceReportIssueListResponse ¶
type AttackSurfaceReportIssueListResponse struct {
// Total number of results
Count int64 `json:"count"`
Issues []AttackSurfaceReportIssueListResponseIssue `json:"issues"`
// Current page within paginated list of results
Page int64 `json:"page"`
// 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"`
IssueClass string `json:"issue_class"`
IssueType IssueType `json:"issue_type"`
Payload interface{} `json:"payload"`
ResolveLink string `json:"resolve_link"`
ResolveText string `json:"resolve_text"`
Severity AttackSurfaceReportIssueListResponseIssuesSeverity `json:"severity"`
Since time.Time `json:"since" format:"date-time"`
Subject string `json:"subject"`
Timestamp time.Time `json:"timestamp" format:"date-time"`
JSON attackSurfaceReportIssueListResponseIssueJSON `json:"-"`
}
func (*AttackSurfaceReportIssueListResponseIssue) UnmarshalJSON ¶
func (r *AttackSurfaceReportIssueListResponseIssue) UnmarshalJSON(data []byte) (err error)
type AttackSurfaceReportIssueListResponseIssuesSeverity ¶
type AttackSurfaceReportIssueListResponseIssuesSeverity string
const ( AttackSurfaceReportIssueListResponseIssuesSeverityLow AttackSurfaceReportIssueListResponseIssuesSeverity = "Low" AttackSurfaceReportIssueListResponseIssuesSeverityModerate AttackSurfaceReportIssueListResponseIssuesSeverity = "Moderate" AttackSurfaceReportIssueListResponseIssuesSeverityCritical AttackSurfaceReportIssueListResponseIssuesSeverity = "Critical" )
func (AttackSurfaceReportIssueListResponseIssuesSeverity) IsKnown ¶
func (r AttackSurfaceReportIssueListResponseIssuesSeverity) IsKnown() bool
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 ¶
func (r *AttackSurfaceReportIssueService) Class(ctx context.Context, params AttackSurfaceReportIssueClassParams, opts ...option.RequestOption) (res *[]AttackSurfaceReportIssueClassResponse, err error)
Get Security Center Issue Counts by Class
func (*AttackSurfaceReportIssueService) Dismiss ¶
func (r *AttackSurfaceReportIssueService) Dismiss(ctx context.Context, issueID string, params AttackSurfaceReportIssueDismissParams, opts ...option.RequestOption) (res *AttackSurfaceReportIssueDismissResponse, err error)
Archive Security Center Insight
func (*AttackSurfaceReportIssueService) List ¶
func (r *AttackSurfaceReportIssueService) List(ctx context.Context, params AttackSurfaceReportIssueListParams, opts ...option.RequestOption) (res *pagination.V4PagePagination[AttackSurfaceReportIssueListResponse], err error)
Get Security Center Issues
func (*AttackSurfaceReportIssueService) ListAutoPaging ¶
func (r *AttackSurfaceReportIssueService) ListAutoPaging(ctx context.Context, params AttackSurfaceReportIssueListParams, opts ...option.RequestOption) *pagination.V4PagePaginationAutoPager[AttackSurfaceReportIssueListResponse]
Get Security Center Issues
func (*AttackSurfaceReportIssueService) Severity ¶
func (r *AttackSurfaceReportIssueService) Severity(ctx context.Context, params AttackSurfaceReportIssueSeverityParams, opts ...option.RequestOption) (res *[]AttackSurfaceReportIssueSeverityResponse, err error)
Get Security Center Issue Counts by Severity
func (*AttackSurfaceReportIssueService) Type ¶
func (r *AttackSurfaceReportIssueService) Type(ctx context.Context, params AttackSurfaceReportIssueTypeParams, opts ...option.RequestOption) (res *[]AttackSurfaceReportIssueTypeResponse, err error)
Get Security Center Issue Counts by Type
type AttackSurfaceReportIssueSeverityParams ¶
type AttackSurfaceReportIssueSeverityParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,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 ¶
func (r AttackSurfaceReportIssueSeverityParams) URLQuery() (v url.Values)
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,required"`
Messages []AttackSurfaceReportIssueSeverityResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success AttackSurfaceReportIssueSeverityResponseEnvelopeSuccess `json:"success,required"`
Result []AttackSurfaceReportIssueSeverityResponse `json:"result"`
JSON attackSurfaceReportIssueSeverityResponseEnvelopeJSON `json:"-"`
}
func (*AttackSurfaceReportIssueSeverityResponseEnvelope) UnmarshalJSON ¶
func (r *AttackSurfaceReportIssueSeverityResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type AttackSurfaceReportIssueSeverityResponseEnvelopeErrors ¶ added in v4.3.0
type AttackSurfaceReportIssueSeverityResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AttackSurfaceReportIssueSeverityResponseEnvelopeErrorsSource `json:"source"`
JSON attackSurfaceReportIssueSeverityResponseEnvelopeErrorsJSON `json:"-"`
}
func (*AttackSurfaceReportIssueSeverityResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *AttackSurfaceReportIssueSeverityResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type AttackSurfaceReportIssueSeverityResponseEnvelopeErrorsSource ¶ added in v4.3.0
type AttackSurfaceReportIssueSeverityResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON attackSurfaceReportIssueSeverityResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*AttackSurfaceReportIssueSeverityResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *AttackSurfaceReportIssueSeverityResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type AttackSurfaceReportIssueSeverityResponseEnvelopeMessages ¶ added in v4.3.0
type AttackSurfaceReportIssueSeverityResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AttackSurfaceReportIssueSeverityResponseEnvelopeMessagesSource `json:"source"`
JSON attackSurfaceReportIssueSeverityResponseEnvelopeMessagesJSON `json:"-"`
}
func (*AttackSurfaceReportIssueSeverityResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *AttackSurfaceReportIssueSeverityResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type AttackSurfaceReportIssueSeverityResponseEnvelopeMessagesSource ¶ added in v4.3.0
type AttackSurfaceReportIssueSeverityResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON attackSurfaceReportIssueSeverityResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*AttackSurfaceReportIssueSeverityResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *AttackSurfaceReportIssueSeverityResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type AttackSurfaceReportIssueSeverityResponseEnvelopeSuccess ¶
type AttackSurfaceReportIssueSeverityResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
AttackSurfaceReportIssueSeverityResponseEnvelopeSuccessTrue AttackSurfaceReportIssueSeverityResponseEnvelopeSuccess = true
)
func (AttackSurfaceReportIssueSeverityResponseEnvelopeSuccess) IsKnown ¶
func (r AttackSurfaceReportIssueSeverityResponseEnvelopeSuccess) IsKnown() bool
type AttackSurfaceReportIssueTypeParams ¶
type AttackSurfaceReportIssueTypeParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,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 ¶
func (r AttackSurfaceReportIssueTypeParams) URLQuery() (v url.Values)
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,required"`
Messages []AttackSurfaceReportIssueTypeResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success AttackSurfaceReportIssueTypeResponseEnvelopeSuccess `json:"success,required"`
Result []AttackSurfaceReportIssueTypeResponse `json:"result"`
JSON attackSurfaceReportIssueTypeResponseEnvelopeJSON `json:"-"`
}
func (*AttackSurfaceReportIssueTypeResponseEnvelope) UnmarshalJSON ¶
func (r *AttackSurfaceReportIssueTypeResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type AttackSurfaceReportIssueTypeResponseEnvelopeErrors ¶ added in v4.3.0
type AttackSurfaceReportIssueTypeResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AttackSurfaceReportIssueTypeResponseEnvelopeErrorsSource `json:"source"`
JSON attackSurfaceReportIssueTypeResponseEnvelopeErrorsJSON `json:"-"`
}
func (*AttackSurfaceReportIssueTypeResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *AttackSurfaceReportIssueTypeResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type AttackSurfaceReportIssueTypeResponseEnvelopeErrorsSource ¶ added in v4.3.0
type AttackSurfaceReportIssueTypeResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON attackSurfaceReportIssueTypeResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*AttackSurfaceReportIssueTypeResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *AttackSurfaceReportIssueTypeResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type AttackSurfaceReportIssueTypeResponseEnvelopeMessages ¶ added in v4.3.0
type AttackSurfaceReportIssueTypeResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source AttackSurfaceReportIssueTypeResponseEnvelopeMessagesSource `json:"source"`
JSON attackSurfaceReportIssueTypeResponseEnvelopeMessagesJSON `json:"-"`
}
func (*AttackSurfaceReportIssueTypeResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *AttackSurfaceReportIssueTypeResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type AttackSurfaceReportIssueTypeResponseEnvelopeMessagesSource ¶ added in v4.3.0
type AttackSurfaceReportIssueTypeResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON attackSurfaceReportIssueTypeResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*AttackSurfaceReportIssueTypeResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *AttackSurfaceReportIssueTypeResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type AttackSurfaceReportIssueTypeResponseEnvelopeSuccess ¶
type AttackSurfaceReportIssueTypeResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
AttackSurfaceReportIssueTypeResponseEnvelopeSuccessTrue AttackSurfaceReportIssueTypeResponseEnvelopeSuccess = true
)
func (AttackSurfaceReportIssueTypeResponseEnvelopeSuccess) IsKnown ¶
func (r AttackSurfaceReportIssueTypeResponseEnvelopeSuccess) IsKnown() bool
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 ¶
func (r *AttackSurfaceReportIssueTypeService) Get(ctx context.Context, query AttackSurfaceReportIssueTypeGetParams, opts ...option.RequestOption) (res *pagination.SinglePage[string], err error)
Get Security Center Issues Types
func (*AttackSurfaceReportIssueTypeService) GetAutoPaging ¶ added in v4.1.0
func (r *AttackSurfaceReportIssueTypeService) GetAutoPaging(ctx context.Context, query AttackSurfaceReportIssueTypeGetParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[string]
Get Security Center Issues Types
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 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 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 ¶
type DNSListParams ¶
type DNSListParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,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 ¶
func (r *DNSService) ListAutoPaging(ctx context.Context, params DNSListParams, opts ...option.RequestOption) *pagination.V4PagePaginationAutoPager[DNS]
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 ¶
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,required"`
// Accepts multiple values like `?domain=cloudflare.com&domain=example.com`.
Domain param.Field[[]string] `query:"domain"`
}
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,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result []DomainBulkGetResponse `json:"result,required,nullable"`
// Whether the API call was successful.
Success DomainBulkGetResponseEnvelopeSuccess `json:"success,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 ¶
func (r DomainBulkGetResponseEnvelopeSuccess) IsKnown() bool
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 ¶
func (r *DomainBulkService) Get(ctx context.Context, params DomainBulkGetParams, opts ...option.RequestOption) (res *[]DomainBulkGetResponse, err error)
Same as summary.
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,required"`
Domain param.Field[string] `query:"domain"`
}
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,required"`
Messages []DomainGetResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success DomainGetResponseEnvelopeSuccess `json:"success,required"`
Result Domain `json:"result"`
JSON domainGetResponseEnvelopeJSON `json:"-"`
}
func (*DomainGetResponseEnvelope) UnmarshalJSON ¶
func (r *DomainGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DomainGetResponseEnvelopeErrors ¶ added in v4.3.0
type DomainGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source DomainGetResponseEnvelopeErrorsSource `json:"source"`
JSON domainGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*DomainGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *DomainGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type DomainGetResponseEnvelopeErrorsSource ¶ added in v4.3.0
type DomainGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON domainGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*DomainGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *DomainGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type DomainGetResponseEnvelopeMessages ¶ added in v4.3.0
type DomainGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source DomainGetResponseEnvelopeMessagesSource `json:"source"`
JSON domainGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*DomainGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *DomainGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type DomainGetResponseEnvelopeMessagesSource ¶ added in v4.3.0
type DomainGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON domainGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*DomainGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
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 ¶
func (r DomainGetResponseEnvelopeSuccess) IsKnown() bool
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 ¶ added in v4.4.0
type DomainHistoryCategorizationsCategory struct {
ID int64 `json:"id"`
Name string `json:"name"`
JSON domainHistoryCategorizationsCategoryJSON `json:"-"`
}
func (*DomainHistoryCategorizationsCategory) UnmarshalJSON ¶ added in v4.4.0
func (r *DomainHistoryCategorizationsCategory) UnmarshalJSON(data []byte) (err error)
type DomainHistoryGetParams ¶
type DomainHistoryGetParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,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,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result []DomainHistory `json:"result,required,nullable"`
// Whether the API call was successful.
Success DomainHistoryGetResponseEnvelopeSuccess `json:"success,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 ¶
func (r DomainHistoryGetResponseEnvelopeSuccess) IsKnown() bool
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 ¶
func (r *DomainHistoryService) Get(ctx context.Context, params DomainHistoryGetParams, opts ...option.RequestOption) (res *[]DomainHistory, err error)
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 ErrorDataSource ¶ added in v4.2.0
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 ¶
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,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,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result []IP `json:"result,required,nullable"`
// Whether the API call was successful.
Success IPGetResponseEnvelopeSuccess `json:"success,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 IPList ¶
type IPList struct {
ID int64 `json:"id"`
Description string `json:"description"`
Name string `json:"name"`
JSON ipListJSON `json:"-"`
}
func (*IPList) UnmarshalJSON ¶
type IPListGetParams ¶
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.
func (*IPListService) Get ¶
func (r *IPListService) Get(ctx context.Context, query IPListGetParams, opts ...option.RequestOption) (res *pagination.SinglePage[IPList], err error)
Get IP Lists.
func (*IPListService) GetAutoPaging ¶ added in v4.1.0
func (r *IPListService) GetAutoPaging(ctx context.Context, query IPListGetParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[IPList]
Get IP Lists.
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 IndicatorFeedDownloadGetResponse ¶
type IndicatorFeedDownloadGetResponse struct {
// Feed id
FileID int64 `json:"file_id"`
// Name of the file unified in our system
Filename string `json:"filename"`
// Current status of upload, should be unified
Status string `json:"status"`
JSON indicatorFeedDownloadGetResponseJSON `json:"-"`
}
func (*IndicatorFeedDownloadGetResponse) UnmarshalJSON ¶
func (r *IndicatorFeedDownloadGetResponse) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedDownloadGetResponseEnvelope ¶
type IndicatorFeedDownloadGetResponseEnvelope struct {
Errors []IndicatorFeedDownloadGetResponseEnvelopeErrors `json:"errors,required"`
Messages []IndicatorFeedDownloadGetResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success IndicatorFeedDownloadGetResponseEnvelopeSuccess `json:"success,required"`
Result IndicatorFeedDownloadGetResponse `json:"result"`
JSON indicatorFeedDownloadGetResponseEnvelopeJSON `json:"-"`
}
func (*IndicatorFeedDownloadGetResponseEnvelope) UnmarshalJSON ¶
func (r *IndicatorFeedDownloadGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedDownloadGetResponseEnvelopeErrors ¶ added in v4.3.0
type IndicatorFeedDownloadGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source IndicatorFeedDownloadGetResponseEnvelopeErrorsSource `json:"source"`
JSON indicatorFeedDownloadGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*IndicatorFeedDownloadGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedDownloadGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedDownloadGetResponseEnvelopeErrorsSource ¶ added in v4.3.0
type IndicatorFeedDownloadGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON indicatorFeedDownloadGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*IndicatorFeedDownloadGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedDownloadGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedDownloadGetResponseEnvelopeMessages ¶ added in v4.3.0
type IndicatorFeedDownloadGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source IndicatorFeedDownloadGetResponseEnvelopeMessagesSource `json:"source"`
JSON indicatorFeedDownloadGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*IndicatorFeedDownloadGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedDownloadGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedDownloadGetResponseEnvelopeMessagesSource ¶ added in v4.3.0
type IndicatorFeedDownloadGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON indicatorFeedDownloadGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*IndicatorFeedDownloadGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedDownloadGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedDownloadGetResponseEnvelopeSuccess ¶
type IndicatorFeedDownloadGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
IndicatorFeedDownloadGetResponseEnvelopeSuccessTrue IndicatorFeedDownloadGetResponseEnvelopeSuccess = true
)
func (IndicatorFeedDownloadGetResponseEnvelopeSuccess) IsKnown ¶
func (r IndicatorFeedDownloadGetResponseEnvelopeSuccess) IsKnown() bool
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.
func (*IndicatorFeedDownloadService) Get ¶
func (r *IndicatorFeedDownloadService) Get(ctx context.Context, feedID int64, query IndicatorFeedDownloadGetParams, opts ...option.RequestOption) (res *IndicatorFeedDownloadGetResponse, err error)
Download indicator feed data
type IndicatorFeedGetParams ¶
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"`
// 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 string `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,required"`
Messages []IndicatorFeedGetResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success IndicatorFeedGetResponseEnvelopeSuccess `json:"success,required"`
Result IndicatorFeedGetResponse `json:"result"`
JSON indicatorFeedGetResponseEnvelopeJSON `json:"-"`
}
func (*IndicatorFeedGetResponseEnvelope) UnmarshalJSON ¶
func (r *IndicatorFeedGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedGetResponseEnvelopeErrors ¶ added in v4.3.0
type IndicatorFeedGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source IndicatorFeedGetResponseEnvelopeErrorsSource `json:"source"`
JSON indicatorFeedGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*IndicatorFeedGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedGetResponseEnvelopeErrorsSource ¶ added in v4.3.0
type IndicatorFeedGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON indicatorFeedGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*IndicatorFeedGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedGetResponseEnvelopeMessages ¶ added in v4.3.0
type IndicatorFeedGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source IndicatorFeedGetResponseEnvelopeMessagesSource `json:"source"`
JSON indicatorFeedGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*IndicatorFeedGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedGetResponseEnvelopeMessagesSource ¶ added in v4.3.0
type IndicatorFeedGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON indicatorFeedGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*IndicatorFeedGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
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 ¶
func (r IndicatorFeedGetResponseEnvelopeSuccess) IsKnown() bool
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 ¶
func (r IndicatorFeedGetResponseLatestUploadStatus) IsKnown() bool
type IndicatorFeedListParams ¶
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,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,required"`
Messages []IndicatorFeedNewResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success IndicatorFeedNewResponseEnvelopeSuccess `json:"success,required"`
Result IndicatorFeedNewResponse `json:"result"`
JSON indicatorFeedNewResponseEnvelopeJSON `json:"-"`
}
func (*IndicatorFeedNewResponseEnvelope) UnmarshalJSON ¶
func (r *IndicatorFeedNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedNewResponseEnvelopeErrors ¶ added in v4.3.0
type IndicatorFeedNewResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source IndicatorFeedNewResponseEnvelopeErrorsSource `json:"source"`
JSON indicatorFeedNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*IndicatorFeedNewResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedNewResponseEnvelopeErrorsSource ¶ added in v4.3.0
type IndicatorFeedNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON indicatorFeedNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*IndicatorFeedNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedNewResponseEnvelopeMessages ¶ added in v4.3.0
type IndicatorFeedNewResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source IndicatorFeedNewResponseEnvelopeMessagesSource `json:"source"`
JSON indicatorFeedNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*IndicatorFeedNewResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedNewResponseEnvelopeMessagesSource ¶ added in v4.3.0
type IndicatorFeedNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON indicatorFeedNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*IndicatorFeedNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
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 ¶
func (r IndicatorFeedNewResponseEnvelopeSuccess) IsKnown() bool
type IndicatorFeedPermissionDeleteParams ¶
type IndicatorFeedPermissionDeleteParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,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,required"`
Messages []IndicatorFeedPermissionDeleteResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success IndicatorFeedPermissionDeleteResponseEnvelopeSuccess `json:"success,required"`
Result IndicatorFeedPermissionDeleteResponse `json:"result"`
JSON indicatorFeedPermissionDeleteResponseEnvelopeJSON `json:"-"`
}
func (*IndicatorFeedPermissionDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *IndicatorFeedPermissionDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedPermissionDeleteResponseEnvelopeErrors ¶ added in v4.3.0
type IndicatorFeedPermissionDeleteResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source IndicatorFeedPermissionDeleteResponseEnvelopeErrorsSource `json:"source"`
JSON indicatorFeedPermissionDeleteResponseEnvelopeErrorsJSON `json:"-"`
}
func (*IndicatorFeedPermissionDeleteResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedPermissionDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedPermissionDeleteResponseEnvelopeErrorsSource ¶ added in v4.3.0
type IndicatorFeedPermissionDeleteResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON indicatorFeedPermissionDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*IndicatorFeedPermissionDeleteResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedPermissionDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedPermissionDeleteResponseEnvelopeMessages ¶ added in v4.3.0
type IndicatorFeedPermissionDeleteResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source IndicatorFeedPermissionDeleteResponseEnvelopeMessagesSource `json:"source"`
JSON indicatorFeedPermissionDeleteResponseEnvelopeMessagesJSON `json:"-"`
}
func (*IndicatorFeedPermissionDeleteResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedPermissionDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedPermissionDeleteResponseEnvelopeMessagesSource ¶ added in v4.3.0
type IndicatorFeedPermissionDeleteResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON indicatorFeedPermissionDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*IndicatorFeedPermissionDeleteResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedPermissionDeleteResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedPermissionDeleteResponseEnvelopeSuccess ¶
type IndicatorFeedPermissionDeleteResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
IndicatorFeedPermissionDeleteResponseEnvelopeSuccessTrue IndicatorFeedPermissionDeleteResponseEnvelopeSuccess = true
)
func (IndicatorFeedPermissionDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r IndicatorFeedPermissionDeleteResponseEnvelopeSuccess) IsKnown() bool
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,required"`
Messages []IndicatorFeedPermissionListResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success IndicatorFeedPermissionListResponseEnvelopeSuccess `json:"success,required"`
Result []IndicatorFeedPermissionListResponse `json:"result"`
JSON indicatorFeedPermissionListResponseEnvelopeJSON `json:"-"`
}
func (*IndicatorFeedPermissionListResponseEnvelope) UnmarshalJSON ¶
func (r *IndicatorFeedPermissionListResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedPermissionListResponseEnvelopeErrors ¶ added in v4.3.0
type IndicatorFeedPermissionListResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source IndicatorFeedPermissionListResponseEnvelopeErrorsSource `json:"source"`
JSON indicatorFeedPermissionListResponseEnvelopeErrorsJSON `json:"-"`
}
func (*IndicatorFeedPermissionListResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedPermissionListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedPermissionListResponseEnvelopeErrorsSource ¶ added in v4.3.0
type IndicatorFeedPermissionListResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON indicatorFeedPermissionListResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*IndicatorFeedPermissionListResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedPermissionListResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedPermissionListResponseEnvelopeMessages ¶ added in v4.3.0
type IndicatorFeedPermissionListResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source IndicatorFeedPermissionListResponseEnvelopeMessagesSource `json:"source"`
JSON indicatorFeedPermissionListResponseEnvelopeMessagesJSON `json:"-"`
}
func (*IndicatorFeedPermissionListResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedPermissionListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedPermissionListResponseEnvelopeMessagesSource ¶ added in v4.3.0
type IndicatorFeedPermissionListResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON indicatorFeedPermissionListResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*IndicatorFeedPermissionListResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedPermissionListResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedPermissionListResponseEnvelopeSuccess ¶
type IndicatorFeedPermissionListResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
IndicatorFeedPermissionListResponseEnvelopeSuccessTrue IndicatorFeedPermissionListResponseEnvelopeSuccess = true
)
func (IndicatorFeedPermissionListResponseEnvelopeSuccess) IsKnown ¶
func (r IndicatorFeedPermissionListResponseEnvelopeSuccess) IsKnown() bool
type IndicatorFeedPermissionNewParams ¶
type IndicatorFeedPermissionNewParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,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,required"`
Messages []IndicatorFeedPermissionNewResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success IndicatorFeedPermissionNewResponseEnvelopeSuccess `json:"success,required"`
Result IndicatorFeedPermissionNewResponse `json:"result"`
JSON indicatorFeedPermissionNewResponseEnvelopeJSON `json:"-"`
}
func (*IndicatorFeedPermissionNewResponseEnvelope) UnmarshalJSON ¶
func (r *IndicatorFeedPermissionNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedPermissionNewResponseEnvelopeErrors ¶ added in v4.3.0
type IndicatorFeedPermissionNewResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source IndicatorFeedPermissionNewResponseEnvelopeErrorsSource `json:"source"`
JSON indicatorFeedPermissionNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*IndicatorFeedPermissionNewResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedPermissionNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedPermissionNewResponseEnvelopeErrorsSource ¶ added in v4.3.0
type IndicatorFeedPermissionNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON indicatorFeedPermissionNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*IndicatorFeedPermissionNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedPermissionNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedPermissionNewResponseEnvelopeMessages ¶ added in v4.3.0
type IndicatorFeedPermissionNewResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source IndicatorFeedPermissionNewResponseEnvelopeMessagesSource `json:"source"`
JSON indicatorFeedPermissionNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*IndicatorFeedPermissionNewResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedPermissionNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedPermissionNewResponseEnvelopeMessagesSource ¶ added in v4.3.0
type IndicatorFeedPermissionNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON indicatorFeedPermissionNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*IndicatorFeedPermissionNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedPermissionNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedPermissionNewResponseEnvelopeSuccess ¶
type IndicatorFeedPermissionNewResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
IndicatorFeedPermissionNewResponseEnvelopeSuccessTrue IndicatorFeedPermissionNewResponseEnvelopeSuccess = true
)
func (IndicatorFeedPermissionNewResponseEnvelopeSuccess) IsKnown ¶
func (r IndicatorFeedPermissionNewResponseEnvelopeSuccess) IsKnown() bool
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 ¶
func (r *IndicatorFeedPermissionService) Delete(ctx context.Context, params IndicatorFeedPermissionDeleteParams, opts ...option.RequestOption) (res *IndicatorFeedPermissionDeleteResponse, err error)
Revoke permission to indicator feed
func (*IndicatorFeedPermissionService) List ¶
func (r *IndicatorFeedPermissionService) List(ctx context.Context, query IndicatorFeedPermissionListParams, opts ...option.RequestOption) (res *[]IndicatorFeedPermissionListResponse, err error)
List indicator feed permissions
func (*IndicatorFeedPermissionService) New ¶
func (r *IndicatorFeedPermissionService) New(ctx context.Context, params IndicatorFeedPermissionNewParams, opts ...option.RequestOption) (res *IndicatorFeedPermissionNewResponse, err error)
Grant permission to indicator feed
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)
Get indicator feed data
func (*IndicatorFeedService) Get ¶
func (r *IndicatorFeedService) Get(ctx context.Context, feedID int64, query IndicatorFeedGetParams, opts ...option.RequestOption) (res *IndicatorFeedGetResponse, err error)
Get indicator feed metadata
func (*IndicatorFeedService) List ¶
func (r *IndicatorFeedService) List(ctx context.Context, query IndicatorFeedListParams, opts ...option.RequestOption) (res *pagination.SinglePage[IndicatorFeedListResponse], err error)
Get indicator feeds owned by this account
func (*IndicatorFeedService) ListAutoPaging ¶
func (r *IndicatorFeedService) ListAutoPaging(ctx context.Context, query IndicatorFeedListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[IndicatorFeedListResponse]
Get indicator feeds owned by this account
func (*IndicatorFeedService) New ¶
func (r *IndicatorFeedService) New(ctx context.Context, params IndicatorFeedNewParams, opts ...option.RequestOption) (res *IndicatorFeedNewResponse, err error)
Create new indicator feed
func (*IndicatorFeedService) Update ¶
func (r *IndicatorFeedService) Update(ctx context.Context, feedID int64, params IndicatorFeedUpdateParams, opts ...option.RequestOption) (res *IndicatorFeedUpdateResponse, err error)
Update indicator feed metadata
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 ¶
func (r *IndicatorFeedSnapshotService) Update(ctx context.Context, feedID int64, params IndicatorFeedSnapshotUpdateParams, opts ...option.RequestOption) (res *IndicatorFeedSnapshotUpdateResponse, err error)
Update indicator feed data
type IndicatorFeedSnapshotUpdateParams ¶
type IndicatorFeedSnapshotUpdateParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
// The file to upload
Source param.Field[string] `json:"source"`
}
func (IndicatorFeedSnapshotUpdateParams) MarshalMultipart ¶
func (r IndicatorFeedSnapshotUpdateParams) MarshalMultipart() (data []byte, contentType string, err error)
type IndicatorFeedSnapshotUpdateResponse ¶
type IndicatorFeedSnapshotUpdateResponse struct {
// Feed id
FileID int64 `json:"file_id"`
// Name of the file unified in our system
Filename string `json:"filename"`
// Current status of upload, should be unified
Status string `json:"status"`
JSON indicatorFeedSnapshotUpdateResponseJSON `json:"-"`
}
func (*IndicatorFeedSnapshotUpdateResponse) UnmarshalJSON ¶
func (r *IndicatorFeedSnapshotUpdateResponse) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedSnapshotUpdateResponseEnvelope ¶
type IndicatorFeedSnapshotUpdateResponseEnvelope struct {
Errors []IndicatorFeedSnapshotUpdateResponseEnvelopeErrors `json:"errors,required"`
Messages []IndicatorFeedSnapshotUpdateResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success IndicatorFeedSnapshotUpdateResponseEnvelopeSuccess `json:"success,required"`
Result IndicatorFeedSnapshotUpdateResponse `json:"result"`
JSON indicatorFeedSnapshotUpdateResponseEnvelopeJSON `json:"-"`
}
func (*IndicatorFeedSnapshotUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *IndicatorFeedSnapshotUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedSnapshotUpdateResponseEnvelopeErrors ¶ added in v4.3.0
type IndicatorFeedSnapshotUpdateResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source IndicatorFeedSnapshotUpdateResponseEnvelopeErrorsSource `json:"source"`
JSON indicatorFeedSnapshotUpdateResponseEnvelopeErrorsJSON `json:"-"`
}
func (*IndicatorFeedSnapshotUpdateResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedSnapshotUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedSnapshotUpdateResponseEnvelopeErrorsSource ¶ added in v4.3.0
type IndicatorFeedSnapshotUpdateResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON indicatorFeedSnapshotUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*IndicatorFeedSnapshotUpdateResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedSnapshotUpdateResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedSnapshotUpdateResponseEnvelopeMessages ¶ added in v4.3.0
type IndicatorFeedSnapshotUpdateResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source IndicatorFeedSnapshotUpdateResponseEnvelopeMessagesSource `json:"source"`
JSON indicatorFeedSnapshotUpdateResponseEnvelopeMessagesJSON `json:"-"`
}
func (*IndicatorFeedSnapshotUpdateResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedSnapshotUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedSnapshotUpdateResponseEnvelopeMessagesSource ¶ added in v4.3.0
type IndicatorFeedSnapshotUpdateResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON indicatorFeedSnapshotUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*IndicatorFeedSnapshotUpdateResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedSnapshotUpdateResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedSnapshotUpdateResponseEnvelopeSuccess ¶
type IndicatorFeedSnapshotUpdateResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
IndicatorFeedSnapshotUpdateResponseEnvelopeSuccessTrue IndicatorFeedSnapshotUpdateResponseEnvelopeSuccess = true
)
func (IndicatorFeedSnapshotUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r IndicatorFeedSnapshotUpdateResponseEnvelopeSuccess) IsKnown() bool
type IndicatorFeedUpdateParams ¶
type IndicatorFeedUpdateParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,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,required"`
Messages []IndicatorFeedUpdateResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success IndicatorFeedUpdateResponseEnvelopeSuccess `json:"success,required"`
Result IndicatorFeedUpdateResponse `json:"result"`
JSON indicatorFeedUpdateResponseEnvelopeJSON `json:"-"`
}
func (*IndicatorFeedUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *IndicatorFeedUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedUpdateResponseEnvelopeErrors ¶ added in v4.3.0
type IndicatorFeedUpdateResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source IndicatorFeedUpdateResponseEnvelopeErrorsSource `json:"source"`
JSON indicatorFeedUpdateResponseEnvelopeErrorsJSON `json:"-"`
}
func (*IndicatorFeedUpdateResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedUpdateResponseEnvelopeErrorsSource ¶ added in v4.3.0
type IndicatorFeedUpdateResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON indicatorFeedUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*IndicatorFeedUpdateResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedUpdateResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedUpdateResponseEnvelopeMessages ¶ added in v4.3.0
type IndicatorFeedUpdateResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source IndicatorFeedUpdateResponseEnvelopeMessagesSource `json:"source"`
JSON indicatorFeedUpdateResponseEnvelopeMessagesJSON `json:"-"`
}
func (*IndicatorFeedUpdateResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *IndicatorFeedUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type IndicatorFeedUpdateResponseEnvelopeMessagesSource ¶ added in v4.3.0
type IndicatorFeedUpdateResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON indicatorFeedUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*IndicatorFeedUpdateResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
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 ¶
func (r IndicatorFeedUpdateResponseEnvelopeSuccess) IsKnown() bool
type IntelService ¶
type IntelService struct {
Options []option.RequestOption
ASN *ASNService
DNS *DNSService
Domains *DomainService
DomainHistory *DomainHistoryService
IPs *IPService
IPLists *IPListService
Miscategorizations *MiscategorizationService
Whois *WhoisService
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" )
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 MiscategorizationNewParams ¶
type MiscategorizationNewParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,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 ¶
func (r MiscategorizationNewParamsIndicatorType) IsKnown() bool
type MiscategorizationNewResponse ¶
type MiscategorizationNewResponse struct {
Errors []MiscategorizationNewResponseError `json:"errors,required"`
Messages []MiscategorizationNewResponseMessage `json:"messages,required"`
// Whether the API call was successful.
Success MiscategorizationNewResponseSuccess `json:"success,required"`
JSON miscategorizationNewResponseJSON `json:"-"`
}
func (*MiscategorizationNewResponse) UnmarshalJSON ¶
func (r *MiscategorizationNewResponse) UnmarshalJSON(data []byte) (err error)
type MiscategorizationNewResponseError ¶ added in v4.3.0
type MiscategorizationNewResponseError struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source MiscategorizationNewResponseErrorsSource `json:"source"`
JSON miscategorizationNewResponseErrorJSON `json:"-"`
}
func (*MiscategorizationNewResponseError) UnmarshalJSON ¶ added in v4.3.0
func (r *MiscategorizationNewResponseError) UnmarshalJSON(data []byte) (err error)
type MiscategorizationNewResponseErrorsSource ¶ added in v4.3.0
type MiscategorizationNewResponseErrorsSource struct {
Pointer string `json:"pointer"`
JSON miscategorizationNewResponseErrorsSourceJSON `json:"-"`
}
func (*MiscategorizationNewResponseErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *MiscategorizationNewResponseErrorsSource) UnmarshalJSON(data []byte) (err error)
type MiscategorizationNewResponseMessage ¶ added in v4.3.0
type MiscategorizationNewResponseMessage struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source MiscategorizationNewResponseMessagesSource `json:"source"`
JSON miscategorizationNewResponseMessageJSON `json:"-"`
}
func (*MiscategorizationNewResponseMessage) UnmarshalJSON ¶ added in v4.3.0
func (r *MiscategorizationNewResponseMessage) UnmarshalJSON(data []byte) (err error)
type MiscategorizationNewResponseMessagesSource ¶ added in v4.3.0
type MiscategorizationNewResponseMessagesSource struct {
Pointer string `json:"pointer"`
JSON miscategorizationNewResponseMessagesSourceJSON `json:"-"`
}
func (*MiscategorizationNewResponseMessagesSource) UnmarshalJSON ¶ added in v4.3.0
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 ¶
func (r MiscategorizationNewResponseSuccess) IsKnown() bool
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 ¶
func (r *MiscategorizationService) New(ctx context.Context, params MiscategorizationNewParams, opts ...option.RequestOption) (res *MiscategorizationNewResponse, err error)
Allows you to submit requests to change a domain’s category.
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 ¶ added in v4.1.0
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 ¶ added in v4.3.0
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 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 int64 `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 ¶
type SinkholeListParams ¶
type SinkholeService ¶
type SinkholeService struct {
Options []option.RequestOption
}
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) List ¶
func (r *SinkholeService) List(ctx context.Context, query SinkholeListParams, opts ...option.RequestOption) (res *pagination.SinglePage[Sinkhole], err error)
List sinkholes owned by this account
func (*SinkholeService) ListAutoPaging ¶
func (r *SinkholeService) ListAutoPaging(ctx context.Context, query SinkholeListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Sinkhole]
List sinkholes owned by this account
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 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 WhoisGetParams ¶
type WhoisGetParams struct {
// Use to uniquely identify or reference the resource.
AccountID param.Field[string] `path:"account_id,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,required"`
Domain string `json:"domain,required"`
Extension string `json:"extension,required"`
Found bool `json:"found,required"`
Nameservers []string `json:"nameservers,required"`
Punycode string `json:"punycode,required"`
Registrant string `json:"registrant,required"`
Registrar string `json:"registrar,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,required"`
Messages []WhoisGetResponseEnvelopeMessages `json:"messages,required"`
// Returns a boolean for the success/failure of the API call.
Success WhoisGetResponseEnvelopeSuccess `json:"success,required"`
Result WhoisGetResponse `json:"result"`
JSON whoisGetResponseEnvelopeJSON `json:"-"`
}
func (*WhoisGetResponseEnvelope) UnmarshalJSON ¶
func (r *WhoisGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type WhoisGetResponseEnvelopeErrors ¶ added in v4.3.0
type WhoisGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source WhoisGetResponseEnvelopeErrorsSource `json:"source"`
JSON whoisGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*WhoisGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *WhoisGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type WhoisGetResponseEnvelopeErrorsSource ¶ added in v4.3.0
type WhoisGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON whoisGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*WhoisGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *WhoisGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type WhoisGetResponseEnvelopeMessages ¶ added in v4.3.0
type WhoisGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source WhoisGetResponseEnvelopeMessagesSource `json:"source"`
JSON whoisGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*WhoisGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *WhoisGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type WhoisGetResponseEnvelopeMessagesSource ¶ added in v4.3.0
type WhoisGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON whoisGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*WhoisGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
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 ¶
func (r WhoisGetResponseEnvelopeSuccess) IsKnown() bool
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)
Get WHOIS Record
Source Files
¶
- aliases.go
- asn.go
- asnsubnet.go
- attacksurfacereport.go
- attacksurfacereportissue.go
- attacksurfacereportissuetype.go
- dns.go
- domain.go
- domainbulk.go
- domainhistory.go
- indicatorfeed.go
- indicatorfeeddownload.go
- indicatorfeedpermission.go
- indicatorfeedsnapshot.go
- intel.go
- ip.go
- iplist.go
- miscategorization.go
- sinkhole.go
- whois.go