Control Panel — API documentation

Please provide a valid credit card using the credit card form on the billing page. Update Card Details

Bifs

Bifs object

Used to create, show, and delete BIF files for a given VOD file. When called with the path to an MP4 file, it will operate on a BIF that corresponds to that video.

A BIF can be created with the create method or the update method, the create method will not do anything if a BIF already exists, the update method will create a bif regardless of whether one already exists.

A fetch will show some technical information on the BIF file, such the frame rate and size. To see details about the file in storage itself, use the files endpoint. See the files page for more information.

Delete will remove a BIF for a video file. It is also possible to delete the BIF directly using the files endpoint, for cases such as if the video file has been moved or deleted.

Descriptions

path String Immutable

File path to the VOD item the BIF is for

String

Sample value:/recordings/my-vod.mp4

bif_path String Autogenerated

File path to the BIF, for use with the files endpoint

Sample value:/recordings/my-vod.bif

frame_size Integer Write-only

Size of each frame in the bif, in pixels of height

Range:64 - 1080

Sample value:240

frame_rate Integer Normal

set rate of frames when generating a bif, in milliseconds per frame

Range:1000 - 60000

Sample value:10000

info Array Autogenerated

Additional information about the BIF, on a GET. Data shows as key value pairs.

option:related String

Include related object in results

Default:none

Sample value:file

None

Related endpoints

File

List files

Examples

Get the Bifs object with id recordings/my-vod.mp4.

Example URL

https://jb-sestore.secdn.net/v1/bifs/recordings/my-vod.mp4

Example cURL

curl --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://jb-sestore.secdn.net/v1/bifs/recordings/my-vod.mp4

Example request body

None

Example response data

{
    "path": "/recordings/my-vod.mp4",
    "bif_path": "/recordings/my-vod.bif",
    "frame_rate": 10000,
    "info": null
}

Create a new Bifs object.

Example URL

https://jb-sestore.secdn.net/v1/bifs

Example cURL

curl -X PUT --data-binary @/path/to/request/body --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://jb-sestore.secdn.net/v1/bifs

Example request body

{
    "path": "/recordings/my-vod.mp4",
    "frame_size": "240",
    "frame_rate": 10000
}

Example response data

{
    "path": "/recordings/my-vod.mp4",
    "bif_path": "/recordings/my-vod.bif",
    "frame_size": "240",
    "frame_rate": 10000,
    "info": null
}

Update the Bifs object with id recordings/my-vod.mp4.

Example URL

https://jb-sestore.secdn.net/v1/bifs/recordings/my-vod.mp4

Example cURL

curl -X POST --data-binary @/path/to/request/body --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://jb-sestore.secdn.net/v1/bifs/recordings/my-vod.mp4

Example request body

{
    "frame_size": "240",
    "frame_rate": 10000
}

Example response data

{
    "path": "/recordings/my-vod.mp4",
    "bif_path": "/recordings/my-vod.bif",
    "frame_size": "240",
    "frame_rate": 10000,
    "info": null
}

Delete the Bifs object with id recordings/my-vod.mp4.

Example URL

https://jb-sestore.secdn.net/v1/bifs/recordings/my-vod.mp4

Example cURL

curl -X DELETE --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://jb-sestore.secdn.net/v1/bifs/recordings/my-vod.mp4

Example request body


			
			

Example response data

None

Errors

ACCESS_VIOLATION

You do not have access to modify this field

TYPE_MISMATCH

Data type does not conform to required field type

MAX_LENGTH_EXCEEDED

The value exceeded maximum length allowed

INVALID_RANGE

The value must be between the predefined range