Get category list

Prev Next

Available in Classic and VPC

Get the list of categories.

Request

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

Method URI
GET /api/v2/category

Request headers

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

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
pageNo Integer Optional Page number
  • 1-N (default: 1)
pageSizeNo Integer Optional Number of items per page
  • 1-N (default: 20)

Request example

The request example is as follows:

curl --location --request GET 'https://vodstation.apigw.ntruss.com/api/v2/category' \
--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 - Category list: content
total Integer - Total response count

content

The following describes content.

Field Type Required Description
disabled Boolean - Whether Sub Account is disabled
  • true | false
    • true: Disabled
    • false: Enabled
id Integer - Category ID
name String - Category name
thumbnail Boolean - Thumbnail extraction settings
  • true | false
    • true: Extract
    • false: Not extract
notificationUrl String - Callback URL
output Object - Output settings information
output.bucketName String - Bucket name to save the output file
output.filePath String - Detailed path to save the output file
output.accessControl String - Disclosure scope of the output file
output.thumbnailAccessControl String - Disclosure scope of the output thumbnail
output.thumbnailBucketName String - Bucket name to save the output thumbnail
output.thumbnailFilePath String - Detailed path to save the output thumbnail
lastWorkStart Integer - Last job start time (millisecond)
  • Unix timestamp format
createTime Integer - Category creation date and time (millisecond)
  • Unix timestamp format
updateTime Integer - Category modification date and time (millisecond)
  • Unix timestamp format
status String - Category status
  • CREATED | DELETED | RUNNING
    • CREATED: Creation completed
    • DELETED: Deletion completed
    • RUNNING: In use
outputTotalSize Integer - Total size of output file (byte)
outputTotal Integer - Total number of output files
inputTotal Integer - Total number of input files
outputType Integer - Number of output types according to the encoding settings
advancedOptions Object - Advanced settings information
advancedOptions.trimming Object - Output file trimming (playback section) settings
advancedOptions.trimming.startTimeCode String - Trimming start point (HH:MM:SS.S)
advancedOptions.trimming.endTimeCode String - Trimming end point (HH:MM:SS.S)
advancedOptions.imageOverlay Object - Image overlay (insertion) settings
advancedOptions.imageOverlay.input Object - Image settings information
advancedOptions.imageOverlay.input.bucketName String - Name of the bucket where the image is saved
advancedOptions.imageOverlay.input.filePath String - Detailed path of the image including the file name
advancedOptions.imageOverlay.size Object - Image size information
advancedOptions.imageOverlay.size.width Integer - Image width (pixel)
advancedOptions.imageOverlay.size.height Integer - Image height (pixel)
advancedOptions.imageOverlay.position Object - Location settings of image to be inserted
advancedOptions.imageOverlay.position.x Integer - Location of x-axis (pixel)
advancedOptions.imageOverlay.position.y Integer - Location of y-axis (pixel)
encodingOptions Array - Encoding option ID
encodingOptionTemplateId Integer - Encoding template ID

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": [
        {
            "disabled": false,
            "id": *****,
            "name": "VOD-Category",
            "thumbnail": true,
            "notificationUrl": "https://example.com/vodstation/callback",
            "output": {
                "bucketName": "station-000",
                "filePath": "/",
                "accessControl": "PUBLIC_READ",
                "thumbnailAccessControl": "PUBLIC_READ",
                "thumbnailBucketName": "station-000",
                "thumbnailFilePath": "/thumbnail"
            },
            "lastWorkStart": 1755576724000,
            "createTime": 1755569623000,
            "updateTime": 1755569623000,
            "status": "CREATED",
            "outputTotalSize": 3421908,
            "outputTotal": 3,
            "inputTotal": 1,
            "outputType": 3,
            "advancedOptions": {
                "trimming": {
                    "startTimeCode": "00:00:00.0",
                    "endTimeCode": "00:08:00.9"
                },
                "imageOverlay": {
                    "input": {
                        "bucketName": "station-000",
                        "filePath": "/VODStation.png"
                    },
                    "size": {
                        "width": 50,
                        "height": 50
                    },
                    "position": {
                        "x": 50,
                        "y": 50
                    }
                }
            },
            "encodingOptions": [
                1,
                2,
                3
            ],
            "encodingOptionTemplateId": 1
        }
    ],
    "total": 1
}