Do not miss any v2 - Secrets API (stable) changes, ever again

Subscribe to the v2 - Secrets API (stable) 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
20 structure changes including:
20 Modifications
Modified 20 Breaking
GET /api/v2/guest/receipt/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • secret_ttl, receipt_ttl, lifespan, expiration_in_seconds, share_path, share_url, expiration properties Modified
          • Properties are now required
            Breaking
      • details property Modified
        • display_lines property Modified
          • Property is now required
            Breaking
GET /api/v2/guest/secret/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • secret_ttl, lifespan properties Modified
          • Properties are now required
            Breaking
      • details property Modified
        • display_lines property Modified
          • Property is now required
            Breaking
GET /api/v2/private/recent
  • Response
  • 200 response Modified
    • application/json content type Modified
      • records property Modified
        • secret_ttl property Modified
          • Removing polymorphism is always breaking
            Breaking
        • receipt_ttl, lifespan properties Modified
          • Properties are now required
      • details property Modified
        • received, notreceived properties Modified
GET /api/v2/private/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • secret_ttl, receipt_ttl, lifespan, expiration_in_seconds, share_path, share_url, expiration properties Modified
          • Properties are now required
      • details property Modified
        • display_lines property Modified
          • Property is now required
GET /api/v2/receipt/recent
  • Response
  • 200 response Modified
    • application/json content type Modified
      • records property Modified
        • secret_ttl property Modified
          • Removing polymorphism is always breaking
            Breaking
        • receipt_ttl, lifespan properties Modified
          • Properties are now required
            Breaking
      • details property Modified
        • received, notreceived properties Modified
GET /api/v2/receipt/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • secret_ttl, receipt_ttl, lifespan, expiration_in_seconds, share_path, share_url, expiration properties Modified
          • Properties are now required
            Breaking
      • details property Modified
        • display_lines property Modified
          • Property is now required
            Breaking
GET /api/v2/secret/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • secret_ttl, lifespan properties Modified
          • Properties are now required
            Breaking
      • details property Modified
        • display_lines property Modified
          • Property is now required
            Breaking
GET /api/v2/secret/{identifier}/status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • alternative Modified
        • object-2 alternative Modified
PATCH /api/v2/private/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • secret_ttl, receipt_ttl, lifespan, expiration_in_seconds, share_path, share_url, expiration properties Modified
          • Properties are now required
      • details property Modified
        • display_lines property Modified
          • Property is now required
PATCH /api/v2/receipt/{identifier}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • secret_ttl, receipt_ttl, lifespan, expiration_in_seconds, share_path, share_url, expiration properties Modified
          • Properties are now required
            Breaking
      • details property Modified
        • display_lines property Modified
          • Property is now required
            Breaking
POST /api/v2/guest/receipt/{identifier}/burn
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • secret_ttl, receipt_ttl, lifespan, expiration_in_seconds, share_path, share_url, expiration properties Modified
          • Properties are now required
            Breaking
      • details property Modified
        • display_lines property Modified
          • Property is now required
            Breaking
POST /api/v2/guest/secret/conceal
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt, secret properties Modified
        • share_domain property Modified
          • Property is now required
            Breaking
POST /api/v2/guest/secret/generate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt, secret properties Modified
        • share_domain property Modified
          • Property is now required
            Breaking
POST /api/v2/guest/secret/{identifier}/reveal
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • secret_ttl, lifespan properties Modified
          • Properties are now required
            Breaking
      • details property Modified
        • display_lines property Modified
          • Property is now required
            Breaking
POST /api/v2/private/{identifier}/burn
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • secret_ttl, receipt_ttl, lifespan, expiration_in_seconds, share_path, share_url, expiration properties Modified
          • Properties are now required
      • details property Modified
        • display_lines property Modified
          • Property is now required
POST /api/v2/receipt/{identifier}/burn
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • secret_ttl, receipt_ttl, lifespan, expiration_in_seconds, share_path, share_url, expiration properties Modified
          • Properties are now required
            Breaking
      • details property Modified
        • display_lines property Modified
          • Property is now required
            Breaking
POST /api/v2/secret/conceal
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt, secret properties Modified
        • share_domain property Modified
          • Property is now required
            Breaking
POST /api/v2/secret/generate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • receipt, secret properties Modified
        • share_domain property Modified
          • Property is now required
            Breaking
POST /api/v2/secret/status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • records property Modified
POST /api/v2/secret/{identifier}/reveal
  • Response
  • 200 response Modified
    • application/json content type Modified
      • record property Modified
        • secret_ttl, lifespan properties Modified
          • Properties are now required
            Breaking
      • details property Modified
        • display_lines property Modified
          • Property is now required
            Breaking