content_scanning

type ASN ¶

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam ¶

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog ¶

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction ¶

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor ¶

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType ¶

type AuditLogActorType = shared.AuditLogActorType

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

This is an alias to an internal type.

type AuditLogOwner ¶

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource ¶

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type 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 ContentScanningDisableParams ¶

type ContentScanningDisableParams struct {
	// Defines an identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type ContentScanningDisableResponse ¶

type ContentScanningDisableResponse = interface{}

type ContentScanningDisableResponseEnvelope ¶

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

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

type ContentScanningDisableResponseEnvelopeSuccess ¶

type ContentScanningDisableResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ContentScanningDisableResponseEnvelopeSuccessTrue ContentScanningDisableResponseEnvelopeSuccess = true
)

func (r ContentScanningDisableResponseEnvelopeSuccess) IsKnown() bool

type ContentScanningEnableParams ¶

type ContentScanningEnableParams struct {
	// Defines an identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type ContentScanningEnableResponse ¶

type ContentScanningEnableResponse = interface{}

type ContentScanningEnableResponseEnvelope ¶

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

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

type ContentScanningEnableResponseEnvelopeSuccess ¶

type ContentScanningEnableResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ContentScanningEnableResponseEnvelopeSuccessTrue ContentScanningEnableResponseEnvelopeSuccess = true
)

func (r ContentScanningEnableResponseEnvelopeSuccess) IsKnown() bool

type ContentScanningService ¶

type ContentScanningService struct {
	Options  []option.RequestOption
	Payloads *PayloadService
	Settings *SettingService
}

ContentScanningService 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 NewContentScanningService method instead.

func NewContentScanningService(opts ...option.RequestOption) (r *ContentScanningService)

func (r *ContentScanningService) Disable(ctx context.Context, body ContentScanningDisableParams, opts ...option.RequestOption) (res *ContentScanningDisableResponse, err error)

func (r *ContentScanningService) Enable(ctx context.Context, body ContentScanningEnableParams, opts ...option.RequestOption) (res *ContentScanningEnableResponse, err error)

type Error ¶

type Error = apierror.Error

type ErrorData ¶

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource ¶ added in v4.2.0

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type Member ¶

type Member = shared.Member

This is an alias to an internal type.

type MemberPoliciesAccess ¶

type MemberPoliciesAccess = shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroup ¶

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

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

This is an alias to an internal type.

type MemberPoliciesPermissionGroupsMeta ¶

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type MemberPoliciesResourceGroup ¶

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsMeta ¶

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScope ¶

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

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

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScopeObject ¶

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

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

This is an alias to an internal type.

type MemberPolicy ¶

type MemberPolicy = shared.MemberPolicy

This is an alias to an internal type.

type MemberStatus ¶

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUser ¶

type MemberUser = shared.MemberUser

Details of the user associated to the membership.

This is an alias to an internal type.

type PayloadDeleteParams ¶

type PayloadDeleteParams struct {
	// Defines an identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type PayloadDeleteResponse ¶

type PayloadDeleteResponse struct {
	// defines the unique ID for this custom scan expression.
	ID string `json:"id"`
	// Defines the ruleset expression to use in matching content objects.
	Payload string                    `json:"payload"`
	JSON    payloadDeleteResponseJSON `json:"-"`
}

Defines a custom scan expression to match Content Scanning on.

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

type PayloadListParams ¶

type PayloadListParams struct {
	// Defines an identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type PayloadListResponse ¶

type PayloadListResponse struct {
	// defines the unique ID for this custom scan expression.
	ID string `json:"id"`
	// Defines the ruleset expression to use in matching content objects.
	Payload string                  `json:"payload"`
	JSON    payloadListResponseJSON `json:"-"`
}

Defines a custom scan expression to match Content Scanning on.

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

type PayloadNewParams ¶

type PayloadNewParams struct {
	// Defines an identifier.
	ZoneID param.Field[string]    `path:"zone_id,required"`
	Body   []PayloadNewParamsBody `json:"body,required"`
}

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

type PayloadNewParamsBody ¶

type PayloadNewParamsBody struct {
	// Defines the ruleset expression to use in matching content objects.
	Payload param.Field[string] `json:"payload,required"`
}

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

type PayloadNewResponse ¶

type PayloadNewResponse struct {
	// defines the unique ID for this custom scan expression.
	ID string `json:"id"`
	// Defines the ruleset expression to use in matching content objects.
	Payload string                 `json:"payload"`
	JSON    payloadNewResponseJSON `json:"-"`
}

Defines a custom scan expression to match Content Scanning on.

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

type PayloadService ¶

type PayloadService struct {
	Options []option.RequestOption
}

PayloadService 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 NewPayloadService method instead.

func NewPayloadService(opts ...option.RequestOption) (r *PayloadService)

func (r *PayloadService) Delete(ctx context.Context, expressionID string, body PayloadDeleteParams, opts ...option.RequestOption) (res *pagination.SinglePage[PayloadDeleteResponse], err error)

func (r *PayloadService) DeleteAutoPaging(ctx context.Context, expressionID string, body PayloadDeleteParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[PayloadDeleteResponse]

func (r *PayloadService) List(ctx context.Context, query PayloadListParams, opts ...option.RequestOption) (res *pagination.SinglePage[PayloadListResponse], err error)

func (r *PayloadService) ListAutoPaging(ctx context.Context, query PayloadListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[PayloadListResponse]

func (r *PayloadService) New(ctx context.Context, params PayloadNewParams, opts ...option.RequestOption) (res *pagination.SinglePage[PayloadNewResponse], err error)

func (r *PayloadService) NewAutoPaging(ctx context.Context, params PayloadNewParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[PayloadNewResponse]

type Permission ¶

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant ¶

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam ¶

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type RatePlan ¶

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanID ¶ 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 ResponseInfo ¶

type ResponseInfo = shared.ResponseInfo

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 Role ¶

type Role = shared.Role

This is an alias to an internal type.

type RoleParam ¶

type RoleParam = shared.RoleParam

This is an alias to an internal type.

type RolePermissions ¶

type RolePermissions = shared.RolePermissions

This is an alias to an internal type.

type RolePermissionsParam ¶

type RolePermissionsParam = shared.RolePermissionsParam

This is an alias to an internal type.

type SettingGetParams ¶

type SettingGetParams struct {
	// Defines an identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type SettingGetResponse ¶

type SettingGetResponse struct {
	// Defines the last modification date (ISO 8601) of the Content Scanning status.
	Modified string `json:"modified"`
	// Defines the status of Content Scanning.
	Value string                 `json:"value"`
	JSON  settingGetResponseJSON `json:"-"`
}

Defines the status for Content Scanning.

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

type SettingGetResponseEnvelope ¶

type SettingGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Defines the status for Content Scanning.
	Result SettingGetResponse `json:"result,required"`
	// Whether the API call was successful.
	Success SettingGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    settingGetResponseEnvelopeJSON    `json:"-"`
}

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

type SettingGetResponseEnvelopeSuccess ¶

type SettingGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	SettingGetResponseEnvelopeSuccessTrue SettingGetResponseEnvelopeSuccess = true
)

func (r SettingGetResponseEnvelopeSuccess) IsKnown() bool

type SettingService ¶

type SettingService struct {
	Options []option.RequestOption
}

SettingService 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 NewSettingService method instead.

func NewSettingService(opts ...option.RequestOption) (r *SettingService)

func (r *SettingService) Get(ctx context.Context, query SettingGetParams, opts ...option.RequestOption) (res *SettingGetResponse, err error)

type SortDirection ¶

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type Subscription ¶

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency ¶

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam ¶

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState ¶

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type Token ¶

type Token = shared.Token

This is an alias to an internal type.

type TokenCondition ¶

type TokenCondition = shared.TokenCondition

This is an alias to an internal type.

type TokenConditionCIDRList ¶

type TokenConditionCIDRList = shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionCIDRListParam ¶

type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionParam ¶

type TokenConditionParam = shared.TokenConditionParam

This is an alias to an internal type.

type TokenConditionRequestIP ¶

type TokenConditionRequestIP = shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

type TokenConditionRequestIPParam ¶

type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

type TokenParam ¶

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy ¶

type TokenPolicy = shared.TokenPolicy

This is an alias to an internal type.

type TokenPolicyEffect ¶

type TokenPolicyEffect = shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

type TokenPolicyParam ¶

type TokenPolicyParam = shared.TokenPolicyParam

This is an alias to an internal type.

type TokenPolicyPermissionGroup ¶

type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup

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

This is an alias to an internal type.

type TokenPolicyPermissionGroupParam ¶

type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam

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

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMeta ¶

type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMetaParam ¶

type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

type 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.