Edit video details
Edit details for a single video.
Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYYAPI Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
X-Auth-Email: user@example.comThe previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194ParametersExpand Collapse
params StreamEditParams
Body param: Lists the origins allowed to display the video. Enter allowed origin domains in an array and use * for wildcard subdomains. Empty arrays allow the video to be viewed on any origin.
Body param: A user-defined identifier for the media creator.
Body param: The maximum duration in seconds for a video upload. Can be set for a video that is not yet uploaded to limit its duration. Uploads that exceed the specified duration will fail during processing. A value of -1 means the value is unknown.
Body param: A user modifiable key-value store used to reference other systems of record for managing videos.
Body param: Indicates whether the video can be a accessed using the UID. When set to true, a signed token must be generated with a signing key to view the video.
Body param: Indicates the date and time at which the video will be deleted. Omit the field to indicate no change, or include with a null value to remove an existing scheduled deletion. If specified, must be at least 30 days from upload time.
Body param: The timestamp for a thumbnail image calculated as a percentage value of the video’s duration. To convert from a second-wise timestamp to a percentage, divide the desired timestamp by the total duration of the video. If this value is not set, the default thumbnail image is taken from 0s of the video.
Body param: The unique identifier for the video. Can be used to verify the video being updated.
ReturnsExpand Collapse
type Video struct{…}
Lists the origins allowed to display the video. Enter allowed origin domains in an array and use * for wildcard subdomains. Empty arrays allow the video to be viewed on any origin.
The duration of the video in seconds. A value of -1 means the duration is unknown. The duration becomes available after the upload and before the video is ready.
Input VideoInputOptional
The maximum duration in seconds for a video upload. Can be set for a video that is not yet uploaded to limit its duration. Uploads that exceed the specified duration will fail during processing. A value of -1 means the value is unknown.
A user modifiable key-value store used to reference other systems of record for managing videos.
The video’s preview page URI. This field is omitted until encoding is complete.
PublicDetails VideoPublicDetailsOptionalPublic details for the video including title, share link, channel link, and logo.
Public details for the video including title, share link, channel link, and logo.
Indicates whether the video is playable. The field is empty if the video is not ready for viewing or the live stream is still in progress.
Indicates the time at which the video became playable. The field is empty if the video is not ready for viewing or the live stream is still in progress.
Indicates whether the video can be a accessed using the UID. When set to true, a signed token must be generated with a signing key to view the video.
Indicates the date and time at which the video will be deleted. Omit the field to indicate no change, or include with a null value to remove an existing scheduled deletion. If specified, must be at least 30 days from upload time.
Status VideoStatusOptionalSpecifies a detailed status for a video. If the state is inprogress or error, the step field returns encoding or manifest. If the state is inprogress, pctComplete returns a number between 0 and 100 to indicate the approximate percent of completion. If the state is error, errorReasonCode and errorReasonText provide additional details.
Specifies a detailed status for a video. If the state is inprogress or error, the step field returns encoding or manifest. If the state is inprogress, pctComplete returns a number between 0 and 100 to indicate the approximate percent of completion. If the state is error, errorReasonCode and errorReasonText provide additional details.
Specifies why the video failed to encode. This field is empty if the video is not in an error state. Preferred for programmatic use.
Specifies why the video failed to encode using a human readable error message in English. This field is empty if the video is not in an error state.
State VideoStatusStateOptionalSpecifies the processing status for all quality levels for a video.
Specifies the processing status for all quality levels for a video.