{
  "opencollection": "1.0.0",
  "info": {
    "name": "Ant Media Server REST API Reference Broadcasts Vods API",
    "version": "V2.0"
  },
  "items": [
    {
      "info": {
        "name": "Vods",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "VoD file from database",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.antmedia.io:5443/Sandbox/rest/v2/vods/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the VoD file"
              }
            ]
          },
          "docs": "Retrieves a VoD file from the database by its ID."
        },
        {
          "info": {
            "name": "Delete specific VoD File",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://test.antmedia.io:5443/Sandbox/rest/v2/vods/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the VoD file"
              }
            ]
          },
          "docs": "Deletes a specific VoD file from the database by its ID."
        },
        {
          "info": {
            "name": "Delete bulk VoD Files based on Vod Id",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://test.antmedia.io:5443/Sandbox/rest/v2/vods",
            "params": [
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "Comma-separated IDs of the VoD files"
              }
            ]
          },
          "docs": "Deletes multiple VoD files from the database by their IDs."
        },
        {
          "info": {
            "name": "Get the total number of VoDs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.antmedia.io:5443/Sandbox/rest/v2/vods/count"
          },
          "docs": "Retrieves the total number of VoD files in the database."
        },
        {
          "info": {
            "name": "Get the partial number of VoDs depending on the searched items",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.antmedia.io:5443/Sandbox/rest/v2/vods/count/:search",
            "params": [
              {
                "name": "search",
                "value": "",
                "type": "path",
                "description": "Search parameter to get the number of items including it"
              }
            ]
          },
          "docs": "Retrieves the number of VoD files that include the specified search parameter."
        },
        {
          "info": {
            "name": "Get the VoD list from database",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.antmedia.io:5443/Sandbox/rest/v2/vods/list/:offset/:size",
            "params": [
              {
                "name": "offset",
                "value": "",
                "type": "path",
                "description": "Offset of the list"
              },
              {
                "name": "size",
                "value": "",
                "type": "path",
                "description": "Number of items that will be fetched"
              },
              {
                "name": "sort_by",
                "value": "",
                "type": "query",
                "description": "Field to sort. Possible values are 'name', 'date'"
              },
              {
                "name": "order_by",
                "value": "",
                "type": "query",
                "description": "'asc' for Ascending, 'desc' for Descending order"
              },
              {
                "name": "streamId",
                "value": "",
                "type": "query",
                "description": "ID of the stream to filter the results by stream ID"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "Search string"
              }
            ]
          },
          "docs": "Retrieves the list of VoD files from the database. It returns up to 50 items. You can use offset value to get result page by page."
        },
        {
          "info": {
            "name": "Import VoD files from a directory and make them streamable.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://test.antmedia.io:5443/Sandbox/rest/v2/vods/directory",
            "params": [
              {
                "name": "directory",
                "value": "",
                "type": "query",
                "description": "The full path of the directory that VoD files will be imported to the datastore and linked to the streams"
              }
            ]
          },
          "docs": "Imports VoD files from a directory to the datastore and links them to the streams."
        },
        {
          "info": {
            "name": "Unlinks VoD path from streams directory and delete the database record.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://test.antmedia.io:5443/Sandbox/rest/v2/vods/directory",
            "params": [
              {
                "name": "directory",
                "value": "",
                "type": "query",
                "description": "The full path of the directory from which imported VoD files will be deleted from the database"
              }
            ]
          },
          "docs": "Deletes the database record associated with the specified directory, without deleting the files themselves."
        },
        {
          "info": {
            "name": "Import VoDs to Stalker Portal",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://test.antmedia.io:5443/Sandbox/rest/v2/vods/import-to-stalker"
          },
          "docs": "Imports VoDs to the Stalker Portal."
        },
        {
          "info": {
            "name": "Upload external VoD file to Ant Media Server",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://test.antmedia.io:5443/Sandbox/rest/v2/vods/create",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Name of the VoD File"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "file",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          },
          "docs": "Uploads an external VoD file to Ant Media Server."
        }
      ]
    }
  ],
  "bundled": true
}