Get encoding option template list

Prev Next

Available in Classic and VPC

Get the list of encoding option templates. Setting up templates makes it easy to use encoding presets that are assembled for different types of video content.

Request

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

Method URI
GET /api/v2/encoding-option/template

Request headers

For information about the headers common to all VOD Station APIs, see VOD Station request headers.

Request example

The request example is as follows:

curl --location --request GET 'https://vodstation.apigw.ntruss.com/api/v2/encoding-option/template' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
content Array - Template list: content

content

The following describes content.

Field Type Required Description
id Integer - Template ID
name String - Template name
  • Practical content | Business content | Ultra-high-definition content
    • Practical content: Practical content
    • Business content: Business content
    • Ultra-high-definition content: Ultra-high definition content
encodingOptionIds Array - List of encoding option IDs included in the template

Response status codes

For information about the HTTP status codes common to all VOD Station APIs, see VOD Station response status codes.

Response example

The response example is as follows:

{
    "content": [
        {
            "id": 1,
            "name": "Practical content",
            "encodingOptionIds": [
                1,
                2,
                3
            ]
        },
        {
            "id": 2,
            "name": "Business content",
            "encodingOptionIds": [
                2,
                3,
                4
            ]
        },
        {
            "id": 3,
            "name": "Ultra-high-definition content",
            "encodingOptionIds": [
                10,
                11,
                12,
                13
            ]
        }
    ]
}