Create player

Prev Next

Available in Classic and VPC

Create a player.

Request

This section describes the request format. The method and URI are as follows:

Method URI
POST /api/v1/players

Request headers

For information about the headers common to all Video Player Enhancement APIs, see Video Player Enhancement request headers.

Request body

You can include the following data in the body of your request:

Field Type Required Description
auto_update String Optional Player SDK auto-update
  • Y | N (default)
    • Y: Enable
    • N: Disable
domains Array Required Site domain list: domains
name String Required Player name
  • Enter 3 to 30 characters using a combination of lowercase English letters, numbers, and special characters "_", "-", and "@".
  • The string must start with an English letter.See Check player name.
  • Duplication and validation: See Check player name.
version String Optional Player SDK version

domains

The following describes domains.

Field Type Required Description
type String Required Site domain type
  • web | ios | aos
    • web: Website URL
    • ios: iOS app package ID
    • aos: Android app package ID
domain String Required Domain or mobile app package ID

Request example

The request example is as follows:

curl --location --request POST 'https://vpe.apigw.ntruss.com/api/v1/players' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--header 'x-ncp-region_code: KR' \
--data '{
    "auto_update": "Y",
    "domains": [
        {
            "domain": "https://www.example.com",
            "type": "web"
        }
    ],
    "name": "player001"
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
code String - Response code
message String - Response message

Response status codes

For information about the HTTP status codes common to all Video Player Enhancement APIs, see Common Video Player Enhancement response status codes.

Response example

The response example is as follows:

{
    "code": "200",
    "message": "ok"
}