POST /f.json
Create a new file push.

File Push Creation ↑

Creates a new file push with the given payload and files.

Example Request ↑

curl -X POST \
  -H "Authorization: Bearer MyAPIToken" \
  -F "file_push[files][]=@/path/to/file/file1.extension" \
  -F "file_push[files][]=@/path/to/file/file2.extension" \
  https://pwpush.com/f.json

Example Response ↑

{
  "url_token": "quyul5r5w18",
  "created_at": "2023-10-20T15:32:01Z",
  "expire_after_days": 2,
  "expire_after_views": 5,
  ...
}

Supported Formats

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.