Do not miss any v3 - Secrets API (preview) changes, ever again

Subscribe to the v3 - Secrets API (preview) changelog to be up to date on recent changes.

RSS

1 day ago

main
2026-11-04
Compare
2026-11-04

API structure has changed

Next change
18 structure changes including:
18 Modifications
Modified 18 Breaking
GET /api/v3/guest/receipt/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • expiration, share_path, share_url properties Modified
          • Properties are now required
            Breaking
      • details property Modified
        • has_passphrase, can_decrypt properties Modified
          • Properties are now required
            Breaking
GET /api/v3/guest/secret/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • details property Modified
        • one_liner property Modified
          • Property is now required
            Breaking
GET /api/v3/receipt/recent
  • Response
  • 200 response Modified
    • application/json content type Modified
      • records property Modified
      • details property Modified
        • revealed_receipts, pending_receipts properties Modified
GET /api/v3/receipt/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • expiration, share_path, share_url properties Modified
          • Properties are now required
            Breaking
      • details property Modified
        • has_passphrase, can_decrypt properties Modified
          • Properties are now required
            Breaking
GET /api/v3/secret/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • details property Modified
        • one_liner property Modified
          • Property is now required
            Breaking
GET /api/v3/secret/{identifier}/status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • details property Modified
        • one_liner property Modified
          • Property is now required
            Breaking
PATCH /api/v3/receipt/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • expiration, share_path, share_url properties Modified
          • Properties are now required
            Breaking
      • details property Modified
        • has_passphrase, can_decrypt properties Modified
          • Properties are now required
            Breaking
POST /api/incoming/secret
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt, secret properties Modified
      • details property Modified
POST /api/v3/feedback
  • Response
  • 200 response Modified
    • application/json content type Modified
      • details property Modified
        • received property Modified
          • Property is now required
            Breaking
POST /api/v3/guest/receipt/{identifier}/burn
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • expiration, share_path, share_url properties Modified
          • Properties are now required
            Breaking
      • details property Modified
        • has_passphrase, can_decrypt properties Modified
          • Properties are now required
            Breaking
POST /api/v3/guest/receipts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • records property Modified
      • details property Modified
        • revealed_receipts, pending_receipts properties Modified
POST /api/v3/guest/secret/conceal
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt property Modified
        • share_domain property Modified
          • Property is now required
            Breaking
POST /api/v3/guest/secret/generate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt property Modified
        • share_domain property Modified
          • Property is now required
            Breaking
POST /api/v3/guest/secret/{identifier}/reveal
  • Response
  • 200 response Modified
    • application/json content type Modified
      • details property Modified
        • one_liner property Modified
          • Property is now required
            Breaking
POST /api/v3/receipt/{identifier}/burn
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • expiration, share_path, share_url properties Modified
          • Properties are now required
            Breaking
      • details property Modified
        • has_passphrase, can_decrypt properties Modified
          • Properties are now required
            Breaking
POST /api/v3/secret/conceal
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt property Modified
        • share_domain property Modified
          • Property is now required
            Breaking
POST /api/v3/secret/generate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt property Modified
        • share_domain property Modified
          • Property is now required
            Breaking
POST /api/v3/secret/{identifier}/reveal
  • Response
  • 200 response Modified
    • application/json content type Modified
      • details property Modified
        • one_liner property Modified
          • Property is now required
            Breaking