{"openapi":"3.0.0","info":{"title":"5centsCDN - Transcoding","description":"API for managing Transcoding in <a href=\"https://www.5centscdn.net\" target=\"_blank\">5centsCDN</a>","version":"4.0.0","contact":{"email":"help@5centscdn.com"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"servers":[{"url":"https://api.5centscdn.com/v2","description":"5centsCDN API Server - Production"}],"security":[{"ApiKeyAuth":[]}],"tags":[{"name":"File Transcoding Profiles","description":"endpoints related to Global Transcode Preset Profiles"},{"name":"Reports -  Video Transcoding Minutes","description":"Reports for  Video Transcoding Minutes"}],"paths":{"/transcoding/file/profiles":{"get":{"tags":["File Transcoding Profiles"],"summary":"List File Transcoding Profiles","description":"List File Transcoding Profiles","operationId":"ProfilesList","responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"success"},"profiles":{"$ref":"#/components/schemas/transcodeProfileList"}}}}}}}}},"/transcoding/file/profiles/defaults":{"post":{"tags":["File Transcoding Profiles"],"summary":"Create Global Auto Transcode Preset Profiles","description":"These presets will be automatically added to your new zones","operationId":"createAutoTranscodeProfiles","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/createDefaultProfiles"}}}},"deprecated":false,"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"success"},"message":{"type":"string"}}}}}}}}},"/transcoding/file/profiles/new":{"post":{"tags":["File Transcoding Profiles"],"summary":"Create Transcoding Profiles","description":"Create Transcoding Profiles","operationId":"createTranscodingProfile","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/createProfileCombined"}}}},"deprecated":false,"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"success"},"message":{"type":"string"}}}}}}}}},"/transcoding/file/profiles/{profileid}":{"post":{"tags":["File Transcoding Profiles"],"summary":"Edit Transcoding Profile","description":"Edit Transcoding Profile","operationId":"editTranscodingProfile","parameters":[{"$ref":"#/components/parameters/profileIdParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/editProfileCombined"}}}},"deprecated":false,"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"success"},"message":{"type":"string"}}}}}}}},"delete":{"tags":["File Transcoding Profiles"],"summary":"Delete Transcoding Profile","description":"Delete the information of Transcoding Profile. To cast request method POST and parameters _METHOD = DELETE","operationId":"deleteTranscodingProfile","parameters":[{"$ref":"#/components/parameters/profileIdParam"}],"deprecated":false,"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"success"},"message":{"type":"string"}}}}}}}}},"/transcoding/file/filters":{"get":{"tags":["File Transcoding Profiles"],"summary":"List File Transcoding Filters","description":"List File Transcoding Filters","operationId":"transcodingFileFilter","responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"success"},"filters":{"$ref":"#/components/schemas/filtersList"}}}}}}}}},"/transcoding/file/filters/new":{"post":{"tags":["File Transcoding Profiles"],"summary":"Create File Transcoding Filters","description":"Create File Transcoding Filters","operationId":"createFileTranscodingFilter","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/createFileTranscodingFilter"}}}},"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"success"},"filters":{"$ref":"#/components/schemas/filtersList"}}}}}}}}},"/transcoding/file/filters/{filterid}":{"post":{"tags":["File Transcoding Profiles"],"summary":"Edit Transcoding Profile Filter","description":"Edit Transcoding Profile Filter","operationId":"editTranscodingProfileFilter","parameters":[{"$ref":"#/components/parameters/filterIdParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/editFileTranscodingFilter"}}}},"deprecated":false,"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"success"},"message":{"type":"string"}}}}}}}},"delete":{"tags":["File Transcoding Profiles"],"summary":"Edit Transcoding Profile Filter","description":"Delete the information of Transcoding Profile filter. To cast request method POST and parameters _METHOD = DELETE","operationId":"deleteTranscodingProfileFilter","parameters":[{"$ref":"#/components/parameters/filterIdParam"}],"deprecated":false,"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"success"},"message":{"type":"string"}}}}}}}}},"/transcoding/file/mins/stats":{"post":{"tags":["Reports -  Video Transcoding Minutes"],"summary":"Reports by Video Transcoding Minutes","description":"Get reports of Video Transcoding Minutes","operationId":"reportVideoTranscodingMinutes","parameters":[{"$ref":"#/components/parameters/rParam"},{"$ref":"#/components/parameters/fParam"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","example":"success"},"zones":{"type":"array","items":{"type":"integer","format":"int64"}},"logs":{"type":"array","items":{"$ref":"#/components/schemas/logsList"}}}}}}}}}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key"}},"schemas":{"transcodeProfileList":{"properties":{"0":{"type":"object","properties":{"id":{"type":"integer"},"serviceid":{"type":"integer"},"type":{"type":"string"},"name":{"type":"string"},"filemode":{"type":"string"},"settings":{"$ref":"#/components/schemas/settingsList"},"codec":{"type":"string"}}}}},"filtersList":{"properties":{"0":{"type":"object","properties":{"id":{"type":"integer"},"serviceid":{"type":"integer"},"type":{"type":"string"},"name":{"type":"string"},"settings":{"$ref":"#/components/schemas/settingFilterList"}}}}},"settingFilterList":{"properties":{"filter":{"type":"string"},"args":{"type":"object","properties":{"text":{"type":"string"},"fontsize":{"type":"integer"},"fontcolor":{"type":"string"},"position":{"type":"string"},"url":{"type":"string"},"scale":{"type":"integer"}}}}},"settingsList":{"properties":{"name":{"type":"string"},"f":{"type":"string"},"cv":{"type":"string"},"sv":{"type":"string"},"svvalue":{"type":"string"},"crfv":{"type":"integer"},"bv":{"type":"integer"},"bvvalue":{"type":"integer"},"vpass":{"type":"integer"},"vprofile":{"type":"string"},"ca":{"type":"string"},"aca":{"type":"integer"},"ba":{"type":"integer"},"bavalue":{"type":"integer"},"ara":{"type":"integer"},"filemode":{"type":"string"}}},"logsList":{"properties":{"serverid":{"type":"integer","format":"int64"},"id":{"type":"integer","format":"int64"},"type":{"type":"string"},"file":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"}}},"editFileTranscodingFilter":{"properties":{"args":{"type":"object","properties":{"url":{"type":"string","description":"Enter Logo Url"},"scale":{"type":"integer","format":"int32","description":"values can be \tmin: 5, max: 150"},"position":{"type":"string","description":"Enter position"},"text":{"type":"string","description":"Enter watermark text"},"fontsize":{"type":"integer","format":"int32","description":"Enter text font size"},"fontcolor":{"type":"string","description":"Enter text font color"}}}}},"createFileTranscodingFilter":{"required":["name","_METHOD"],"properties":{"_METHOD":{"type":"string","description":"To cast request method POST to PUT","example":"PUT"},"name":{"type":"string","description":"Enter fliter name"},"filter":{"type":"string","description":"Filter settings values can be overlay or drawtext"},"args":{"type":"object","properties":{"overlay":{"type":"object","properties":{"url":{"type":"string","description":"Enter Logo Url"},"scale":{"type":"integer","format":"int32","description":"values can be \tmin: 5, max: 150"},"position":{"type":"string","description":"Enter position of logo"}}},"drawtext":{"type":"object","properties":{"text":{"type":"string","description":"Enter watermark text"},"fontsize":{"type":"integer","format":"int32","description":"Enter text font size"},"fontcolor":{"type":"string","description":"Enter text font color"},"position":{"type":"string","description":"Enter text postion"}}}}}}},"createDefaultProfiles":{"properties":{"defaultprofiles":{"type":"array","items":{"type":"integer","format":"int64","description":"defaultprofiles, Should be one of the profiles id from the GET /transcoding/file/profiles call"}}}},"createProfileCombined":{"required":["name","_METHOD"],"properties":{"_METHOD":{"type":"string","description":"To cast request method POST to PUT","example":"PUT"},"filemode":{"type":"string","description":"values can set Single or Combined","example":"Single"},"name":{"type":"string","description":"Enter profile name"},"f":{"type":"string","description":"Values can be mp4 or webm.","example":"mp4"},"cv":{"type":"string","description":"Values can be libx264,libx265 set Container Format is mp4. when Container Format is webm set value libvpx-vp9.","example":"libx264"},"sv":{"type":"string","description":"Resolution values can be 0,1,1080p,720p,576p,480p,360p or 240p","example":0},"svvalue":{"type":"string","description":"value can be this format Width x Height"},"crfv":{"type":"integer","format":"int64","description":"Constrained Quality values can be 18,24, or 28"},"bv":{"type":"integer","format":"int32","description":"Values can be 0 or 1.<br>Set to 0 if Bitrate should be As Source.<br> Set to 1 if Bitrate should be As Defined."},"bvvalue":{"type":"integer","format":"int64","description":"values can be \tmin: 256, max: 4096"},"vpass":{"type":"integer","format":"int32","description":"Bitrate value should  be set  1 then set no pass 1 or 2"},"vprofile":{"type":"string","description":"Profile values can be disabled,baseline,main or high","example":"disabled"},"vlevel":{"type":"string","description":"Level. It can be set if  Profile is baseline,main or high. profile value is  set basline  value of level is 3.0 or 3.1. profile value is  set main  value of level is 3.1 or 4.0. profile value is  set high  value of level is 4.0,4.1 or 4.2"},"upscale":{"type":"string","description":"Video upscaling value Y to set allow and N to to set disallow","example":"Y"},"ca":{"type":"string","description":"Codec. value can be set aac, libmp3lame,libvorbis or libopus","example":"aac"},"aca":{"type":"integer","format":"int32","description":"Channels values can set 0,1 or 2"},"ba":{"type":"integer","format":"int32","description":"Audio settings bitrate value can be 0 or 1."},"bavalue":{"type":"integer","format":"int64","description":"value can be \tmin: 48, max: 196","example":80},"ara":{"type":"integer","format":"int64","description":"Sample Rate can be set 44100 or 48000","example":44100},"tm":{"type":"string","description":"Values can be disabled,fixed or interval.","example":"disabled"},"tv":{"type":"string","description":"Enter time in H:i:s format","example":"00:00:00"},"filters":{"type":"array","items":{"type":"integer","format":"int32","description":"values can be 1 or 2.  <br>Set to 1 if Horizontal Flip should be enabled.<br> Set to 2 if Vertical Flip should be disabled."}},"sourcevideo":{"type":"string","description":"Filemode is Combined set Original Video Stream, Values can be Y or N. <br>Set to Y if Video Stream should be enabled.<br> Set to N if Video Stream should be disabled.","example":"N"},"sourceaudio":{"type":"string","description":"Filemode is Combined set Audio Streams, Values can be Y,O or A.","example":"O"},"profiles":{"type":"array","items":{"type":"integer","format":"int64","description":"Filemode is Combined set defaultprofiles, Should be one of the profiles id from the GET /transcoding/file/profiles call"}}}},"editProfileCombined":{"properties":{"filemode":{"type":"string","description":"values can set Single or Combined","example":"Single"},"f":{"type":"string","description":"Values can be mp4 or webm.","example":"mp4"},"cv":{"type":"string","description":"Values can be libx264,libx265 set Container Format is mp4. when Container Format is webm set value libvpx-vp9.","example":"libx264"},"sv":{"type":"string","description":"Resolution values can be 0,1,1080p,720p,576p,480p,360p or 240p","example":0},"svvalue":{"type":"string","description":"value can be this format Width x Height"},"crfv":{"type":"integer","format":"int64","description":"Constrained Quality values can be 18,24, or 28"},"bv":{"type":"integer","format":"int32","description":"Values can be 0 or 1.<br>Set to 0 if Bitrate should be As Source.<br> Set to 1 if Bitrate should be As Defined."},"bvvalue":{"type":"integer","format":"int64","description":"values can be \tmin: 256, max: 4096"},"vpass":{"type":"integer","format":"int32","description":"Bitrate value should  be set  1 then set no pass 1 or 2"},"vprofile":{"type":"string","description":"Profile values can be disabled,baseline,main or high","example":"disabled"},"vlevel":{"type":"string","description":"Level. It can be set if  Profile is baseline,main or high. profile value is  set basline  value of level is 3.0 or 3.1. profile value is  set main  value of level is 3.1 or 4.0. profile value is  set high  value of level is 4.0,4.1 or 4.2"},"upscale":{"type":"string","description":"Video upscaling value Y to set allow and N to to set disallow","example":"Y"},"ca":{"type":"string","description":"Codec. value can be set aac, libmp3lame,libvorbis or libopus","example":"aac"},"aca":{"type":"integer","format":"int32","description":"Channels values can set 0,1 or 2"},"ba":{"type":"integer","format":"int32","description":"Audio settings bitrate value can be 0 or 1."},"bavalue":{"type":"integer","format":"int64","description":"value can be \tmin: 48, max: 196","example":80},"ara":{"type":"integer","format":"int64","description":"Sample Rate can be set 44100 or 48000","example":44100},"tm":{"type":"string","description":"Values can be disabled,fixed or interval.","example":"disabled"},"tv":{"type":"string","description":"Enter time in H:i:s format","example":"00:00:00"},"filters":{"type":"array","items":{"type":"integer","format":"int32","description":"values can be 1 or 2.  <br>Set to 1 if Horizontal Flip should be enabled.<br> Set to 2 if Vertical Flip should be disabled."}},"sourcevideo":{"type":"string","description":"Filemode is Combined set Original Video Stream, Values can be Y or N. <br>Set to Y if Video Stream should be enabled.<br> Set to N if Video Stream should be disabled.","example":"N"},"sourceaudio":{"type":"string","description":"Filemode is Combined set Audio Streams, Values can be Y,O or A.","example":"O"},"profiles":{"type":"array","items":{"type":"integer","format":"int64","description":"Filemode is Combined set defaultprofiles, Should be one of the profiles id from the GET /transcoding/file/profiles call"}}}}},"parameters":{"profileIdParam":{"name":"profileid","in":"path","description":"Id of the Transcode Profile","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},"filterIdParam":{"name":"filterid","in":"path","description":"Id of the Transcode Profile filter","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},"rParam":{"name":"r","in":"header","description":"Enter date range","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},"fParam":{"name":"f","in":"header","description":"Enter reported by","style":"simple","explode":false,"schema":{"type":"string"}}}}}