Cloudflare API | Leaked Credential Checks › Detections › Update Leaked Credential Checks Custom Detection

API Reference

Account & User Management

Resource Sharing

AI

Certificate Management

Certificate Authorities

Client Certificates

Custom Certificates

Custom Hostnames

Keyless Certificates

MTLS Certificates

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

Cloudflare One

DNS

Account Custom Nameservers

Domain/Zone Management

IP Addresses

Media

Networking

Magic Network Monitoring

Network Interconnects

Observability

Security Center

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Content Scanning

Leaked Credential Checks

Set Leaked Credential Checks Status

Get Leaked Credential Checks Status

Create Leaked Credential Checks Custom Detection

Delete Leaked Credential Checks Custom Detection

List Leaked Credential Checks Custom Detections

Update Leaked Credential Checks Custom Detection

Storage & Databases

Threat Intelligence

Brand Protection

Workers & Pages

Browser Rendering

Durable Objects

Workers For Platforms

Shared

Leaked Credential Checks

leaked_credential_checks

Methods

Set Leaked Credential Checks Status -> Envelope<{ enabled }>

post/zones/{zone_id}/leaked-credential-checks

Updates the current status of Leaked Credential Checks

Get Leaked Credential Checks Status -> Envelope<{ enabled }>

get/zones/{zone_id}/leaked-credential-checks

Retrieves the current status of Leaked Credential Checks

Leaked Credential Checks

Detections

leaked_credential_checks.detections

Methods

Create Leaked Credential Checks Custom Detection -> Envelope<{ id, password, username }>

post/zones/{zone_id}/leaked-credential-checks/detections

Create user-defined detection pattern for Leaked Credential Checks

Delete Leaked Credential Checks Custom Detection -> Envelope<unknown>

delete/zones/{zone_id}/leaked-credential-checks/detections/{detection_id}

Remove user-defined detection pattern for Leaked Credential Checks

List Leaked Credential Checks Custom Detections -> SinglePage<{ id, password, username }>

get/zones/{zone_id}/leaked-credential-checks/detections

List user-defined detection patterns for Leaked Credential Checks

Update Leaked Credential Checks Custom Detection -> Envelope<{ id, password, username }>

put/zones/{zone_id}/leaked-credential-checks/detections/{detection_id}

Update user-defined detection pattern for Leaked Credential Checks

Security

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Zone WAF Write Account WAF Write

Parameters

zone_id: string

(maxLength: 32)

Identifier

detection_id: string

(maxLength: 32)

The unique ID for this custom detection

Response fields

errors: Array<

>

messages: Array<

>

result: { id, password, username }

A custom set of username/password expressions to match Leaked Credential Checks on

success: true

Whether the API call was successful

Request example

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/leaked-credential-checks/detections/$DETECTION_ID \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{
      "password": "lookup_json_string(http.request.body.raw, \\"secret\\")",
      "username": "lookup_json_string(http.request.body.raw, \\"user\\")"
    }'

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "result": {
    "password": "lookup_json_string(http.request.body.raw, \"secret\")",
    "username": "lookup_json_string(http.request.body.raw, \"user\")"
  },
  "success": true
}