Paid plans

Set or remove a link password

Paid plans: protect a link with a password, or send null to remove it.

put/links/{slug}/password

Request

  • Base URL: https://putit.online/api/v1
  • URL: https://putit.online/api/v1/links/{slug}/password
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://putit.online/oauth/authorize, token URL https://putit.online/oauth/token, scopes: links:read, links:write, account:read)

Path parameters

slugstring required

Link name, e.g. k3x9pq

Request body

passwordstring nullable required

Visitors must enter this password to open the link; available on plans with password protection.

Response

OK

slugstring required
urlstring required

The public link to share.

status'awaiting_upload' | 'checking' | 'live' | 'in_review' | 'unpublished' | 'publishing' | 'removed' | 'expired' | 'deleted' required

checking = not live yet (poll get_link); live = shareable; unpublished = not published; publishing = will be live soon (poll get_link); in_review = not available right now; removed = removed by moderation (see removed_reason, appeal_url).

status_messagestring required
content_urlstring

Only when live, for sites and single files: where the content itself is served (https://<slug>.putitcdn.com/…). Share url instead; it always works.

checkout_urlstring

Only with status unpublished: the page where the uploader can publish this link.

removed_reasonstring

Only with status removed: why, in plain words.

removed_categorystring nullable

Only with status removed: the moderation category (malware, phishing, explicit, …); null when not disclosed.

appeal_urlstring

Only with status removed: mailto link to appeal to abuse@putit.online.

kindstring required

html | site | file | bundle | pending

titlestring required
size_bytesnumber required
file_countnumber required
viewsnumber nullable required

View count; null when the link's account plan has no view counts, or the link has no account.

permanentboolean required
password_protectedboolean required
created_atstring required
expires_atstring nullable required

ISO time the link stops working; null for permanent links.

manage_urlstring

Private page to manage/delete the link. Only returned on creation; keep it secret.

manage_tokenstring

Secret token returned on creation for every new link (keep it secret). Anonymous callers pass it to get_link/delete_link; a link in an account is managed by that account instead.

Changes

No recorded changes to this operation across all 1 revision of this API.