File Pushes
Interact directly with file pushes. This feature (and corresponding API) is currently in beta.

>>>

GET /f/:url_token.json
Retrieve a file push.

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.

Supported Formats

json

Examples

curl -X GET -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/f/fk27vnslkd.json

Params

Param name Description
url_token
required

Secret URL token of a previously created push.

Validations:

  • Must be a String
>>>

POST /f.json
Create a new file push.

Supported Formats

json

Examples

curl -X POST -H "X-User-Email: <email>" -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

Params

Param name Description
file_push
required

Push details

Validations:

  • Must be a Hash
file_push[payload]
required

The URL encoded secret text to share.

Validations:

  • Must be a String
file_push[passphrase]
optional

Require recipients to enter this passphrase to view the created push.

Validations:

  • Must be a String
file_push[note]
optional , blank allowed

If authenticated, the URL encoded note for this push. Visible only to the push creator.

Validations:

  • Must be a String
file_push[expire_after_days]
optional

Expire secret link and delete after this many days.

Validations:

  • Must be a Integer
file_push[expire_after_views]
optional

Expire secret link and delete after this many views.

Validations:

  • Must be a Integer
file_push[deletable_by_viewer]
optional

Allow users to delete the push once retrieved.

Validations:

  • Must be one of: true, false.
file_push[retrieval_step]
optional

Helps to avoid chat systems and URL scanners from eating up views.

Validations:

  • Must be one of: true, false.
>>>

GET /f/:url_token/preview.json
Helper endpoint to retrieve the fully qualified secret URL of a push.

Supported Formats

json

Examples

curl -X GET -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/f/fk27vnslkd/preview.json

Params

Param name Description
url_token
required

Secret URL token of a previously created push.

Validations:

  • Must be a String
>>>

GET /f/:url_token/audit.json
Retrieve the audit log for a push.

This will return array of views including IP, referrer and other such metadata. The successful 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.

Supported Formats

json

Examples

curl -X GET -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/f/fk27vnslkd/audit.json

Params

Param name Description
url_token
required

Secret URL token of a previously created push.

Validations:

  • Must be a String
>>>

DELETE /f/:url_token.json
Expire a push: delete the files, payload and expire the secret URL.

Expires a push immediately. Must be authenticated & owner of the push or the push must have been created with deleteable_by_viewer.

Supported Formats

json

Examples

curl -X DELETE -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/f/fkwjfvhall92.json

Params

Param name Description
url_token
required

Secret URL token of a previously created push.

Validations:

  • Must be a String
>>>

GET /f/active.json
Retrieve your active file pushes.

Returns the list of file pushes that you previously pushed which are still active.

Supported Formats

json

Examples

curl -X GET -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/f/active.json
>>>

GET /f/expired.json
Retrieve your expired file pushes.

Returns the list of file pushes that you previously pushed which have expired.

Supported Formats

json

Examples

curl -X GET -H "X-User-Email: <email>" -H "X-User-Token: MyAPIToken" https://pwpush.com/f/expired.json