Retrieves 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.
curl -X GET -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/p/fk27vnslkd.json
Param name | Description |
---|---|
url_token
required |
Secret URL token of a previously created push. Validations:
|
curl -X POST -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken"-F "password[payload]=my_secure_payload"-F "password[files][]=@/path/to/file/file1.extension" -F "password[files][]=@/path/to/file/file2.extension" https://pwpush.com/p.json
Param name | Description |
---|---|
password
required |
Push details Validations:
|
password[payload]
required |
The URL encoded password or secret text to share. Validations:
|
password[files]
optional |
File(s) to upload and attach to the push. Validations:
|
password[passphrase]
optional |
Require recipients to enter this passphrase to view the created push. Validations:
|
password[note]
optional , blank allowed |
If authenticated, the URL encoded note for this push. Visible only to the push creator. Validations:
|
password[expire_after_days]
optional |
Expire secret link and delete after this many days. Validations:
|
password[expire_after_views]
optional |
Expire secret link and delete after this many views. Validations:
|
password[deletable_by_viewer]
optional |
Allow users to delete passwords once retrieved. Validations:
|
password[retrieval_step]
optional |
Helps to avoid chat systems and URL scanners from eating up views. Validations:
|
password[kind]
optional |
The kind of push to create. If ‘url’, the generated secret link will 303 redirect the URL in the payload. Defaults to ‘text’. Validations:
|
curl -X GET -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/p/fk27vnslkd/preview.json
Param name | Description |
---|---|
url_token
required |
Secret URL token of a previously created push. Validations:
|
This will return array of views including IP, referrer and other such metadata. 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.
curl -X GET -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/p/fk27vnslkd/audit.json
Param name | Description |
---|---|
url_token
required |
Secret URL token of a previously created push. Validations:
|
Expires a push immediately. Must be authenticated & owner of the push or the push must have been created with deleteable_by_viewer.
curl -X DELETE -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/p/fkwjfvhall92.json
Param name | Description |
---|---|
url_token
required |
Secret URL token of a previously created push. Validations:
|
Returns the list of pushes that you previously pushed which are still active.
curl -X GET -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/p/active.json
Returns the list of pushes that you previously pushed which have expired.
curl -X GET -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/p/expired.json