API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Leaked Credential Checks

Get Leaked Credential Checks Status

leaked_credential_checks.get(LeakedCredentialCheckGetParams**kwargs) -> LeakedCredentialCheckGetResponse

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

Set Leaked Credential Checks Status

leaked_credential_checks.create(LeakedCredentialCheckCreateParams**kwargs) -> LeakedCredentialCheckCreateResponse

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

ModelsExpand Collapse

class LeakedCredentialCheckGetResponse: …

Defines the overall status for Leaked Credential Checks.

enabled: Optional[bool]

Determines whether or not Leaked Credential Checks are enabled.

class LeakedCredentialCheckCreateResponse: …

Defines the overall status for Leaked Credential Checks.

enabled: Optional[bool]

Determines whether or not Leaked Credential Checks are enabled.

Leaked Credential ChecksDetections

List Leaked Credential Checks Custom Detections

leaked_credential_checks.detections.list(DetectionListParams**kwargs) -> SyncSinglePage[DetectionListResponse]

GET/zones/{zone_id}/leaked-credential-checks/detections

Create Leaked Credential Checks Custom Detection

leaked_credential_checks.detections.create(DetectionCreateParams**kwargs) -> DetectionCreateResponse

POST/zones/{zone_id}/leaked-credential-checks/detections

Get Leaked Credential Checks Custom Detection

leaked_credential_checks.detections.get(strdetection_id, DetectionGetParams**kwargs) -> DetectionGetResponse

GET/zones/{zone_id}/leaked-credential-checks/detections/{detection_id}

Update Leaked Credential Checks Custom Detection

leaked_credential_checks.detections.update(strdetection_id, DetectionUpdateParams**kwargs) -> DetectionUpdateResponse

PUT/zones/{zone_id}/leaked-credential-checks/detections/{detection_id}

Delete Leaked Credential Checks Custom Detection

leaked_credential_checks.detections.delete(strdetection_id, DetectionDeleteParams**kwargs) -> object

DELETE/zones/{zone_id}/leaked-credential-checks/detections/{detection_id}

ModelsExpand Collapse

class DetectionListResponse: …

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

id: Optional[str]

Defines the unique ID for this custom detection.

maxLength32

password: Optional[str]

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

username: Optional[str]

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

class DetectionCreateResponse: …

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

id: Optional[str]

Defines the unique ID for this custom detection.

maxLength32

password: Optional[str]

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

username: Optional[str]

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

class DetectionGetResponse: …

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

id: Optional[str]

Defines the unique ID for this custom detection.

maxLength32

password: Optional[str]

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

username: Optional[str]

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

class DetectionUpdateResponse: …

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

id: Optional[str]

Defines the unique ID for this custom detection.

maxLength32

password: Optional[str]

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

username: Optional[str]

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