Get Video Library

Get Video Library

curl --request GET \
  --url https://api.bunny.net/videolibrary/{id} \
  --header 'AccessKey: <api-key>'

{
  "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>"
}

GET

videolibrary

{id}

Get Video Library

curl --request GET \
  --url https://api.bunny.net/videolibrary/{id} \
  --header 'AccessKey: <api-key>'

{
  "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

AccessKey

string

header

required

API Access Key authorization header

Path Parameters

integer<int64>

required

The ID of the Video Library that will be returned

Response

The requested video library

integer<int64>

required

VideoCount

integer<int64>

required

The number of videos in the video library

StorageUsage

integer<int64>

required

The total amount of storage used by the library

DateCreated

string<date-time>

required

The date when the video library was created

HasWatermark

boolean

required

Determines if the video library has a watermark configured

WatermarkPositionLeft

integer<int32>

required

The left offset of the watermark position (in %)

WatermarkPositionTop

integer<int32>

required

The top offset of the watermark position (in %)

WatermarkWidth

integer<int32>

required

The width of the watermark (in %)

PullZoneId

integer<int64>

required

The ID of the connected underlying pull zone

StorageZoneId

integer<int64>

required

The ID of the connected underlying storage zone

WatermarkHeight

integer<int32>

required

The height of the watermark (in %)

CaptionsFontSize

integer<int32>

required

The captions display font size

PlayerTokenAuthenticationEnabled

boolean

required

Determines if the player token authentication is enabled

BlockNoneReferrer

boolean

required

Determines if the requests without a referrer are blocked

EnableMP4Fallback

boolean

required

Determines if the MP4 fallback feature is enabled

KeepOriginalFiles

boolean

required

Determines if the original video files should be stored after encoding

AllowDirectPlay

boolean

required

Determines direct play URLs are enabled for the library

EnableDRM

boolean

required

Determines if the DRM is enabled

Bitrate240p

integer<int32>

required

The bitrate used for encoding 240p videos

Bitrate360p

integer<int32>

required

The bitrate used for encoding 360p videos

Bitrate480p

integer<int32>

required

The bitrate used for encoding 480p videos

Bitrate720p

integer<int32>

required

The bitrate used for encoding 720p videos

Bitrate1080p

integer<int32>

required

The bitrate used for encoding 1080p videos

Bitrate1440p

integer<int32>

required

The bitrate used for encoding 1440p videos

Bitrate2160p

integer<int32>

required

The bitrate used for encoding 2160p videos

ShowHeatmap

boolean

required

Determines if the video watch heatmap should be displayed in the player.

EnableContentTagging

boolean

required

Determines if content tagging should be enabled for this library.

WatermarkVersion

integer<int64>

required

EnableTranscribing

boolean

required

Determines if the automatic audio transcribing is currently enabled for this zone.

EnableTranscribingTitleGeneration

boolean

required

Determines if automatic transcribing title generation is currently enabled.

EnableTranscribingDescriptionGeneration

boolean

required

Determines if automatic transcribing description generation is currently enabled.

EnableTranscribingChaptersGeneration

boolean

required

Determines if automatic transcribing chapters generation is currently enabled.

EnableTranscribingMomentsGeneration

boolean

required

Determines if automatic transcribing moments generation is currently enabled.

RememberPlayerPosition

boolean

required

Determines if the player will automatically remember the playback position.

EnableMultiAudioTrackSupport

boolean

required

Determines if multiple output audio track support is enabled on video library.

UseSeparateAudioStream

boolean

required

Determines whether output audio stream should be split from video stream segments.

JitEncodingEnabled

boolean

required

Determines whether JIT encoding should be used for the library. Supported in premium encoding only.

MonthlyChargesTranscribing

number<decimal>

required

MonthlyChargesPremiumEncoding

number<decimal>

required

MonthlyChargesEnterpriseDrm

number<decimal>

required

PlayerVersion

integer<int32>

required

RemoveMetadataFromFallbackVideos

boolean

required

Marks whether all potential video metadata should be removed from the fallback files. Default false.

ScaleVideoUsingBothDimensions

boolean

required

Marks whether videos should be scaled using both dimensions. Prevents videos being upscaled or unexpected aspect ratio changes. Default true.

ExposeOriginals

boolean

required

Marks whether original video files should be exposed via CDN.

ExposeVideoMetadata

boolean

required

Marks whether video metadata in form of schema meta tags and LD+JSON should be exposed.

Name

string | null

The name of the Video Library.

ReplicationRegions

string[] | null

The geo-replication regions of the underlying storage zone

ApiKey

string | null

The API key used for authenticating with the video library

ReadOnlyApiKey

string | null

The read-only API key used for authenticating with the video library

EnabledResolutions

string | null

The comma separated list of enabled resolutions

ViAiPublisherId

string | null

The vi.ai publisher id for advertising configuration

VastTagUrl

string | null

The URL of the VAST tag endpoint for advertising configuration

WebhookUrl

string | null

The webhook URL of the video library

CaptionsFontColor

string | null

The captions display font color

CaptionsBackground

string | null

The captions display background color

UILanguage

string | null

The UI language of the player

AllowEarlyPlay

boolean | null

Determines if the Early-Play feature is enabled

AllowedReferrers

string[] | null

The list of allowed referrer domains allowed to access the library

BlockedReferrers

string[] | null

The list of blocked referrer domains blocked from accessing the library

DrmVersion

enum<string>

DRM version (basic or enterprise)

Available options:

Basic,

Enterprise,

BasicV2

Example:

"Basic"

AppleFairPlayDrm

object

Described Apple FairPlay DRM

Show child attributes

GoogleWidevineDrm

object

Describes Google Widevine DRM

Show child attributes

ApiAccessKey

string | null

PullZoneType

enum<string>

The type of the pull zone attached. Premium = 0, Volume = 1

Available options:

Premium,

Volume

Example:

"Premium"

CustomHTML

string | null

The custom HTMl that is added into the head of the HTML player.

Controls

string | null

The list of controls on the video player.

PlaybackSpeeds

string | null

The list of playback speeds available in the video player.

PlayerKeyColor

string | null

The key color of the player.

FontFamily

string | null

The captions font family.

TranscribingCaptionLanguages

string[] | null

The list of languages that the captions will be automatically transcribed to.

EnableCaptionsInPlaylist

boolean | null

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.

EncodingTier

enum<string>

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.

Available options:

Free,

Premium

Example:

"Free"

OutputCodecs

string | null

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.

DrmBasePriceOverride

number<decimal> | null

DRM (enterprise) monthly base price for this video library if it differs from list price.

DrmCostPerLicenseOverride

number<decimal> | null

DRM (enterprise) cost per license for this video library if it differs from list price.

TranscribingPriceOverride

number<decimal> | null

PremiumEncodingPriceOverride

number<decimal> | null

FeatureFlags

string | null

Add Video Library

Update Video Library

⌘I

API Reference

Core Platform API

Origin Errors API

Storage API

Stream API

Shield API

Edge Scripting API

Authorizations

Path Parameters

Response