Skip to main content

Set Public Access

POST 
/api/v1/assets/:asset_id/content/set_public_access

This API can be used to set public-read access to a file or its conversions in the Cloud Storage (such as S3).

warning

This makes the file publicly accessible in the cloud storage. Do this only if you intend to let everyone in the world access the file.

Possible Key values

Typekeys list values
All filesBuilt-in key original the asset original file
Image filesBuilt-in keys: deepzoom and/or all the custom conversion keys setup in account settings
Video filesBuilt-in keys: 360p-video, 360p-wm-video, 480p-video, 480p-wm-video, 720p-video, 720p-wm-video, 1080p-video, 1080p-wm-video and/or hls-video (note that *-wm-video keys are for watermarked videos)

To make the files private again, use Remove Public Access.

HTTP Response​

200 when the change is queued. The storage permission is updated in the background, usually within seconds. 400 if keys is missing or empty.

For video transcode keys (*-video), the response also carries links: the permanent public_url (direct MP4, or the HLS playlist.m3u8) and embed_url (a hosted player page for an <iframe>) each one serves once the change has applied. The same links appear on the conversion in Get Data while it is public.

Request​

Responses​

Successful operation - change queued