API docs by Redocly

Brightcove Player Management API Reference (2.0.0)

Download OpenAPI specification:Download

Reference for the Brightcove Player Management API, used to manipulate players, player configurations and child players (embeds). To test API requests, you can use our API Testing Tools. Popular testing tools include:

  • cURL
  • Postman - note that the tutorial here uses the Player Management API as an example
  • Insomnia - note that the tutorial here uses the Player Management API as an example

If you haven't gone through Step-by-Step: Player Management, it's highly recommended you start there. You'll get security set up and learn some of the basics of using the Player Management API.

If you are working with this API for the first time, read the Player Management API Overview.

Remember that after making any configuration changes you MUST re-publish your player. Note: Fields in configuration objects need to be set only if you wish to change their values. Fields in configuration objects will be displayed in the response only if explicitly set. For information on authenticating API requests, see OAuth Overview.

For additional in-depth guides to features of the API, see the general documentation.

Base URL: https://players.api.brightcove.com/v2

Players

Operations for managing players.

Get a list of players

Get a list of players

Authorizations:
BC_OAuth2
path Parameters
account_id
required
string

Video Cloud account ID.

header Parameters
Content-Type
required
string
Example: application/json

Content-Type: application/json

Authorization
required
string

There are two ways to authenticate requests to the Player Management API. The first is more secure and recommended. The second (Basic) authorization method should only be used for testing, and never in a production app.

  1. Authorization: Bearer {access_token} - (see Getting Access Tokens)

  2. Authorization: Basic {username:password} - the username and password here are those used for Video Cloud. the whole username:password string must be Base64 encoded (CURL does this automatically; for other languages you must encode the string manually)

Responses

Response samples

Content type
application/json
{}

Create a player

Create a player. The POST method creates a player by submitting a player configuration. The properties of Brightcove Player you can manipulate with player management are detailed in the Request Body Fields section below. To create a player, a publisher must decide what properties the final player will have. If no properties are given at creation, a blank player will be created with only the base player skin applied to the player. A user may then use an HTTP PATCH method to update properties after the player has been created.

Authorizations:
BC_OAuth2
path Parameters
account_id
required
string

Video Cloud account ID.

header Parameters
Content-Type
required
string
Example: application/json

Content-Type: application/json

Authorization
required
string

There are two ways to authenticate requests to the Player Management API. The first is more secure and recommended. The second (Basic) authorization method should only be used for testing, and never in a production app.

  1. Authorization: Bearer {access_token} - (see Getting Access Tokens)

  2. Authorization: Basic {username:password} - the username and password here are those used for Video Cloud. the whole username:password string must be Base64 encoded (CURL does this automatically; for other languages you must encode the string manually)

Request Body schema: application/json

Create a player

name
string

A name for the player - avoid confusion by giving the player a name that will help convey what it should be used for

description
string

A description of the player - avoid confusion by giving the player a description that will help convey what it should be used for

object (Player Configuration)

Configuration for a player

Responses

Request samples

Content type
application/json
{
  • "name": "Test_Player",
  • "description": "A test player for autoplay and video looping",
  • "configuration": {
    }
}

Response samples

Content type
application/json
{}

Get a single player

Get a player by ID

Authorizations:
BC_OAuth2
path Parameters
account_id
required
string

Video Cloud account ID.

player_id
required
string

Brightcove Player ID.

header Parameters
Content-Type
required
string
Example: application/json

Content-Type: application/json

Authorization
required
string

There are two ways to authenticate requests to the Player Management API. The first is more secure and recommended. The second (Basic) authorization method should only be used for testing, and never in a production app.

  1. Authorization: Bearer {access_token} - (see Getting Access Tokens)

  2. Authorization: Basic {username:password} - the username and password here are those used for Video Cloud. the whole username:password string must be Base64 encoded (CURL does this automatically; for other languages you must encode the string manually)

Responses

Response samples

Content type
application/json
{}

Update a player by ID

Update a single player. The PATCH method can be used on a single player to do a VERY limited update. The only fields you can update in this manner are the name and description properties. All other player configuration must be done via the PLAYER CONFIGURATIONS APIs, detailed below.

Authorizations:
BC_OAuth2
path Parameters
account_id
required
string

Video Cloud account ID.

player_id
required
string

Brightcove Player ID.

header Parameters
Content-Type
required
string
Example: application/json

Content-Type: application/json

Authorization
required
string

There are two ways to authenticate requests to the Player Management API. The first is more secure and recommended. The second (Basic) authorization method should only be used for testing, and never in a production app.

  1. Authorization: Bearer {access_token} - (see Getting Access Tokens)

  2. Authorization: Basic {username:password} - the username and password here are those used for Video Cloud. the whole username:password string must be Base64 encoded (CURL does this automatically; for other languages you must encode the string manually)

Request Body schema: application/json

Update the player

name
string

The player name

description
string

The player description

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{}

Delete a player by ID

Delete a player and all embeds associated with it.

Authorizations:
BC_OAuth2
path Parameters
account_id
required
string

Video Cloud account ID.

player_id
required
string

Brightcove Player ID.

header Parameters
Content-Type
required
string
Example: application/json

Content-Type: application/json

Authorization
required
string

There are two ways to authenticate requests to the Player Management API. The first is more secure and recommended. The second (Basic) authorization method should only be used for testing, and never in a production app.

  1. Authorization: Bearer {access_token} - (see Getting Access Tokens)

  2. Authorization: Basic {username:password} - the username and password here are those used for Video Cloud. the whole username:password string must be Base64 encoded (CURL does this automatically; for other languages you must encode the string manually)

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully deleted player with the id: 69EmV4W8r"
}

Publish a player

Publish a player for optimization and production use.

Authorizations:
BC_OAuth2
path Parameters
account_id
required
string

Video Cloud account ID.

player_id
required
string

Brightcove Player ID.

header Parameters
Content-Type
required
string
Example: application/json

Content-Type: application/json

Authorization
required
string

There are two ways to authenticate requests to the Player Management API. The first is more secure and recommended. The second (Basic) authorization method should only be used for testing, and never in a production app.

  1. Authorization: Bearer {access_token} - (see Getting Access Tokens)

  2. Authorization: Basic {username:password} - the username and password here are those used for Video Cloud. the whole username:password string must be Base64 encoded (CURL does this automatically; for other languages you must encode the string manually)

Responses

Response samples

Content type
application/json
{}

Player Configurations

Operations for managing player configurations.

Get player configuration

Get a preview or published player configuration

Authorizations:
BC_OAuth2
path Parameters
account_id
required
string

Video Cloud account ID.

player_id
required
string

Brightcove Player ID.

branch
required
string
Enum: "master" "preview"

A plugin id

header Parameters
Content-Type
required
string
Example: application/json

Content-Type: application/json

Authorization
required
string

There are two ways to authenticate requests to the Player Management API. The first is more secure and recommended. The second (Basic) authorization method should only be used for testing, and never in a production app.

  1. Authorization: Bearer {access_token} - (see Getting Access Tokens)

  2. Authorization: Basic {username:password} - the username and password here are those used for Video Cloud. the whole username:password string must be Base64 encoded (CURL does this automatically; for other languages you must encode the string manually)

Responses

Response samples

Content type
application/json
{
  • "ad_config_id": "undefined",
  • "ad_failover": "undefined",
  • "application_id": "undefined",
  • "autoadvance": "not enabled",
  • "autoplay": false,
  • "compatibility": true,
  • "crossorigin": true,
  • "css": {
    },
  • "debugger": true,
  • "errors": true,
  • "flash": { },
  • "fullscreenControl": true,
  • "hls": { },
  • "language": "undefined",
  • "languages": [
    ],
  • "loop": false,
  • "media": {
    },
  • "muted": false,
  • "play_button": {
    },
  • "player": {
    },
  • "player_id": "string",
  • "player_name": "string",
  • "playsinline": false,
  • "plugins": [
    ],
  • "preload": "auto",
  • "query_string_to_window": {
    },
  • "repeat": false,
  • "scripts": "none",
  • "skin": "graphite",
  • "stylesheets": "none",
  • "techOrder": [
    ],
  • "video_cloud": {
    }
}

Update player configuration

Update a player configuration

Authorizations:
BC_OAuth2
path Parameters
account_id
required
string

Video Cloud account ID.

player_id
required
string

Brightcove Player ID.

header Parameters
Content-Type
required
string
Example: application/json

Content-Type: application/json

Authorization
required
string

There are two ways to authenticate requests to the Player Management API. The first is more secure and recommended. The second (Basic) authorization method should only be used for testing, and never in a production app.

  1. Authorization: Bearer {access_token} - (see Getting Access Tokens)

  2. Authorization: Basic {username:password} - the username and password here are those used for Video Cloud. the whole username:password string must be Base64 encoded (CURL does this automatically; for other languages you must encode the string manually)

Request Body schema: application/json

Update a player configuration. Please note that all the parameters except for name and description must be inside a configuration object

ad_config_id
string
Default: "undefined"

A Dynamic Delivery SSAI ad configuration ID. In addition to being set on the player configuration, it can be set at runtime via the adConfigId query string parameter for iframe players or the data-ad-config-id attribute for in-page players. Either of these will override any value in the player configuration.

ad_failover
boolean
Default: "undefined"

Set to true to enable ad failover behavior. This is a multi-part configuration that depends on:
- Both IMA3 and SSAI plugins must be configured on the player.
- An ad_config_id should be available, otherwise SSAI ads are not available.

application_id
string
Default: "undefined"

The application ID is used to differentiate multiple uses of a single player in metrics. It is invisible to the user.

autoadvance
integer
Default: "not enabled"

Autoadvance setting if using playlists: 0 for no wait; a number for seconds between advance; null to cancel autoadvance

boolean or string
Default: false

Indicates player should play video immediately, on platforms that allow this

object

Object containing CSS color overrides

debugger
boolean

If true, debugger shows player information in a modal window. See the Player Information Modal document for full information.

errors
boolean

Indicates if the error messages plugin should be excluded

flash
object

Can be used to provide custom Flash options to Video.js.

fullscreenControl
boolean

Indicates whether the fullscreen control should be shown in the control bar

boolean or object
Default: {}

Handling of videojs-contrib-hls and renaming of 608 captions

language
string
Default: "undefined"

Can be provided to set the lang attribute of the <html> element.

languages
Array of strings
Items Enum: "ar" "ba" "bg" "ca" "cs" "da" "de" "el" "en" "es" "fa" "fi" "fr" "gl" "he" "hr" "hu" "it" "ja" "ko" "nb" "nl" "nn" "pl" "pt-BR" "pt-PT" "ru" "sk" "sr" "sv" "tr" "uk" "vi" "zh-CN" "zh-TW"

Languages (2 letter abbreviations) you wish your player to support, from the video.js supported list

loop
boolean
Default: false

Indicates if the video should play over as soon as it ends

object

Media information for non-Video Cloud media

muted
boolean
Default: false

If true, the player will be muted when it loads

object

Properties are available for modification of the play button via player configuration

object

General settings for the player

playsinline
boolean
Default: false

Allows inline playback (necessary for playback on some devices)

Array of objects

The plugins property specifies the order to initialize video.js plugins and any customized settings to apply to them.
For plugins in the plugin registry: include the registry_idand a version (and options, if any)
For plugins not in the plugin registry: include the name (and options, if any). The plugin must be supported by a corresponding scripts property URL entry, and if needed a supporting stylesheets URL.

preload
string
Default: "none"
Enum: "auto" "metadata" "none"

What data should be preloaded immediately - note that preload is just a suggestion in the HTML5 spec, so there may be different behavior across browsers.
auto indicates that the whole video may be downloaded if possible (which improves performance for viewers, but also consumes unnecessary bandwidth if the user does not watch the video).
metadata indicates that video metadata should be preloaded; at least a few seconds of the video itself will also be preloaded.
none tells the player not to load any video data or metadata until the user clicks play.

object

Used to control the population of the global namespace (window) from query string parameters. This is useful particularly in cases of embedded players, such as Google's AMP components or Facebook Instant Articles. The parsing of query strings is done using the Node.js querystring module. Use of this configuration object requires at least one of the following sub-properties. Both can be used simultaneously. Supported for Standard (iframe) player implementations only.

repeat
boolean
Default: false

Will cause a playlist to repeat playing IF the player is a playlist player. Set at the top level of the player configuration.

scripts
Array of strings
Default: "none"

The data type is an array of strings (URLs) referencing JavaScript files that are included with the player. At the time the player is built, these files will be downloaded and inlined into the resulting output so that they do not need to be subsequently fetched at runtime. Note: unless the script is for a registered plugin, you can not use it to interact with the player.

skin
string
Value: "graphite"

Select the Brightcove Player 1.x skin instead of the Brightcove Player 5.x look. If you enable this option, you will also need to make sure Brightcove Player 1.x compatibility property is also set to true.

stylesheets
Array of strings
Default: "none"

The data type is an array of strings (URLs) referencing CSS files that are included with the player. At the time the player is built, these files will be downloaded and inlined into the resulting output so that they do not need to be subsequently fetched at runtime. Note: the stylesheets are included in the order you specify them.

techOrder
Array of strings
Default: ["html5","flash"]
Items Enum: "html5" "flash"

By default Brightcove Player performs tech-first ordering when it searches for a source/tech combination to play videos. This means that if you have two sources and two techs, the player will try to play each video with the first tech in the techOrder option property before moving on to try the next playback technology. See the Guide: Playback Technology document for more information.

object

With this property you can create a player using a video from your Video Cloud library and add a few more settings specific to Video Cloud.

Responses

Request samples

Content type
application/json
{
  • "ad_config_id": "undefined",
  • "ad_failover": "undefined",
  • "application_id": "undefined",
  • "autoadvance": "not enabled",
  • "autoplay": false,
  • "css": {
    },
  • "debugger": true,
  • "errors": true,
  • "flash": { },
  • "fullscreenControl": true,
  • "hls": { },
  • "language": "undefined",
  • "languages": [
    ],
  • "loop": false,
  • "media": {
    },
  • "muted": false,
  • "play_button": {
    },
  • "player": {
    },
  • "playsinline": false,
  • "plugins": [
    ],
  • "preload": "auto",
  • "query_string_to_window": {
    },
  • "repeat": false,
  • "scripts": "none",
  • "skin": "graphite",
  • "stylesheets": "none",
  • "techOrder": [
    ],
  • "video_cloud": {
    }
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "created_at": "string",
  • "embeds_count": 0,
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "url": "string",
  • "branches": {
    }
}

Plugin Registry

Operations for working with the player plugin registry.

Get all plugins

Get all plugins

Authorizations:
BC_OAuth2
query Parameters
template_version
string

Limit results to plugins compatible with a specific player template version.

header Parameters
Content-Type
required
string
Example: application/json

Content-Type: application/json

Authorization
required
string

There are two ways to authenticate requests to the Player Management API. The first is more secure and recommended. The second (Basic) authorization method should only be used for testing, and never in a production app.

  1. Authorization: Bearer {access_token} - (see Getting Access Tokens)

  2. Authorization: Basic {username:password} - the username and password here are those used for Video Cloud. the whole username:password string must be Base64 encoded (CURL does this automatically; for other languages you must encode the string manually)

Responses

Response samples

Content type
application/json
{
  • "versions": [
    ],
  • "documentation": "https://player.support.brightcove.com/plugins/advertising-ima3-plugin.html",
  • "description": "Google Interactive Media Ads (IMA) v3 support for video.js",
  • "id": "@brightcove/videojs-ima3",
  • "name": "ima3",
  • "current_version": "3.x"
}

Get a single plugin

Get a single plugin

Authorizations:
BC_OAuth2
path Parameters
plugin_id
required
string

The plugin ID in the Plugin Registry.

header Parameters
Content-Type
required
string
Example: application/json

Content-Type: application/json

Authorization
required
string

There are two ways to authenticate requests to the Player Management API. The first is more secure and recommended. The second (Basic) authorization method should only be used for testing, and never in a production app.

  1. Authorization: Bearer {access_token} - (see Getting Access Tokens)

  2. Authorization: Basic {username:password} - the username and password here are those used for Video Cloud. the whole username:password string must be Base64 encoded (CURL does this automatically; for other languages you must encode the string manually)

Responses

Response samples

Content type
application/json
{
  • "versions": [
    ],
  • "documentation": "string",
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "current_version": "string"
}

Player Embeds

Operations for managing player embeds (child players).

Get all the embeds for a player.

Get all the embeds (child players) for a player.

Authorizations:
BC_OAuth2
path Parameters
account_id
required
string

Video Cloud account ID.

player_id
required
string

Brightcove Player ID.

header Parameters
Content-Type
required
string
Example: application/json

Content-Type: application/json

Authorization
required
string

There are two ways to authenticate requests to the Player Management API. The first is more secure and recommended. The second (Basic) authorization method should only be used for testing, and never in a production app.

  1. Authorization: Bearer {access_token} - (see Getting Access Tokens)

  2. Authorization: Basic {username:password} - the username and password here are those used for Video Cloud. the whole username:password string must be Base64 encoded (CURL does this automatically; for other languages you must encode the string manually)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Create an embed

Create an embed (child player) for a player. Note that the initial creation of the embed is automatically published. Any changes to the embed thereafter will need to be published. When creating the embed, the body must be an object representing configuration settings for the new embed. By default when you create an embed, data in the embed overrides like data that would otherwise be inherited from the common player. This situation is different for fields that contain arrays. When the data type of the field is an array, you can choose the inheritance behavior to be overwrite, prepend or append. The fields whose data type is an array, and for which you can control inheritance behavior are: scripts, stylesheets, plugins, sources. You can add special field names to the configuration object to control array inheritance, and change the default behavior of embeds overriding common player data. If a array field in an embed's configuration has a child item called array_prepend or array_append the data will be correspondingly prepended or appended to the common player's data for the like field. See the Array fields section of the Embeds Guide for a complete discussion.

Authorizations:
BC_OAuth2
path Parameters
account_id
required
string

Video Cloud account ID.

player_id
required
string

Brightcove Player ID.

header Parameters
Content-Type
required
string
Example: application/json

Content-Type: application/json

Authorization
required
string

There are two ways to authenticate requests to the Player Management API. The first is more secure and recommended. The second (Basic) authorization method should only be used for testing, and never in a production app.

  1. Authorization: Bearer {access_token} - (see Getting Access Tokens)

  2. Authorization: Basic {username:password} - the username and password here are those used for Video Cloud. the whole username:password string must be Base64 encoded (CURL does this automatically; for other languages you must encode the string manually)

Request Body schema: application/json

Create a player

description
string

A description of the player

name
string

The name of the player

object (Player Configuration)

Configuration for a player

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "configuration": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "url": "string",
  • "embed_code": "string",
  • "embed_in_page": "string",
  • "preview_url": "string",
  • "preview_embed_in_page": "string",
  • "preview_embed_code": "string"
}

Get a specific embed for a player.

Get a specific embed (child player) for a player.

Authorizations:
BC_OAuth2
path Parameters
account_id
required
string

Video Cloud account ID.

player_id
required
string

Brightcove Player ID.

embed_id
required
string

The embed id.

header Parameters
Content-Type
required
string
Example: application/json

Content-Type: application/json

Authorization
required
string

There are two ways to authenticate requests to the Player Management API. The first is more secure and recommended. The second (Basic) authorization method should only be used for testing, and never in a production app.

  1. Authorization: Bearer {access_token} - (see Getting Access Tokens)

  2. Authorization: Basic {username:password} - the username and password here are those used for Video Cloud. the whole username:password string must be Base64 encoded (CURL does this automatically; for other languages you must encode the string manually)

Responses

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "created_at": "string",
  • "embeds_count": 0,
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "url": "string",
  • "branches": {
    }
}

Delete an embed

Delete a particular embed (child player) for a player.

Authorizations:
BC_OAuth2
path Parameters
account_id
required
string

Video Cloud account ID.

player_id
required
string

Brightcove Player ID.

embed_id
required
string

The embed id.

header Parameters
Content-Type
required
string
Example: application/json

Content-Type: application/json

Authorization
required
string

There are two ways to authenticate requests to the Player Management API. The first is more secure and recommended. The second (Basic) authorization method should only be used for testing, and never in a production app.

  1. Authorization: Bearer {access_token} - (see Getting Access Tokens)

  2. Authorization: Basic {username:password} - the username and password here are those used for Video Cloud. the whole username:password string must be Base64 encoded (CURL does this automatically; for other languages you must encode the string manually)

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Embed Configurations

Operations for managing player embed (child player) configurations.

Get player embed configuration

Get the configuration for an embed. You must specify the branch, either master or preview.

Authorizations:
BC_OAuth2
path Parameters
account_id
required
string

Video Cloud account ID.

player_id
required
string

Brightcove Player ID.

embed_id
required
string

The embed id.

branch
required
string
Enum: "master" "preview"

A plugin id

header Parameters
Content-Type
required
string
Example: application/json

Content-Type: application/json

Authorization
required
string

There are two ways to authenticate requests to the Player Management API. The first is more secure and recommended. The second (Basic) authorization method should only be used for testing, and never in a production app.

  1. Authorization: Bearer {access_token} - (see Getting Access Tokens)

  2. Authorization: Basic {username:password} - the username and password here are those used for Video Cloud. the whole username:password string must be Base64 encoded (CURL does this automatically; for other languages you must encode the string manually)

Responses

Response samples

Content type
application/json
{
  • "ad_config_id": "undefined",
  • "ad_failover": "undefined",
  • "application_id": "undefined",
  • "autoadvance": "not enabled",
  • "autoplay": false,
  • "compatibility": true,
  • "crossorigin": true,
  • "css": {
    },
  • "debugger": true,
  • "errors": true,
  • "flash": { },
  • "fullscreenControl": true,
  • "hls": { },
  • "language": "undefined",
  • "languages": [
    ],
  • "loop": false,
  • "media": {
    },
  • "muted": false,
  • "play_button": {
    },
  • "player": {
    },
  • "player_id": "string",
  • "player_name": "string",
  • "playsinline": false,
  • "plugins": [
    ],
  • "preload": "auto",
  • "query_string_to_window": {
    },
  • "repeat": false,
  • "scripts": "none",
  • "skin": "graphite",
  • "stylesheets": "none",
  • "techOrder": [
    ],
  • "video_cloud": {
    }
}

Update embed configuration

Update the configuration for an embed. Note that you will need to publish the altered embed for optimization and production use. You can also use a PUT HTTP method instead of the PATCH shown here. When using PUT it replaces all embed configuration information, so you must supply all embed configuration information when using PUT. In contrast, PATCH appends or modifies existing configuration information. Using PUT is such rare use case it is not detailed in this reference.

Authorizations:
BC_OAuth2
path Parameters
account_id
required
string

Video Cloud account ID.

player_id
required
string

Brightcove Player ID.

embed_id
required
string

The embed id.

header Parameters
Content-Type
required
string
Example: application/json

Content-Type: application/json

Authorization
required
string

There are two ways to authenticate requests to the Player Management API. The first is more secure and recommended. The second (Basic) authorization method should only be used for testing, and never in a production app.

  1. Authorization: Bearer {access_token} - (see Getting Access Tokens)

  2. Authorization: Basic {username:password} - the username and password here are those used for Video Cloud. the whole username:password string must be Base64 encoded (CURL does this automatically; for other languages you must encode the string manually)

Responses

Response samples

Content type
application/json
{
  • "preview_url": "string",
  • "preview_embed_in_page": "string"
}

Get Configuration Combinations

Retrieve the configuration for a parent/child combination of master and preview branches. If you are using the second query parameter (and hence using the ampersand [&]), you MUST use quotes around the endpoint or the curl statement will fail at the ampersand. For example:

"https://players.api.brightcove.com/v1/accounts/{account_id}/players/{player_id}/embeds/{embed_id}/configuration/merged?playerBranch=preview&embedBranch=master".

Using this endpoint provides a way to view what the resulting configuration would be when combining different combinations of parent and child (also called embed) versions of players. Using this endpoint does not change any configurations, it is only useful for seeing results of merging changes to configurations.

Authorizations:
BC_OAuth2
path Parameters
account_id
required
string

Video Cloud account ID.

player_id
required
string

Brightcove Player ID.

embed_id
required
string

The embed id.

query Parameters
playerBranch
string
Enum: "master" "preview"

The (master) player branch to use.

embedBranch
string
Enum: "master" "preview"

The embed (child player) branch to use.

header Parameters
Content-Type
required
string
Example: application/json

Content-Type: application/json

Authorization
required
string

There are two ways to authenticate requests to the Player Management API. The first is more secure and recommended. The second (Basic) authorization method should only be used for testing, and never in a production app.

  1. Authorization: Bearer {access_token} - (see Getting Access Tokens)

  2. Authorization: Basic {username:password} - the username and password here are those used for Video Cloud. the whole username:password string must be Base64 encoded (CURL does this automatically; for other languages you must encode the string manually)

Responses

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "created_at": "string",
  • "embeds_count": 0,
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "url": "string",
  • "branches": {
    }
}