Edit player

Prev Next

Available in Classic and VPC

Edit domain information of a player. Edited player is deployed to the production environment.

Note

Once edited, the player can be deployed to either the develop or production environment, depending on the purpose of the deployment.

  • When edited with API: Deployable to the production environment.
  • When edited in the console: Deployable to the develop or production environment.

Request

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

Method URI
PUT /api/v1/players/{player_no}

Request headers

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

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
player_no String Required Player number

Request body

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

Field Type Required Description
domains Array Required Site domain list: domains

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 PUT 'https://vpe.apigw.ntruss.com/api/v1/players/6284' \
--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 '{
    "domains": [
        {
            "type": "aos",
            "domain": "{App Package ID}"
        }
    ]
}'

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