Cloudflare API | Leaked Credential Checks › Detections › List Leaked Credential Checks Custom Detections

API Reference

Overview

Account & User Management

Abuse Reports

Certificate Management

ACM

Certificate Authorities

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

SSL

Cloudflare One

Email Security

Zero Trust

DNS

Account Custom Nameservers

DNS

DNS Firewall

Domain/Zone Management

IP Addresses

Media

Networking

Magic Cloud Networking

Magic Network Monitoring

Magic Transit

Network Interconnects

Observability

Radar

Routing & Performance

Rules

Storage & Databases

Threat Intelligence

Workers & Pages

Workers For Platforms

Shared

Leaked Credential Checks

leaked_credential_checks

Methods

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

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

Retrieves the current status of Leaked Credential Checks.

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

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

Updates the current status of Leaked Credential Checks.

Leaked Credential Checks

Detections

leaked_credential_checks.detections

Methods

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.

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 Zone WAF Read Account WAF Write Account WAF Read

path Parameters

zone_id: string

(maxLength: 32)

Defines an identifier.

Response fields

errors: Array<

ResponseInfo

messages: Array<

ResponseInfo

result: Array<{ id, password, username }>

Nullable

success: true

Defines whether the API call was successful.

Request example

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/leaked-credential-checks/detections \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

200Example

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

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.

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.

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.