Notifications Runs

Unlock leaks from a notification run

Changed on

Unlock leaks that belong to a specific notification run. You can optionally filter by search and is_email, and cap the number of new unlocks with max. The effective limit is capped by your available points.

Behavior

  • Only items not previously unlocked in this run are attempted.
  • Points are charged only for newly unlocked items.
  • The response contains the final unlocked state for the requested IDs.

Errors

  • 400 No leaks for this run, all data already unlocked, or no data matches the search.
  • 401 Authentication required, or invalid/expired API key.
  • 403 The target monitored by this run is blocked.
  • 404 Run not found.
  • 422 Request validation error.
post/notification_runs/{run_id}/leaks/unlock

Request

Path parameters

run_idinteger required

ID of the notification run.

Query parameters

maxinteger nullable

Max items to unlock (capped by your available points).

searchstring nullable

Optional free-text filter on URL or username.

is_emailboolean nullable

Filter by identifier type: true=emails, false=usernames, null=both.

list_idinteger nullable

Optional unlocked-list ID assigned to newly unlocked items.

Response

Leaks unlocked successfully.

Example response

[
  {
    "added_at": "2025-01-15T10:30:00Z",
    "id": "3f1a9c2b7e",
    "is_email": true,
    "password": "P@ssw0rd123",
    "password_strength": 6,
    "status": "new",
    "unlocked": true,
    "url": "https://example.com/login",
    "username": "john.doe@example.com"
  }
]

Changes

    • info

      added to the response property anyOf list for the response status

    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional query request parameter list_id

    • info

      added to the response property anyOf list for the response status