Cloudflare API | Leaked Credential Checks › Set Leaked Credential Checks Status

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/leaked-credential-checks \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{
      "enabled": true
    }'

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": {
    "enabled": true
  },
  "success": true
}

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.