API Reference
Core Platform API
- Overview
- Errors
- GETList Video Libraries
- POSTAdd Video Library
- GETGet Video Library
- POSTUpdate Video Library
- DELDelete Video Library
- GETGet Languages
- POSTReset API Key
- POSTReset API Key
- POSTReset Read Only API Key
- POSTReset Read Only API Key
- POSTAdd Allowed Referer
- POSTRemove Allowed Referer
- POSTAdd Blocked Referer
- POSTRemove Blocked Referer
- PUTAdd Watermark
- DELDelete Watermark
- GETGet Video Library Transcribing Statistics
- GETGet Video Library DRM Statistics
- GET
Origin Errors API
Storage API
Stream API
Shield API
Edge Scripting API
curl --request POST \
--url https://api.bunny.net/videolibrary/{id} \
--header 'AccessKey: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"RtmpOutputs": [
{
"Endpoint": "<string>",
"StreamKey": "<string>"
}
],
"Name": "<string>",
"CustomHTML": "<string>",
"PlayerKeyColor": "<string>",
"EnableTokenAuthentication": true,
"EnableTokenIPVerification": true,
"ResetToken": true,
"WatermarkPositionLeft": 123,
"WatermarkPositionTop": 123,
"WatermarkWidth": 123,
"WatermarkHeight": 123,
"EnabledResolutions": "<string>",
"ViAiPublisherId": "<string>",
"VastTagUrl": "<string>",
"WebhookUrl": "<string>",
"CaptionsFontSize": 123,
"CaptionsFontColor": "<string>",
"CaptionsBackground": "<string>",
"UILanguage": "<string>",
"AllowEarlyPlay": true,
"PlayerTokenAuthenticationEnabled": true,
"BlockNoneReferrer": true,
"EnableMP4Fallback": true,
"KeepOriginalFiles": true,
"AllowDirectPlay": true,
"EnableDRM": true,
"DrmVersion": "Basic",
"Controls": "<string>",
"PlaybackSpeeds": "<string>",
"Bitrate240p": 123,
"Bitrate360p": 123,
"Bitrate480p": 123,
"Bitrate720p": 123,
"Bitrate1080p": 123,
"Bitrate1440p": 123,
"Bitrate2160p": 123,
"ShowHeatmap": true,
"EnableContentTagging": true,
"FontFamily": "<string>",
"EnableTranscribing": true,
"EnableTranscribingTitleGeneration": true,
"EnableTranscribingDescriptionGeneration": true,
"EnableTranscribingChaptersGeneration": true,
"EnableTranscribingMomentsGeneration": true,
"TranscribingCaptionLanguages": [
"<string>"
],
"EnableCaptionsInPlaylist": true,
"RememberPlayerPosition": true,
"EnableMultiAudioTrackSupport": true,
"UseSeparateAudioStream": true,
"JitEncodingEnabled": true,
"EncodingTier": "Free",
"OutputCodecs": "<string>",
"AppleFairPlayDrm": {
"Enabled": true
},
"GoogleWidevineDrm": {
"Enabled": true,
"SdOnlyForL3": true,
"MinClientSecurityLevel": "None"
},
"PlayerVersion": 123,
"RemoveMetadataFromFallbackVideos": true,
"ScaleVideoUsingBothDimensions": true,
"ExposeOriginals": true,
"ExposeVideoMetadata": true
}
'{
"Id": 123,
"VideoCount": 123,
"StorageUsage": 123,
"DateCreated": "2023-11-07T05:31:56Z",
"HasWatermark": true,
"WatermarkPositionLeft": 123,
"WatermarkPositionTop": 123,
"WatermarkWidth": 123,
"PullZoneId": 123,
"StorageZoneId": 123,
"WatermarkHeight": 123,
"CaptionsFontSize": 123,
"PlayerTokenAuthenticationEnabled": true,
"BlockNoneReferrer": true,
"EnableMP4Fallback": true,
"KeepOriginalFiles": true,
"AllowDirectPlay": true,
"EnableDRM": true,
"Bitrate240p": 123,
"Bitrate360p": 123,
"Bitrate480p": 123,
"Bitrate720p": 123,
"Bitrate1080p": 123,
"Bitrate1440p": 123,
"Bitrate2160p": 123,
"ShowHeatmap": true,
"EnableContentTagging": true,
"WatermarkVersion": 123,
"EnableTranscribing": true,
"EnableTranscribingTitleGeneration": true,
"EnableTranscribingDescriptionGeneration": true,
"EnableTranscribingChaptersGeneration": true,
"EnableTranscribingMomentsGeneration": true,
"RememberPlayerPosition": true,
"EnableMultiAudioTrackSupport": true,
"UseSeparateAudioStream": true,
"JitEncodingEnabled": true,
"MonthlyChargesTranscribing": 123,
"MonthlyChargesPremiumEncoding": 123,
"MonthlyChargesEnterpriseDrm": 123,
"PlayerVersion": 123,
"RemoveMetadataFromFallbackVideos": true,
"ScaleVideoUsingBothDimensions": true,
"ExposeOriginals": true,
"ExposeVideoMetadata": true,
"Name": "<string>",
"ReplicationRegions": [
"<string>"
],
"ApiKey": "<string>",
"ReadOnlyApiKey": "<string>",
"EnabledResolutions": "<string>",
"ViAiPublisherId": "<string>",
"VastTagUrl": "<string>",
"WebhookUrl": "<string>",
"CaptionsFontColor": "<string>",
"CaptionsBackground": "<string>",
"UILanguage": "<string>",
"AllowEarlyPlay": true,
"AllowedReferrers": [
"<string>"
],
"BlockedReferrers": [
"<string>"
],
"DrmVersion": "Basic",
"AppleFairPlayDrm": {
"Enabled": true,
"CertificateId": 123,
"CertificateExpirationDate": "2023-11-07T05:31:56Z",
"Provider": "<string>"
},
"GoogleWidevineDrm": {
"Enabled": true,
"SdOnlyForL3": true,
"CertificateId": 123,
"CertificateExpirationDate": "2023-11-07T05:31:56Z",
"Provider": "<string>",
"MinClientSecurityLevel": "None"
},
"ApiAccessKey": "<string>",
"PullZoneType": "Premium",
"CustomHTML": "<string>",
"Controls": "<string>",
"PlaybackSpeeds": "<string>",
"PlayerKeyColor": "<string>",
"FontFamily": "<string>",
"TranscribingCaptionLanguages": [
"<string>"
],
"EnableCaptionsInPlaylist": true,
"EncodingTier": "Free",
"OutputCodecs": "<string>",
"DrmBasePriceOverride": 123,
"DrmCostPerLicenseOverride": 123,
"TranscribingPriceOverride": 123,
"PremiumEncodingPriceOverride": 123,
"FeatureFlags": "<string>"
}Update Video Library
curl --request POST \
--url https://api.bunny.net/videolibrary/{id} \
--header 'AccessKey: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"RtmpOutputs": [
{
"Endpoint": "<string>",
"StreamKey": "<string>"
}
],
"Name": "<string>",
"CustomHTML": "<string>",
"PlayerKeyColor": "<string>",
"EnableTokenAuthentication": true,
"EnableTokenIPVerification": true,
"ResetToken": true,
"WatermarkPositionLeft": 123,
"WatermarkPositionTop": 123,
"WatermarkWidth": 123,
"WatermarkHeight": 123,
"EnabledResolutions": "<string>",
"ViAiPublisherId": "<string>",
"VastTagUrl": "<string>",
"WebhookUrl": "<string>",
"CaptionsFontSize": 123,
"CaptionsFontColor": "<string>",
"CaptionsBackground": "<string>",
"UILanguage": "<string>",
"AllowEarlyPlay": true,
"PlayerTokenAuthenticationEnabled": true,
"BlockNoneReferrer": true,
"EnableMP4Fallback": true,
"KeepOriginalFiles": true,
"AllowDirectPlay": true,
"EnableDRM": true,
"DrmVersion": "Basic",
"Controls": "<string>",
"PlaybackSpeeds": "<string>",
"Bitrate240p": 123,
"Bitrate360p": 123,
"Bitrate480p": 123,
"Bitrate720p": 123,
"Bitrate1080p": 123,
"Bitrate1440p": 123,
"Bitrate2160p": 123,
"ShowHeatmap": true,
"EnableContentTagging": true,
"FontFamily": "<string>",
"EnableTranscribing": true,
"EnableTranscribingTitleGeneration": true,
"EnableTranscribingDescriptionGeneration": true,
"EnableTranscribingChaptersGeneration": true,
"EnableTranscribingMomentsGeneration": true,
"TranscribingCaptionLanguages": [
"<string>"
],
"EnableCaptionsInPlaylist": true,
"RememberPlayerPosition": true,
"EnableMultiAudioTrackSupport": true,
"UseSeparateAudioStream": true,
"JitEncodingEnabled": true,
"EncodingTier": "Free",
"OutputCodecs": "<string>",
"AppleFairPlayDrm": {
"Enabled": true
},
"GoogleWidevineDrm": {
"Enabled": true,
"SdOnlyForL3": true,
"MinClientSecurityLevel": "None"
},
"PlayerVersion": 123,
"RemoveMetadataFromFallbackVideos": true,
"ScaleVideoUsingBothDimensions": true,
"ExposeOriginals": true,
"ExposeVideoMetadata": true
}
'{
"Id": 123,
"VideoCount": 123,
"StorageUsage": 123,
"DateCreated": "2023-11-07T05:31:56Z",
"HasWatermark": true,
"WatermarkPositionLeft": 123,
"WatermarkPositionTop": 123,
"WatermarkWidth": 123,
"PullZoneId": 123,
"StorageZoneId": 123,
"WatermarkHeight": 123,
"CaptionsFontSize": 123,
"PlayerTokenAuthenticationEnabled": true,
"BlockNoneReferrer": true,
"EnableMP4Fallback": true,
"KeepOriginalFiles": true,
"AllowDirectPlay": true,
"EnableDRM": true,
"Bitrate240p": 123,
"Bitrate360p": 123,
"Bitrate480p": 123,
"Bitrate720p": 123,
"Bitrate1080p": 123,
"Bitrate1440p": 123,
"Bitrate2160p": 123,
"ShowHeatmap": true,
"EnableContentTagging": true,
"WatermarkVersion": 123,
"EnableTranscribing": true,
"EnableTranscribingTitleGeneration": true,
"EnableTranscribingDescriptionGeneration": true,
"EnableTranscribingChaptersGeneration": true,
"EnableTranscribingMomentsGeneration": true,
"RememberPlayerPosition": true,
"EnableMultiAudioTrackSupport": true,
"UseSeparateAudioStream": true,
"JitEncodingEnabled": true,
"MonthlyChargesTranscribing": 123,
"MonthlyChargesPremiumEncoding": 123,
"MonthlyChargesEnterpriseDrm": 123,
"PlayerVersion": 123,
"RemoveMetadataFromFallbackVideos": true,
"ScaleVideoUsingBothDimensions": true,
"ExposeOriginals": true,
"ExposeVideoMetadata": true,
"Name": "<string>",
"ReplicationRegions": [
"<string>"
],
"ApiKey": "<string>",
"ReadOnlyApiKey": "<string>",
"EnabledResolutions": "<string>",
"ViAiPublisherId": "<string>",
"VastTagUrl": "<string>",
"WebhookUrl": "<string>",
"CaptionsFontColor": "<string>",
"CaptionsBackground": "<string>",
"UILanguage": "<string>",
"AllowEarlyPlay": true,
"AllowedReferrers": [
"<string>"
],
"BlockedReferrers": [
"<string>"
],
"DrmVersion": "Basic",
"AppleFairPlayDrm": {
"Enabled": true,
"CertificateId": 123,
"CertificateExpirationDate": "2023-11-07T05:31:56Z",
"Provider": "<string>"
},
"GoogleWidevineDrm": {
"Enabled": true,
"SdOnlyForL3": true,
"CertificateId": 123,
"CertificateExpirationDate": "2023-11-07T05:31:56Z",
"Provider": "<string>",
"MinClientSecurityLevel": "None"
},
"ApiAccessKey": "<string>",
"PullZoneType": "Premium",
"CustomHTML": "<string>",
"Controls": "<string>",
"PlaybackSpeeds": "<string>",
"PlayerKeyColor": "<string>",
"FontFamily": "<string>",
"TranscribingCaptionLanguages": [
"<string>"
],
"EnableCaptionsInPlaylist": true,
"EncodingTier": "Free",
"OutputCodecs": "<string>",
"DrmBasePriceOverride": 123,
"DrmCostPerLicenseOverride": 123,
"TranscribingPriceOverride": 123,
"PremiumEncodingPriceOverride": 123,
"FeatureFlags": "<string>"
}Authorizations
API Access Key authorization header
Path Parameters
Body
Up to 4 default RTMP outputs for live streams
Show child attributes
Show child attributes
(Optional) Sets name of the video library
(Optional) Sets the player custom HTML code
(Optional) Sets the player key control color
(Optional) Determines if the token authentication should be enabled
(Optional) Determines if the token IP verification should be enabled
(Optional) Set to true to reset the CDN and embed view token key
(Optional) Sets the left offset of the watermark position (in %)
(Optional) Sets the top offset of the watermark position (in %)
(Optional) Sets the width of the watermark (in %)
(Optional) Sets the height of the watermark (in %)
(Optional) Sets the enabled resolutions for the transcoding. At least one resolution should be enabled. Possible values: 240p, 360p, 480p, 720p, 1080p, 1440p, 2160p
(Optional) Sets the vi.ai publisher ID
(Optional) Sets the Vast tag URL
(Optional) Sets the webhook API url
(Optional) Sets the captions display font size
(Optional) Sets the captions display font color
(Optional) Sets the captions display background color
(Optional) Sets the UI language of the video player.
(Optional) Determines if the Early-Play feature should be enabled. Enabling this will enable Expose Originals.
(Optional) Determines if the token authentication should be enabled.
(Optional) Determines if requests without a referer should be blocked.
(Optional) Determines if MP4 fallback should be enabled for this library.
(Optional) Determines if the original file should be kept after the video is processed.
(Optional) Determines if direct play URLs should be enabled for the library
(Optional) Determines if MediaCage DRM should be enabled for this library
(Optional) Determines MediaCage DRM version to be used for this library
Basic, Enterprise, BasicV2 "Basic"
(Optional) The comma separated list of controls that will be displayed in the video player. Possible values: play-large, play, progress, current-time, mute, volume, captions, settings, pip, airplay, fullscreen.
(Optional) The comma separated list of playback speeds that will be available in the video player. Possible values: 0.25,0.5,0.75,1.0,1.25,1.5,1.75,2.0,2.5,3,3.5,4
(Optional) The bitrate used for encoding 240p videos
(Optional) The bitrate used for encoding 360p videos
(Optional) The bitrate used for encoding 480p videos
(Optional) The bitrate used for encoding 720p videos
(Optional) The bitrate used for encoding 1080p videos
(Optional) The bitrate used for encoding 1440p videos
(Optional) The bitrate used for encoding 2160p videos
(Optional) Determines if the video watch heatmap should be displayed in the player.
(Optional) Determines if content tagging should be enabled for this library.
(Optional) The captions font family.
(Optional) Determines if the automatic audio transcribing is currently enabled for this zone.
(Optional) Determines if automatic transcribing title generation is currently enabled.
(Optional) Determines if automatic transcribing description generation is currently enabled.
(Optional) Determines if automatic transcribing chapters generation is currently enabled.
(Optional) Determines if automatic transcribing moments generation is currently enabled.
(Optional) The list of languages that the captions will be automatically transcribed to.
(Optional) Determines if any associated captions will be automatically signaled in the HLS master playlist via EXT-X-MEDIA tags, allowing client players to show captions.
(Optional) Determines if the player will automatically remember the playback position.
(Optional) Determines if multiple output audio track support is enabled on video library.
(Optional) Determines whether output audio stream should be split from video stream segments.
(Optional) Determines whether JIT encoding should be used for the library. Supported in premium encoding only.
(Optional) Defines encoding tier to be used with video library. premium is a paid tier that offers either JIT encoding or prioritized encoding and extra codec support.
Free, Premium "Free"
(Optional) Specifies which video codecs are used for encoding, provided as a comma-separated (CSV) string. Free encoding tier supports only x264. A premium encoding tier adds support for vp9, hevc, and av1.
(Optional) Configure Apple FairPlay DRM. Works only if Enterprise DRM is set up.
Show child attributes
Show child attributes
(Optional) Configure Google Widevine DRM. Works only if Enterprise DRM is set up.
Show child attributes
Show child attributes
(Optional) Sets player version used for this library
(Optional) Marks whether all potential video metadata should be removed from the fallback files
(Optional) Marks whether videos should be scaled using both dimensions. Prevents videos being upscaled or unexpected aspect ratio changes.
(Optional) Marks whether original video files should be exposed via CDN. Originals are not protected by DRM. Enabling Early-Play will enable this.
(Optional) Marks whether video metadata in form of schema meta tags and LD+JSON should be exposed.
Response
The requested video library has been successfuly deleted
The number of videos in the video library
The total amount of storage used by the library
The date when the video library was created
Determines if the video library has a watermark configured
The left offset of the watermark position (in %)
The top offset of the watermark position (in %)
The width of the watermark (in %)
The ID of the connected underlying pull zone
The ID of the connected underlying storage zone
The height of the watermark (in %)
The captions display font size
Determines if the player token authentication is enabled
Determines if the requests without a referrer are blocked
Determines if the MP4 fallback feature is enabled
Determines if the original video files should be stored after encoding
Determines direct play URLs are enabled for the library
Determines if the DRM is enabled
The bitrate used for encoding 240p videos
The bitrate used for encoding 360p videos
The bitrate used for encoding 480p videos
The bitrate used for encoding 720p videos
The bitrate used for encoding 1080p videos
The bitrate used for encoding 1440p videos
The bitrate used for encoding 2160p videos
Determines if the video watch heatmap should be displayed in the player.
Determines if content tagging should be enabled for this library.
Determines if the automatic audio transcribing is currently enabled for this zone.
Determines if automatic transcribing title generation is currently enabled.
Determines if automatic transcribing description generation is currently enabled.
Determines if automatic transcribing chapters generation is currently enabled.
Determines if automatic transcribing moments generation is currently enabled.
Determines if the player will automatically remember the playback position.
Determines if multiple output audio track support is enabled on video library.
Determines whether output audio stream should be split from video stream segments.
Determines whether JIT encoding should be used for the library. Supported in premium encoding only.
Marks whether all potential video metadata should be removed from the fallback files. Default false.
Marks whether videos should be scaled using both dimensions. Prevents videos being upscaled or unexpected aspect ratio changes. Default true.
Marks whether original video files should be exposed via CDN.
Marks whether video metadata in form of schema meta tags and LD+JSON should be exposed.
The name of the Video Library.
The geo-replication regions of the underlying storage zone
The API key used for authenticating with the video library
The read-only API key used for authenticating with the video library
The comma separated list of enabled resolutions
The vi.ai publisher id for advertising configuration
The URL of the VAST tag endpoint for advertising configuration
The webhook URL of the video library
The captions display font color
The captions display background color
The UI language of the player
Determines if the Early-Play feature is enabled
The list of allowed referrer domains allowed to access the library
The list of blocked referrer domains blocked from accessing the library
DRM version (basic or enterprise)
Basic, Enterprise, BasicV2 "Basic"
Described Apple FairPlay DRM
Show child attributes
Show child attributes
Describes Google Widevine DRM
Show child attributes
Show child attributes
The type of the pull zone attached. Premium = 0, Volume = 1
Premium, Volume "Premium"
The custom HTMl that is added into the head of the HTML player.
The list of controls on the video player.
The list of playback speeds available in the video player.
The key color of the player.
The captions font family.
The list of languages that the captions will be automatically transcribed to.
Determines if any associated captions will be automatically signaled in the HLS master playlist via EXT-X-MEDIA tags, allowing client players to show captions.
Defines encoding tier to be used with video library. premium is a paid tier that offers either JIT encoding or prioritized encoding and extra codec support.
Free, Premium "Free"
Specifies which video codecs are used for encoding, provided as a comma-separated (CSV) string. Free encoding tier supports only x264. A premium encoding tier adds support for vp9, hevc, and av1.
DRM (enterprise) monthly base price for this video library if it differs from list price.
DRM (enterprise) cost per license for this video library if it differs from list price.
Was this page helpful?