brand_protection

package
v2.4.0 Latest Latest
Warning

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

 Go to latest Published: Jul 16, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source 
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source 
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source 
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source 
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source 
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source 
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source 
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source 
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source 
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source 
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source 
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN added in v2.1.0 

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam added in v2.1.0 

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog 

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction 

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor 

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType 

type AuditLogActorType = shared.AuditLogActorType

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

This is an alias to an internal type.

type AuditLogOwner 

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource 

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type BrandProtectionService 

type BrandProtectionService struct {
	Options []option.RequestOption
}

BrandProtectionService 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 NewBrandProtectionService method instead.

func NewBrandProtectionService 

func NewBrandProtectionService(opts ...option.RequestOption) (r *BrandProtectionService)

NewBrandProtectionService 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 (*BrandProtectionService) Submit 

func (r *BrandProtectionService) Submit(ctx context.Context, params BrandProtectionSubmitParams, opts ...option.RequestOption) (res *Submit, err error)

Submit suspicious URL for scanning

func (*BrandProtectionService) URLInfo 

func (r *BrandProtectionService) URLInfo(ctx context.Context, params BrandProtectionURLInfoParams, opts ...option.RequestOption) (res *Info, err error)

Get results for a URL scan

type BrandProtectionSubmitParams 

type BrandProtectionSubmitParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// URL(s) to filter submissions results by
	URL param.Field[string] `json:"url" format:"uri"`
}

func (BrandProtectionSubmitParams) MarshalJSON 

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

type BrandProtectionSubmitResponseEnvelope 

type BrandProtectionSubmitResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success BrandProtectionSubmitResponseEnvelopeSuccess `json:"success,required"`
	Result  Submit                                       `json:"result"`
	JSON    brandProtectionSubmitResponseEnvelopeJSON    `json:"-"`
}

func (*BrandProtectionSubmitResponseEnvelope) UnmarshalJSON 

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

type BrandProtectionSubmitResponseEnvelopeSuccess 

type BrandProtectionSubmitResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	BrandProtectionSubmitResponseEnvelopeSuccessTrue BrandProtectionSubmitResponseEnvelopeSuccess = true
)

func (BrandProtectionSubmitResponseEnvelopeSuccess) IsKnown 

func (r BrandProtectionSubmitResponseEnvelopeSuccess) IsKnown() bool

type BrandProtectionURLInfoParams 

type BrandProtectionURLInfoParams struct {
	// Identifier
	AccountID  param.Field[string]                                 `path:"account_id,required"`
	URL        param.Field[string]                                 `query:"url"`
	URLIDParam param.Field[BrandProtectionURLInfoParamsURLIDParam] `query:"url_id_param"`
}

func (BrandProtectionURLInfoParams) URLQuery 

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

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

type BrandProtectionURLInfoParamsURLIDParam 

type BrandProtectionURLInfoParamsURLIDParam struct {
	// Submission ID(s) to filter submission results by.
	URLID param.Field[int64] `query:"url_id"`
}

func (BrandProtectionURLInfoParamsURLIDParam) URLQuery 

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

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

type BrandProtectionURLInfoResponseEnvelope 

type BrandProtectionURLInfoResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success BrandProtectionURLInfoResponseEnvelopeSuccess `json:"success,required"`
	Result  Info                                          `json:"result"`
	JSON    brandProtectionURLInfoResponseEnvelopeJSON    `json:"-"`
}

func (*BrandProtectionURLInfoResponseEnvelope) UnmarshalJSON 

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

type BrandProtectionURLInfoResponseEnvelopeSuccess 

type BrandProtectionURLInfoResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	BrandProtectionURLInfoResponseEnvelopeSuccessTrue BrandProtectionURLInfoResponseEnvelopeSuccess = true
)

func (BrandProtectionURLInfoResponseEnvelopeSuccess) IsKnown 

func (r BrandProtectionURLInfoResponseEnvelopeSuccess) IsKnown() bool

type CertificateCA added in v2.2.0 

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType added in v2.2.0 

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 added in v2.3.0 

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 Error 

type Error = apierror.Error

type ErrorData 

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type Info 

type Info struct {
	// List of categorizations applied to this submission.
	Categorizations []InfoCategorization `json:"categorizations"`
	// List of model results for completed scans.
	ModelResults []URLInfoModelResults `json:"model_results"`
	// List of signatures that matched against site content found when crawling the
	// URL.
	RuleMatches []RuleMatch `json:"rule_matches"`
	// Status of the most recent scan found.
	ScanStatus ScanStatus `json:"scan_status"`
	// For internal use.
	ScreenshotDownloadSignature string `json:"screenshot_download_signature"`
	// For internal use.
	ScreenshotPath string `json:"screenshot_path"`
	// URL that was submitted.
	URL  string   `json:"url"`
	JSON infoJSON `json:"-"`
}

func (*Info) UnmarshalJSON 

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

type InfoCategorization 

type InfoCategorization struct {
	// Name of the category applied.
	Category string `json:"category"`
	// Result of human review for this categorization.
	VerificationStatus string                 `json:"verification_status"`
	JSON               infoCategorizationJSON `json:"-"`
}

func (*InfoCategorization) UnmarshalJSON 

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

type MemberParam added in v2.1.0 

type MemberParam = shared.MemberParam

This is an alias to an internal type.

type MemberRoleParam added in v2.1.0 

type MemberRoleParam = shared.MemberRoleParam

This is an alias to an internal type.

type MemberRolesPermissionsParam added in v2.1.0 

type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam

This is an alias to an internal type.

type MemberStatus added in v2.3.0 

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUserParam added in v2.1.0 

type MemberUserParam = shared.MemberUserParam

Details of the user associated to the membership.

This is an alias to an internal type.

type Permission 

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant 

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam 

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type ResponseInfo 

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type Role 

type Role = shared.Role

This is an alias to an internal type.

type RuleMatch 

type RuleMatch struct {
	// For internal use.
	Banning bool `json:"banning"`
	// For internal use.
	Blocking bool `json:"blocking"`
	// Description of the signature that matched.
	Description string `json:"description"`
	// Name of the signature that matched.
	Name string        `json:"name"`
	JSON ruleMatchJSON `json:"-"`
}

func (*RuleMatch) UnmarshalJSON 

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

type ScanStatus 

type ScanStatus struct {
	// Timestamp of when the submission was processed.
	LastProcessed string `json:"last_processed"`
	// For internal use.
	ScanComplete bool `json:"scan_complete"`
	// Status code that the crawler received when loading the submitted URL.
	StatusCode int64 `json:"status_code"`
	// ID of the most recent submission.
	SubmissionID int64          `json:"submission_id"`
	JSON         scanStatusJSON `json:"-"`
}

Status of the most recent scan found.

func (*ScanStatus) UnmarshalJSON 

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

type SortDirection added in v2.2.0 

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type Submit 

type Submit struct {
	// URLs that were excluded from scanning because their domain is in our no-scan
	// list.
	ExcludedURLs []SubmitExcludedURL `json:"excluded_urls"`
	// URLs that were skipped because the same URL is currently being scanned
	SkippedURLs []SubmitSkippedURL `json:"skipped_urls"`
	// URLs that were successfully submitted for scanning.
	SubmittedURLs []SubmitSubmittedURL `json:"submitted_urls"`
	JSON          submitJSON           `json:"-"`
}

func (*Submit) UnmarshalJSON 

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

type SubmitExcludedURL 

type SubmitExcludedURL struct {
	// URL that was excluded.
	URL  string                `json:"url"`
	JSON submitExcludedURLJSON `json:"-"`
}

func (*SubmitExcludedURL) UnmarshalJSON 

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

type SubmitSkippedURL 

type SubmitSkippedURL struct {
	// URL that was skipped.
	URL string `json:"url"`
	// ID of the submission of that URL that is currently scanning.
	URLID int64                `json:"url_id"`
	JSON  submitSkippedURLJSON `json:"-"`
}

func (*SubmitSkippedURL) UnmarshalJSON 

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

type SubmitSubmittedURL 

type SubmitSubmittedURL struct {
	// URL that was submitted.
	URL string `json:"url"`
	// ID assigned to this URL submission. Used to retrieve scanning results.
	URLID int64                  `json:"url_id"`
	JSON  submitSubmittedURLJSON `json:"-"`
}

func (*SubmitSubmittedURL) UnmarshalJSON 

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

type URLInfoModelResults 

type URLInfoModelResults struct {
	// Name of the model.
	ModelName string `json:"model_name"`
	// Score output by the model for this submission.
	ModelScore float64                 `json:"model_score"`
	JSON       urlInfoModelResultsJSON `json:"-"`
}

func (*URLInfoModelResults) UnmarshalJSON 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

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