{"docs":{"name":"Password Pusher","info":"\n\u003cp\u003eThe Password Pusher JSON API documentation.\u003c/p\u003e\n\n\u003cp\u003eThis API allows for both anonymous and authenticated access.\u003c/p\u003e\n\n\u003cp\u003eTo authenticate, get your API token from \u003ca href=\"/en/users/token\"\u003ethe API token page\u003c/a\u003e and then apply it in your API calls as request headers:\u003c/p\u003e\n\n\u003cp\u003e‘X-User-Email’: “\u0026lt;email\u0026gt;”\u003c/p\u003e\n\n\u003cp\u003e‘X-User-Token’: “\u0026lt;token\u0026gt;”\u003c/p\u003e\n\n\u003cp\u003eExample:\u003c/p\u003e\n\n\u003cp\u003ecurl -X DELETE -H “X-User-Email: \u0026lt;email\u0026gt;” -H “X-User-Token: \u0026lt;token\u0026gt;” \u003ca href=\"https://pwpush.com/p/fkwjfvhall92.json\"\u003epwpush.com/p/fkwjfvhall92.json\u003c/a\u003e\u003c/p\u003e\n","copyright":"\u0026copy; 2022 Peter Giacomo Lombardo","doc_url":"/api/1.0","api_url":"","resources":{"dashboard":{"doc_url":"/api/1.0/dashboard","id":"dashboard","api_url":"","name":"Dashboard","short_description":"View your previously created pushes.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/1.0/dashboard/active","name":"active","apis":[{"api_url":"/d/active.json","http_method":"GET","short_description":"Retrieve your active pushes.","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eReturns the list of pushes that you previously pushed which are still active.\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":["curl -X GET -H \"X-User-Email: \u003cemail\u003e\" -H \"X-User-Token: MyAPIToken\" https://pwpush.com/d/active.json"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/1.0/dashboard/expired","name":"expired","apis":[{"api_url":"/d/expired.json","http_method":"GET","short_description":"Retrieve your expired pushes.","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eReturns the list of pushes that you previously pushed which have expired.\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":["curl -X GET -H \"X-User-Email: \u003cemail\u003e\" -H \"X-User-Token: MyAPIToken\" https://pwpush.com/d/expired.json"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"passwords":{"doc_url":"/api/1.0/passwords","id":"passwords","api_url":"","name":"Pushes","short_description":"Interact directly with pushes.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/1.0/passwords/show","name":"show","apis":[{"api_url":"/p/:url_token.json","http_method":"GET","short_description":"Retrieve a push.","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eRetrieves a push including it’s payload and details.  If the push is still active, this will burn a view and the transaction will be logged in the push audit log.\u003c/p\u003e\n","errors":[],"params":[{"name":"url_token","full_name":"url_token","description":"\n\u003cp\u003eSecret URL token of a previously created push.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -X GET -H \"X-User-Email: \u003cemail\u003e\" -H \"X-User-Token: MyAPIToken\" https://pwpush.com/p/fk27vnslkd.json"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/1.0/passwords/create","name":"create","apis":[{"api_url":"/p.json","http_method":"POST","short_description":"Create a new push.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"password","full_name":"password","description":"\n\u003cp\u003ePush details\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"payload","full_name":"password[payload]","description":"\n\u003cp\u003eThe password or secret text to share.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"note","full_name":"password[note]","description":"\n\u003cp\u003eIf authenticated, the note to label this push.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expire_after_days","full_name":"password[expire_after_days]","description":"\n\u003cp\u003eExpire secret link and delete after this many days.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"expire_after_views","full_name":"password[expire_after_views]","description":"\n\u003cp\u003eExpire secret link and delete after this many views.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"deletable_by_viewer","full_name":"password[deletable_by_viewer]","description":"\n\u003cp\u003eAllow users to delete passwords once retrieved.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"retrieval_step","full_name":"password[retrieval_step]","description":"\n\u003cp\u003eHelps to avoid chat systems and URL scanners from eating up views.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["curl -X POST -H \"X-User-Email: \u003cemail\u003e\" -H \"X-User-Token: MyAPIToken\" --data \"password[payload]=mypassword\u0026password[expire_after_days]=2\u0026password[expire_after_views]=10\" https://pwpush.com/p.json"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/1.0/passwords/preview","name":"preview","apis":[{"api_url":"/p/:url_token/preview.json","http_method":"GET","short_description":"Helper endpoint to retrieve the fully qualified secret URL of a push.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"url_token","full_name":"url_token","description":"\n\u003cp\u003eSecret URL token of a previously created push.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -X GET -H \"X-User-Email: \u003cemail\u003e\" -H \"X-User-Token: MyAPIToken\" https://pwpush.com/p/fk27vnslkd/preview.json"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/1.0/passwords/audit","name":"audit","apis":[{"api_url":"/p/:url_token/audit.json","http_method":"GET","short_description":"Retrieve the logged views for a push.","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eThis will return array of views including IP, referrer and other such metadata.  The \u003cem\u003esuccessful\u003c/em\u003e field indicates whether the view was made while the push was still active (and not expired).\u003c/p\u003e\n","errors":[],"params":[{"name":"url_token","full_name":"url_token","description":"\n\u003cp\u003eSecret URL token of a previously created push.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -X GET -H \"X-User-Email: \u003cemail\u003e\" -H \"X-User-Token: MyAPIToken\" https://pwpush.com/p/fk27vnslkd/audit.json"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/1.0/passwords/destroy","name":"destroy","apis":[{"api_url":"/p/:url_token.json","http_method":"DELETE","short_description":"Expire a push: delete the payload and expire the secret URL.","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eExpires a push immediately.  Must be authenticated \u0026amp; owner of the push \u003cem\u003eor\u003c/em\u003e the push must have been created with \u003cem\u003edeleteable_by_viewer\u003c/em\u003e.\u003c/p\u003e\n","errors":[],"params":[{"name":"url_token","full_name":"url_token","description":"\n\u003cp\u003eSecret URL token of a previously created push.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["curl -X DELETE -H \"X-User-Email: \u003cemail\u003e\" -H \"X-User-Token: MyAPIToken\" https://pwpush.com/p/fkwjfvhall92.json"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}}}}