Documentation Powered by ReDoc

Stream API (1.0.0)

Download OpenAPI specification:Download

ByteArk Stream APIs Specification (OpenAPI)

Introduction

การเริ่มต้นใช้งาน ByteArk Stream
วิธีการสร้างและจัดการโปรเจ็ค Project

Authentication

ByteArkTeamAuth

ระบุ team namespace ที่เข้าใช้งาน

Security Scheme Type API Key
Header parameter name: x-byteark-team

Video (VOD)

API operation related to video on demand

Show Video Jobs Deprecated

List exist jobs in video

Authorizations:
ByteArkTeamAuth
path Parameters
videoKey
required
string
Example: SWhMaRylfmt7

Video key string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List Videos

List exist videos

Authorizations:
ByteArkTeamAuth
query Parameters
projectKey
string

project key string

q
string

title of video

tagIds
string
Example: tagIds=60fa7fd128ad1347f591b3b5,60fa7fd128ad1347f591b3b4

tagIds of video

page
number

Number of the page for the pagination

limit
number

Number of the items in the response

Responses

Response samples

Content type
application/json
{
  • "total": 1,
  • "from": 1,
  • "to": 1,
  • "currentPage": 1,
  • "lastPage": 1,
  • "perPage": 20,
  • "data": [
    ]
}

Create Video

สร้างวิดีโอสำหรับการรับชมแบบออนดีมานด์

Authorizations:
ByteArkTeamAuth
Request Body schema: application/json
projectKey
required
string

โปรเจ็กต์ที่ต้องการสร้างวิดีโอ

presetId
string

presetId ที่ต้องการใช้กับวิดีโอ

required
Array of objects

List ข้อมูลเบื้องต้นของวิดีโอที่ต้องการสร้าง

Responses

Request samples

Content type
application/json
{
  • "projectKey": "tsetst-7o8d35",
  • "presetId": "60de850ca05d52b33910491f",
  • "videos": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Show Video

Show exist video

Authorizations:
ByteArkTeamAuth
path Parameters
videoKey
required
string
Example: SWhMaRylfmt7

Video key string

Responses

Response samples

Content type
application/json
{
  • "id": "5e817a8cecb9cf0228467837",
  • "key": "RuguHtZPJYm4",
  • "title": "test-video1",
  • "subtitle": "awesome movie you'll never seen before",
  • "duration": 60.1,
  • "tagIds": [
    ],
  • "tags": [
    ],
  • "coverImage": {
    },
  • "projectId": "5e817a56ecb9cf0228467836",
  • "creatorId": "5e81789f5c6dfc0033beb9d3",
  • "qoderProjectId": 0,
  • "qoderVideoId": 0,
  • "createdAt": "2020-03-30T04:50:20.635Z",
  • "updatedAt": "2020-03-30T04:50:34.122Z",
  • "playable": false,
  • "playableAt": "2020-03-30T04:50:34.122Z",
  • "playerId": "5f62e36e211aef111068f287",
  • "player": {
    },
  • "primaryPlaybackChannelId": "6087aa53cd7df70e44249807",
  • "primaryPlaybackUrl": {},
  • "playbackChannelIds": [
    ],
  • "playbackUrls": [],
  • "embeddedUrl": "stream-playlist.stream.byteark.com/players/5f62e36e211aef111068f287/videos/RuguHtZPJYm4",
  • "vod": {
    },
  • "creator": {
    },
  • "videoTimemachineId": "5f62e36e211aef111068f288",
  • "videoTimemachine": {
    },
  • "geoblockPolicy": {
    },
  • "customFields": {
    },
  • "customFieldEntries": [
    ],
  • "customImageEnries": [
    ],
  • "simpleCustomImageEnries": [
    ]
}

Update Video Detail

Update video detail

Authorizations:
ByteArkTeamAuth
path Parameters
videoKey
required
string
Example: SWhMaRylfmt7

Video key string

Request Body schema: application/json
title
required
string
subtitle
string
description
string
object
Array of objects
GeoblockPolicyCustomRule (object) or GeoblockPolicyExistingRule (object)

Responses

Request samples

Content type
application/json
{
  • "title": "TestVideo.mp4",
  • "subtitle": "Subtitle Example",
  • "description": "Description Example",
  • "coverImage": {
    },
  • "tags": [
    ],
  • "geoblockPolicy": {
    }
}

Response samples

Content type
application/json
{
  • "id": "5e817a8cecb9cf0228467837",
  • "key": "RuguHtZPJYm4",
  • "title": "test-video1",
  • "subtitle": "awesome movie you'll never seen before",
  • "duration": 60.1,
  • "tagIds": [
    ],
  • "tags": [
    ],
  • "coverImage": {
    },
  • "projectId": "5e817a56ecb9cf0228467836",
  • "creatorId": "5e81789f5c6dfc0033beb9d3",
  • "qoderProjectId": 0,
  • "qoderVideoId": 0,
  • "createdAt": "2020-03-30T04:50:20.635Z",
  • "updatedAt": "2020-03-30T04:50:34.122Z",
  • "playable": false,
  • "playableAt": "2020-03-30T04:50:34.122Z",
  • "playerId": "5f62e36e211aef111068f287",
  • "player": {
    },
  • "primaryPlaybackChannelId": "6087aa53cd7df70e44249807",
  • "primaryPlaybackUrl": {},
  • "playbackChannelIds": [
    ],
  • "playbackUrls": [],
  • "embeddedUrl": "stream-playlist.stream.byteark.com/players/5f62e36e211aef111068f287/videos/RuguHtZPJYm4",
  • "vod": {
    },
  • "creator": {
    },
  • "videoTimemachineId": "5f62e36e211aef111068f288",
  • "videoTimemachine": {
    },
  • "geoblockPolicy": {
    },
  • "customFields": {
    },
  • "customFieldEntries": [
    ],
  • "customImageEnries": [
    ],
  • "simpleCustomImageEnries": [
    ]
}

Remove video

Remove video

Authorizations:
ByteArkTeamAuth
path Parameters
videoKey
required
string
Example: SWhMaRylfmt7

Video key string

Responses

Response samples

Content type
application/json
{
  • "error": "forbidden",
  • "message": "Forbidden reason message"
}

Upload Video Source

อัปโหลดไฟล์วิดีโอไปยัง video key ที่กำหนด

Authorizations:
ByteArkTeamAuth
path Parameters
videoKey
required
string
Example: SWhMaRylfmt7

Video key string

Request Body schema: multipart/form-data
file
required
string <binary>

ไฟล์ที่ต้องการอัปโหลด

Responses

Response samples

Content type
application/json
{
  • "id": "5e817a8cecb9cf0228467837",
  • "key": "RuguHtZPJYm4",
  • "title": "test-video1",
  • "subtitle": "awesome movie you'll never seen before",
  • "duration": 60.1,
  • "tagIds": [
    ],
  • "tags": [
    ],
  • "coverImage": {
    },
  • "projectId": "5e817a56ecb9cf0228467836",
  • "creatorId": "5e81789f5c6dfc0033beb9d3",
  • "qoderProjectId": 0,
  • "qoderVideoId": 0,
  • "createdAt": "2020-03-30T04:50:20.635Z",
  • "updatedAt": "2020-03-30T04:50:34.122Z",
  • "playable": false,
  • "playableAt": "2020-03-30T04:50:34.122Z",
  • "playerId": "5f62e36e211aef111068f287",
  • "player": {
    },
  • "primaryPlaybackChannelId": "6087aa53cd7df70e44249807",
  • "primaryPlaybackUrl": {},
  • "playbackChannelIds": [
    ],
  • "playbackUrls": [],
  • "embeddedUrl": "stream-playlist.stream.byteark.com/players/5f62e36e211aef111068f287/videos/RuguHtZPJYm4",
  • "vod": {
    },
  • "creator": {
    },
  • "videoTimemachineId": "5f62e36e211aef111068f288",
  • "videoTimemachine": {
    },
  • "geoblockPolicy": {
    },
  • "customFields": {
    },
  • "customFieldEntries": [
    ],
  • "customImageEnries": [
    ],
  • "simpleCustomImageEnries": [
    ]
}

List VOD Revision

List VOD Revision

Authorizations:
ByteArkTeamAuth
path Parameters
videoKey
required
string
Example: SWhMaRylfmt7

Video key string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set VOD Revision

Set VOD Revision

Authorizations:
ByteArkTeamAuth
path Parameters
videoKey
required
string
Example: SWhMaRylfmt7

Video key string

Responses

Response samples

Content type
application/json
{
  • "id": "5e817a8cecb9cf0228467837",
  • "key": "RuguHtZPJYm4",
  • "title": "test-video1",
  • "subtitle": "awesome movie you'll never seen before",
  • "duration": 60.1,
  • "tagIds": [
    ],
  • "tags": [
    ],
  • "coverImage": {
    },
  • "projectId": "5e817a56ecb9cf0228467836",
  • "creatorId": "5e81789f5c6dfc0033beb9d3",
  • "qoderProjectId": 0,
  • "qoderVideoId": 0,
  • "createdAt": "2020-03-30T04:50:20.635Z",
  • "updatedAt": "2020-03-30T04:50:34.122Z",
  • "playable": false,
  • "playableAt": "2020-03-30T04:50:34.122Z",
  • "playerId": "5f62e36e211aef111068f287",
  • "player": {
    },
  • "primaryPlaybackChannelId": "6087aa53cd7df70e44249807",
  • "primaryPlaybackUrl": {},
  • "playbackChannelIds": [
    ],
  • "playbackUrls": [],
  • "embeddedUrl": "stream-playlist.stream.byteark.com/players/5f62e36e211aef111068f287/videos/RuguHtZPJYm4",
  • "vod": {
    },
  • "creator": {
    },
  • "videoTimemachineId": "5f62e36e211aef111068f288",
  • "videoTimemachine": {
    },
  • "geoblockPolicy": {
    },
  • "customFields": {
    },
  • "customFieldEntries": [
    ],
  • "customImageEnries": [
    ],
  • "simpleCustomImageEnries": [
    ]
}

Show Video Jobs From Current Revision Key

List exist jobs in video from current revision key

Authorizations:
ByteArkTeamAuth
path Parameters
videoKey
required
string
Example: SWhMaRylfmt7

Video key string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Restore Video

Restore deleted video

Authorizations:
ByteArkTeamAuth
path Parameters
videoKey
required
string
Example: SWhMaRylfmt7

Video key string

Responses

Response samples

Content type
application/json
{
  • "id": "5e817a8cecb9cf0228467837",
  • "key": "RuguHtZPJYm4",
  • "title": "test-video1",
  • "subtitle": "awesome movie you'll never seen before",
  • "duration": 60.1,
  • "tagIds": [
    ],
  • "tags": [
    ],
  • "coverImage": {
    },
  • "projectId": "5e817a56ecb9cf0228467836",
  • "creatorId": "5e81789f5c6dfc0033beb9d3",
  • "qoderProjectId": 0,
  • "qoderVideoId": 0,
  • "createdAt": "2020-03-30T04:50:20.635Z",
  • "updatedAt": "2020-03-30T04:50:34.122Z",
  • "playable": false,
  • "playableAt": "2020-03-30T04:50:34.122Z",
  • "playerId": "5f62e36e211aef111068f287",
  • "player": {
    },
  • "primaryPlaybackChannelId": "6087aa53cd7df70e44249807",
  • "primaryPlaybackUrl": {},
  • "playbackChannelIds": [
    ],
  • "playbackUrls": [],
  • "embeddedUrl": "stream-playlist.stream.byteark.com/players/5f62e36e211aef111068f287/videos/RuguHtZPJYm4",
  • "vod": {
    },
  • "creator": {
    },
  • "videoTimemachineId": "5f62e36e211aef111068f288",
  • "videoTimemachine": {
    },
  • "geoblockPolicy": {
    },
  • "customFields": {
    },
  • "customFieldEntries": [
    ],
  • "customImageEnries": [
    ],
  • "simpleCustomImageEnries": [
    ]
}

Video Revision

API operation related to video on demand

Show VOD Revision

Show VOD Revision

Authorizations:
ByteArkTeamAuth
path Parameters
videoKey
required
string
Example: SWhMaRylfmt7

Video key string

revisionKey
required
string
Example: SZdkKi0Dv6d9

Video revision key

Responses

Response samples

Content type
application/json
{
  • "sourceId": "5e817a8cecb9cf0228467838",
  • "hostingId": "5e817a8cecb9cf0228467838",
  • "storageId": "5e817a8cecb9cf0228467838",
  • "presetId": "5e817a8cecb9cf02284678ea",
  • "processingInfo": {
    },
  • "videoKey": "string",
  • "revisionKey": "string",
  • "submittedAt": "2020-03-30T04:50:34.121Z",
  • "sourceAvailabledAt": "2020-03-30T04:50:34.121Z",
  • "createdAt": "2020-03-30T04:50:20.652Z",
  • "updatedAt": "2020-03-30T04:50:20.652Z",
  • "source": {
    },
  • "hosting": {
    },
  • "storage": {
    },
  • "preset": {
    },
  • "captions": [
    ],
  • "outputs": [
    ]
}

Show Video Jobs From Revision Key

List exist jobs in video from revision key

Authorizations:
ByteArkTeamAuth
path Parameters
videoKey
required
string
Example: SWhMaRylfmt7

Video key string

revisionKey
required
string
Example: SZdkKi0Dv6d9

Video revision key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Tag

Create Video Tag

Create new video Tag

Authorizations:
ByteArkTeamAuth
path Parameters
projectKey
required
string
Example: byteark-staging-123456

Project key

Request Body schema: application/json
Array ()
name
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

List Video Tag

List exist video Tag

Authorizations:
ByteArkTeamAuth
path Parameters
projectKey
required
string
Example: byteark-staging-123456

Project key

Responses

Response samples

Content type
application/json
{
  • "total": 1,
  • "from": 1,
  • "to": 1,
  • "currentPage": 1,
  • "lastPage": 1,
  • "perPage": 20,
  • "data": [
    ]
}

Project

Create Project

Create new project

Authorizations:
ByteArkTeamAuth
Request Body schema: application/json
name
required
string
key
required
string^[a-z0-9]{3,}[a-z0-9-]*-[a-z0-9]{6}$

Project key สำหรับเรียกใช้งาน

description
string
Array of objects (NewMembership) >= 0 items

กำหนดรายช่ือสมาชิกในทีมที่สามารถเข้าถึงโปรเจ็กต์ (ผู้สร้างโปรเจ็กต์จะถูกเพิ่มในรายชื่อโดยอัตโนมัติ)

ProjectNewHosting (object) or ProjectExistingHosting (object)
required
ProjectNewPreset (object) or ProjectExistingPreset (object)
ProjectNewPlaybackChannel (object) or ProjectExistingPlaybackChannel (object)

กำหนดช่องทางการเผยแพร่การรับชม

ProjectNewGeoblock (object) or ProjectExistingGeoblock (object)

กำหนดการตั้งค่า Geo-blocking

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "key": "mynamespace-sample-project-a23da1",
  • "description": "string",
  • "memberships": [
    ],
  • "hosting": {
    },
  • "preset": {
    },
  • "playbackChannel": {
    },
  • "geoblockRule": {
    }
}

Response samples

Content type
application/json
{
  • "name": "ByteArk",
  • "description": "string",
  • "key": "byteark-123fqasdf",
  • "teamNamespace": "byteark",
  • "creatorId": "5f2906c4d9c2cc002333f742",
  • "createdAt": "2019-12-26T09:43:57.032Z",
  • "updatedAt": "2019-12-26T09:43:57.032Z",
  • "deletedAt": "2019-12-26T09:43:57.032Z",
  • "geoblockRuleId": "5e817a8cecb9cf0228467837",
  • "memberships": [
    ],
  • "playerId": "5f3cd3e92d87cd167aede980",
  • "primaryPlaybackChannelId": "string",
  • "playbackChannelIds": [
    ],
  • "hosting": {
    },
  • "preset": {
    },
  • "geoblockRule": {
    },
  • "player": {
    },
  • "primaryPlaybackChannel": {
    },
  • "playbackChannels": [
    ],
  • "currentJobQueueKey": "RuguHtZPJYm4",
  • "currentJobQueue": {
    }
}

List Projects

List exist project

Authorizations:
ByteArkTeamAuth

Responses

Response samples

Content type
application/json
{
  • "total": 1,
  • "from": 1,
  • "to": 1,
  • "currentPage": 1,
  • "lastPage": 1,
  • "perPage": 20,
  • "data": [
    ]
}

Show Projects

Show exist project

Authorizations:
ByteArkTeamAuth
path Parameters
projectKey
required
string
Example: byteark-staging-123456

Project key

Responses

Response samples

Content type
application/json
{
  • "name": "ByteArk",
  • "description": "string",
  • "key": "byteark-123fqasdf",
  • "teamNamespace": "byteark",
  • "creatorId": "5f2906c4d9c2cc002333f742",
  • "createdAt": "2019-12-26T09:43:57.032Z",
  • "updatedAt": "2019-12-26T09:43:57.032Z",
  • "deletedAt": "2019-12-26T09:43:57.032Z",
  • "geoblockRuleId": "5e817a8cecb9cf0228467837",
  • "memberships": [
    ],
  • "playerId": "5f3cd3e92d87cd167aede980",
  • "primaryPlaybackChannelId": "string",
  • "playbackChannelIds": [
    ],
  • "hosting": {
    },
  • "preset": {
    },
  • "geoblockRule": {
    },
  • "player": {
    },
  • "primaryPlaybackChannel": {
    },
  • "playbackChannels": [
    ],
  • "currentJobQueueKey": "RuguHtZPJYm4",
  • "currentJobQueue": {
    }
}

Update Project

Update project

Authorizations:
ByteArkTeamAuth
path Parameters
projectKey
required
string
Example: byteark-staging-123456

Project key

Request Body schema: application/json
name
required
string

Project name

description
string
presetId
string

Preset id ที่ต้องการเปลี่ยนมาใช้งาน (มีผลกับวิดีโอใหม่เท่านั้น)

geoblockRuleId
string

Geoblock rule id ที่ต้องการเปลี่ยนมาใช้งาน (มีผลกับวิดีโอใหม่เท่านั้น)

playerId
string

Player id ที่ต้องการเปลี่ยนมาใช้งาน (มีผลย้อนหลังทุกวิดีโอใน Project)
ในกรณีที่วิดีโอถูกเผยแพร่ด้วย Player id ก่อนหน้า จะยังสามารถรับชมได้ตามปกติ

storageTierKey
string
Enum: "standard" "nearline" "standard_2_sites"

storage tier key for updated video in project

Responses

Request samples

Content type
application/json
{
  • "name": "Name Example",
  • "description": "Description Example",
  • "presetId": "string",
  • "geoblockRuleId": "5e817a8cecb9cf0228467837",
  • "playerId": "5e817a8cecb9cf0228467837",
  • "storageTierKey": "nearline"
}

Response samples

Content type
application/json
{
  • "name": "ByteArk",
  • "description": "string",
  • "key": "byteark-123fqasdf",
  • "teamNamespace": "byteark",
  • "creatorId": "5f2906c4d9c2cc002333f742",
  • "createdAt": "2019-12-26T09:43:57.032Z",
  • "updatedAt": "2019-12-26T09:43:57.032Z",
  • "deletedAt": "2019-12-26T09:43:57.032Z",
  • "geoblockRuleId": "5e817a8cecb9cf0228467837",
  • "memberships": [
    ],
  • "playerId": "5f3cd3e92d87cd167aede980",
  • "primaryPlaybackChannelId": "string",
  • "playbackChannelIds": [
    ],
  • "hosting": {
    },
  • "preset": {
    },
  • "geoblockRule": {
    },
  • "player": {
    },
  • "primaryPlaybackChannel": {
    },
  • "playbackChannels": [
    ],
  • "currentJobQueueKey": "RuguHtZPJYm4",
  • "currentJobQueue": {
    }
}

Destroy Project

Destroy project

Authorizations:
ByteArkTeamAuth
path Parameters
projectKey
required
string
Example: byteark-staging-123456

Project key

Responses

Response samples

Content type
application/json
{
  • "error": "forbidden",
  • "message": "Forbidden reason message"
}

Project Memberships

Show Memberships

Show memberships in project

Authorizations:
ByteArkTeamAuth
path Parameters
projectKey
required
string
Example: byteark-staging-123456

Project key

Responses

Response samples

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

Add Memberships

Add new memberships to project

Authorizations:
ByteArkTeamAuth
path Parameters
projectKey
required
string
Example: byteark-staging-123456

Project key

Request Body schema: application/json
Array of objects (NewMembership)

Responses

Request samples

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

Response samples

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

Update Membership Role

Update role of membership

Authorizations:
ByteArkTeamAuth
path Parameters
projectKey
required
string
Example: byteark-staging-123456

Project key

accountId
required
string
Example: 5e8da15216511941396124e4
Request Body schema: application/json
projectRole
required
string
Enum: "admin" "uploader" "viewer"

Responses

Request samples

Content type
application/json
{
  • "projectRole": "uploader"
}

Response samples

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

Remove membership

Remove membership from project

Authorizations:
ByteArkTeamAuth
path Parameters
projectKey
required
string
Example: byteark-staging-123456

Project key

accountId
required
string
Example: 5e8da15216511941396124e4

Responses

Response samples

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

Me

Show My Detail

show my account detail

Authorizations:
ByteArkTeamAuth

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "bytearkAccountUserId": 123,
  • "name": "ByteArk User",
  • "email": "byteark-user@inox.co.th",
  • "username": "byteark/user@byteark.com",
  • "lang": "th",
  • "role": "manager",
  • "isBot": true,
  • "displayImage": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "team": {
    }
}

Collection

List Collections in Project

List existing collections in project

Authorizations:
ByteArkTeamAuth
path Parameters
projectKey
required
string
Example: byteark-staging-123456

Project key

Responses

Response samples

Content type
application/json
{
  • "total": 1,
  • "from": 1,
  • "to": 1,
  • "currentPage": 1,
  • "lastPage": 1,
  • "perPage": 20,
  • "data": [
    ]
}

Get Collection

Show existing collection within a project, with videos inside

Authorizations:
ByteArkTeamAuth
path Parameters
projectKey
required
string
Example: byteark-staging-123456

Project key

collectionId
required
string
Example: 5e817a8cecb9cf0228467837

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "collectionTypeId": "string",
  • "name": "Sample Collection",
  • "excerpt": "This is a sample collection",
  • "coverImage": {
    },
  • "tagIds": [
    ],
  • "tags": [
    ],
  • "customFieldEntries": [
    ],
  • "customImageEntries": [
    ],
  • "createdAt": "2020-03-30T04:50:20.635Z",
  • "updatedAt": "2020-03-30T04:50:34.122Z",
  • "itemLists": [
    ]
}

Snapshots

Show Video Snapshot

Show video snapshot

Authorizations:
ByteArkTeamAuth
path Parameters
videoKey
required
string
Example: SWhMaRylfmt7

Video key string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Preset

List Preset

List exist preset of team including default preset

Authorizations:
ByteArkTeamAuth

Responses

Response samples

Content type
application/json
{
  • "total": 1,
  • "from": 1,
  • "to": 1,
  • "currentPage": 1,
  • "lastPage": 1,
  • "perPage": 20,
  • "data": [
    ]
}

List Format

List exist format

Authorizations:
ByteArkTeamAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List Codec

List exist codec

Authorizations:
ByteArkTeamAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List Resolution

List predefined resolution

Authorizations:
ByteArkTeamAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Show Preset

Show exist preset

Authorizations:
ByteArkTeamAuth
path Parameters
presetId
required
string
Example: 5e817a8cecb9cf0228467837

Responses

Response samples

Content type
application/json
{
  • "id": "5e817a8cecb9cf0228467837",
  • "name": "HLS only",
  • "key": "S0G9uJaV",
  • "teamNamespace": "inox",
  • "isTeamDefault": true,
  • "isGlobalDefault": false,
  • "editable": true,
  • "enableBitRatePrediction": false,
  • "profiles": [
    ],
  • "createdAt": "2019-12-26T09:43:57.032Z",
  • "updatedAt": "2019-12-26T09:43:57.032Z"
}

Playback Channel

List Playback Channel

List playback channel

Authorizations:
ByteArkTeamAuth

Responses

Response samples

Content type
application/json
{
  • "total": 1,
  • "from": 1,
  • "to": 1,
  • "currentPage": 1,
  • "lastPage": 1,
  • "perPage": 20,
  • "data": [
    ]
}

Show Playback Channel

Show playback channel

Authorizations:
ByteArkTeamAuth
path Parameters
playbackChannelId
required
string

Playback Channel ID

Responses

Response samples

Content type
application/json
{
  • "id": "5f3cd3e92d87cd167aede980",
  • "teamNamespace": "byteark",
  • "defaultPlaybackDomain": "string",
  • "playbackDomains": [
    ],
  • "signedUrl": {
    },
  • "accessControlPolicy": {
    },
  • "allowPreview": true,
  • "isTeamDefault": false
}

Image

Upload Image

Upload image

Authorizations:
ByteArkTeamAuth
Request Body schema: multipart/form-data
file
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "mediaServerType": "imgproxy",
  • "size": { }
}

Upload Snapshots

Upload snapshots

Authorizations:
ByteArkTeamAuth
query Parameters
token
required
string
Example: token=token
Request Body schema: multipart/form-data
file
required
string <binary>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Original Image File

Get original image file

Authorizations:
path Parameters
prefix1
required
string
Example: R
prefix2
required
string
Example: y
filePath
required
string
Example: Ry6Aqt7NsDKN.png

Responses

Get Image File

Get image file

Authorizations:
ByteArkTeamAuth
path Parameters
imagePreset
required
string
Example: video-cover-144p
prefix1
required
string
Example: R
prefix2
required
string
Example: y
filePath
required
string
Example: Ry6Aqt7NsDKN.png

Responses

Imagine

Upload Multiple Images

Upload multiple images

Authorizations:
ByteArkTeamAuth
Request Body schema: multipart/form-data
file
required
string <binary>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GeoblockRule

List GeoblockRule

List exist geoblockRule of team including default geoblockRule

Authorizations:
ByteArkTeamAuth

Responses

Response samples

Content type
application/json
{
  • "total": 1,
  • "from": 1,
  • "to": 1,
  • "currentPage": 1,
  • "lastPage": 1,
  • "perPage": 20,
  • "data": [
    ]
}

Show GeoblockRule

Show exist geoblockRule

Authorizations:
ByteArkTeamAuth
path Parameters
geoblockRuleId
required
string
Example: 5e817a8cecb9cf0228467837

Geoblock rule ID

Responses

Response samples

Content type
application/json
{
  • "id": "5e817a8cecb9cf0228467837",
  • "name": "test geoblock",
  • "teamNamespace": "inox",
  • "isTeamDefault": false,
  • "isGlobalDefault": false,
  • "createdAt": "2020-03-30T04:50:20.635Z",
  • "updatedAt": "2020-03-30T04:50:34.122Z",
  • "allowCountryCodes": [
    ],
  • "denyCountryCodes": [ ]
}

Update GeoblockRule

Update GeoblockRule

Authorizations:
ByteArkTeamAuth
path Parameters
geoblockRuleId
required
string
Example: 5e817a8cecb9cf0228467837

Geoblock rule ID

Request Body schema: application/json
name
required
string
allowCountryCodes
required
Array of strings >= 0 items

ระบุประเทศที่อนุญาตให้รับชม โดยใช้รหัสประเทศ 2 ตัว จาก API List Country

denyCountryCodes
required
Array of strings >= 0 items

ระบุประเทศที่ไม่อนุญาตให้รับชม โดยใช้รหัสประเทศ 2 ตัว จาก API List Country

Responses

Request samples

Content type
application/json
{
  • "name": "Allow From TH",
  • "allowCountryCodes": [
    ],
  • "denyCountryCodes": [ ]
}

Response samples

Content type
application/json
{
  • "id": "5e817a8cecb9cf0228467837",
  • "name": "test geoblock",
  • "teamNamespace": "inox",
  • "isTeamDefault": false,
  • "isGlobalDefault": false,
  • "createdAt": "2020-03-30T04:50:20.635Z",
  • "updatedAt": "2020-03-30T04:50:34.122Z",
  • "allowCountryCodes": [
    ],
  • "denyCountryCodes": [ ]
}

Delete GeoblockRule

Destroy geoblockRule

Authorizations:
ByteArkTeamAuth
path Parameters
geoblockRuleId
required
string
Example: 5e817a8cecb9cf0228467837

Geoblock rule ID

Responses

Response samples

Content type
application/json
{
  • "error": "forbidden",
  • "message": "Forbidden reason message"
}

List Country

List Countries detail

Authorizations:
ByteArkTeamAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Player

List Player

List exist player

Authorizations:
ByteArkTeamAuth

Responses

Response samples

Content type
application/json
{
  • "total": 1,
  • "from": 1,
  • "to": 1,
  • "currentPage": 1,
  • "lastPage": 1,
  • "perPage": 20,
  • "data": [
    ]
}

Show Player

Show exist player

Authorizations:
ByteArkTeamAuth
path Parameters
playerId
required
string
Example: 5f3cd3e92d87cd167aede980

Responses

Response samples

Content type
application/json
{
  • "id": "5f3cd3e92d87cd167aede980",
  • "name": "test player",
  • "options": { },
  • "teamNamespace": "inox",
  • "isTeamDefault": false,
  • "createdAt": "2020-03-30T04:50:20.635Z",
  • "updatedAt": "2020-03-30T04:50:34.122Z",
  • "accessControlPolicy": {
    }
}