Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions api-reference/leaks/export-leaks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@ openapi: post /v1/leaks/export

## Overview

Export leaked credentials data with the same filtering capabilities as the main leaks endpoint. Supports both JSON and CSV formats for easy integration with external tools and reporting systems.
Export leaked credentials data with filtering by type, domain, email, date range, and more. Supports both JSON and CSV formats for easy integration with external tools and reporting systems.

<Info>
**Password Unmasking**: Passwords are displayed unmasked after [domain verification](/cloud/credential-monitoring#domain-verification). Without verification, passwords appear as `***MASKED***`.
</Info>

## Export Formats

Expand Down Expand Up @@ -120,9 +124,9 @@ curl -X POST "https://api.projectdiscovery.io/v1/leaks/export" \
- CSV format is more efficient for large datasets

### Security Considerations
- Exported data may contain sensitive information
- Exported data may contain sensitive information including unmasked passwords
- Ensure secure handling and storage of exported files
- Password unmasking follows the same ACL rules as the main leaks endpoint
- Passwords are unmasked after [domain verification](/cloud/credential-monitoring#domain-verification)

### Performance Tips
- Use specific filters to reduce export size
Expand Down
140 changes: 0 additions & 140 deletions api-reference/leaks/get-all-leaks.mdx

This file was deleted.

47 changes: 0 additions & 47 deletions api-reference/leaks/get-domain-customer-leaks.mdx

This file was deleted.

38 changes: 0 additions & 38 deletions api-reference/leaks/get-domain-leaks.mdx

This file was deleted.

47 changes: 22 additions & 25 deletions api-reference/leaks/get-domain-stats.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,17 @@ openapi: get /v1/leaks/stats/domain

## Overview

Get statistical information about leaks associated with a specific domain. This endpoint provides aggregate data for monitoring and reporting purposes.
Get statistical information about leaks associated with any domain. This is a **public endpoint** that doesn't require authentication, making it ideal for quick breach checks and integrations.

<Info>
This endpoint requires domain verification. You can only get stats for domains you have verified ownership of.
**Public Endpoint**: No authentication required. You can check leak statistics for any domain.
</Info>

## Query Parameters

| Parameter | Type | Description |
|-----------|------|-------------|
| `domain` | string | **Required.** The domain to get leak statistics for |
| `unmask_email` | boolean | Whether to unmask email addresses in the response |

## Response Structure

Expand All @@ -25,12 +24,8 @@ The response provides comprehensive statistics about leaks for the specified dom
{
"domain": "example.com",
"total_leaks": 150,
"open_leaks": 120,
"fixed_leaks": 30,
"leak_types": {
"employee_leaks": 100,
"customer_leaks": 50
},
"employee_leaks": 100,
"customer_leaks": 50,
"recent_activity": {
"last_30_days": 15,
"last_7_days": 3
Expand Down Expand Up @@ -60,26 +55,28 @@ The response provides comprehensive statistics about leaks for the specified dom

## Usage Examples

### Get basic domain stats
### Check domain breach status
```bash
curl -X GET "https://api.projectdiscovery.io/v1/leaks/stats/domain?domain=example.com" \
-H "Authorization: Bearer YOUR_API_KEY"
curl -X GET "https://api.projectdiscovery.io/v1/leaks/stats/domain?domain=example.com"
```

### Get stats with unmasked emails
```bash
curl -X GET "https://api.projectdiscovery.io/v1/leaks/stats/domain?domain=example.com&unmask_email=true" \
-H "Authorization: Bearer YOUR_API_KEY"
```
<Note>
No API key or authentication header is required for this endpoint.
</Note>

## Best Practices
## Use Cases

### Regular Monitoring
- Check domain stats regularly to identify new leaks quickly
- Set up automated alerts when leak counts increase
- Monitor the ratio of open vs fixed leaks
### Quick Breach Check
Use this endpoint to quickly check if a domain has any known credential leaks without requiring authentication.

### Security Integrations
Integrate with your security tools to monitor domains for new leaks and alert when breach counts increase.

### Due Diligence
Check potential partners or vendors for credential exposure as part of your security assessment process.

## Best Practices

### Performance Considerations
- Cache stats data appropriately to avoid excessive API calls
- Use this endpoint for summary data, detailed leak info requires other endpoints
- Cache results appropriately to avoid excessive API calls
- Use this for summary data; detailed leak information requires authenticated endpoints
- Consider rate limiting when building automated monitoring systems
38 changes: 0 additions & 38 deletions api-reference/leaks/get-email-leaks.mdx

This file was deleted.

Loading
Loading