Skip to content
Cloudflare API
Start here
API Reference

Leaked Credential Checks

Get the Leaked Credential Checks status for a zone.
client.leakedCredentialChecks.get(LeakedCredentialCheckGetParams { zone_id } params, RequestOptionsoptions?): LeakedCredentialCheckGetResponse { enabled }
GET/zones/{zone_id}/leaked-credential-checks
Update the Leaked Credential Checks status for a zone.
client.leakedCredentialChecks.create(LeakedCredentialCheckCreateParams { zone_id, enabled } params, RequestOptionsoptions?): LeakedCredentialCheckCreateResponse { enabled }
POST/zones/{zone_id}/leaked-credential-checks
ModelsExpand Collapse
LeakedCredentialCheckGetResponse { enabled }

Defines the overall status for Leaked Credential Checks.

enabled?: boolean

Determines whether or not Leaked Credential Checks are enabled.

LeakedCredentialCheckCreateResponse { enabled }

Defines the overall status for Leaked Credential Checks.

enabled?: boolean

Determines whether or not Leaked Credential Checks are enabled.

Leaked Credential ChecksDetections

List the custom detection locations of a zone.
client.leakedCredentialChecks.detections.list(DetectionListParams { zone_id } params, RequestOptionsoptions?): SinglePage<DetectionListResponse { id, password, username } >
GET/zones/{zone_id}/leaked-credential-checks/detections
Create a custom detection location for a zone.
client.leakedCredentialChecks.detections.create(DetectionCreateParams { zone_id, password, username } params, RequestOptionsoptions?): DetectionCreateResponse { id, password, username }
POST/zones/{zone_id}/leaked-credential-checks/detections
Get a custom detection location of a zone.
client.leakedCredentialChecks.detections.get(stringdetectionID, DetectionGetParams { zone_id } params, RequestOptionsoptions?): DetectionGetResponse { id, password, username }
GET/zones/{zone_id}/leaked-credential-checks/detections/{detection_id}
Update a custom detection location of a zone.
client.leakedCredentialChecks.detections.update(stringdetectionID, DetectionUpdateParams { zone_id, password, username } params, RequestOptionsoptions?): DetectionUpdateResponse { id, password, username }
PUT/zones/{zone_id}/leaked-credential-checks/detections/{detection_id}
Delete a custom detection location from a zone.
client.leakedCredentialChecks.detections.delete(stringdetectionID, DetectionDeleteParams { zone_id } params, RequestOptionsoptions?): DetectionDeleteResponse
DELETE/zones/{zone_id}/leaked-credential-checks/detections/{detection_id}
ModelsExpand Collapse
DetectionListResponse { id, password, username }

Defines a custom set of username/password expressions to match Leaked Credential Checks on.

id?: string

Defines the unique ID for this custom detection.

maxLength32
password?: string

Defines ehe ruleset expression to use in matching the password in a request.

username?: string

Defines the ruleset expression to use in matching the username in a request.

DetectionCreateResponse { id, password, username }

Defines a custom set of username/password expressions to match Leaked Credential Checks on.

id?: string

Defines the unique ID for this custom detection.

maxLength32
password?: string

Defines ehe ruleset expression to use in matching the password in a request.

username?: string

Defines the ruleset expression to use in matching the username in a request.

DetectionGetResponse { id, password, username }

Defines a custom set of username/password expressions to match Leaked Credential Checks on.

id?: string

Defines the unique ID for this custom detection.

maxLength32
password?: string

Defines ehe ruleset expression to use in matching the password in a request.

username?: string

Defines the ruleset expression to use in matching the username in a request.

DetectionUpdateResponse { id, password, username }

Defines a custom set of username/password expressions to match Leaked Credential Checks on.

id?: string

Defines the unique ID for this custom detection.

maxLength32
password?: string

Defines ehe ruleset expression to use in matching the password in a request.

username?: string

Defines the ruleset expression to use in matching the username in a request.

DetectionDeleteResponse = unknown