Retrieves the specified Application configuration

Application Operations

Operations

Adds an Application to the list of Applications for the specified vhost

Request

This API is available in builds 15089 or later.

Security

basicAuth

Path

serverNamestringrequired

Reserved for future use

Default "_defaultServer_"

vhostNamestringrequired

Default "_defaultVHost_"

Bodyapplication/jsonrequired

httpOptimizeFileReadsbooleanrequired

captionLiveIngestTypestringrequired

streamConfigobject(StreamConfigurationConfig)required

streamConfig.streamTypestringrequired

streamConfig.storageDirExistsbooleanrequired

streamConfig.keyDirstringrequired

streamConfig.createStorageDirbooleanrequired

streamConfig.liveStreamPacketizerArray of stringsrequired

streamConfig.serverNamestringrequired

streamConfig.storageDirstringrequired

streamConfig.saveFieldListArray of strings

streamConfig.versionstringrequired

streamConfig.httpRandomizeMediaNamebooleanrequired

serverNamestringrequired

descriptionstringrequired

closedCaptionLiveOutput608Enabledbooleanrequired

webRTCConfigobject(WebRTCConfig)required

webRTCConfig.udpBindAddressstringrequired

webRTCConfig.enablePlaybooleanrequired

webRTCConfig.preferredCodecsAudiostringrequired

webRTCConfig.preferredCodecsVideostringrequired

webRTCConfig.enableQuerybooleanrequired

webRTCConfig.debugLogbooleanrequired

webRTCConfig.serverNamestringrequired

webRTCConfig.saveFieldListArray of strings

webRTCConfig.iceCandidateIpAddressesstringrequired

webRTCConfig.versionstringrequired

webRTCConfig.enablePublishbooleanrequired

mediaCacheSourceListArray of stringsrequired

repeaterOriginURLstringrequired

clientStreamReadAccessstringrequired

appTypestringrequired

pingTimeoutinteger(int32)required

vodTimedTextProvidersArray of stringsrequired

saveFieldListArray of strings

mediaReaderRandomAccessReaderClassstringrequired

mediaReaderBufferSeekIObooleanrequired

httpStreamersArray of stringsrequired

httpCORSHeadersEnabledbooleanrequired

closedCaptionLiveOutput708Enabledbooleanrequired

avSyncMethodstringrequired

transcoderConfigobject(TranscoderAppConfig)required

transcoderConfig.profileDirstringrequired

transcoderConfig.licensedbooleanrequired

transcoderConfig.templatesobject(TranscoderTemplatesConfig)required

transcoderConfig.templates.vhostNamestringrequired

transcoderConfig.templates.templatesArray of objects(ShortObject)required

transcoderConfig.templates.templates[].idstringrequired

transcoderConfig.templates.templates[].hrefstringrequired

transcoderConfig.templates.serverNamestringrequired

transcoderConfig.templates.saveFieldListArray of strings

transcoderConfig.templates.versionstringrequired

transcoderConfig.availablebooleanrequired

transcoderConfig.serverNamestringrequired

transcoderConfig.templateDirstringrequired

transcoderConfig.versionstringrequired

transcoderConfig.createTemplateDirbooleanrequired

transcoderConfig.licensesinteger(int32)required

transcoderConfig.liveStreamTranscoderstringrequired

transcoderConfig.templatesInUsestringrequired

transcoderConfig.licensesInUseinteger(int32)required

transcoderConfig.saveFieldListArray of strings

clientStreamWriteAccessstringrequired

repeaterQueryStringstringrequired

drmConfigobject(DRMConfig)required

drmConfig.buyDRMProtectMpegDashStreamingbooleanrequired

drmConfig.serverNamestringrequired

drmConfig.buyDRMProtectCupertinoStreamingbooleanrequired

drmConfig.versionstringrequired

drmConfig.verimatrixCupertinoKeyServerPortinteger(int32)required

drmConfig.verimatrixSmoothKeyServerPortinteger(int32)required

drmConfig.verimatrixStreamMapsobject(VerimatrixStreamMapsConfig)required

drmConfig.verimatrixStreamMaps.filenamestringrequired

drmConfig.verimatrixStreamMaps.serverNamestringrequired

drmConfig.verimatrixStreamMaps.saveFieldListArray of strings

drmConfig.verimatrixStreamMaps.versionstringrequired

drmConfig.verimatrixStreamMaps.verimatrixStreamMapsArray of stringsrequired

drmConfig.verimatrixSmoothKeyServerIpAddressstringrequired

drmConfig.licenseTypestringrequired

drmConfig.verimatrixCupertinoKeyServerIpAddressstringrequired

drmConfig.buyDRMProtectSmoothStreamingbooleanrequired

drmConfig.buyDRMUserKeystringrequired

drmConfig.inUsebooleanrequired

drmConfig.ezDRMUsernamestringrequired

drmConfig.verimatrixProtectSmoothStreamingbooleanrequired

drmConfig.buyDRMStreamMapsobject(BuyDRMStreamMapsConfig)required

drmConfig.buyDRMStreamMaps.buyDRMStreamNameMapFilestringrequired

drmConfig.buyDRMStreamMaps.serverNamestringrequired

drmConfig.buyDRMStreamMaps.saveFieldListArray of strings

drmConfig.buyDRMStreamMaps.versionstringrequired

drmConfig.verimatrixCupertinoVODPerSessionKeysbooleanrequired

drmConfig.saveFieldListArray of strings

drmConfig.ezDRMPasswordstringrequired

drmConfig.verimatrixProtectCupertinoStreamingbooleanrequired

drmConfig.cupertinoEncryptionAPIBasedbooleanrequired

versionstringrequired

modulesobject(ModulesConfig)required

modules.moduleListArray of objects(ModuleConfig)required

modules.moduleList[].namestringrequired

modules.moduleList[].serverNamestringrequired

modules.moduleList[].descriptionstringrequired

modules.moduleList[].saveFieldListArray of strings

modules.moduleList[].versionstringrequired

modules.moduleList[].classstringrequired

modules.moduleList[].orderinteger(int32)required

modules.serverNamestringrequired

modules.saveFieldListArray of strings

modules.versionstringrequired

srtListenerAuthenticationModestringrequired

maxRTCPWaitTimeinteger(int32)required

securityConfigobject(SecurityConfig)required

securityConfig.playMaximumConnectionsinteger(int32)required

securityConfig.publishBlockDuplicateStreamNamesbooleanrequired

securityConfig.publishIPWhiteListstringrequired

securityConfig.playAuthenticationMethodstringrequired

securityConfig.serverNamestringrequired

securityConfig.clientStreamWriteAccessstringrequired

securityConfig.playIPWhiteListstringrequired

securityConfig.publishRequirePasswordbooleanrequired

securityConfig.playIPBlackListstringrequired

securityConfig.versionstringrequired

securityConfig.secureTokenVersioninteger(int32)required

securityConfig.publishPasswordFilestringrequired

securityConfig.publishValidEncodersstringrequired

securityConfig.secureTokenQueryParametersPrefixstringrequired

securityConfig.secureTokenUseTEAForRTMPbooleanrequired

securityConfig.publishAuthenticationMethodstringrequired

securityConfig.secureTokenHashAlgorithmstringrequired

securityConfig.publishIPBlackListstringrequired

securityConfig.playRequireSecureConnectionbooleanrequired

securityConfig.secureTokenOriginSharedSecretstringrequired

securityConfig.saveFieldListArray of strings

securityConfig.secureTokenIncludeClientIPInHashbooleanrequired

securityConfig.publishRTMPSecureURLstringrequired

securityConfig.secureTokenSharedSecretstringrequired

dvrConfigobject(DVRConfig)required

dvrConfig.windowDurationinteger(int32)required

dvrConfig.dvrMediaCacheEnabledbooleanrequired

dvrConfig.dvrEnablebooleanrequired

dvrConfig.startRecordingOnStartupbooleanrequired

dvrConfig.serverNamestringrequired

dvrConfig.storestringrequired

dvrConfig.versionstringrequired

dvrConfig.recordersstringrequired

dvrConfig.dvrOnlyStreamingbooleanrequired

dvrConfig.httpRandomizeMediaNamebooleanrequired

dvrConfig.licenseTypestringrequired

dvrConfig.dvrEncryptionSharedSecretstringrequired

dvrConfig.inUsebooleanrequired

dvrConfig.archiveStrategystringrequired

dvrConfig.storageDirstringrequired

dvrConfig.saveFieldListArray of strings

applicationTimeoutinteger(int32)required

namestringrequired

curl -i -X POST \
  -u <username>:<password> \
  'http://localhost:8089/v2/servers/{serverName}/vhosts/{vhostName}/applications' \
  -H 'Content-Type: application/json' \
  -d '{
    "httpOptimizeFileReads": true,
    "captionLiveIngestType": "string",
    "streamConfig": {
      "streamType": "string",
      "storageDirExists": true,
      "keyDir": "string",
      "createStorageDir": true,
      "liveStreamPacketizer": [
        "string"
      ],
      "serverName": "string",
      "storageDir": "string",
      "saveFieldList": [
        "string"
      ],
      "version": "string",
      "httpRandomizeMediaName": true
    },
    "serverName": "string",
    "description": "string",
    "closedCaptionLiveOutput608Enabled": true,
    "webRTCConfig": {
      "udpBindAddress": "string",
      "enablePlay": true,
      "preferredCodecsAudio": "string",
      "preferredCodecsVideo": "string",
      "enableQuery": true,
      "debugLog": true,
      "serverName": "string",
      "saveFieldList": [
        "string"
      ],
      "iceCandidateIpAddresses": "string",
      "version": "string",
      "enablePublish": true
    },
    "mediaCacheSourceList": [
      "string"
    ],
    "repeaterOriginURL": "string",
    "clientStreamReadAccess": "string",
    "appType": "string",
    "pingTimeout": 0,
    "vodTimedTextProviders": [
      "string"
    ],
    "saveFieldList": [
      "string"
    ],
    "mediaReaderRandomAccessReaderClass": "string",
    "mediaReaderBufferSeekIO": true,
    "httpStreamers": [
      "string"
    ],
    "httpCORSHeadersEnabled": true,
    "closedCaptionLiveOutput708Enabled": true,
    "avSyncMethod": "string",
    "transcoderConfig": {
      "profileDir": "string",
      "licensed": true,
      "templates": {
        "vhostName": "string",
        "templates": [
          {
            "id": "string",
            "href": "string"
          }
        ],
        "serverName": "string",
        "saveFieldList": [
          "string"
        ],
        "version": "string"
      },
      "available": true,
      "serverName": "string",
      "templateDir": "string",
      "version": "string",
      "createTemplateDir": true,
      "licenses": 0,
      "liveStreamTranscoder": "string",
      "templatesInUse": "string",
      "licensesInUse": 0,
      "saveFieldList": [
        "string"
      ]
    },
    "clientStreamWriteAccess": "string",
    "repeaterQueryString": "string",
    "drmConfig": {
      "buyDRMProtectMpegDashStreaming": true,
      "serverName": "string",
      "buyDRMProtectCupertinoStreaming": true,
      "version": "string",
      "verimatrixCupertinoKeyServerPort": 0,
      "verimatrixSmoothKeyServerPort": 0,
      "verimatrixStreamMaps": {
        "filename": "string",
        "serverName": "string",
        "saveFieldList": [
          "string"
        ],
        "version": "string",
        "verimatrixStreamMaps": [
          "string"
        ]
      },
      "verimatrixSmoothKeyServerIpAddress": "string",
      "licenseType": "string",
      "verimatrixCupertinoKeyServerIpAddress": "string",
      "buyDRMProtectSmoothStreaming": true,
      "buyDRMUserKey": "string",
      "inUse": true,
      "ezDRMUsername": "string",
      "verimatrixProtectSmoothStreaming": true,
      "buyDRMStreamMaps": {
        "buyDRMStreamNameMapFile": "string",
        "serverName": "string",
        "saveFieldList": [
          "string"
        ],
        "version": "string"
      },
      "verimatrixCupertinoVODPerSessionKeys": true,
      "saveFieldList": [
        "string"
      ],
      "ezDRMPassword": "string",
      "verimatrixProtectCupertinoStreaming": true,
      "cupertinoEncryptionAPIBased": true
    },
    "version": "string",
    "modules": {
      "moduleList": [
        {
          "name": "string",
          "serverName": "string",
          "description": "string",
          "saveFieldList": [
            "string"
          ],
          "version": "string",
          "class": "string",
          "order": 0
        }
      ],
      "serverName": "string",
      "saveFieldList": [
        "string"
      ],
      "version": "string"
    },
    "srtListenerAuthenticationMode": "string",
    "maxRTCPWaitTime": 0,
    "securityConfig": {
      "playMaximumConnections": 0,
      "publishBlockDuplicateStreamNames": true,
      "publishIPWhiteList": "string",
      "playAuthenticationMethod": "string",
      "serverName": "string",
      "clientStreamWriteAccess": "string",
      "playIPWhiteList": "string",
      "publishRequirePassword": true,
      "playIPBlackList": "string",
      "version": "string",
      "secureTokenVersion": 0,
      "publishPasswordFile": "string",
      "publishValidEncoders": "string",
      "secureTokenQueryParametersPrefix": "string",
      "secureTokenUseTEAForRTMP": true,
      "publishAuthenticationMethod": "string",
      "secureTokenHashAlgorithm": "string",
      "publishIPBlackList": "string",
      "playRequireSecureConnection": true,
      "secureTokenOriginSharedSecret": "string",
      "saveFieldList": [
        "string"
      ],
      "secureTokenIncludeClientIPInHash": true,
      "publishRTMPSecureURL": "string",
      "secureTokenSharedSecret": "string"
    },
    "dvrConfig": {
      "windowDuration": 0,
      "dvrMediaCacheEnabled": true,
      "dvrEnable": true,
      "startRecordingOnStartup": true,
      "serverName": "string",
      "store": "string",
      "version": "string",
      "recorders": "string",
      "dvrOnlyStreaming": true,
      "httpRandomizeMediaName": true,
      "licenseType": "string",
      "dvrEncryptionSharedSecret": "string",
      "inUse": true,
      "archiveStrategy": "string",
      "storageDir": "string",
      "saveFieldList": [
        "string"
      ]
    },
    "applicationTimeout": 0,
    "name": "string"
  }'

Responses

Successful response