{"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; 2011-Present Peter Giacomo Lombardo","doc_url":"/api/1.0","api_url":"","resources":{"file_pushes":{"doc_url":"/api/1.0/file_pushes","id":"file_pushes","api_url":"","name":"File Pushes","short_description":"Interact directly with file pushes.  This feature (and corresponding API) is currently in beta.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/1.0/file_pushes/show","name":"show","apis":[{"api_url":"/f/:url_token.json","http_method":"GET","short_description":"Retrieve a file 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":[],"deprecated":false}],"returns":[],"examples":["curl -X GET -H \"X-User-Email: \u003cemail\u003e\" -H \"X-User-Token: MyAPIToken\" https://pwpush.com/f/fk27vnslkd.json"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/1.0/file_pushes/create","name":"create","apis":[{"api_url":"/f.json","http_method":"POST","short_description":"Create a new file push.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"file_push","full_name":"file_push","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":[],"deprecated":false,"params":[{"name":"payload","full_name":"file_push[payload]","description":"\n\u003cp\u003eThe URL encoded 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":[],"deprecated":false},{"name":"passphrase","full_name":"file_push[passphrase]","description":"\n\u003cp\u003eRequire recipients to enter this passphrase to view the created push.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"note","full_name":"file_push[note]","description":"\n\u003cp\u003eIf authenticated, the URL encoded note for this push.  Visible only to the push creator.\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":[],"deprecated":false},{"name":"expire_after_days","full_name":"file_push[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":[],"deprecated":false},{"name":"expire_after_views","full_name":"file_push[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":[],"deprecated":false},{"name":"deletable_by_viewer","full_name":"file_push[deletable_by_viewer]","description":"\n\u003cp\u003eAllow users to delete the push 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, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"retrieval_step","full_name":"file_push[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, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":["curl -X POST -H \"X-User-Email: \u003cemail\u003e\" -H \"X-User-Token: MyAPIToken\" -F \"file_push[files][]=@/path/to/file/file1.extension\" -F \"file_push[files][]=@/path/to/file/file2.extension\" https://pwpush.com/f.json"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/1.0/file_pushes/preview","name":"preview","apis":[{"api_url":"/f/: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":[],"deprecated":false}],"returns":[],"examples":["curl -X GET -H \"X-User-Email: \u003cemail\u003e\" -H \"X-User-Token: MyAPIToken\" https://pwpush.com/f/fk27vnslkd/preview.json"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/1.0/file_pushes/audit","name":"audit","apis":[{"api_url":"/f/:url_token/audit.json","http_method":"GET","short_description":"Retrieve the audit log 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).  Note that you must be the owner of the push to retrieve the audit log and this call will always return 401 Unauthorized for pushes not owned by the credentials provided.\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":[],"deprecated":false}],"returns":[],"examples":["curl -X GET -H \"X-User-Email: \u003cemail\u003e\" -H \"X-User-Token: MyAPIToken\" https://pwpush.com/f/fk27vnslkd/audit.json"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/1.0/file_pushes/destroy","name":"destroy","apis":[{"api_url":"/f/:url_token.json","http_method":"DELETE","short_description":"Expire a push: delete the files, 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":[],"deprecated":false}],"returns":[],"examples":["curl -X DELETE -H \"X-User-Email: \u003cemail\u003e\" -H \"X-User-Token: MyAPIToken\" https://pwpush.com/f/fkwjfvhall92.json"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/1.0/file_pushes/active","name":"active","apis":[{"api_url":"/f/active.json","http_method":"GET","short_description":"Retrieve your active file pushes.","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eReturns the list of file 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/f/active.json"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/1.0/file_pushes/expired","name":"expired","apis":[{"api_url":"/f/expired.json","http_method":"GET","short_description":"Retrieve your expired file pushes.","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eReturns the list of file 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/f/expired.json"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"passwords":{"doc_url":"/api/1.0/passwords","id":"passwords","api_url":"","name":"Text Pushes","short_description":"Interact directly with text 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.  If the push has a passphrase, provide it in a ?passphrase=xxx GET parameter.\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":[],"deprecated":false}],"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":[],"deprecated":false,"params":[{"name":"payload","full_name":"password[payload]","description":"\n\u003cp\u003eThe URL encoded 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":[],"deprecated":false},{"name":"passphrase","full_name":"password[passphrase]","description":"\n\u003cp\u003eRequire recipients to enter this passphrase to view the created push.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"note","full_name":"password[note]","description":"\n\u003cp\u003eIf authenticated, the URL encoded note for this push.  Visible only to the push creator.\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":[],"deprecated":false},{"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":[],"deprecated":false},{"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":[],"deprecated":false},{"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, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"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, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"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":[],"deprecated":false}],"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 audit log 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).  Note that you must be the owner of the push to retrieve the audit log and this call will always return 401 Unauthorized for pushes not owned by the credentials provided.\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":[],"deprecated":false}],"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":[],"deprecated":false}],"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},{"doc_url":"/api/1.0/passwords/active","name":"active","apis":[{"api_url":"/p/active.json","http_method":"GET","short_description":"Retrieve your active pushes.","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eReturns the list of password 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/p/active.json"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/1.0/passwords/expired","name":"expired","apis":[{"api_url":"/p/expired.json","http_method":"GET","short_description":"Retrieve your expired pushes.","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eReturns the list of password 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/p/expired.json"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"urls":{"doc_url":"/api/1.0/urls","id":"urls","api_url":"","name":"URL Pushes","short_description":"Interact directly with URL pushes.  This feature (and corresponding API) is currently in beta.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/api/1.0/urls/show","name":"show","apis":[{"api_url":"/r/:url_token.json","http_method":"GET","short_description":"Retrieve a URL 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":[],"deprecated":false}],"returns":[],"examples":["curl -X GET -H \"X-User-Email: \u003cemail\u003e\" -H \"X-User-Token: MyAPIToken\" https://pwpush.com/r/fk27vnslkd.json"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/1.0/urls/create","name":"create","apis":[{"api_url":"/r.json","http_method":"POST","short_description":"Create a new URL push.","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"url","full_name":"url","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":[],"deprecated":false,"params":[{"name":"payload","full_name":"url[payload]","description":"\n\u003cp\u003eThe URL encoded URL to redirect to.\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":[],"deprecated":false},{"name":"passphrase","full_name":"url[passphrase]","description":"\n\u003cp\u003eRequire recipients to enter this passphrase to view the created push.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"note","full_name":"url[note]","description":"\n\u003cp\u003eIf authenticated, the URL encoded note for this push.  Visible only to the push creator.\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":[],"deprecated":false},{"name":"expire_after_days","full_name":"url[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":[],"deprecated":false},{"name":"expire_after_views","full_name":"url[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":[],"deprecated":false},{"name":"retrieval_step","full_name":"url[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, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":["curl -X POST -H \"X-User-Email: \u003cemail\u003e\" -H \"X-User-Token: MyAPIToken\" --data \"url[payload]=myurl\u0026url[expire_after_days]=2\u0026url[expire_after_views]=10\" https://pwpush.com/r.json"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/1.0/urls/preview","name":"preview","apis":[{"api_url":"/r/: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":[],"deprecated":false}],"returns":[],"examples":["curl -X GET -H \"X-User-Email: \u003cemail\u003e\" -H \"X-User-Token: MyAPIToken\" https://pwpush.com/r/fk27vnslkd/preview.json"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/1.0/urls/audit","name":"audit","apis":[{"api_url":"/r/:url_token/audit.json","http_method":"GET","short_description":"Retrieve the audit log 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).  Note that you must be the owner of the push to retrieve the audit log and this call will always return 401 Unauthorized for pushes not owned by the credentials provided.\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":[],"deprecated":false}],"returns":[],"examples":["curl -X GET -H \"X-User-Email: \u003cemail\u003e\" -H \"X-User-Token: MyAPIToken\" https://pwpush.com/r/fk27vnslkd/audit.json"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/1.0/urls/destroy","name":"destroy","apis":[{"api_url":"/r/: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":[],"deprecated":false}],"returns":[],"examples":["curl -X DELETE -H \"X-User-Email: \u003cemail\u003e\" -H \"X-User-Token: MyAPIToken\" https://pwpush.com/r/fkwjfvhall92.json"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/1.0/urls/active","name":"active","apis":[{"api_url":"/r/active.json","http_method":"GET","short_description":"Retrieve your active URL pushes.","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eReturns the list of URL 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/r/active.json"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/1.0/urls/expired","name":"expired","apis":[{"api_url":"/r/expired.json","http_method":"GET","short_description":"Retrieve your expired URL pushes.","deprecated":null}],"formats":["json"],"full_description":"\n\u003cp\u003eReturns the list of URL 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/r/expired.json"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}}}}