API v2

The next generation REST API for Password Pusher.

🚀 Beta Release — API v2 is currently in beta. While we’ve made every effort to ensure stability, there may be breaking changes before the final release.

Overview

API v2 is the next generation REST API for Password Pusher, providing a comprehensive interface for creating, retrieving, and managing secure password pushes and requests.

Key Features

  • Bearer Token Authentication — Secure API access with token-based authentication
  • JSON-Only Responses — Consistent JSON format across all endpoints
  • RESTful Design — Intuitive REST endpoints following best practices
  • Pushes & Requests — Full support for one-way pushes and two-way requests
  • Password generator — POST /api/v2/generate for passwords, passphrases, and PINs (count 1–10). OSS defaults come from environment variables; Pro uses workspace or instance policy.
  • Collections Support — Organize and manage pushes in collections
  • Comprehensive Audit Logs — Access detailed audit trails via API

Pagination

Paginated list endpoints (/api/v2/pushes/active, /api/v2/pushes/expired, /api/v2/pushes/:url_token/audit, and the equivalent requests endpoints in Pro) accept:

  • Query parameter: page (optional integer, default 1, valid range 1 to 200)
  • Fixed page size of 50 items

The JSON body is unchanged. Successful responses include pagination metadata in HTTP headers:

Header Description
Link RFC 5988 links (first, last, and when applicable prev / next)
X-Page Current page number
X-Per-Page Page size (50)
X-Total Total matching records
X-Total-Pages Total number of pages

See the in-app documentation at https://pwpush.com/help/api for full endpoint details.

Availability

API v2 is currently available on:

Platform Status
pwpush.com Free, Solo, Team, and Organization (US and EU) ✅ Available
Self-Hosted Pro ✅ Available
Open Source Edition ✅ Available (v2.4.2+)

On hosted Team (including eu.pwpush.com), authorized workspace members can read a request response with GET /api/v2/requests/:url_token once the request is in the ready state. This is not limited to Organization. Combine it with the request.response_received webhook to automate retrieval.

Open Source Edition support for API v2 is available in Password Pusher v2.4.2 and newer.

Documentation

Complete API v2 documentation is available at:

https://pwpush.com/help/api

The documentation includes:

  • Authentication — How to obtain and use API tokens
  • Generate — Passwords, passphrases, and PINs (POST /api/v2/generate)
  • Pushes — Create, retrieve, preview, and expire pushes
  • Requests — Create and manage two-way secure requests
  • Workspaces — List and manage workspaces (where applicable)
  • Error Handling — Standard HTTP status codes and error responses
  • Rate Limits — Usage limits and best practices
  • Complete Examples — Working curl examples for all endpoints

Need the older JSON API? See API v1. It is deprecated and will be removed in the future.

Quick Example

Here’s a quick example of creating a push with API v2:

curl -X POST https://eu.pwpush.com/api/v2/pushes \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "push": {
      "payload": "MySecretPassword123",
      "expire_after_duration": 6,
      "expire_after_views": 3
    }
  }'

API v1 vs v2

Feature API v1 API v2
Authentication Bearer Token Bearer Token
Response Format JSON JSON
Pushes ✅ ✅
Requests Limited ✅ Full Support
Collections ❌ ✅
Audit Logs via API ❌ ✅
Password generator (/api/v2/generate) ❌ ✅
Rate Limiting Basic Advanced

API v1 is deprecated and will be removed in the future. Use API v2 for new integrations. Existing v1 integrations still work today; see the API v1 documentation.

Feedback

We welcome your feedback on API v2! If you encounter any issues or have suggestions, please reach out through our support channels.