Skip to content
Start here

Leaked Credential Checks

Get the Leaked Credential Checks status for a zone.
GET/zones/{zone_id}/leaked-credential-checks
Update the Leaked Credential Checks status for a zone.
POST/zones/{zone_id}/leaked-credential-checks
ModelsExpand Collapse
LeakedCredentialCheckGetResponse object { enabled }

Defines the overall status for Leaked Credential Checks.

enabled: optional boolean

Determines whether or not Leaked Credential Checks are enabled.

LeakedCredentialCheckCreateResponse object { enabled }

Defines the overall status for Leaked Credential Checks.

enabled: optional boolean

Determines whether or not Leaked Credential Checks are enabled.

Leaked Credential ChecksDetections

List the custom detection locations of a zone.
GET/zones/{zone_id}/leaked-credential-checks/detections
Create a custom detection location for a zone.
POST/zones/{zone_id}/leaked-credential-checks/detections
Get a custom detection location of a zone.
GET/zones/{zone_id}/leaked-credential-checks/detections/{detection_id}
Update a custom detection location of a zone.
PUT/zones/{zone_id}/leaked-credential-checks/detections/{detection_id}
Delete a custom detection location from a zone.
DELETE/zones/{zone_id}/leaked-credential-checks/detections/{detection_id}
ModelsExpand Collapse
DetectionListResponse object { id, password, username }

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

id: optional string

Defines the unique ID for this custom detection.

maxLength32
password: optional string

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

username: optional string

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

DetectionCreateResponse object { id, password, username }

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

id: optional string

Defines the unique ID for this custom detection.

maxLength32
password: optional string

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

username: optional string

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

DetectionGetResponse object { id, password, username }

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

id: optional string

Defines the unique ID for this custom detection.

maxLength32
password: optional string

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

username: optional string

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

DetectionUpdateResponse object { id, password, username }

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

id: optional string

Defines the unique ID for this custom detection.

maxLength32
password: optional string

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

username: optional string

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

DetectionDeleteResponse = unknown