---
title: Leaked Credential Checks
---

[Skip to content](#%5Ftop) 

[API Reference](https://developers.cloudflare.com/api/typescript)

Copy Markdown

Open in **Claude**

Open in **ChatGPT**

Open in **Cursor**

---

**Copy Markdown**

**View as Markdown**

# Leaked Credential Checks

##### [Get the Leaked Credential Checks status for a zone.](https://developers.cloudflare.com/api/typescript/resources/leaked%5Fcredential%5Fchecks/methods/get)

client.leakedCredentialChecks.get(LeakedCredentialCheckGetParams { zone\_id } params, RequestOptionsoptions?): [LeakedCredentialCheckGetResponse](https://developers.cloudflare.com/api/typescript/resources/leaked%5Fcredential%5Fchecks#%28resource%29%20leaked%5Fcredential%5Fchecks%20%3E%20%28model%29%20leaked%5Fcredential%5Fcheck%5Fget%5Fresponse%20%3E%20%28schema%29) { enabled } 

GET/zones/{zone\_id}/leaked-credential-checks

##### [Update the Leaked Credential Checks status for a zone.](https://developers.cloudflare.com/api/typescript/resources/leaked%5Fcredential%5Fchecks/methods/create)

client.leakedCredentialChecks.create(LeakedCredentialCheckCreateParams { zone\_id, enabled } params, RequestOptionsoptions?): [LeakedCredentialCheckCreateResponse](https://developers.cloudflare.com/api/typescript/resources/leaked%5Fcredential%5Fchecks#%28resource%29%20leaked%5Fcredential%5Fchecks%20%3E%20%28model%29%20leaked%5Fcredential%5Fcheck%5Fcreate%5Fresponse%20%3E%20%28schema%29) { 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.](https://developers.cloudflare.com/api/typescript/resources/leaked%5Fcredential%5Fchecks/subresources/detections/methods/list)

client.leakedCredentialChecks.detections.list(DetectionListParams { zone\_id } params, RequestOptionsoptions?): SinglePage<[DetectionListResponse](https://developers.cloudflare.com/api/typescript/resources/leaked%5Fcredential%5Fchecks#%28resource%29%20leaked%5Fcredential%5Fchecks.detections%20%3E%20%28model%29%20detection%5Flist%5Fresponse%20%3E%20%28schema%29) { id, password, username } \>

GET/zones/{zone\_id}/leaked-credential-checks/detections

##### [Create a custom detection location for a zone.](https://developers.cloudflare.com/api/typescript/resources/leaked%5Fcredential%5Fchecks/subresources/detections/methods/create)

client.leakedCredentialChecks.detections.create(DetectionCreateParams { zone\_id, password, username } params, RequestOptionsoptions?): [DetectionCreateResponse](https://developers.cloudflare.com/api/typescript/resources/leaked%5Fcredential%5Fchecks#%28resource%29%20leaked%5Fcredential%5Fchecks.detections%20%3E%20%28model%29%20detection%5Fcreate%5Fresponse%20%3E%20%28schema%29) { id, password, username } 

POST/zones/{zone\_id}/leaked-credential-checks/detections

##### [Get a custom detection location of a zone.](https://developers.cloudflare.com/api/typescript/resources/leaked%5Fcredential%5Fchecks/subresources/detections/methods/get)

client.leakedCredentialChecks.detections.get(stringdetectionID, DetectionGetParams { zone\_id } params, RequestOptionsoptions?): [DetectionGetResponse](https://developers.cloudflare.com/api/typescript/resources/leaked%5Fcredential%5Fchecks#%28resource%29%20leaked%5Fcredential%5Fchecks.detections%20%3E%20%28model%29%20detection%5Fget%5Fresponse%20%3E%20%28schema%29) { id, password, username } 

GET/zones/{zone\_id}/leaked-credential-checks/detections/{detection\_id}

##### [Update a custom detection location of a zone.](https://developers.cloudflare.com/api/typescript/resources/leaked%5Fcredential%5Fchecks/subresources/detections/methods/update)

client.leakedCredentialChecks.detections.update(stringdetectionID, DetectionUpdateParams { zone\_id, password, username } params, RequestOptionsoptions?): [DetectionUpdateResponse](https://developers.cloudflare.com/api/typescript/resources/leaked%5Fcredential%5Fchecks#%28resource%29%20leaked%5Fcredential%5Fchecks.detections%20%3E%20%28model%29%20detection%5Fupdate%5Fresponse%20%3E%20%28schema%29) { id, password, username } 

PUT/zones/{zone\_id}/leaked-credential-checks/detections/{detection\_id}

##### [Delete a custom detection location from a zone.](https://developers.cloudflare.com/api/typescript/resources/leaked%5Fcredential%5Fchecks/subresources/detections/methods/delete)

client.leakedCredentialChecks.detections.delete(stringdetectionID, DetectionDeleteParams { zone\_id } params, RequestOptionsoptions?): [DetectionDeleteResponse](https://developers.cloudflare.com/api/typescript/resources/leaked%5Fcredential%5Fchecks#%28resource%29%20leaked%5Fcredential%5Fchecks.detections%20%3E%20%28model%29%20detection%5Fdelete%5Fresponse%20%3E%20%28schema%29)

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