{
  "opencollection": "1.0.0",
  "info": {
    "name": "Kaltura OTT accessControl liveStream API",
    "version": "3.6.287.20720"
  },
  "items": [
    {
      "info": {
        "name": "liveStream",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "liveStream.add",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/service/livestream/action/add",
            "params": [
              {
                "name": "ks",
                "value": "",
                "type": "query"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The format of the response"
              },
              {
                "name": "clientTag",
                "value": "",
                "type": "query"
              },
              {
                "name": "partnerId",
                "value": "",
                "type": "query"
              },
              {
                "name": "language",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Adds new live stream entry.\n\nThe entry will be queued for provision."
        },
        {
          "info": {
            "name": "liveStream.addLiveStreamPushPublishConfiguration",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/service/livestream/action/addLiveStreamPushPublishConfiguration",
            "params": [
              {
                "name": "ks",
                "value": "",
                "type": "query"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The format of the response"
              },
              {
                "name": "clientTag",
                "value": "",
                "type": "query"
              },
              {
                "name": "partnerId",
                "value": "",
                "type": "query"
              },
              {
                "name": "language",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Add new pushPublish configuration to entry"
        },
        {
          "info": {
            "name": "liveStream.allocateConferenceRoom",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/service/livestream/action/allocateConferenceRoom",
            "params": [
              {
                "name": "ks",
                "value": "",
                "type": "query"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The format of the response"
              },
              {
                "name": "clientTag",
                "value": "",
                "type": "query"
              },
              {
                "name": "partnerId",
                "value": "",
                "type": "query"
              },
              {
                "name": "language",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Allocates a conference room or returns ones that has already been allocated"
        },
        {
          "info": {
            "name": "liveStream.appendRecording",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/service/livestream/action/appendRecording",
            "params": [
              {
                "name": "ks",
                "value": "",
                "type": "query"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The format of the response"
              },
              {
                "name": "clientTag",
                "value": "",
                "type": "query"
              },
              {
                "name": "partnerId",
                "value": "",
                "type": "query"
              },
              {
                "name": "language",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Append recorded video to live entry"
        },
        {
          "info": {
            "name": "liveStream.archive",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/service/livestream/action/archive",
            "params": [
              {
                "name": "ks",
                "value": "",
                "type": "query"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The format of the response"
              },
              {
                "name": "clientTag",
                "value": "",
                "type": "query"
              },
              {
                "name": "partnerId",
                "value": "",
                "type": "query"
              },
              {
                "name": "language",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Archive a live entry which was recorded"
        },
        {
          "info": {
            "name": "liveStream.authenticate",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/service/livestream/action/authenticate",
            "params": [
              {
                "name": "ks",
                "value": "",
                "type": "query"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The format of the response"
              },
              {
                "name": "clientTag",
                "value": "",
                "type": "query"
              },
              {
                "name": "partnerId",
                "value": "",
                "type": "query"
              },
              {
                "name": "language",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Authenticate live-stream entry against stream token and partner limitations"
        },
        {
          "info": {
            "name": "liveStream.createPeriodicSyncPoints",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/service/livestream/action/createPeriodicSyncPoints",
            "params": [
              {
                "name": "ks",
                "value": "",
                "type": "query"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The format of the response"
              },
              {
                "name": "clientTag",
                "value": "",
                "type": "query"
              },
              {
                "name": "partnerId",
                "value": "",
                "type": "query"
              },
              {
                "name": "language",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Creates periodic metadata sync-point events on a live stream"
        },
        {
          "info": {
            "name": "liveStream.createRecordedEntry",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/service/livestream/action/createRecordedEntry",
            "params": [
              {
                "name": "ks",
                "value": "",
                "type": "query"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The format of the response"
              },
              {
                "name": "clientTag",
                "value": "",
                "type": "query"
              },
              {
                "name": "partnerId",
                "value": "",
                "type": "query"
              },
              {
                "name": "language",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Create recorded entry id if it doesn't exist and make sure it happens on the DC that the live entry was created on."
        },
        {
          "info": {
            "name": "liveStream.delete",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/service/livestream/action/delete",
            "params": [
              {
                "name": "ks",
                "value": "",
                "type": "query"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The format of the response"
              },
              {
                "name": "clientTag",
                "value": "",
                "type": "query"
              },
              {
                "name": "partnerId",
                "value": "",
                "type": "query"
              },
              {
                "name": "language",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Delete a live stream entry."
        },
        {
          "info": {
            "name": "liveStream.finishConf",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/service/livestream/action/finishConf",
            "params": [
              {
                "name": "ks",
                "value": "",
                "type": "query"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The format of the response"
              },
              {
                "name": "clientTag",
                "value": "",
                "type": "query"
              },
              {
                "name": "partnerId",
                "value": "",
                "type": "query"
              },
              {
                "name": "language",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "When the conf is finished this API should be called."
        },
        {
          "info": {
            "name": "liveStream.get",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/service/livestream/action/get",
            "params": [
              {
                "name": "ks",
                "value": "",
                "type": "query"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The format of the response"
              },
              {
                "name": "clientTag",
                "value": "",
                "type": "query"
              },
              {
                "name": "partnerId",
                "value": "",
                "type": "query"
              },
              {
                "name": "language",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get live stream entry by ID."
        },
        {
          "info": {
            "name": "liveStream.getDetails",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/service/livestream/action/getDetails",
            "params": [
              {
                "name": "ks",
                "value": "",
                "type": "query"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The format of the response"
              },
              {
                "name": "clientTag",
                "value": "",
                "type": "query"
              },
              {
                "name": "partnerId",
                "value": "",
                "type": "query"
              },
              {
                "name": "language",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Delivering the status of a live stream (on-air/offline) if it is possible"
        },
        {
          "info": {
            "name": "liveStream.isLive",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/service/livestream/action/isLive",
            "params": [
              {
                "name": "ks",
                "value": "",
                "type": "query"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The format of the response"
              },
              {
                "name": "clientTag",
                "value": "",
                "type": "query"
              },
              {
                "name": "partnerId",
                "value": "",
                "type": "query"
              },
              {
                "name": "language",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Delivering the status of a live stream (on-air/offline) if it is possible"
        },
        {
          "info": {
            "name": "liveStream.list",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/service/livestream/action/list",
            "params": [
              {
                "name": "ks",
                "value": "",
                "type": "query"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The format of the response"
              },
              {
                "name": "clientTag",
                "value": "",
                "type": "query"
              },
              {
                "name": "partnerId",
                "value": "",
                "type": "query"
              },
              {
                "name": "language",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "List live stream entries by filter with paging support."
        },
        {
          "info": {
            "name": "liveStream.regenerateStreamToken",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/service/livestream/action/regenerateStreamToken",
            "params": [
              {
                "name": "ks",
                "value": "",
                "type": "query"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The format of the response"
              },
              {
                "name": "clientTag",
                "value": "",
                "type": "query"
              },
              {
                "name": "partnerId",
                "value": "",
                "type": "query"
              },
              {
                "name": "language",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Regenerate new secure token for liveStream"
        },
        {
          "info": {
            "name": "liveStream.registerConf",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/service/livestream/action/registerConf",
            "params": [
              {
                "name": "ks",
                "value": "",
                "type": "query"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The format of the response"
              },
              {
                "name": "clientTag",
                "value": "",
                "type": "query"
              },
              {
                "name": "partnerId",
                "value": "",
                "type": "query"
              },
              {
                "name": "language",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Mark that the conference has actually started"
        },
        {
          "info": {
            "name": "liveStream.registerMediaServer",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/service/livestream/action/registerMediaServer",
            "params": [
              {
                "name": "ks",
                "value": "",
                "type": "query"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The format of the response"
              },
              {
                "name": "clientTag",
                "value": "",
                "type": "query"
              },
              {
                "name": "partnerId",
                "value": "",
                "type": "query"
              },
              {
                "name": "language",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Register media server to live entry"
        },
        {
          "info": {
            "name": "liveStream.removeLiveStreamPushPublishConfiguration",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/service/livestream/action/removeLiveStreamPushPublishConfiguration",
            "params": [
              {
                "name": "ks",
                "value": "",
                "type": "query"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The format of the response"
              },
              {
                "name": "clientTag",
                "value": "",
                "type": "query"
              },
              {
                "name": "partnerId",
                "value": "",
                "type": "query"
              },
              {
                "name": "language",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Remove push publish configuration from entry"
        },
        {
          "info": {
            "name": "liveStream.setRecordedContent",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/service/livestream/action/setRecordedContent",
            "params": [
              {
                "name": "ks",
                "value": "",
                "type": "query"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The format of the response"
              },
              {
                "name": "clientTag",
                "value": "",
                "type": "query"
              },
              {
                "name": "partnerId",
                "value": "",
                "type": "query"
              },
              {
                "name": "language",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Set recorded video to live entry"
        },
        {
          "info": {
            "name": "liveStream.unregisterMediaServer",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/service/livestream/action/unregisterMediaServer",
            "params": [
              {
                "name": "ks",
                "value": "",
                "type": "query"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The format of the response"
              },
              {
                "name": "clientTag",
                "value": "",
                "type": "query"
              },
              {
                "name": "partnerId",
                "value": "",
                "type": "query"
              },
              {
                "name": "language",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Unregister media server from live entry"
        },
        {
          "info": {
            "name": "liveStream.update",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/service/livestream/action/update",
            "params": [
              {
                "name": "ks",
                "value": "",
                "type": "query"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The format of the response"
              },
              {
                "name": "clientTag",
                "value": "",
                "type": "query"
              },
              {
                "name": "partnerId",
                "value": "",
                "type": "query"
              },
              {
                "name": "language",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Update live stream entry. Only the properties that were set will be updated."
        },
        {
          "info": {
            "name": "liveStream.updateOfflineThumbnailFromUrl",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/service/livestream/action/updateOfflineThumbnailFromUrl",
            "params": [
              {
                "name": "ks",
                "value": "",
                "type": "query"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The format of the response"
              },
              {
                "name": "clientTag",
                "value": "",
                "type": "query"
              },
              {
                "name": "partnerId",
                "value": "",
                "type": "query"
              },
              {
                "name": "language",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Update entry thumbnail using url"
        },
        {
          "info": {
            "name": "liveStream.updateOfflineThumbnailJpeg",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/service/livestream/action/updateOfflineThumbnailJpeg",
            "params": [
              {
                "name": "ks",
                "value": "",
                "type": "query"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The format of the response"
              },
              {
                "name": "entryId",
                "value": "",
                "type": "query",
                "description": "live stream entry id"
              }
            ]
          },
          "docs": "Update live stream entry thumbnail using a raw jpeg file"
        },
        {
          "info": {
            "name": "liveStream.validateRegisteredMediaServers",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/service/livestream/action/validateRegisteredMediaServers",
            "params": [
              {
                "name": "ks",
                "value": "",
                "type": "query"
              },
              {
                "name": "format",
                "value": "",
                "type": "query",
                "description": "The format of the response"
              },
              {
                "name": "clientTag",
                "value": "",
                "type": "query"
              },
              {
                "name": "partnerId",
                "value": "",
                "type": "query"
              },
              {
                "name": "language",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Validates all registered media servers"
        }
      ]
    }
  ],
  "bundled": true
}