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
| Type | keys list values |
|---|---|
| All files | Built-in key original the asset original file |
| Image files | Built-in keys: deepzoom and/or all the custom conversion keys setup in account settings |
| Video files | Built-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.
Request
Responses
- 200
- 400
- 401
- 403
- 500
Successful operation - change queued
Bad request - keys missing or empty
Unauthorized - Invalid or missing authentication
Forbidden - Insufficient permissions
Internal server error