Skip to content
Cloudflare API
Start here
API Reference

Fraud

Get Fraud Detection Settings
client.Fraud.Get(ctx, query) (*FraudSettings, error)
GET/zones/{zone_id}/fraud_detection/settings
Update Fraud Detection Settings
client.Fraud.Update(ctx, params) (*FraudSettings, error)
PUT/zones/{zone_id}/fraud_detection/settings
ModelsExpand Collapse
type FraudSettings struct{…}
AuthenticationSettings FraudSettingsAuthenticationSettingsOptional

Configuration for classifying login authentication outcomes based on the origin response. Requires user_profiles to be enabled.

  • Success and failure criteria are independently updatable — sending only success_criteria leaves failure codes untouched, and vice versa.
  • Omit authentication_settings entirely to leave both unchanged.
  • Status codes must not overlap between success and failure criteria.
FailureCriteria FraudSettingsAuthenticationSettingsFailureCriteriaOptional

Criterion for identifying failed login responses.

Kind FraudSettingsAuthenticationSettingsFailureCriteriaKind

The type of criterion. Currently only status_code is supported.

StatusCodes []int64Optional

HTTP status codes to match against the origin response.

  • Maximum of 10 codes per criterion.
  • Each code must be a valid HTTP status code (100-599).
  • Codes are deduplicated and sorted on save.
  • Omit to leave unchanged on update.
  • Provide an empty array [] to clear codes on update.
SuccessCriteria FraudSettingsAuthenticationSettingsSuccessCriteriaOptional

Criterion for identifying successful login responses.

Kind FraudSettingsAuthenticationSettingsSuccessCriteriaKind

The type of criterion. Currently only status_code is supported.

StatusCodes []int64Optional

HTTP status codes to match against the origin response.

  • Maximum of 10 codes per criterion.
  • Each code must be a valid HTTP status code (100-599).
  • Codes are deduplicated and sorted on save.
  • Omit to leave unchanged on update.
  • Provide an empty array [] to clear codes on update.
UserProfiles FraudSettingsUserProfilesOptional

Whether Fraud User Profiles is enabled for the zone.

One of the following:
const FraudSettingsUserProfilesEnabled FraudSettingsUserProfiles = "enabled"
const FraudSettingsUserProfilesDisabled FraudSettingsUserProfiles = "disabled"
UsernameExpressions []stringOptional

List of expressions to detect usernames in write HTTP requests.

  • Maximum of 10 expressions.
  • Omit or set to null to leave unchanged on update.
  • Provide an empty array [] to clear all expressions on update.
  • Invalid expressions will result in a 10400 Bad Request with details in the messages array.