WMSPanel products API reference

WMSPanel allows collecting statistics data from various streaming media servers.
You may have different server types and get aggregated stats for further usage. WMSPanel provides additional capabilities for obtaining the data and using it in for further analysis within customers' workflow.
WMSPanel also provides efficient push API methods for getting immediate alerts from the system for proper handling within customer's environment.
Another efficient feature is Nimble Streamer control API.
The reference below describes the set of API methods provided by the service. You may also read API-related articles to see certain use cases.

WMSPanel stats pull API usage

WMSPanel allows accessing data by making API calls.
Each call is a GET request via HTTPS. You need to use HTTPS for all connections.
As a response you get JSON structure with required data.
If you have incorrect credentials for any request, the response code will be 403.

Limits. Each WMSPanel account has a limit of 15000 API calls for every 24 hours, starting from 0:00 UTC. If you need to add more API calls to your daily limit, you can increase the limit on API setup control page. You'll make a small one-time up-front payment and your subscription will be upgraded accordingly, each 1 thousand of calls will cost 10 USD per month.

For those who want to use API more extensively, we recommend using API proxy. We created sample API proxy code for your convenience.

WMSPanel stats, WMSAuth, Dispersa API

To start using the API, you need to make small setup on WMSPanel side by following these steps:

  • Go to Control menu -> API setup -> Pull API tab.
  • Enable API by clicking on respective button.
  • Copy Client ID for further usage in your scripts.
  • Click on "Generate New Key" to copy API key as well. This will be used for further authorization.
  • Populate whitelist with IPs of the hosts where you will be making API calls from, like your development machine or your web server. Just enter new IP and click on "Add IP to Whitelist" one by one.
    Check this screenshot as a reference:

The daily limit for API requests is 15000 calls, this number is reset at 0:00 UTC.
You can set the threshold alert for API calls. If they exceed the limit which you specify, you'll get an email notification about it. Don't forget to set up notifications email to get alerted.

Another way for getting API ID and API key is to define them for separate users. This is useful when your client wants to have direct access to his data. Read this article to learn more about it. Once you create user-specific ID and key, he may use them instead of account-wise client ID and API key. The data scope for this client ID and key will be limited to the client's data slices settings. All parameters mentioned for each call will remain the same.
Now you're ready to request the data.

Running pull API call from command line.

Making this call:
# wget https://api.wmspanel.com/v1/data_slices?client_id=aaaaaaaa&api_key=bbbbbb
returns 403 response. When you make this call from browser, it succeeds.
You need to quote the URL which you use for the call. Like this:
# wget 'https://api.wmspanel.com/v1/data_slices?client_id=aaaaaaaa&api_key=bbbbbb'
Because otherwise the ampersand sign is processed as a launch of second command. This is why this could be launched from browser and couldn't be launched from command line for you. API call will be working fine when calling from your scripts without quote characters.

This request allows getting list of servers in customer account for further requests. You may also get server ID via web UI, just choose Servers menu, then go to server details and check its URL - the big ID would be the one you need.

Request URL:
GET https://api.wmspanel.com/v1/server
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server?client_id=[client_id]&api_key=[api_key]'
Response example: 
  {
    "status" : "Ok",
    "servers" : [
      {
        "id" : "05e17aea6f7687aa0341aedb",
        "name" : "WIN-PE1MBBSAUHE",
        "kind" : "Nimble",
        "ip": [
            "169.168.48.213",
            "fe80:0:0:0:250:56ff:fec0:2%4"
        ],
        "status": "online",
        "custom_ips": [
            "188.16.62.49"
        ],
        "tags": [
          "MyTag1",
          "MyTag2"
        ]
      },
      {
        "id" : "0fe819faf12386e706d33d45",
        "name" : "MyBookLive",
        "kind" : "Nimble",
        "status": "offline",
        "ip": [
            "192.168.217.1"
        ]
      },
      {
        "id" : "5afe78fd81fc1090ac420c55",
        "name" : "edge-centos",
        "kind" : "Nimble",
        "status": "online",
        "ip": [
            "192.168.36.1"
        ]
      },
      {
        "id" : "3bb85dc9691e0bd8e9a98087",
        "name" : "centos64-64",
        "kind" : "Wowza",
        "status": "pending",
        "ip": [
            "192.168.254.105"
        ],
        "custom_ips": [
            "188.16.88.79",
            "mydomain.org"
        ]
      },
    ]
  }
Response parameters:
Each server is described with the following parameters:
  • id - unique server ID for further usage
  • name - server's display name, which is displayed in the servers list UI
  • kind - server's kind, Nimble or Wowza
  • status - server's status (online, offline or pending)
  • ip - a list of IP addresses reported by the server
  • custom_ips - a list of IP addresses and/or domain names those were assigned via API or WMSPanel UI
  • tags - a list of tags assigned to server

This request allows to get a specific server info.

Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • server_id - can be obtained from "Get list" request.
CURL request example:
curl 'https://api.wmspanel.com/v1/server/05e17aea6f7687aa0341aedb?client_id=[client_id]&api_key=[api_key]'
Response example: 
  {
    "status" : "Ok",
    "server" : {
        "id" : "05e17aea6f7687aa0341aedb",
        "name" : "WIN-PE1MBBSAUHE",
        "kind" : "Nimble",
        "ip": [
            "169.168.48.213",
            "fe80:0:0:0:250:56ff:fec0:2%4"
        ],
        "status": "online",
        "custom_ips": [
            "188.16.62.49"
        ],
        "tags": [
            "MyTag1",
            "MyTag2"
        ]
      }
    }
Response parameters:
The same as for "Get list" request.

The following request allows to update each server's display name and define list of custom IP addresses or domain names.

Request URL:
PUT https://api.wmspanel.com/v1/server/[server_id]
Request parameters:

  • server_id - is ID of appropriate server
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{name: 'MyNewBook', custom_ips: ["mybookdomain.com", "198.45.88.90"]}' 'https://api.wmspanel.com/v1/server/552c97320640fdd1bf000052?client_id=[client_id]&api_key=[api_key]'
The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • name - server's display name.
  • custom_ips - a list of IP addresses or domain names those you want to assign to given server. If you want to remove everything assigned before, just provide an empty array.
  • tags - a list of string tags to assign to given server. HTML tags are not allowed inside server tags and will be removed. If you want to remove all tags from the server, just provide an empty array.
Response example: 
  {
    "status" : "Ok",
    "server" : {
        "id" : "0fe819faf12386e706d33d45",
        "name" : "MyNewBook",
        "kind" : "Nimble",
        "status": "online",
        "ip": [
            "192.168.217.1"
        ],
        "custom_ips" : [
            "mybookdomain.com",
            "198.45.88.90"
        ],
        "tags": [
            "MyTag1",
            "MyTag2"
        ]
    }
  }
Response parameters:
The same as for "Get list" request.

Delete an existing server and all related data including settings and statistics.

By default this API is disabled. To enable it, please, contact our support .
We strongly recommend to use Nimble servers settings backups to avoid accidental data loss, if you have enabled this API.

Request URL:
DELETE https://api.wmspanel.com/v1/server/[server_id]
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • server_id - can be obtained from "Get list" request.
CURL request example:
curl -X DELETE 'https://api.wmspanel.com/v1/server/05e17aea6f7687aa0341aedb?client_id=[client_id]&api_key=[api_key]'
Response example: 
  {
    "status" : "Ok"
  }

This request allows getting list of streams. This method is available only when Deep stats reporting is enabled for customer account.
Request URL:
GET https://api.wmspanel.com/v1/streams/
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • data_slice - the ID of the data slice. If you have user-based authorization, then this parameter is optional - in this case the data will be selected by the slice where a user is assigned to.
  • server - is the ID of the server to filter data for (Optional in case of active streams). If 'server' parameter is not set, then 'server_kind' optional parameter must be specified.

Optional parameters:
  • page - number of the page (One page contain upto 1000 streams).
  • kind - "active"(default) or "inactive".
  • realtime_data - if "true" append realtime data.
  • server_kind - "wowza"(default) or "nimble". Required, if server is not set, to return data about active streams for all wowza or nimble servers.
CURL request example:
curl 'https://api.wmspanel.com/v1/streams?client_id=[client_id]&api_key=[api_key]&data_slice=56bc25b4e2cd2846db000001&server=56bc25bde2cd2846db000002'
Response example: 
    {
    "status": "Ok",
    "streams": [
      "127.0.0.1:1935/live/my_stream"
      "127.0.0.1:1935/vod/sample.mp4",
      "127.0.0.1:1935/vod/bunny.mp4",
    ]
  }

Response example with "realtime_data=true": 
    {
    "status": "Ok",
    "streams": [
      {
        "name": "127.0.0.1:1935/live/my_stream",
        "connected": 2,
        "bandwidth": 1600
      },
      {
        "name": "127.0.0.1:1935/vod/sample.mp4",
        "connected": 1,
        "bandwidth": 1600
      },
      {
        "name": "127.0.0.1:1935/vod/bunny.mp4",
        "connected": 1,
        "bandwidth": 1600
      }
    ]
  }

Retrieve a list of company regular users. This API is available if extended data slices API is enabled for company.
To enable extended data slices API, please, contact our support .

Request URL:
https://api.wmspanel.com/v1/users
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl "https://api.wmspanel.com/v1/users?client_id=[client_id]&api_key=[api_key]"
Response example: 
{
  "status" : "Ok",
  "users" : [
    {
      "id": "58e5b96afe7cd31d0000000d",
      "email": "test1@example.com",
    },
    {
      "id": "58fc0354fe7cd319b4000017",
      "email": "test2@example.com",
    },
    {
      "id": "59ed3019fe7cd3728c000001",
      "email": "test3@example.com",
    },
  ]
}

Response fields:
  • id - unique user ID for further usage.
  • email - user email address.

Create new regular user. This API is available if extended data slices API is enabled for company.
To enable extended data slices API, please, contact our support .

Request URL:
https://api.wmspanel.com/v1/users
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{"email": "test@example.com", "password": "1234", "data_slice_id": "5a5f0856fe7cd34f1f000006"}' "https://api.wmspanel.com/v1/users?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • email - user email.
  • password - user password.
  • data_slice_id - data slice id to assign new user.
Response example: 
{
  "status" : "Ok",
  "user" :
    {
      "id": "58e5b96afe7cd31d0000000e",
      "email": "test@example.com",
    }
}

Response fields: The same as for "Get list" API.

Retrieve a list of all data slices for your company. You need to know your data slice ID in order to request stats for it. This ID does not change over time so you may obtain it just once and use it going forward. You can also obtain list of servers for each slice by adding extra parameter to your request.
By default this API returns a small number of data slice fields (id, name and server_ids). But if extended data slices API is enabled for company, then all data slice fields are returned.
To enable extended data slices API, please, contact our support .

Request URL:
https://api.wmspanel.com/v1/data_slices
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • show_servers - (optional, applicable for default API only) specifies whether list of server IDs is returned for each data slice (should be either true or false)
CURL request example:
curl "https://api.wmspanel.com/v1/data_slices?client_id=[client_id]&api_key=[api_key]&show_servers=true"
Response example (default): 
{
  "status" : "Ok",
  "data_slices" : [
    {
      "id" : "53e03c9978a6fc8596000001",
      "name" : "Full data slice",
      "server_ids": [
        "590820a0fe7cd38c24000001",
        "5940d33efe7cd37856000003"
        "59350441fe7cd3b20e000051"
      ]
    },
    {
      "id" : "53e03ca678a6fc8599000001",
      "name" : "DS2",
      "server_ids" : [
        "590820a0fe7cd38c24000001",
        "5940d33efe7cd37856000003"
      ]
    }
  ]
}

Response example (extended data slice API): 
{
  "status" : "Ok",
  "data_slices" : [
    {
      "id": "53e03c9978a6fc8596000001",
      "name": "Full data slice",
      "description": "Full information about all servers, applications and streams.",
      "default": true,
      "show_servers": true,
      "lite_slice": false,
      "show_billing": true,
      "show_deep_in_billing": true,
      "streamed": false,
      "high_pre": true,
      "geo": false,
      "time_zone_name": "UTC",
      "time_zone_offset": 0,
      "show_traffic": false,
      "show_bandwidth": false,
      "deep_daily_stats": false,
      "deep_stats_period": 7,
      "show_deep": false,
      "show_high_pre": false,
      "show_geo": false,
      "show_isp": false,
      "show_asn": false,
      "show_total_stats": false,
      "show_retrospective": false,
      "show_realtime": false,
      "deep_unique_viewers": false,
      "unique_viewers": false,
      "rules": [],
      "assigned_users_ids": [
        "58fc0354fe7cd319b4000017",
        "5af926cef776484009bce68c",
        "59ed3019fe7cd3728c000001"
      ],
      "server_ids": [
        "590820a0fe7cd38c24000001",
        "5940d33efe7cd37856000003"
        "59350441fe7cd3b20e000051"
      ]
    },
    {
      "id": "53e03ca678a6fc8599000001",
      "name": "DS2",
      "description": "Custom data slice",
      "default": false,
      "show_servers": true,
      "lite_slice": false,
      "show_billing": true,
      "show_deep_in_billing": false,
      "streamed": false,
      "high_pre": true,
      "geo": false,
      "time_zone_name": "Central Time (US & Canada)",
      "time_zone_offset": -6,
      "show_traffic": false,
      "show_bandwidth": false,
      "deep_daily_stats": true,
      "deep_stats_period": 7,
      "show_deep": false,
      "show_high_pre": false,
      "show_geo": false,
      "show_isp": false,
      "show_asn": false,
      "show_total_stats": false,
      "show_retrospective": false,
      "show_realtime": false,
      "deep_unique_viewers": false,
      "unique_viewers": false,
      "rules": [
        {
          "name": "live",
          "app": "^live$",
          "include": true,
          "enabled": false,
          "vhost": ""
        },
        {
          "name": "Humor",
          "app": "^Humor$",
          "include": true,
          "enabled": false,
          "vhost": ""
        },
        {
          "name": "Classic",
          "app": "^Classic$",
          "include": true,
          "enabled": true,
          "vhost": ""
        }
      ],
      "assigned_users_ids": [
        "58fc0354fe7cd319b4000017",
        "59ed3019fe7cd3728c000001"
      ],
      "server_ids": [
        "590820a0fe7cd38c24000001",
        "5940d33efe7cd37856000003"
      ]
    }
  ]
}

Response fields:
  • id - unique data slice ID for further usage.
  • name - data slice name.
  • description - data slice description.
  • default - default data slice.
  • show_servers - show servers details for users.
  • lite_slice - lite data slice.
  • show_billing - show billing information for users.
  • show_deep_in_billing - show deep stats records number in billing information for users.
  • streamed - streamed data slice.
  • high_pre - collect high precision data.
  • geo - collect geo stats.
  • time_zone_name - time zone name.
  • time_zone_offset - time zone offset in hours from UTC.
  • show_traffic - show traffic information for users.
  • show_bandwidth - show bandwidth information for users.
  • deep_daily_stats - collect deep daily stats.
  • deep_stats_period - period to collect deep daily stats in days.
  • show_deep - show deep stats for users.
  • show_high_pre - show high precision data for users.
  • show_geo - show geo stats for users.
  • show_isp - show ISP stats for users.
  • show_asn - show ASN stats for users.
  • show_total_stats - show daily stats reports for users.
  • show_retrospective - show retrospective data for users.
  • show_realtime - show real-time data for users.
  • deep_unique_viewers - collect deep unique visitors stats.
  • unique_viewers - collect unique visitors stats.
  • rules - data slice rules
    • "name" - rule name.
    • "app" - application name or regular expression for application names.
    • "include" - rule type: include (true) or exclude (false).
    • "enabled" - rule status: enabled (true) or disabled (false).
    • "vhost" - virtual host name or regular expression for virtual host names.
    • "stream" - stream name or regular expression for stream names (applicable for streamed data slices only).
  • assigned_users_ids - IDs of users assigned to data slice.
  • server_ids - IDs of servers assigned to data slice.

Pick up a specific data slice. This API is available if extended data slices API is enabled for company.
To enable extended data slices API, please, contact our support .

Request URL:
GET https://api.wmspanel.com/v1/data_slices/[data_slice_id]
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • data_slice_id - unique data slice ID
CURL request example:
curl "https://api.wmspanel.com/v1/data_slices/53e03c9978a6fc8596000001?client_id=[client_id]&api_key=[api_key]"

Response example: 
{
  "status" : "Ok",
  "data_slice" : {
    "id": "53e03c9978a6fc8596000001",
    "name": "Full data slice",
    "description": "Full information about all servers, applications and streams.",
    "default": true,
    "show_servers": true,
    "lite_slice": false,
    "show_billing": true,
    "show_deep_in_billing": true,
    "streamed": false,
    "high_pre": true,
    "geo": false,
    "time_zone_name": "UTC",
    "time_zone_offset": 0,
    "show_traffic": false,
    "show_bandwidth": false,
    "deep_daily_stats": false,
    "deep_stats_period": 7,
    "show_deep": false,
    "show_high_pre": false,
    "show_geo": false,
    "show_isp": false,
    "show_asn": false,
    "show_total_stats": false,
    "show_retrospective": false,
    "show_realtime": false,
    "deep_unique_viewers": false,
    "unique_viewers": false,
    "rules": [],
    "assigned_users_ids": [
      "58fc0354fe7cd319b4000017",
      "5af926cef776484009bce68c",
      "59ed3019fe7cd3728c000001"
    ],
    "server_ids": [
      "590820a0fe7cd38c24000001",
      "5940d33efe7cd37856000003"
      "59350441fe7cd3b20e000051"
    ]
  }
}
Response fields:
The same as for "Get list" API.

Create a new data slice. This API is available, if extended data slices API is enabled for company.
To enable extended data slices API, please, contact our support .

Request URL:
POST https://api.wmspanel.com/v1/data_slices
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{"name": "Data slice 1", "description": "Data slice created via API"}' "https://api.wmspanel.com/v1/data_slices?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • name - data slice name.
  • description (optional) - data slice description.
  • show_servers (optional) - show servers details for users.
  • lite_slice (optional) - lite data slice.
  • show_billing (optional) - show billing information for users.
  • show_deep_in_billing (optional) - show deep stats records number in billing information for users.
  • streamed (optional) - streamed data slice.
  • high_pre (optional) - collect high precision data.
  • geo (optional) - collect geo stats.
  • time_zone_name (optional) - standard time zone name ("UTC", "Central Time (US & Canada)" etc.). If time zone name is not recognized, then time zone offset will be used to find correct time zone.
  • time_zone_offset (optional) - time zone offset in hours from UTC. It is used if time zone name was not recognized only.
  • show_traffic (optional) - show traffic information for users.
  • show_bandwidth (optional) - show bandwidth information for users.
  • deep_daily_stats (optional) - collect deep daily stats.
  • deep_stats_period (optional) - period to collect deep daily stats in days.
  • show_deep (optional) - show deep stats for users.
  • show_high_pre (optional) - show high precision data for users.
  • show_geo (optional) - show geo stats for users.
  • show_isp (optional) - show ISP stats for users.
  • show_asn (optional) - show ASN stats for users.
  • show_total_stats (optional) - show daily stats reports for users.
  • show_retrospective (optional) - show retrospective data for users.
  • show_realtime (optional) - show real-time data for users.
  • deep_unique_viewers (optional) - collect deep unique visitors stats.
  • unique_viewers (optional) - collect unique visitors stats.
  • rules (optional) - data slice rules
    • "name" - rule name.
    • "app" - application name or regular expression for application names.
    • "include" (optional) - rule type: include (true) or exclude (false).
    • "enabled" (optional) - rule status: enabled (true) or disabled (false).
    • "vhost" (optional) - virtual host name or regular expression for virtual host names.
    • "stream" - stream name or regular expression for stream names (applicable for streamed data slices only).
  • assigned_users_ids (optional) - IDs of users assigned to data slice. You can get company users IDs via "Users" API.
  • server_ids (optional) - IDs of servers assigned to data slice.
Response example: 
    {
      "status": "Ok",
      "data_slice": {
        "id": "5c8b0d402c47e530f9c3c565",
        "name": "Data slice 1",
        "description": "Data slice created via API",
        "default": false,
        "show_servers": false,
        "lite_slice": false,
        "show_billing": false,
        "show_deep_in_billing": false,
        "streamed": false,
        "high_pre": true,
        "geo": true,
        "time_zone_name": "UTC",
        "time_zone_offset": 0,
        "show_traffic": true,
        "show_bandwidth": true,
        "deep_daily_stats": false,
        "deep_stats_period": 0,
        "show_deep": true,
        "show_high_pre": true,
        "show_geo": true,
        "show_isp": true,
        "show_asn": false,
        "show_total_stats": true,
        "show_retrospective": true,
        "show_realtime": true,
        "deep_unique_viewers": false,
        "unique_viewers": false,
        "rules": [],
        "assigned_users_ids": [],
        "server_ids": []
      }
    }
Response fields: The same as for "Get list" API.

Update an existing data slice. This API is available, if extended data slices API is enabled for company.
To enable extended data slices API, please, contact our support .

Request URL:
PUT https://api.wmspanel.com/v1/data_slices/[data_slice_id]
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • data_slice_id - unique data slice ID
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"name": "Data slice 1 modified", assigned_users_ids: ["58fc0354fe7cd319b4000017"]}' "https://api.wmspanel.com/v1/data_slices/5c8b0d402c47e530f9c3c565/?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
The same as for "Create" API with following limitations:
  • Field streamed cannot be updated. It is impossible to convert normal data slice to streamed and back.
  • Default data slice cannot be updated
Response example: 
    {
      "status": "Ok",
      "data_slice": {
        "id": "5c8b0d402c47e530f9c3c565",
        "name": "Data slice 1 modified",
        "description": "Data slice created via API",
        "default": false,
        "show_servers": false,
        "lite_slice": false,
        "show_billing": false,
        "show_deep_in_billing": false,
        "streamed": false,
        "high_pre": true,
        "geo": true,
        "time_zone_name": "UTC",
        "time_zone_offset": 0,
        "show_traffic": true,
        "show_bandwidth": true,
        "deep_daily_stats": false,
        "deep_stats_period": 0,
        "show_deep": true,
        "show_high_pre": true,
        "show_geo": true,
        "show_isp": true,
        "show_asn": false,
        "show_total_stats": true,
        "show_retrospective": true,
        "show_realtime": true,
        "deep_unique_viewers": false,
        "unique_viewers": false,
        "rules": [],
        "assigned_users_ids": [
          "58fc0354fe7cd319b4000017"
        ],
        "server_ids": []
      }
    }
Response fields: The same as in "Get list" API.

Real-time data is requested with required frequency and gives the same snapshot as you can get on data slice dashboard. You may also get data for selected streams and servers.
If you want to create load balancing based on current load of Nimble Streamer, you should use Nimble Streamer real-time API which is best fit for this task.
Request URL: https://api.wmspanel.com/v1/realtime_data
Request parameters:

  • client_id - client ID you've copied previously from UI
  • api_key - API key from UI
  • data_slice - the data slice ID obtained via Data slices "Get list" API.
Optional parameters:
The real-time stats may be obtained for single stream. This is available for regular data slices only, as lite slices have no streams' real-time.
  • stream - stream hash, which can be obtained in WMSPanel UI while looking at stream real-time stats or calculated from full stream path (see detailes below).
You may also request data for separate server, just as you can in web UI.
  • server - is the ID of the server to filter data for. Check "Get servers list" method to obtain your servers list.
If no server is specified in request, the data is presented as described above. If the stream ID is specified with server ID, this will show real-time stats for specific stream on a specific server.
Request example:
https://api.wmspanel.com/v1/realtime_data?client_id=[client_id]&api_key=[api_key]&data_slice=53e03c9978a6fc8596000001
Response example: 
{
  "status" : "Ok",
  "realtime_data" : {
    "connected" : 2,
    "bandwidth" : 267784,
    "geo" : [
      [ "BR", 1 ],
      [ "US", 1 ],
    ]
  }
}

Response parameters:
  • connected - amount of connections,
  • bandwidth - current transmission speed
  • geo - top-20 countries of visitors, the series of sets like [alpha2, connected_count]
How to obtain stream hash:
Stream hash is calculated from full stream path. 
i32hash('127.0.0.1:1935/vod/sample.mp4') => 565817233
See examples of i32hash function for different languages below.

PHP example: 
function i32hash($str) {
  $h = 0;
  foreach (unpack('C*', $str) as &$p) { $h = (37 * $h + $p) % 4294967296; }
  return ($h - 2147483648);
}

Ruby example: 
def i32hash str
  h = 0
  str.bytes.to_a.each{|p| h = (37 * h + p) % 4294967296 }
  h-2147483648
end

This method allows obtaining realtime data for multiple streams in one request.
Request URL: https://api.wmspanel.com/v1/realtime_data
Request parameters:

  • client_id - client ID you've copied previously from UI
  • api_key - API key from UI
  • data_slice - the data slice ID obtained via Data slices "Get list" API.
Request data fields:
  • streams - list of streams hashes
Request example:
curl -X POST -H 'Content-Type: application/json' -d '{"streams":[-325053721,1439361443]}' "https://api.wmspanel.com/v1/realtime_data?client_id=[client_id]&api_key=[api_key]&data_slice=53e03c9978a6fc8596000001"
Response example: 
{
  "status": "Ok",
  "streams_realtime_data": {
    "1439361443": {
      "connected": 1,
      "bandwidth": 1600,
      "geo": [ [ "CN", 1 ] ]
    },
    "-325053721": {
      "connected": 2,
      "bandwidth": 1600,
      "geo": [ [ "CN", 2 ] ]
    }
  }
}

Response parameters:
  • connected - amount of connections,
  • bandwidth - current transmission speed
  • geo - top-20 countries of visitors, the series of sets like [alpha2, connected_count]
How to obtain stream hash:
Stream hash is calculated from full stream path. 
i32hash('127.0.0.1:1935/vod/sample.mp4') => 565817233
See examples of i32hash function for different languages below.

PHP example: 
function i32hash($str) {
  $h = 0;
  foreach (unpack('C*', $str) as &$p) { $h = (37 * $h + $p) % 4294967296; }
  return ($h - 2147483648);
}

Ruby example: 
def i32hash str
  h = 0
  str.bytes.to_a.each{|p| h = (37 * h + p) % 4294967296 }
  h-2147483648
end

This method allows obtaining realtime data for multiple data slices in one request.
Request URL: https://api.wmspanel.com/v1/realtime_data_multi
Request parameters:

  • client_id - client ID you've copied previously from UI.
  • api_key - API key from UI.
  • data_slice - the data slice ID obtained via Data slices "Get list" API.
  • stream (optional) - stream hash to get data for single stream. This hash can be obtained in WMSPanel UI while looking at stream real-time stats or calculated from full stream path (see detailes below).
  • server (optional) - server ID to get data for single server. Check "Servers" API to obtain your servers list.
Request data fields:
  • data_slices - a list of data slices IDs
Request example:
curl -X POST -H 'Content-Type: application/json' -d '{ "data_slices": ["5a5f0856fe7cd34f1f000006","53d9a52efe7cd39dc2000001"]}' "https://api.wmspanel.com/v1/realtime_data_multi?client_id=[client_id]&api_key=[api_key]"
Response example: 
{
  "status": "Ok",
  "realtime_data": {
    "53d9a52efe7cd39dc2000001": {
      "connected": 5,
      "bandwidth": 9961680,
      "geo": [["CN", 3], ["BR", 2]]
    },
    "5a5f0856fe7cd34f1f000006": {
      "connected": 2,
      "bandwidth": 7203456,
      "geo": [["US", 2]]
    }
  }
}


Response parameters:
  • connected - amount of connections,
  • bandwidth - current transmission speed
  • geo - top-20 countries of visitors, the series of sets like [alpha2, connected_count]
How to obtain stream hash:
Stream hash is calculated from full stream path. 
i32hash('127.0.0.1:1935/vod/sample.mp4') => 565817233
See examples of i32hash function for different languages below.

PHP example: 
function i32hash($str) {
  $h = 0;
  foreach (unpack('C*', $str) as &$p) { $h = (37 * $h + $p) % 4294967296; }
  return ($h - 2147483648);
}

Ruby example: 
def i32hash str
  h = 0
  str.bytes.to_a.each{|p| h = (37 * h + p) % 4294967296 }
  h-2147483648
end

This is the Retrospective data report which is available at WMSPanel Dashboard.
Request URL:
GET https://api.wmspanel.com/v1/retro_data
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • data_slice - the data slice ID obtained via Data slices "Get list" API
Optional parameters:
The retro stats may be obtained for single stream. This is available for regular data slices only, as lite slices have no streams' retro stats.
  • stream - stream hash, which can be obtained in WMSPanel UI while looking at stream retro stats or calculated from full stream path (see 'Real-time statistics / Single stream' section for details).
You may also request data for separate server, just as you can in web UI.
  • server - is the ID of the server to filter data for. Check "Get servers list" method to obtain your servers list.
If no server is specified in request, the data is presented as described above. If the stream ID is specified with server ID, this will show retro stats for specific stream on a specific server.
  • interval - time interval to request data (day, week, month, year). Day is used by default. It is ignored for single stream request.
Request example:
https://api.wmspanel.com/v1/retro_data?client_id=[client_id]&api_key=[api_key]&data_slice=[data_slice_id]&interval=day
Response example: 
    {
    "status" : "Ok",
    "retro_data": [
        {
            "message_in": 23861,
            "message_out": 14527474,
            "message_lost": 0,
            "viewers_old": 2,
            "viewers_new": 0,
            "bandwidth": 8070,
            "time": "2020-12-28 06:30:00"
        },
        {
            "message_in": 23345,
            "message_out": 3435456,
            "message_lost": 0,
            "viewers_old": 0,
            "viewers_new": 3,
            "bandwidth": 9456,
            "time": "2020-12-28 06:45:00"
        },
        ...
        {
            "message_in": 233532,
            "message_out": 4455666,
            "message_lost": 2343,
            "viewers_old": 1,
            "viewers_new": 2,
            "bandwidth": 7324,
            "time": "2020-12-29 06:15:00"
        }
    ]
}

Response parameters:
  • message_in - incoming traffic in bytes
  • message_out - outgoing traffic in bytes
  • message_lost - lost traffic in bytes
  • viewers_old - staying viewers count
  • viewers_new - new viewers count
  • bandwidth - average transmission speed in bits per second
  • time - these data time point
Total connections count can be calculated as viewers_old + viewers_new

This is the daily statistics report which is available under Reporting / Daily stats menu. This includes connections count, traffic, bandwidth and play time.
Request URL:
https://api.wmspanel.com/v1/daily_stats
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • from - report beginning date, the format is YYYY-MM-DD, e.g. 2014-08-01
  • to - report ending date with the same format, like 2014-12-31
  • data_slice - the data slice ID which you got from  "Data slices -> Get list" request. If you have user-based authorization, then this parameter is optional - in this case the data will be selected by the slice where a user is assigned to.
Optional parameters:
You may also request data for separate server, just as you can in web UI.
  • server - is the ID of the server to filter data for. Check "Get servers list" method to obtain your servers list.
Request example:
https://api.wmspanel.com/v1/daily_stats?client_id=[client_id]&api_key=[api_key]&from=2014-01-01&to=2014-12-31&data_slice=53e03ca678a6fc8599
Response example: 
{
  "status" : "Ok",
  "stats" : [
    {
      "message_out" : 0,
      "mgh_viewers" : 0,
      "rtmp_viewers" : 39,
      "message_lost" : 0,
      "max_message_in_rate" : 51425008,
      "total_view_time" : 31044,
      "max_message_out_rate" : 370556200,
      "dvr_viewers" : 0,
      "date" : "2014-10-17",
      "dash_viewers" : 0,
      "message_in" : 0,
      "ice_viewers" : 0,
      "rtsp_viewers" : 6,
      "smooth_viewers" : 0,
      "viewers" : 96,
      "peak_viewers": 12,
      "pd_viewers" : 0,
      "hds_viewers" : 0,
      "hls_viewers" : 51,
      "srt_viewers" : 0,
      "unique_viewers" : 34
    },
    {
      "message_out" : 0,
      "mgh_viewers" : 0,
      "rtmp_viewers" : 0,
      "message_lost" : 0,
      "max_message_in_rate" : 0,
      "total_view_time" : 17460,
      "max_message_out_rate" : 127307424,
      "dvr_viewers" : 0,
      "date" : "2014-10-20",
      "dash_viewers" : 0,
      "message_in" : 0,
      "ice_viewers" : 0,
      "rtsp_viewers" : 0,
      "smooth_viewers" : 0,
      "viewers" : 16,
      "peak_viewers": 3,
      "pd_viewers" : 0,
      "hds_viewers" : 0,
      "hls_viewers" : 16,
      "srt_viewers" : 0,
      "unique_viewers" : 3
    }
  ]
}

Response fields:
  • date - the day for which the data is exposed
  • viewers - a total number of connections
  • peak_viewers - a peak number of connections
  • hls_viewers - HLS connections number
  • hds_viewers - HDS connections number
  • smooth_viewers - SmoothStreaming connections number
  • rtsp_viewers - RTSP connections number
  • rtmp_viewers - RTMP connections number
  • mgh_viewers - MPEG-DASH connections number
  • dvr_viewers - DVR connections number
  • ice_viewers - Icecast connections number
  • pd_viewers - progressive download connections number
  • dash_viewers - DASH connections number
  • sldp_viewers - SLDP connections number
  • srt_viewers - SRT connections number
  • whep_viewers - WHEP connections number
  • message_in - incoming traffic
  • message_out - outgoing traffic
  • message_lost - lost traffic
  • max_message_in_rate - maximum incoming bandwidth (transmission speed)
  • max_message_our_rate - maximum outgoing bandwidth (transmission speed)
  • total_view_time - total amount of view time
  • unique_viewers - unique visitors number

This is the daily duration report which is available under Reporting / Duration stats menu.
Request URL:
https://api.wmspanel.com/v1/duration_stats
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • from - report beginning date, the format is YYYY-MM-DD, e.g. 2014-08-01
  • to - report ending date with the same format, like 2014-12-31
  • data_slice - the data slice ID which you got from  "Data slices -> Get list" request. If you have user-based authorization, then this parameter is optional - in this case the data will be selected by the slice where a user is assigned to.
Optional parameters:
You may also request data for separate server, just as you can in web UI.
  • server - is the ID of the server to filter data for. Check "Get servers list" method to obtain your servers list.

Request example: https://api.wmspanel.com/v1/duration_stats?client_id=[client_id]&api_key=[api_key]&from=2022-05-23&to=2022-05-24&data_slice=53e03ca678a6fc8599
Response example: 
{
  "status" : "Ok",
  "stats" : [
    {
        "date": "2022-05-24",
        "viewers": 16,
        "total_view_time": 9240,
        "up_to_5_secs": 0,
        "up_to_10_secs": 0,
        "up_to_15_secs": 0,
        "up_to_20_secs": 0,
        "up_to_25_secs": 0,
        "up_to_30_secs": 0,
        "up_to_1_min": 2,
        "up_to_5_mins": 1,
        "up_to_15_mins": 13,
        "up_to_30_mins": 0,
        "up_to_1_hour": 0,
        "up_to_2_hours": 0,
        "up_to_3_hours": 0,
        "more_than_3_hours": 0
    },
    {
        "date": "2022-05-23",
        "viewers": 1,
        "total_view_time": 123,
        "up_to_5_secs": 0,
        "up_to_10_secs": 0,
        "up_to_15_secs": 0,
        "up_to_20_secs": 0,
        "up_to_25_secs": 0,
        "up_to_30_secs": 0,
        "up_to_1_min": 0,
        "up_to_5_mins": 1,
        "up_to_15_mins": 0,
        "up_to_30_mins": 0,
        "up_to_1_hour": 0,
        "up_to_2_hours": 0,
        "up_to_3_hours": 0,
        "more_than_3_hours": 0
    }
  ]
}

Response fields:
  • date - the day for which the data is exposed
  • viewers - total amount of connections
  • total_view_time - total amount of view time
  • up_to_5_secs - number of connections for up to 5 seconds
  • up_to_10_secs - number of connections more than 5 seconds up to 10
  • up_to_15_secs - up to 15 seconds
  • up_to_20_secs - up to 20 seconds
  • up_to_25_secs - up to 25 seconds
  • up_to_30_secs - up to 30 seconds
  • up_to_1_min - up to 1 minute
  • up_to_5_mins - up to 5 minutes
  • up_to_15_mins - up to 15 minutes
  • up_to_30_mins - up to 30 minutes
  • up_to_1_hour - up to 1 hour
  • up_to_2_hours - up to 2 hours
  • up_to_3_hours - up to 3 hours
  • more_than_3_hours - more than 3 hours

This is the daily players report which is available under Reporting / Players stats menu.
Request URL:
https://api.wmspanel.com/v1/players_stats
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • from - report beginning date, the format is YYYY-MM-DD, e.g. 2014-08-01
  • to - report ending date with the same format, like 2014-12-31
  • data_slice - the data slice ID which you got from  "Data slices -> Get list" request. If you have user-based authorization, then this parameter is optional - in this case the data will be selected by the slice where a user is assigned to.
Optional parameters:
You may also request data for separate server, just as you can in web UI.
  • server - is the ID of the server to filter data for. Check "Get servers list" method to obtain your servers list.

Request example:
https://api.wmspanel.com/v1/players_stats?client_id=[client_id]&api_key=[api_key]&from=2014-01-01&to=2014-12-31&data_slice=53e03ca678a6fc8599
Response example: 
{
  "status" : "Ok",
  "stats" : [
    {
      "Safari" : 9,
      "Unknown" : 45,
      "date" : "2014-10-17",
      "MSIE" : 3,
      "Flash" : 39
    },
    {
      "Safari" : 12,
      "Unknown" : 0,
      "date" : "2014-10-20",
      "MSIE" : 4,
      "Flash" : 0
    }
  ]
}

Response fields:
  • date - the day for which the data is exposed
  • Unknown - total amount of connections from unknown players
  • Flash - total mount of Flash players
  • Safari, MSIE, Chrome etc. - numbers of connections for known browsers and players.

This is the daily devices report which is available under Reporting / Devices stats menu.
Request URL:
https://api.wmspanel.com/v1/devices_stats
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • from - report beginning date, the format is YYYY-MM-DD, e.g. 2014-08-01
  • to - report ending date with the same format, like 2014-12-31
  • data_slice - the data slice ID which you got from  "Data slices -> Get list" request. If you have user-based authorization, then this parameter is optional - in this case the data will be selected by the slice where a user is assigned to.
Optional parameters:
You may also request data for separate server, just as you can in web UI.
  • server - is the ID of the server to filter data for. Check "Get servers list" method to obtain your servers list.

Request example:
https://api.wmspanel.com/v1/devices_stats?client_id=[client_id]&api_key=[api_key]&from=2014-01-01&to=2014-12-31&data_slice=53e03ca678a6fc8599
Response example: 
{
  "status" : "Ok",
  "stats" : [
    {
      "iPhone" : 6,
      "iPad" : 6,
      "Macintosh" : 3,
      "Unknown" : 21,
      "Linux" : 12,
      "date" : "2014-10-17",
      "Windows" : 48
    },
    {
      "Unknown" : 0,
      "date" : "2014-10-20",
      "Windows" : 16
    }
  ]
}

Response fields:
  • date - the day for which the data is exposed
  • Unknown - total amount of connections from unknown players
  • Windows, Linux etc. - total mount of connections from mentioned OSes
  • iPad, iPhone, SmartTV etc. - total mount of connections from mentioned devices

This is the Geo statistics report which is available under Reporting / Geo stats.
Request URL:
GET https://api.wmspanel.com/v1/geo
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • from - report beginning date, the format is YYYY-MM-DD, e.g. 2014-08-01
  • to - report ending date with the same format, like 2014-12-31
  • data_slice - the "id" which you got from the previous request. If you have user-based authorization, then this parameter is optional - in this case the data will be selected by the slice where a user is assigned to.
  • alpha2 (optional) - country code
  • region (optional) - region code or "All"
Request example:
https://api.wmspanel.com/v1/geo?client_id=[client_id]&api_key=[api_key]&data_slice=[data_slice_id]&from=2015-04-16&to=2015-04-17
Response example: 
    {
    "status" : "Ok",
    "stats" : [
      {
        "code" : "US",
        "viewers" : 14,
        "country" : "United States"
      },
      {
        "code" : "JP",
        "viewers" : 14,
        "country" : "Japan"
      },
      {
        "code" : "CA",
        "viewers" : 1137,
        "country" : "Canada"
      },
      {
        "code" : "BD",
        "viewers" : 42,
        "country" : "Bangladesh"
      },
      {
        "code" : "KR",
        "viewers" : 14,
        "country" : "Korea, Republic of"
      }
    ]
}
Request example:
https://api.wmspanel.com/v1/geo?client_id=[client_id]&api_key=[api_key]&data_slice=[data_slice_id]&from=2015-04-16&to=2015-04-17&alpha2=CA
Response example: 
    {
    "status" : "Ok",
    "stats" : [
      {
        "code" : "BC",
        "viewers" : 181,
        "region" : "British Columbia"
      },
      {
        "code" : "ON",
        "viewers" : 775,
        "region" : "Ontario"
      },
      {
        "code" : "QC",
        "viewers" : 181,
        "region" : "Quebec"
      }
    ]
}
Request example:
https://api.wmspanel.com/v1/geo?client_id=[client_id]&api_key=[api_key]&data_slice=[data_slice_id]&from=2015-04-16&to=2015-04-17&alpha2=CA&region=ON
Response example: 
    {
    "status" : "Ok",
    "stats" : [
      {
        "city" : "Brampton",
        "viewers" : 594
      },
      {
        "city" : "Toronto",
        "viewers" : 181
      }
    ]
}
Request example:
https://api.wmspanel.com/v1/geo?client_id=[client_id]&api_key=[api_key]&data_slice=[data_slice_id]&from=2015-04-16&to=2015-04-17&alpha2=CA&region=All
Response example: 
    {
    "status" : "Ok",
    "stats" : [
      {
        "city" : "Brampton",
        "viewers" : 594
      },
      {
        "city" : "Montréal",
        "viewers" : 181
      },
      {
        "city" : "North Vancouver",
        "viewers" : 181
      },
      {
        "city" : "Toronto",
        "viewers" : 181
      }
    ]
}

This is the internet service providers statistics report which is available under Reporting / ISP stats.
Request URL:
GET https://api.wmspanel.com/v1/isp
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • from - report beginning date, the format is YYYY-MM-DD, e.g. 2014-08-01
  • to - report ending date with the same format, like 2014-12-31
  • data_slice - the "id" which you got from the previous request. If you have user-based authorization, then this parameter is optional - in this case the data will be selected by the slice where a user is assigned to.
Request example:
https://api.wmspanel.com/v1/isp?client_id=[client_id]&api_key=[api_key]&data_slice=[data_slice_id]&from=2015-04-16&to=2015-04-17
Response example: 
    {
    "status" : "Ok",
    "stats" : [
      {
        "ISP" : "012 Smile",
        "viewers" : 1
      },
      {
        "ISP" : "Vodafone DSL",
        "viewers" : 1
      },
      {
        "ISP" : "YOU Telecom India Pvt Ltd",
        "viewers" : 2
      },
      {
        "ISP" : "iiNet Limited",
        "viewers" : 1
      }
    ]
}

This is the ASN statistics report which is available under Reporting / ASN stats.
Request URL:
GET https://api.wmspanel.com/v1/asn
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • from - report beginning date, the format is YYYY-MM-DD, e.g. 2014-08-01
  • to - report ending date with the same format, like 2014-12-31
  • data_slice - the "id" which you got from the previous request. If you have user-based authorization, then this parameter is optional - in this case the data will be selected by the slice where a user is assigned to.
Optional parameters:
You may also request data for separate server, just as you can in web UI.
  • server - is the ID of the server to filter data for. Check "Get servers list" method to obtain your servers list.
Request example:
https://api.wmspanel.com/v1/asn?client_id=[client_id]&api_key=[api_key]&data_slice=[data_slice_id]&from=2015-04-16&to=2015-04-17&server=[server_id]
Response example: 
    {
    "status" : "Ok",
    "stats" : [
      {
          "6849": 4,
          "total": 4,
          "date": "2020-03-17"
      },
      {
          "6849": 2,
          "Unknown": 1,
          "total": 3,
          "date": "2020-03-18"
      }
    ]
}

This is the request which shows overall report as part of In-depth statistics which is available under Reporting / Deep stats menu. Calling this method is an analogue of opening the report, choosing the criteria and clicking "Find". The result data will be equal. To get further stats for single stream, check "Get Deep stats single stream daily stats" method below.
Request URL:
https://api.wmspanel.com/v1/deep
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • data_slice - the "id" which you got from the previous request. If you have user-based authorization, then this parameter is optional - in this case the data will be selected by the slice where a user is assigned to.
  • from - report beginning date, the format is YYYY-MM-DD, e.g. 2014-08-01
  • to - report ending date with the same format, like 2014-12-31
  • stream - regular expression or full name of the stream to search for
  • top - how many streams to have in result output (20, 50, 100, 1000), it's 20 by default
  • kind - sort criteria: "played", "traffic", "view_time", "avg_view_time", "unique" (it's "played" by default)
  • sort - sorting mode: "least", "most" ("most" by default)
  • total - whether to aggregate results and make last line as the total amounts of values as it's made in Deep stats UI ("false" by default)
  • page - a number of the page to show. One page contains a number of deep records specified by "top" parameter. Page value should be an integer from 1 to 10000. For example, if top=1000 and page=2, then first 1000 records will be skipped and records from 1001 to 2000 will be displayed, if available.

Request example:
https://api.wmspanel.com/v1/deep?client_id=[client_id]&api_key=[api_key]&data_slice=53e03ca678a6fc8599&from=2014-01-01&to=2014-12-31&stream=live&top=20&kind=traffic&sort=least&total=true
Response example: 
{
  "status" : "Ok",
  "streams" : [
    {
      "played" : 1,
      "id" : -567265953,
      "traffic" : 0,
      "avg_view_time" : 1,
      "view_time" : 1,
      "name" : "localhost:8081/live/sample.mp4",
      "unique" : 1
    },
    {
      "played" : 1,
      "id" : 884562081,
      "traffic" : 163643,
      "avg_view_time" : 80,
      "view_time" : 80,
      "name" : "_defaultVHost_/live/_definst_/stream",
      "unique" : 1
    },
    {
      "played" : 2,
      "id" : 957567282,
      "traffic" : 44105071,
      "avg_view_time" : 400,
      "view_time" : 800,
      "name" : "localhost:8081/live/stream",
      "unique" : 1
    },
    {
      "played" : 11,
      "id" : 458257673,
      "traffic" : 79347999,
      "avg_view_time" : 290,
      "view_time" : 3197,
      "name" : "localhost:8081/live/stream/video.ts",
      "unique" : 4
    },
    {
      "played" : 29,
      "id" : 0,
      "traffic" : 149174693,
      "avg_view_time" : 197,
      "view_time" : 5723,
      "name" : "Total (5 streams)",
      "unique" : 7
    }
  ]
}

Response fields:
  • played - amount of connections;
  • id - ID of the stream within WMSPanel, it's used for detailed stream-related requests;
  • traffic - bytes of traffic;
  • avg_view_time - average view time;
  • view_time - total view time;
  • name - public name of the stream, as appears in WMSPanel streams report.
  • unique - unique visitors.

This is the request which shows daily statistics report for individual stream or file as part of In-depth statistics which is available under Reporting / Deep stats menu. This call is available after calling "Get Deeps stats streams list and total stats" method and getting stream ID for further request. Calling this method is an analogue of opening the individual stream or file report in Deep stats.
Request URL:
https://api.wmspanel.com/v1/deep_daily
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • data_slice - the "id" which you got from the previous request. If you have user-based authorization, then this parameter is optional - in this case the data will be selected by the slice where a user is assigned to.
  • from - report beginning date, the format is YYYY-MM-DD, e.g. 2014-08-01
  • to - report ending date with the same format, like 2014-12-31
  • stream - the ID which is received by previous streams list request; this ID can also be obtained in WMSPanel UI while looking at stream real-time stats.

Request example:
https://api.wmspanel.com/v1/deep_daily?client_id=[client_id]&api_key=[api_key]&from=2014-01-01&to=2014-12-31&data_slice=53e03ca678a6fc8599&stream=957567282
Response example: 
{
  "status" : "Ok",
  "stats" : [
    {
      "pd_viewers" : 6,
      "date" : "2014-08-01",
      "total_view_time" : 809,
      "hls_viewers" : 6,
      "message_out" : 41528276,
      "viewers" : 12,
      "message_in" : 68072,
      "unique_viewers" : 4
    },
    {
      "pd_viewers" : 12,
      "date" : "2014-08-02",
      "total_view_time" : 668,
      "hls_viewers" : 8,
      "message_out" : 65361320,
      "viewers" : 20,
      "message_in" : 69941,
      "unique_viewers" : 18
    },
    {
      "pd_viewers" : 4,
      "date" : "2014-08-03",
      "total_view_time" : 585,
      "hls_viewers" : 7,
      "message_out" : 29922755,
      "viewers" : 11,
      "message_in" : 43654,
      "unique_viewers" : 9
    },
    {
      "date" : "2014-08-04",
      "total_view_time" : 1075,
      "hls_viewers" : 13,
      "message_out" : 36573313,
      "viewers" : 13,
      "message_in" : 84323,
      "unique_viewers" : 10
    },
    {
      "pd_viewers" : 5,
      "date" : "2014-08-05",
      "total_view_time" : 1528,
      "hls_viewers" : 12,
      "message_out" : 66173365,
      "viewers" : 17,
      "message_in" : 107114,
      "unique_viewers" : 4
    },
    {
      "pd_viewers" : 8,
      "date" : "2014-08-07",
      "total_view_time" : 596,
      "hls_viewers" : 9,
      "message_out" : 28151857,
      "viewers" : 17,
      "message_in" : 44666,
      "unique_viewers" : 17
    },
    {
      "pd_viewers" : 24,
      "date" : "2014-08-06",
      "total_view_time" : 1575,
      "hls_viewers" : 34,
      "message_out" : 117408560,
      "viewers" : 58,
      "message_in" : 167024,
      "unique_viewers" : 43
    },
    {
      "date" : "2014-08-08",
      "total_view_time" : 108,
      "hls_viewers" : 2,
      "message_out" : 3487210,
      "viewers" : 2,
      "message_in" : 8456,
      "unique_viewers" : 1
    }
  ]
}

Response fields:
  • date - the day for which the data is exposed
  • viewers - amount of connection
  • hls_viewers - amount of connections via HLS
  • hds_viewers - HDS connections
  • smooth_viewers - SmoothStreaming connections
  • rtsp_viewers - RTSP connections
  • rtmp_viewers - RTMP connections
  • dash_viewers - MPEG-DASH connections
  • dvr_viewers - DVR connections
  • ice_viewers - Icecast connections
  • pd_viewers - progressive download connections
  • message_in - incoming traffic
  • message_out - outgoing traffic
  • message_lost - lost traffic
  • total_view_time - total amount of view time
  • unique_viewers - unique visitors
If some protocol does not have stats, it is not included in the response.
If some day does not have stats, it is not included in the response.

This is the request which shows duration statistics report for individual stream or file as part of In-depth statistics which is available under Reporting / Deep stats menu. This call is available after calling "Get Deeps stats streams list and total stats" method and getting stream ID for further request. Calling this method is an analogue of opening the individual stream or file report in Deep stats.
Request URL:
https://api.wmspanel.com/v1/deep_duration
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • data_slice - the "id" which you got from the previous request. If you have user-based authorization, then this parameter is optional - in this case the data will be selected by the slice where a user is assigned to.
  • from - report beginning date, the format is YYYY-MM-DD, e.g. 2014-08-01
  • to - report ending date with the same format, like 2014-12-31
  • stream - the ID which is received by previous streams list request; this ID can also be obtained in WMSPanel UI while looking at stream real-time stats.

Request example: https://api.wmspanel.com/v1/deep_duration?client_id=[client_id]&api_key=[api_key]&from=2022-05-23&to=2022-05-24&data_slice=53e03ca678a6fc8599&stream=957567282
Response example: 
{
  "status" : "Ok",
  "stats" : [
    {
        "viewers": 4,
        "total_view_time": 932,
        "up_to_5_secs": 0,
        "up_to_10_secs": 0,
        "up_to_15_secs": 0,
        "up_to_20_secs": 0,
        "up_to_25_secs": 0,
        "up_to_30_secs": 0,
        "up_to_1_min": 2,
        "up_to_5_mins": 1,
        "up_to_15_mins": 1,
        "up_to_30_mins": 0,
        "up_to_1_hour": 0,
        "up_to_2_hours": 0,
        "up_to_3_hours": 0,
        "more_than_3_hours": 0,
        "date": "2022-05-24"
    },
    {
        "viewers": 1,
        "total_view_time": 123,
        "up_to_5_secs": 0,
        "up_to_10_secs": 0,
        "up_to_15_secs": 0,
        "up_to_20_secs": 0,
        "up_to_25_secs": 0,
        "up_to_30_secs": 0,
        "up_to_1_min": 0,
        "up_to_5_mins": 1,
        "up_to_15_mins": 0,
        "up_to_30_mins": 0,
        "up_to_1_hour": 0,
        "up_to_2_hours": 0,
        "up_to_3_hours": 0,
        "more_than_3_hours": 0,
        "date": "2022-05-23"
    }
  ]
}

Response fields:
  • date - the day for which the data is exposed
  • viewers - total amount of connections
  • total_view_time - total amount of view time
  • up_to_5_secs - number of connections for up to 5 seconds
  • up_to_10_secs - number of connections more than 5 seconds up to 10
  • up_to_15_secs - up to 15 seconds
  • up_to_20_secs - up to 20 seconds
  • up_to_25_secs - up to 25 seconds
  • up_to_30_secs - up to 30 seconds
  • up_to_1_min - up to 1 minute
  • up_to_5_mins - up to 5 minutes
  • up_to_15_mins - up to 15 minutes
  • up_to_30_mins - up to 30 minutes
  • up_to_1_hour - up to 1 hour
  • up_to_2_hours - up to 2 hours
  • up_to_3_hours - up to 3 hours
  • more_than_3_hours - more than 3 hours

This is the request which shows players statistics report for individual stream or file as part of In-depth statistics which is available under Reporting / Deep stats menu. This call is available after calling "Get Deeps stats streams list and total stats" method and getting stream ID for further request. Calling this method is an analogue of opening the individual stream or file report in Deep stats.
Request URL:
https://api.wmspanel.com/v1/deep_players
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • data_slice - the "id" which you got from the previous request. If you have user-based authorization, then this parameter is optional - in this case the data will be selected by the slice where a user is assigned to.
  • from - report beginning date, the format is YYYY-MM-DD, e.g. 2014-08-01
  • to - report ending date with the same format, like 2014-12-31
  • stream - the ID which is received by previous streams list request; this ID can also be obtained in WMSPanel UI while looking at stream real-time stats.

Request example:
https://api.wmspanel.com/v1/deep_players?client_id=[client_id]&api_key=[api_key]&from=2014-01-01&to=2014-12-31&data_slice=53e03ca678a6fc8599&stream=957567282
Response example: 
{
  "status" : "Ok",
  "stats" : [
    {
      "Safari" : 9,
      "Unknown" : 45,
      "date" : "2014-10-17",
      "MSIE" : 3,
      "Flash" : 39
    },
    {
      "Safari" : 12,
      "Unknown" : 0,
      "date" : "2014-10-20",
      "MSIE" : 4,
      "Flash" : 0
    }
  ]
}

Response fields:
  • date - the day for which the data is exposed
  • Unknown - total amount of connections from unknown players
  • Flash - total mount of Flash players
  • Safari, MSIE, Chrome etc. - numbers of connections for known browsers and players.

This is the request which shows devices statistics report for individual stream or file as part of In-depth statistics which is available under Reporting / Deep stats menu. This call is available after calling "Get Deeps stats streams list and total stats" method and getting stream ID for further request. Calling this method is an analogue of opening the individual stream or file report in Deep stats.
Request URL:
https://api.wmspanel.com/v1/deep_devices

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • data_slice - the "id" which you got from the previous request. If you have user-based authorization, then this parameter is optional - in this case the data will be selected by the slice where a user is assigned to.
  • from - report beginning date, the format is YYYY-MM-DD, e.g. 2014-08-01
  • to - report ending date with the same format, like 2014-12-31
  • stream - the ID which is received by previous streams list request; this ID can also be obtained in WMSPanel UI while looking at stream real-time stats.

Request example:
https://api.wmspanel.com/v1/deep_devices?client_id=[client_id]&api_key=[api_key]&from=2014-01-01&to=2014-12-31&data_slice=53e03ca678a6fc8599&stream=957567282
Response example: 
{
  "status" : "Ok",
  "stats" : [
    {
      "iPhone" : 6,
      "iPad" : 6,
      "Macintosh" : 3,
      "Unknown" : 21,
      "Linux" : 12,
      "date" : "2014-10-17",
      "Windows" : 48
    },
    {
      "Unknown" : 0,
      "date" : "2014-10-20",
      "Windows" : 16
    }
  ]
}

Response fields:
  • date - the day for which the data is exposed
  • Unknown - total amount of connections from unknown players
  • Windows, Linux etc. - total mount of connections from mentioned OSes
  • iPad, iPhone, SmartTV etc. - total mount of connections from mentioned devices

This is the High precision data report which is available under Reporting / High precision data.
Request URL:
GET https://api.wmspanel.com/v1/high_pre
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • data_slice - the "id" which you got from 'Get data slices list' request.
By default API will return last 24 hours data for all servers assigned to specified data slice.

Optional parameters:
You may also request data for separate server and specific time interval. Time interval should be no more than 2 days.
  • server - is the ID of the server to filter data for. Check "Get servers list" method to obtain your servers list.
  • from - report beginning date and time, the format is YYYY-mm-DDTHH:MM, e.g. 2021-06-20T17:45
  • to - report ending date with the same format, like 2021-06-21T18:15.
Request example:
https://api.wmspanel.com/v1/high_pre?client_id=[client_id]&api_key=[api_key]&data_slice=[data_slice_id]&from=2021-06-01T01%3A20&to=2021-06-02T03%3A40&server=[server_id]
Response example: 
  {
    "status" : "Ok",
    "stats" : [
        {
            "date": "2021-06-02T03:35:00",
            "bandwidth": 4120560,
            "traffic": 87164844,
            "connections": 3,
            "max_total_connections": 7
        },
        {
            "date": "2021-06-02T03:30:00",
            "bandwidth": 3921551,
            "traffic": 43582422,
            "connections": 2,
            "max_total_connections": 4
        }
     ]
  }
Response fields:
  • date - the date and time for which the data is exposed
  • bandwidth - a bandwidth in bits per second
  • traffic - a traffic in bytes
  • connections - a number of new connections
  • max_total_connections - a maximum number of total connections

Retrieve a list of all IP range groups for your company. You can view this list by navigating to "Control / WMSAuth paywall setup" and then clicking on "MANAGE CUSTOM IP RANGES" link of dialog menu.
Request URL:
GET https://api.wmspanel.com/v1/ip_ranges
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/ip_ranges?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "ip_ranges": [
        {
            "id": "538bcbd3f5aef0bed900000f",
            "name": "Range 1",
            "description": "Test range",
            "cidrs": [
                "192.168.0.0/22"
            ]
        },
        {
            "id": "538bcbd3f5aef0bed9000011",
            "name": "LocalHostRange",
            "description": "",
            "cidrs": [
                "127.0.0.0/8",
                "128.0.0.0/8"
            ]
        },
        {
            "id": "538bcbd3f5aef0bed9000012",
            "name": "all",
            "description": "",
            "cidrs": [
                "0.0.0.0/0"
            ]
        }
    ]
}
Response fields:
  • id - unique IP range group ID for further usage.
  • name - IP range group name.
  • description - IP range group description.
  • cidrs - a list of CIDR blocks identifying specific ranges of IP addresses.

Pick up specific IP range group.
Request URL:
GET https://api.wmspanel.com/v1/ip_ranges/[range_group_id]
Request parameters:

  • range_group_id - is ID of the IP range group obtained via "Get list of IP range groups" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl "https://api.wmspanel.com/v1/ip_ranges/57217510082389594a000001?client_id=[client_id]&api_key=[api_key]"
Response example: 
    {
    "status": "Ok",
    "ip_range": {
        "id": "57217510082389594a000001",
        "name": "IP range 1",
        "description": "IP range created via API",
        "cidrs": [
            "192.168.1.0/24",
            "192.168.2.0/24"
        ]
    }
}
Response fields:
  • id - unique IP range group ID for further usage.
  • name - IP range group name.
  • description - IP range group description.
  • cidrs - a list of CIDR blocks identifying specific ranges of IP addresses.

Create a new IP range group.
Request URL:
POST https://api.wmspanel.com/v1/ip_ranges
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{"name": "IP range 1","description": "IP range created via API", "cidrs": ["192.168.1.0/24", "192.168.2.0/24"]}' "https://api.wmspanel.com/v1/ip_ranges?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • name - IP range group name.
  • description (optional) - IP range group description.
  • cidrs (optional) - a list of CIDR blocks identifying specific ranges of IP addresses. Incorrect entries will be skipped.
Response example: 
    {
    "status": "Ok",
    "ip_range": {
        "id": "57217510082389594a000001",
        "name": "IP range 1",
        "description": "IP range created via API",
        "cidrs": [
            "192.168.1.0/24",
            "192.168.2.0/24"
        ]
    }
}
Response fields: The same as in "Get an existing IP range group".

Update an existing IP range group.
Request URL:
PUT https://api.wmspanel.com/v1/ip_ranges/[range_group_id]
Request parameters:

  • range_group_id - is ID of the IP range group obtained via "Get list of IP range groups" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"name": "IP range 1 modified", "cidrs": ["192.168.5.0/24"]}' "https://api.wmspanel.com/v1/ip_ranges/57217510082389594a000001/?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • name - IP range group name.
  • description - IP range group description.
  • cidrs - a list of CIDR blocks identifying specific ranges of IP addresses. Incorrect entries will be skipped.
All fields are optional.

Response example: 
    {
    "status": "Ok",
    "ip_range": {
        "id": "57217510082389594a000001",
        "name": "IP range 1 modified",
        "description": "IP range created via API",
        "cidrs": [
            "192.168.5.0/24"
        ]
    }
}
Response fields: The same as in "Get an existing IP range group".

Delete an existing IP range group.
Request URL:
DELETE https://api.wmspanel.com/v1/ip_ranges/[range_group_id]
Request parameters:

  • range_group_id - is ID of the IP range group obtained via "Get list of IP range groups" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/ip_ranges/57217510082389594a000001?client_id=[client_id]&api_key=[api_key]"

Response example: 
    {
    "status" : "Ok",
}

Get list of CIDR blocks assigned to specific IP range group.
Request URL:
GET https://api.wmspanel.com/v1/ip_ranges/[range_group_id]/cidrs
Request parameters:

  • range_group_id - is ID of the IP range group obtained via "Get list of IP range groups" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl "https://api.wmspanel.com/v1/ip_ranges/57217510082389594a000001/cidrs?client_id=[client_id]&api_key=[api_key]"
Response example: 
    {
    "status": "Ok",
    "cidrs": [
        "192.168.5.0/24"
    ]
}
Response fields:
  • cidrs - a list of CIDR blocks identifying specific ranges of IP addresses.

Assign specific cidrs to an existing IP range group.
Request URL:
PUT https://api.wmspanel.com/v1/ip_ranges/[range_group_id]/cidrs/assign
Request parameters:

  • range_group_id - is ID of the IP range group obtained via "Get list of IP range groups" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"cidrs": ["127.0.0.0/8", "224.168.0.0/16"]}' "https://api.wmspanel.com/v1/ip_ranges/57217510082389594a000001/cidrs/assign?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • cidrs - a list of CIDR blocks to append to the list of CIDR blocks of given IP range group. Incorrect entries will be skipped.
Response example: 
    {
    "status": "Ok",
    "cidrs": [
        "192.168.5.0/24",
        "127.0.0.0/8",
        "224.168.0.0/16"
    ]
}
Response fields: The same as in "Get CIDR blocks list from an IP range group".

Revoke specific cidrs from an existing IP range group.
Request URL:
PUT https://api.wmspanel.com/v1/ip_ranges/[range_group_id]/cidrs/revoke
Request parameters:

  • range_group_id - is ID of the IP range group obtained via "Get list of IP range groups" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"cidrs": ["127.0.0.0/8"]}' "https://api.wmspanel.com/v1/ip_ranges/57217510082389594a000001/cidrs/revoke?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • cidrs - a list of CIDR blocks to revoke from the list of CIDR blocks of given IP range group. Incorrect entries will be skipped.
Response example: 
    {
    "status": "Ok",
    "cidrs": [
        "192.168.5.0/24",
        "224.168.0.0/16"
    ]
}
Response fields: The same as in "Get CIDR blocks list from an IP range group".

Retrieve a list of all User-agent groups for your company. You can view this list by navigating to "Control / WMSAuth paywall setup" and then clicking on "User-agent groups" link of dialog menu. User-agent groups allow to define User-agent header constraints for further usage in WMSAuth security rules.

Request URL:
GET https://api.wmspanel.com/v1/user_agent_groups
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/user_agent_groups?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "user_agent_groups": [
        {
            "id": "572028890823892aeb000002",
            "name": "VLC",
            "description": "VLC player",
            "rules": [
                "^vlc"
            ]
        },
        {
            "id": "572032a40823892aeb000003",
            "name": "Curl",
            "description": "Curl User-agent",
            "rules": [
                "curl"
            ]
        }
    ]
}
Response fields:
  • id - unique User-agent group ID for further usage.
  • name - User-agent group name.
  • description - User-agent group description.
  • rules - a list of regular expressions matching target User-agent header(s).

Pick up specific User-agent group.

Request URL:
GET https://api.wmspanel.com/v1/user_agent_groups/[group_id]
Request parameters:

  • group_id - is ID of the User-agent group obtained via "Get User-agent groups list" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl "https://api.wmspanel.com/v1/user_agent_groups/57217f6a082389594a000003/?client_id=[client_id]&api_key=[api_key]"
Response example: 
    {
    "status": "Ok",
    "user_agent_group": {
        "id": "57217f6a082389594a000003",
        "name": "Sample user agents",
        "description": "Deny user-agent- with id",
        "rules": [
            "user-agent-d+",
            "super-user-agent-d+"
        ]
    }
}
Response fields:
  • id - unique User-agent group ID for further usage.
  • name - User-agent group name.
  • description - User-agent group description.
  • rules - a list of regular expressions matching target User-agent header(s).

Create a new User-agent group. User-agent groups allow to define User-agent string constraints for further usage in WMSAuth security rules.

Request URL:
POST https://api.wmspanel.com/v1/user_agent_groups
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{"name": "Sample user agents","description": "Deny user-agent- with id", "rules": ["user-agent-\d+", "super-user-agent-\d+"]}' "https://api.wmspanel.com/v1/user_agent_groups?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • name - User-agent group name.
  • description (optional) - User-agent group description.
  • rules (optional) - a list of regular expressions matching target User-agent header(s).
Response example: 
    {
    "status": "Ok",
    "user_agent_group": {
        "id": "57217f6a082389594a000003",
        "name": "Sample user agents",
        "description": "Deny user-agent- with id",
        "rules": [
            "user-agent-d+",
            "super-user-agent-d+"
        ]
    }
}
Response fields: The same as in "Get User-agent groups list".

Update an existing User-agent group.

Request URL:
PUT https://api.wmspanel.com/v1/user_agent_groups/[group_id]
Request parameters:

  • group_id - is ID of the User-agent group obtained via "Get User-agent groups list" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"description": "Deny user agents starting with 'bad' and 'wrong'", "rules": ["^bad", "^wrong"]}' "https://api.wmspanel.com/v1/user_agent_groups/[group_id]/?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • name - User-agent group name.
  • description - User-agent group description.
  • rules - a list of regular expressions matching target User-agent header(s).
All fields are optional.

Response example: 
    {
    "status": "Ok",
    "user_agent_group": {
        "id": "57217f6a082389594a000003",
        "name": "Sample user agents",
        "description": "Deny user agents starting with 'bad' and 'wrong'",
        "rules": [
            "^bad",
            "^wrong"
        ]
    }
}
Response fields: The same as in "Get User-agent groups list".

Delete an existing User-agent group.

Request URL:
DELETE https://api.wmspanel.com/v1/user_agent_groups/[group_id]
Request parameters:

  • group_id - is ID of the User-agent group obtained via "Get User-agent groups list" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/user_agent_groups/57217f6a082389594a000003?client_id=[client_id]&api_key=[api_key]"

Response example: 
    {
    "status" : "Ok",
}

Retrieve a list of all Referer groups for your company. You can view this list by navigating to "Control / WMSAuth paywall setup" and then clicking on "Referer groups" link of dialog menu. Referer groups allow to define referer header constraints for further usage in WMSAuth security rules.

Request URL:
GET https://api.wmspanel.com/v1/referer_groups
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/referer_groups?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "referer_groups": [
        {
            "id": "572028890823892aeb000002",
            "name": "Test",
            "description": "Test group",
            "rules": [
                "test.com"
            ]
        },
        {
            "id": "572032a40823892aeb000003",
            "name": "Test 2",
            "description": "Test group 2",
            "rules": [
                "^((?!test2\.testdomain\.com).)*$"
            ]
        }
    ]
}
Response fields:
  • id - unique referer group ID for further usage.
  • name - referer group name.
  • description - referer group description.
  • rules - a list of regular expressions matching target referer header(s).

Pick up specific Referer group.

Request URL:
GET https://api.wmspanel.com/v1/referer_groups/[group_id]
Request parameters:

  • group_id - is ID of the referer group obtained via "Get Referer groups list" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl "https://api.wmspanel.com/v1/referer_groups/57217f6a082389594a000003/?client_id=[client_id]&api_key=[api_key]"
Response example: 
    {
    "status": "Ok",
    "referer_group": {
        "id": "57217f6a082389594a000003",
        "name": "Sample referers",
        "description": "Deny test referer",
        "rules": [
            "test1+",
            "test2+"
        ]
    }
}
Response fields:
  • id - unique referer group ID for further usage.
  • name - referer group name.
  • description - referer group description.
  • rules - a list of regular expressions matching target referer header(s).

Create a new Referer group. Referer groups allow to define referer string constraints for further usage in WMSAuth security rules.

Request URL:
POST https://api.wmspanel.com/v1/referer_groups
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{"name": "Sample referers","description": "Deny test referere", "rules": ["test1\d+", "test2-\d+"]}' "https://api.wmspanel.com/v1/referer_groups?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • name - referer group name.
  • description (optional) - referer group description.
  • rules (optional) - a list of regular expressions matching target referer header(s).
Response example: 
    {
    "status": "Ok",
        "id": "57217f6a082389594a000003",
        "referer_group": {
        "name": "Sample referers",
        "description": "Deny test referer",
        "rules": [
            "test1+",
            "test2+"
        ]
    }
}
Response fields: The same as in "Get Referer groups list".

Update an existing Referer group.

Request URL:
PUT https://api.wmspanel.com/v1/referer_groups/[group_id]
Request parameters:

  • group_id - is ID of the referer group obtained via "Get Referer groups list" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"description": "Deny test referers", "rules": ["^test1", "^test2"]}' "https://api.wmspanel.com/v1/referer_groups/[group_id]/?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • name - referer group name.
  • description - referer group description.
  • rules - a list of regular expressions matching target referer header(s).
All fields are optional.

Response example: 
    {
    "status": "Ok",
    "referer_group": {
        "id": "57217f6a082389594a000003",
        "name": "Sample referers",
        "description": "Deny test referers",
        "rules": [
            "^test1",
            "^test2"
        ]
    }
}
Response fields: The same as in "Get Referer groups list".

Delete an existing Referer group.

Request URL:
DELETE https://api.wmspanel.com/v1/referer_groups/[group_id]
Request parameters:

  • group_id - is ID of the referer group obtained via "Get Referer groups list" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/referer_groups/57217f6a082389594a000003?client_id=[client_id]&api_key=[api_key]"

Response example: 
    {
    "status" : "Ok",
}

Retrieve a list of all WMSAuth groups for your company. You can view this list by navigating to "Control / WMSAuth paywall setup". WMSAuth groups allow to apply various security rules for specific set of media servers.
Request URL:
GET https://api.wmspanel.com/v1/wmsauth/groups
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/wmsauth/groups?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "groups": [
        {
            "id": "56bd2ebb082389516b000005",
            "name": "Domain lock",
            "description": "",
            "server_ids": [
                "538bcbd3f5aef0bed9000003"
            ]
        },
        {
            "id": "571dec050823897d48000004",
            "name": "Empty group",
            "description": "A group without servers",
            "server_ids": []
        },
        {
            "id": "571ded990823897d48000005",
            "name": "API group",
            "description": "A group created via API",
            "server_ids": [
                "538bcbd3f5aef0bed9000003",
                "538bcbd3f5aef0bed9000004",
                "538bcbd3f5aef0bed9000005",
                "538bcbd3f5aef0bed9000006",
                "538bcbd3f5aef0bed9000007",
                "538bcbd3f5aef0bed9000009",
                "538bcbd3f5aef0bed900000b",
                "538bcbd3f5aef0bed900000c",
                "538bcbd3f5aef0bed900000d",
                "538bcbd3f5aef0bed900000e",
                "539e6df55cc8f54999000001",
                "539e84a75cc8f54c53000003",
                "53c709f55cc8f51a2f00000f",
                "53e97fbd7303917ee7000004",
                "54396b04f5aef090ea00000a",
                "54fcfbb0639bbd6c77000007"
            ]
        }
    ]
}
Response fields:
  • id - unique WMSAuth group ID for further usage.
  • name - WMSAuth group name.
  • description - WMSAuth group description.
  • server_ids - a list of server IDs assigned to the group. You can retrieve full information about your servers via the "Get servers list" API call.

Pick up a WMSAuth group.
Request URL:
GET https://api.wmspanel.com/v1/wmsauth/groups/[group_id]
Request parameters:

  • group_id - is ID of the WMSAuth group obtained via "Get WMSAuth groups list" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/wmsauth/groups/571ded990823897d48000005?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "group": {
        "id": "571ded990823897d48000005",
        "name": "API group",
        "description": "A group created via API",
        "server_ids": [
            "538bcbd3f5aef0bed9000003",
            "538bcbd3f5aef0bed9000004",
            "538bcbd3f5aef0bed9000005",
            "538bcbd3f5aef0bed9000006",
            "538bcbd3f5aef0bed9000007",
            "538bcbd3f5aef0bed9000009",
            "538bcbd3f5aef0bed900000b",
            "538bcbd3f5aef0bed900000c",
            "538bcbd3f5aef0bed900000d",
            "538bcbd3f5aef0bed900000e",
            "539e6df55cc8f54999000001",
            "539e84a75cc8f54c53000003",
            "53c709f55cc8f51a2f00000f",
            "53e97fbd7303917ee7000004",
            "54396b04f5aef090ea00000a",
            "54fcfbb0639bbd6c77000007"
        ]
    }
}
Response fields:
  • id - unique WMSAuth group ID for further usage.
  • name - WMSAuth group name.
  • description - WMSAuth group description.
  • server_ids - a list of server IDs assigned to the group. You can retrieve full information about your servers via the "Get servers list" API call.

Create a new WMSAuth group. WMSAuth group allows to apply various security rules for specific set of media servers.
Request URL:
POST https://api.wmspanel.com/v1/wmsauth/groups
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{"name": "Hot-linking protection", "description": "Hot-linking protection for Nimble-live-1 server", "server_ids": ["54fcfbb0639bbd6c77000007"]}' "https://api.wmspanel.com/v1/wmsauth/groups?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • name - WMSAuth group name.
  • description (optional) - WMSAuth group description.
  • server_ids (optional) - a list of server IDs assigned to the group. You can retrieve full information about your servers via the "Get servers list" API call.
Response example: 
    {
    "status": "Ok",
    "group": {
        "id": "57218a2b082389594a000005",
        "name": "Hot-linking protection",
        "description": "Hot-linking protection for Nimble-live-1 server",
        "server_ids": [
            "54fcfbb0639bbd6c77000007"
        ]
    }
}
Response fields: The same as in "Get an existing WMSAuth group".

Update an existing WMSAuth group.
Request URL:
PUT https://api.wmspanel.com/v1/wmsauth/groups/[group_id]
Request parameters:

  • group_id - is ID of the WMSAuth group obtained via "Get WMSAuth groups list" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"name": "East Asia servers protection", "description": "Hot-linking protection for Shenzhen-Nimble and Seoul-Nimble servers", "server_ids": ["538bcbd3f5aef0bed9000003", "54fcfbb0639bbd6c77000007"]}' "https://api.wmspanel.com/v1/wmsauth/groups/57218a2b082389594a000005?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • name - WMSAuth group name.
  • description - WMSAuth group description.
  • server_ids - a list of server IDs assigned to the group. You can retrieve full information about your servers via the "Get servers list" API call.
All fields are optional.

Response example: 
    {
    "status": "Ok",
    "group": {
        "id": "57218a2b082389594a000005",
        "name": "East Asia servers protection",
        "description": "Hot-linking protection for Shenzhen-Nimble and Seoul-Nimble servers",
        "server_ids": [
            "538bcbd3f5aef0bed9000003",
            "54fcfbb0639bbd6c77000007"
        ]
    }
}
Response fields: The same as in "Get an existing WMSAuth group".

Delete an existing WMSAuth group.
Request URL:
DELETE https://api.wmspanel.com/v1/wmsauth/groups/[group_id]
Request parameters:

  • group_id - is ID of the WMSAuth group obtained via "Get WMSAuth groups list" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/wmsauth/groups/57218a2b082389594a000005?client_id=[client_id]&api_key=[api_key]"

Response example: 
    {
    "status" : "Ok",
}

Retrieve a list of rules from given WMSAuth group. You can view this list by navigating to "Control / WMSAuth paywall setup" and selecting specific WMSAuth group. WMSAuth rules allow to define various security related constraints for your streams, like Hot-linking protection, Geo-restriction, Domain lock, etc.
Request URL:
GET https://api.wmspanel.com/v1/wmsauth/groups/[group_id]/rules
Request parameters:

  • group_id - is ID of the WMSAuth group obtained via "Get WMSAuth groups list" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl "https://api.wmspanel.com/v1/wmsauth/groups/57218a2b082389594a000005/rules?client_id=[client_id]&api_key=[api_key]"
Response example: 
{
    "status": "Ok",
    "rules": [
        {
            "id": "5721bf8f082389594a000007",
            "name": "protect vod application",
            "vhost": "",
            "application": "vod",
            "instance": "",
            "stream": "",
            "allow_preferred": false,
            "allow_countries": ["AX", "AL", "AD", "AT", "BY", "BE", "BA", "BG", "HR", "CY", "CZ", "DK", "EE", "EU", "GB"],
            "deny_countries": ["AF", "AM", "AP", "AZ", "BH", "BD", "BT", "IO", "BN", "KH", "CN", "CX", "CC", "GE", "HK"],
            "allow_ip_range_ids": [],
            "deny_ip_range_ids": [
                "572177ae082389594a000002",
                "538bcbd3f5aef0bed900000f"
            ],
            "deny_user_agent_group_ids": [
                "572028890823892aeb000002"
            ],
            "deny_referer_group_ids": [
                "578f4de6fe7cd35b8b00003a"
            ],
            "time_tolerance": 60,
            "password": "mysecretpassword",
            "protocols": [
                "HLS",
                "SMOOTH",
                "HDS",
                "RTMP",
                "RTSP",
                "DASH",
                "PD",
                "MPEGTS",
                "ICECAST",
                "SLDP",
                "SRT",
                "WHEP"
            ]
        },
        {
            "id": "5721c062082389594a000009",
            "name": "protect sports streams",
            "vhost": "",
            "application": "",
            "instance": "",
            "stream": "^sport-",
            "allow_preferred": false,
            "allow_countries": [
                "BR"
            ],
            "deny_countries": [
                "AU"
            ],
            "allow_ip_range_ids": [
                "546eae5778a6fc3c12000007",
                "53e80b0f78a6fc630b000007"
            ],
            "deny_ip_range_ids": [
                "572177ae082389594a000002"
            ],
            "deny_user_agent_group_ids": [
                "572028890823892aeb000002",
                "572032a40823892aeb000003"
            ],
            "deny_referer_group_ids": [
                "578f4de6fe7cd35b8b00003a"
            ],
            "time_tolerance": 120,
            "password": "yetmoresecretpassword",
            "protocols": [
                "HLS",
                "SMOOTH",
                "HDS",
                "RTMP",
                "RTSP",
                "DASH",
                "PD",
                "MPEGTS",
                "ICECAST"
            ],
            "connections": 100000
        }
    ]
}
Response fields:
  • id - unique WMSAuth rule ID for further usage.
  • name - WMSAuth rule name.
  • vhost - regular expression for Wowza server vHost name or Nimble Streamer hostname.
  • application - regular expression for application name. Empty string means that given rule is applied to all possible application names.
  • instance - regular expression for application instance name. Applicable for Wowza servers only.
  • stream - regular expression for stream name. Empty string means that given rule is applied to all possible stream names. If all the vhost, application, instance and stream parameters are blank, then given rule is considered as global rule applied to assigned servers in general.
  • connections - maximum number of simultaneous connections allowed for the rule targets. The limitation is applied to each server in group separately. As soon as this limit is reached no new connections are allowed. Connections limit has top priority over other types of restrictions. Empty value means no limit.
  • bandwidth - maximum bandwidth allowed for the rule targets, defined as decimal number of Gbps (e.g. 1.3Gbps). The limitation is applied to each server in group separately. Applicable for Wowza servers only. As soon as this limit is reached no new connections are allowed. Bandwidth limit has top priority over other types of restrictions. Empty value means no limit.
  • allow_preferred - defines whether the allow lists (allowed countries and allowed IP ranges) of given rule are evaluated by media server before the deny lists (denied countries and denied IP ranges) of given rule. For more information about this parameter please refer to Paywall FAQ number 8.
  • allow_countries - list of countries those viewers, i.e. viewers with IP addresses belonging to specified countries, are allowed to access target streams without URL signature. Each country is specified with ISO 3166-1 alpha-2 code.
  • deny_countries - list of countries those viewers, i.e. viewers with IP addresses belonging to specified countries, are denied to access target streams regardless of URL signature. Each country is specified with ISO 3166-1 alpha-2 code.
  • allow_ip_range_ids - list of IP range group IDs those are allowed to access target streams without URL signature. You can create and manage IP ranges via API requests described in the "IP ranges" section of this page.
  • deny_ip_range_ids - list of IP range group IDs those are denied to access target streams regardless of URL signature. You can create and manage IP ranges via API requests described in the "IP ranges" section of this page.
  • deny_user_agent_group_ids - list of User-agent group IDs those are denied to access target streams regardless of URL signature. You can create and manage User-agent groups via API requests described in the "User-agent groups" section of this page.
  • deny_referer_group_ids - list of Referer group IDs those are denied to access target streams regardless of URL signature.
  • password - a secret key that is used for generating URL signature and ensures its strength.
  • time_tolerance - maximum time range that is allowed for web server and media server to be unsynchronized.
  • protocols - list of protocols those given rule is applied to. Acceptable values are: 'HLS', 'SMOOTH', 'HDS', 'ICECAST', 'DASH', 'RTMP', 'RTSP', 'DVR', 'MPEGTS', 'PD', 'SLDP', 'SRT' and 'WHEP'.

Pick up specific WMSAuth rule from given WMSAuth group.
Request URL:
GET https://api.wmspanel.com/v1/wmsauth/groups/[group_id]/rules/[rule_id]
Request parameters:

  • rule_id - is ID of the WMSAuth rule obtained via "Get rules list from a WMSAuth group" method.
  • group_id - is ID of the WMSAuth group obtained via "Get WMSAuth groups list" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl "https://api.wmspanel.com/v1/wmsauth/groups/57218a2b082389594a000005/rules/5721c062082389594a000009?client_id=[client_id]&api_key=[api_key]"
Response example: 
{
    "status": "Ok",
    "rule": {
        "id": "5721c062082389594a000009",
        "name": "protect sports streams",
        "vhost": "",
        "application": "",
        "instance": "",
        "stream": "^sport-",
        "allow_preferred": false,
        "allow_countries": [
            "BR"
        ],
        "deny_countries": [
            "AU"
        ],
        "allow_ip_range_ids": [
            "546eae5778a6fc3c12000007",
            "53e80b0f78a6fc630b000007"
        ],
        "deny_ip_range_ids": [
            "572177ae082389594a000002"
        ],
        "deny_user_agent_group_ids": [
            "572028890823892aeb000002",
            "572032a40823892aeb000003"
        ],
        "deny_referer_group_ids": [
            "578f4de6fe7cd35b8b00003a"
        ],
        "time_tolerance": 120,
        "password": "yetmoresecretpassword",
        "protocols": [
            "HLS",
            "SMOOTH",
            "HDS",
            "RTMP",
            "RTSP",
            "DASH",
            "PD",
            "MPEGTS",
            "ICECAST",
            "SLDP",
            "SRT",
            "WHEP"
        ],
        "connections": 100000
    }
}
Response fields:
  • id - unique WMSAuth rule ID for further usage.
  • name - WMSAuth rule name.
  • vhost - regular expression for Wowza server vHost name or Nimble Streamer hostname.
  • application - regular expression for application name. Empty string means that given rule is applied to all possible application names.
  • instance - regular expression for application instance name. Applicable for Wowza servers only.
  • stream - regular expression for stream name. Empty string means that given rule is applied to all possible stream names. If all the vhost, application, instance and stream parameters are blank, then given rule is considered as global rule applied to assigned servers in general.
  • connections - maximum number of simultaneous connections allowed for the rule targets. The limitation is applied to each server in group separately. As soon as this limit is reached no new connections are allowed. Connections limit has top priority over other types of restrictions. Empty value means no limit.
  • bandwidth - maximum bandwidth allowed for the rule targets, defined as decimal number of Gbps (e.g. 1.3Gbps). The limitation is applied to each server in group separately. Applicable for Wowza servers only. As soon as this limit is reached no new connections are allowed. Bandwidth limit has top priority over other types of restrictions. Empty value means no limit.
  • allow_preferred - defines whether the allow lists (allowed countries and allowed IP ranges) of given rule are evaluated by media server before the deny lists (denied countries and denied IP ranges) of given rule. For more information about this parameter please refer to Paywall FAQ number 8.
  • allow_countries - list of countries those viewers, i.e. viewers with IP addresses belonging to specified countries, are allowed to access target streams without URL signature. Each country is specified with ISO 3166-1 alpha-2 code.
  • deny_countries - list of countries those viewers, i.e. viewers with IP addresses belonging to specified countries, are denied to access target streams regardless of URL signature. Each country is specified with ISO 3166-1 alpha-2 code.
  • allow_ip_range_ids - list of IP range group IDs those are allowed to access target streams without URL signature. You can create and manage IP ranges via API requests described in the "IP ranges" section of this page.
  • deny_ip_range_ids - list of IP range group IDs those are denied to access target streams regardless of URL signature. You can create and manage IP ranges via API requests described in the "IP ranges" section of this page.
  • deny_user_agent_group_ids - list of User-agent group IDs those are denied to access target streams regardless of URL signature. You can create and manage User-agent groups via API requests described in the "User-agent groups" section of this page.
  • deny_referer_group_ids - list of Referer group IDs those are denied to access target streams regardless of URL signature.
  • password - a secret key that is used for generating URL signature and ensures its strength.
  • time_tolerance - maximum time range that is allowed for web server and media server to be unsynchronized.
  • protocols - list of protocols those given rule is applied to. Acceptable values are: 'HLS', 'SMOOTH', 'HDS', 'ICECAST', 'DASH', 'RTMP', 'RTSP', 'DVR', 'MPEGTS', 'PD', 'SLDP', 'SRT' and 'WHEP'. By default, all protocols are included.

Create a new rule for given WMSAuth group. WMSAuth rules allow to define various security related constraints for your streams, like Hot-linking protection, Geo-restriction, Domain lock, etc.
Request URL:
POST https://api.wmspanel.com/v1/wmsauth/groups/[group_id]/rules
Request parameters:

  • group_id - is ID of the WMSAuth group obtained via "Get WMSAuth groups list" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{"name": "Example rule", "vhost": "example.com", "application": "live", "instance": "", "stream": "", "allow_preferred": false, "allow_countries": ["BR", "RU"], "deny_countries": ["AU", "HK"], "allow_ip_range_ids": ["546eae5778a6fc3c12000007"], "deny_user_agent_group_ids": ["572028890823892aeb000002", "572032a40823892aeb000003" ], "time_tolerance": 60, "password": "Mdr#89dfDf", "protocols": ["HLS", "SMOOTH", "HDS", "RTMP", "RTSP", "DASH", "PD", "MPEGTS", "ICECAST", "WHEP"]}' "https://api.wmspanel.com/v1/wmsauth/groups/57218a2b082389594a000005/rules?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • name - WMSAuth rule name.
  • vhost - regular expression for Wowza server vHost name or Nimble Streamer hostname.
  • application - regular expression for application name. Empty string means that given rule is applied to all possible application names.
  • instance - regular expression for application instance name. Applicable for Wowza servers only.
  • stream - regular expression for stream name. Empty string means that given rule is applied to all possible stream names. If all the vhost, application, instance and stream parameters are blank, then given rule is considered as global rule applied to assigned servers in general.
  • connections - maximum number of simultaneous connections allowed for the rule targets. The limitation is applied to each server in group separately. As soon as this limit is reached no new connections are allowed. Connections limit has top priority over other types of restrictions. Empty value means no limit.
  • bandwidth - maximum bandwidth allowed for the rule targets, defined as decimal number of Gbps (e.g. 1.3Gbps). The limitation is applied to each server in group separately. Applicable for Wowza servers only. As soon as this limit is reached no new connections are allowed. Bandwidth limit has top priority over other types of restrictions. Empty value means no limit.
  • - defines whether the allow lists (allowed countries and allowed IP ranges) of given rule are evaluated by media server before the deny lists (denied countries and denied IP ranges) of given rule. For more information about this parameter please refer to Paywall FAQ number 8.
  • allow_countries - list of countries those viewers, i.e. viewers with IP addresses belonging to specified countries, are allowed to access target streams without URL signature. Each country must be specified with ISO 3166-1 alpha-2 code. Wrong entries will be skipped.
  • deny_countries - list of countries those viewers, i.e. viewers with IP addresses belonging to specified countries, are denied to access target streams regardless of URL signature. Each country must be specified with ISO 3166-1 alpha-2 code. Wrong entries will be skipped.
  • allow_ip_range_ids - list of IP range group IDs those are allowed to access target streams without URL signature. You can create and manage IP ranges via API requests described in the "IP ranges" section of this page.
  • deny_ip_range_ids - list of IP range group IDs those are denied to access target streams regardless of URL signature. You can create and manage IP ranges via API requests described in the "IP ranges" section of this page.
  • deny_user_agent_group_ids - list of User-agent group IDs those are denied to access target streams regardless of URL signature. You can create and manage User-agent groups via API requests described in the "User-agent groups" section of this page.
  • deny_referer_group_ids - list of Referer group IDs those are denied to access target streams regardless of URL signature.
  • password - a secret key that is used for generating URL signature and ensures its strength.
  • time_tolerance - maximum time range that is allowed for web server and media server to be unsynchronized.
  • protocols - list of protocols those given rule is applied to. Acceptable values are: 'HLS', 'SMOOTH', 'HDS', 'ICECAST', 'DASH', 'RTMP', 'RTSP', 'DVR', 'MPEGTS', 'PD', 'SLDP', 'SRT' and 'WHEP'. If this parameter isn't specified, then all protocols are included.
All fields are optional.

Response example: 
{
    "status": "Ok",
    "group": {
        "id": "5721c55c082389594a00000c",
        "name": "Example rule",
        "vhost": "example.com",
        "application": "live",
        "instance": "",
        "stream": "",
        "allow_preferred": false,
        "allow_countries": [
            "BR",
            "RU"
        ],
        "deny_countries": [
            "AU",
            "HK"
        ],
        "allow_ip_range_ids": [
            "546eae5778a6fc3c12000007"
        ],
        "deny_ip_range_ids": [],
        "deny_user_agent_group_ids": [
            "572028890823892aeb000002",
            "572032a40823892aeb000003"
        ],
        "deny_referer_group_ids": [],
        "time_tolerance": 60,
        "password": "Mdr#89dfDf",
        "protocols": [
            "HLS",
            "SMOOTH",
            "HDS",
            "RTMP",
            "RTSP",
            "DASH",
            "PD",
            "DVR",
            "MPEGTS",
            "ICECAST",
            "SLDP",
            "SRT"
        ]
    }
}
Response fields: The same as in "Get an existing rule from a WMSAuth group".

Update specific rule from given WMSAuth group.
Request URL:
PUT https://api.wmspanel.com/v1/wmsauth/groups/[group_id]/rules/[rule_id]
Request parameters:

  • rule_id - is ID of the WMSAuth rule obtained via "Get rules list from a WMSAuth group" method.
  • group_id - is ID of the WMSAuth group obtained via "Get WMSAuth groups list" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"name": "Example rule modified", "vhost": "", "application": "^live$", "allow_countries": ["HK"], "deny_countries": [], "allow_ip_range_ids": [], "protocols": ["HLS", "RTMP", "PD"]}' "https://api.wmspanel.com/v1/wmsauth/groups/57218a2b082389594a000005/rules/5721c55c082389594a00000c?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • name - WMSAuth rule name.
  • vhost - regular expression for Wowza server vHost name or Nimble Streamer hostname.
  • application - regular expression for application name. Empty string means that given rule is applied to all possible application names.
  • instance - regular expression for application instance name. Applicable for Wowza servers only.
  • stream - regular expression for stream name. Empty string means that given rule is applied to all possible stream names. If all the vhost, application, instance and stream parameters are blank, then given rule is considered as global rule applied to assigned servers in general.
  • connections - maximum number of simultaneous connections allowed for the rule targets. The limitation is applied to each server in group separately. As soon as this limit is reached no new connections are allowed. Connections limit has top priority over other types of restrictions. Empty value means no limit.
  • bandwidth - maximum bandwidth allowed for the rule targets, defined as decimal number of Gbps (e.g. 1.3Gbps). The limitation is applied to each server in group separately. Applicable for Wowza servers only. As soon as this limit is reached no new connections are allowed. Bandwidth limit has top priority over other types of restrictions. Empty value means no limit.
  • allow_preferred - defines whether the allow lists (allowed countries and allowed IP ranges) of given rule are evaluated by media server before the deny lists (denied countries and denied IP ranges) of given rule. For more information about this parameter please refer to Paywall FAQ number 8.
  • allow_countries - list of countries those viewers, i.e. viewers with IP addresses belonging to specified countries, are allowed to access target streams without URL signature. Each country must be specified with ISO 3166-1 alpha-2 code. Wrong entries will be skipped.
  • deny_countries - list of countries those viewers, i.e. viewers with IP addresses belonging to specified countries, are denied to access target streams regardless of URL signature. Each country must be specified with ISO 3166-1 alpha-2 code. Wrong entries will be skipped.
  • allow_ip_range_ids - list of IP range group IDs those are allowed to access target streams without URL signature. You can create and manage IP ranges via API requests described in the "IP ranges" section of this page.
  • deny_ip_range_ids - list of IP range group IDs those are denied to access target streams regardless of URL signature. You can create and manage IP ranges via API requests described in the "IP ranges" section of this page.
  • deny_user_agent_group_ids - list of User-agent group IDs those are denied to access target streams regardless of URL signature. You can create and manage User-agent groups via API requests described in the "User-agent groups" section of this page.
  • deny_referer_group_ids - list of Referer group IDs those are denied to access target streams regardless of URL signature.
  • password - a secret key that is used for generating URL signature and ensures its strength.
  • time_tolerance - maximum time range that is allowed for web server and media server to be unsynchronized.
  • protocols - list of protocols those given rule is applied to. Acceptable values are: 'HLS', 'SMOOTH', 'HDS', 'ICECAST', 'DASH', 'RTMP', 'RTSP', 'DVR', 'MPEGTS', 'PD', 'SLDP', 'SRT' and 'WHEP'.
All fields are optional.

Response example: 
{
    "status": "Ok",
    "group": {
        "id": "5721c55c082389594a00000c",
        "name": "Example rule modified",
        "vhost": "",
        "application": "^live$",
        "instance": "",
        "stream": "",
        "allow_preferred": false,
        "allow_countries": [
            "HK"
        ],
        "deny_countries": [],
        "allow_ip_range_ids": [],
        "deny_ip_range_ids": [],
        "deny_user_agent_group_ids": [
            "572028890823892aeb000002",
            "572032a40823892aeb000003"
        ],
        "deny_referer_group_ids": [],
        "time_tolerance": 60,
        "password": "Mdr#89dfDf",
        "protocols": [
            "HLS",
            "RTMP",
            "PD"
        ]
    }
}
Response fields: The same as in "Get an existing rule from a WMSAuth group".

Delete specific rule from given WMSAuth group.
Request URL:
DELETE https://api.wmspanel.com/v1/wmsauth/groups/[group_id]/rules/[rule_id]
Request parameters:

  • rule_id - is ID of the WMSAuth rule obtained via "Get rules list from a WMSAuth group" method.
  • group_id - is ID of the WMSAuth group obtained via "Get WMSAuth groups list" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/wmsauth/groups/57218a2b082389594a000005/rules/5721c55c082389594a00000c?client_id=[client_id]&api_key=[api_key]"

Response example: 
{
    "status" : "Ok",
}

Retrieve a list of all streams monitored by Dispersa for your company. You can view this list by navigating to "Monitoring" section of the main menu.
Request URL:
GET https://api.wmspanel.com/v1/dispersa/streams
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/dispersa/streams?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "streams": [
        {
            "id": "546eb90f78a6fc1672000002",
            "url": "http://199.138.156.135:8081/vod/nimble.mp4/playlist.m3u8",
            "alias": "Nimble Info",
            "alert": true,
            "paused": false,
            "checkpoints": {
                "AMS": {
                    "status": "online",
                    "time": "2016-05-19 05:33:12 UTC"
                },
                "SFO": {
                    "status": "online",
                    "time": "2016-05-19 05:33:22 UTC"
                },
                "NYC": {
                    "status": "online",
                    "time": "2016-05-19 05:33:20 UTC"
                },
                "SGP": {
                    "status": "offline",
                    "time": "2016-05-19 05:33:13 UTC",
                    "failed_step": "Resolve server name"
                },
                "FRA": {
                    "status": "online",
                    "time": "2016-05-19 05:33:17 UTC"
                },
                "TOR": {
                    "status": "online",
                    "time": "2016-05-19 05:33:10 UTC"
                },
                "538bcbd3f5aef0bed9000004": {
                    "status": "online",
                    "time": "2016-05-19 05:33:08 UTC"
                }
            }
        },
        {
            "id": "52d88d7d54d3152d71000003",
            "url": "https://video.wmspanel.com/local/raw/nimble.mp4/playlist.m3u8",
            "alias": "",
            "alert": false,
            "paused": true,
            "checkpoints": {
                "AMS": {},
                "SFO": {},
                "NYC": {},
                "SGP": {},
                "FRA": {},
                "TOR": {}
            }
        },
        {
            "id": "53c710537d5c007264000243",
            "url": "http://126.155.139.154/video/sample.mp4/playlist.m3u8",
            "alias": "Sample stream",
            "alert": 'all',
            "paused": false,
            "checkpoints": {
                "AMS": {
                    "status": "offline",
                    "time": "2016-05-19 05:34:54 UTC",
                    "failed_step": "Check stream availability"
                },
                "NYC": {
                    "status": "offline",
                    "time": "2016-05-19 05:34:50 UTC",
                    "failed_step": "Check stream availability"
                },
                "SGP": {
                    "status": "offline",
                    "time": "2016-05-19 05:34:47 UTC",
                    "failed_step": "Check stream availability"
                },
                "FRA": {
                    "status": "offline",
                    "time": "2016-05-19 05:34:57 UTC",
                    "failed_step": "Check stream availability"
                },
                "NYC": {
                    "status": "offline",
                    "time": "2016-05-19 05:34:51 UTC",
                    "failed_step": "Check stream availability"
                }
            }
        }
    ]
}
Response fields:
  • id - unique monitored stream ID for further usage.
  • url - monitored stream URL. Supported protocols are HLS, HDS, Smooth streaming, MPEG-DASH, RTMP, RTSP, Icecast, Shoutcast.
  • alias - monitored stream alias, which is used as a name of given stream in Dispersa streams list UI.
  • alert - defines whether Dispersa must produce alert via email and/or push API when monitored stream is offline. Can be either of 3 values:
    • 'all' - alert is produced if at least one checkpoint has reported that given stream is offline
    • true - alert is produced only if all assigned checkpoints have reported that given stream is offline
    • false - alert is never produced for given stream
  • paused - defines whether given stream is not monitored at the moment.
  • checkpoints - a map of checkpoints those are assigned to monitor given stream. Each checkpoint is presented as a "key: value" pair. The key is either 3-character alias in case of default Dispersa checkpoint or server ID in case of private checkpoint. 3-character checkpoint aliases can be found in the "Multiple edit" dialog invoked from Dispersa streams list UI. Server IDs can be obtained via the "Get servers list" API call. The value corresponding to the key is a map consisting of up to 3 following parameters:
    • status - the latest check status. Possible values are: "online" — checkpoint was able to access monitored stream, "offline" — checkpoint has failed to access monitored stream, "pending" — given stream isn't yet monitored by Dispersa.
    • time - the latest check time in UTC format. It's not presented if the latest check status is "pending".
    • failed_step - a brief step description which the latest check has failed on. It's presented only when the latest check status is "offline".

Pick up a stream which is monitored by Dispersa.
Request URL:
GET https://api.wmspanel.com/v1/dispersa/streams/[stream_id]
Request parameters:

  • stream_id - is ID of monitored stream obtained via "Get monitored streams list" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/dispersa/streams/546eb90f78a6fc1672000002?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "stream": {
        "id": "546eb90f78a6fc1672000002",
        "url": "http://199.138.156.135:8081/vod/nimble.mp4/playlist.m3u8",
        "alias": "Nimble Info",
        "alert": true,
        "paused": false,
        "checkpoints": {
            "AMS": {
                "status": "online",
                "time": "2016-05-19 05:33:12 UTC"
            },
            "SFO": {
                "status": "online",
                "time": "2016-05-19 05:33:22 UTC"
            },
            "NYC": {
                "status": "online",
                "time": "2016-05-19 05:33:20 UTC"
            },
            "SGP": {
                "status": "offline",
                "time": "2016-05-19 05:33:13 UTC",
                "failed_step": "Resolve server name"
            },
            "FRA": {
                "status": "online",
                "time": "2016-05-19 05:33:17 UTC"
            },
            "TOR": {
                "status": "online",
                "time": "2016-05-19 05:33:10 UTC"
            },
            "538bcbd3f5aef0bed9000004": {
                "status": "online",
                "time": "2016-05-19 05:33:08 UTC"
            }
        }
    }
}
Response fields:
  • id - unique monitored stream ID for further usage.
  • url - monitored stream URL. Supported protocols are HLS, HDS, Smooth streaming, MPEG-DASH, RTMP, RTSP, Icecast, Shoutcast.
  • alias - monitored stream alias, which is used as a name of given stream in Dispersa streams list UI.
  • alert - defines whether Dispersa must produce alert via email and/or push API when monitored stream is offline. Can be either of 3 values:
    • 'all' - alert is produced if at least one checkpoint has reported that given stream is offline
    • true - alert is produced only if all assigned checkpoints have reported that given stream is offline
    • false - alert is never produced for given stream
  • paused - defines whether given stream is not monitored at the moment.
  • checkpoints - a map of checkpoints those are assigned to monitor given stream. Each checkpoint is presented as a "key: value" pair. The key is either 3-character alias in case of default Dispersa checkpoint or server ID in case of private checkpoint. 3-character checkpoint aliases can be found in the "Multiple edit" dialog invoked from Dispersa streams list UI. Server IDs can be obtained via the "Get servers list" API call. The value corresponding to the key is a map consisting of up to 3 following parameters:
    • status - the latest check status. Possible values are: "online" — checkpoint was able to access monitored stream, "offline" — checkpoint has failed to access monitored stream, "pending" — given stream isn't yet monitored by Dispersa.
    • time - the latest check time in UTC format. It's not presented if the latest check status is "pending".
    • failed_step - a brief step description which the latest check has failed on. It's presented only when the latest check status is "offline".

Add a stream to Dispersa monitoring.
Request URL:
POST https://api.wmspanel.com/v1/dispersa/streams
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{"url": "rtmp://video.example.com/live/superstream", "checkpoints": ["AMS", "SFO", "SGP", "NYC", "538bcbd3f5aef0bed9000004"]}' "https://api.wmspanel.com/v1/dispersa/streams?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • url - monitored stream URL. Must start with one of the following prefixes: "http://", "https://", "rtmp://", "rtmps://", "rtsp://", "rtsps://".
  • alias (optional) - monitored stream alias, which is used as a name of given stream in Dispersa streams list UI.
  • alert (optional) - defines whether Dispersa must produce alert via email and/or push API when monitored stream is offline. Can be either of 3 values:
    • 'all' - alert is produced if at least one checkpoint has reported that given stream is offline
    • true - alert is produced only if all assigned checkpoints have reported that given stream is offline
    • false - alert is never produced for given stream (default)
    By default, it's set to false.
  • paused (optional) - defines whether given stream is not monitored at the moment. By default, it's set to false.
  • checkpoints - a list of checkpoints those will monitor given stream. Each checkpoint must be presented as either 3-character alias of default Dispersa checkpoint or server ID of private checkpoint. 3-character checkpoint aliases can be found in the "Multiple edit" dialog invoked from Dispersa streams list UI. Server IDs can be obtained via the "Get servers list" API call.
Response example: 
    {
    "status": "Ok",
    "stream": {
        "id": "573ee5d70823894d1500003e",
        "url": "rtmp://video.example.com/live/superstream",
        "alias": "",
        "alert": true,
        "paused": false,
        "checkpoints": {
            "AMS": {
                "status": "pending"
            },
            "SFO": {
                "status": "pending"
            },
            "SGP": {
                "status": "pending"
            },
            "NYC": {
                "status": "pending"
            },
            "538bcbd3f5aef0bed9000004": {
                "status": "pending"
            }
        }
    }
}
Response fields: The same as in "Get an existing monitored stream".

Update a stream which is monitored by Dispersa.
Request URL:
PUT https://api.wmspanel.com/v1/dispersa/streams/[stream_id]
Request parameters:

  • stream_id - is ID of monitored stream obtained via "Get monitored streams list" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"alias": "Live super stream", "alert": 'all', "checkpoints": ["AMS", "SGP"]}' "https://api.wmspanel.com/v1/dispersa/streams/573ee5d70823894d1500003e?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • url - monitored stream URL. Must start with one of the following prefixes: "http://", "https://", "rtmp://", "rtmps://", "rtsp://", "rtsps://".
  • alias - monitored stream alias, which is used as a name of given stream in Dispersa streams list UI.
  • alert (optional) - defines whether Dispersa must produce alert via email and/or push API when monitored stream is offline. Can be either of 3 values:
    • 'all' - alert is produced if at least one checkpoint has reported that given stream is offline
    • true - alert is produced only if all assigned checkpoints have reported that given stream is offline
    • false - alert is never produced for given stream (default)
    By default, it's set to false.
  • paused - defines whether given stream is not monitored at the moment. By default, it's set to false.
  • checkpoints - a list of checkpoints those will monitor given stream. Each checkpoint must be presented as either 3-character alias of default Dispersa checkpoint or server ID of private checkpoint. 3-character checkpoint aliases can be found in the "Multiple edit" dialog invoked from Dispersa streams list UI. Server IDs can be obtained via the "Get servers list" API call.
All fields are optional.

Response example: 
    {
    "status": "Ok",
    "stream": {
        "id": "573ee5d70823894d1500003e",
        "url": "rtmp://video.example.com/live/superstream",
        "alias": "Live super stream",
        "alert": 'all',
        "paused": false,
        "checkpoints": {
            "AMS": {
                "status": "pending"
            },
            "SGP": {
                "status": "pending"
            }
        }
    }
}
Response fields: The same as in "Get an existing monitored stream".

Remove specific stream from Dispersa monitoring.
Request URL:
DELETE https://api.wmspanel.com/v1/dispersa/streams/[stream_id]
Request parameters:

  • stream_id - is ID of monitored stream obtained via "Get monitored streams list" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/dispersa/streams/53c710537d5c007264000243?client_id=[client_id]&api_key=[api_key]"

Response example: 
    {
    "status" : "Ok",
}

Get global push API settings for your company. You can view/update these settings by navigating to "Control -> API setup -> Global push API" section of the WMSPanel menu.

Request URL:
GET https://api.wmspanel.com/v1/push
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • global - should be true to get global push API settings
CURL request example:
curl 'https://api.wmspanel.com/v1/push?client_id=[client_id]&api_key=[api_key]&global=true'
Response example: 
    {
        "status": "Ok",
        "push_global_settings": {
            "ppv_url": "http://myhost.com/ppv.php",
            "publish_url": "http://myhost.com/publish.php",
            "token": "fc7ca13a44f1298411251f1c10f71c8f",
            "enable_pay_per_view": true,
            "send_publish_notifications": false,
            "enable_mutual_authorization": false,
            "request_format": "json",
            "sync_interval": 30,
            "report_client_ip": 1,
            "report_user_agents": 0,
            "auth_handler_url": "https://myhost.com/auth.php",
            "auth_concurrency": 999,
            "allow_by_default": true,
            "auth_handler_apps": [
                "TestApp1",
                "TestApp2"
            ]
        }
    }
Response fields:
  • ppv_url - PPV handler URL.
  • publish_url - streams (un)publish handler URL.
  • token - PPV token.
  • enable_pay_per_view - enables pay per view.
  • send_publish_notifications - enables publish/unpublish notifications.
  • enable_mutual_authorization - enables mutual authorization.
  • request_format - defines request format ("json" or "xml").
  • sync_interval - sync interval in seconds (from 5 to 3600 seconds).
  • report_client_ip - a number of client IPs to report (maximum 25).
  • report_user_agents - a number of user agents to report (maximum 25).
  • auth_handler_url - auth handler URL.
  • auth_concurrency - a number of concurrent connections allowed (maximum 1000).
  • allow_by_default - allow connection by default.
  • auth_handler_apps - protected applications.

Set global push API settings for your company. You can view/update these settings by navigating to "Control -> API setup -> Global push API" section of the WMSPanel menu.

Request URL:
PUT https://api.wmspanel.com/v1/push/
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"ppv_url": "http://myhost.com/ppv.php"}' 'https://api.wmspanel.com/v1/push?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
        "status": "Ok",
        "push_global_settings": {
            "ppv_url": "http://myhost.com/ppv.php",
            "publish_url": null,
            "token": "fc7ca13a44f1298411251f1c10f71c8f",
            "enable_pay_per_view": false,
            "send_publish_notifications": false,
            "enable_mutual_authorization": false,
            "request_format": "json",
            "sync_interval": 30,
            "report_client_ip": 1,
            "report_user_agents": 0,
            "auth_handler_url": "https://myhost.com/auth.php",
            "auth_concurrency": 999,
            "allow_by_default": true,
            "auth_handler_apps": []
        }
    }
Request data fields:
  • ppv_url - PPV handler URL.
  • publish_url - streams (un)publish handler URL.
  • token - PPV token. Will be generated automatically, if not available in request.
  • enable_pay_per_view - enables pay per view.
  • send_publish_notifications - enables publish/unpublish notifications.
  • enable_mutual_authorization - enables mutual authorization.
  • request_format - defines request format ("json" or "xml").
  • sync_interval - sync interval in seconds (from 5 to 3600 seconds).
  • report_client_ip - a number of client IPs to report (maximum 25).
  • report_user_agents - a number of user agents to report (maximum 25).
  • auth_handler_url - auth handler URL.
  • auth_concurrency - a number of concurrent connections allowed (maximum 1000).
  • allow_by_default - allow connection by default.
  • auth_handler_apps - protected applications.
All fieds are optional.

Response fields:
Same as request fields.

Get a list of servers push API settings. You can view/update these settings by navigating to "Control -> API setup -> Servers push API" section of the WMSPanel menu.

Request URL:
GET https://api.wmspanel.com/v1/push/
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/push?client_id=[client_id]&api_key=[api_key]'
Response example: 
  {
      "status": "Ok",
      "push_server_settings": [
          {
              "ppv_url": "http://myhost.com/ppv_handler.php",
              "publish_url": "",
              "token": "f128330a6b83a1244b56c151522c60c9",
              "enable_pay_per_view": false,
              "send_publish_notifications": false,
              "enable_mutual_authorization": false,
              "request_format": "json",
              "sync_interval": 30,
              "report_client_ip": 1,
              "report_user_agents": 0,
              "auth_handler_url": "",
              "auth_concurrency": 10,
              "allow_by_default": false,
              "auth_handler_apps": [],
              "server_id": "5a8bbfcff776485bafa70fe7"
          },
          {
              "ppv_url": "http://myhost.com/ppv_handler.php",
              "publish_url": "",
              "token": "e386796776eb403f9288e715940b0e83",
              "enable_pay_per_view": false,
              "send_publish_notifications": true,
              "enable_mutual_authorization": false,
              "request_format": "json",
              "sync_interval": 45,
              "report_client_ip": 1,
              "report_user_agents": 0,
              "auth_handler_url": "http://myhost.com/auth",
              "auth_concurrency": 12,
              "allow_by_default": true,
              "auth_handler_apps": [
                  "TestApp1",
                  "TestApp2",
                  "TestApp3"
              ],
              "server_id": "5695b3d9fe7cd3587600000d"
          }
      ]
  }
Response fields:
  • ppv_url - PPV handler URL.
  • publish_url - streams (un)publish handler URL.
  • token - PPV token.
  • enable_pay_per_view - enables pay per view.
  • send_publish_notifications - enables publish/unpublish notifications.
  • enable_mutual_authorization - enables mutual authorization.
  • request_format - defines request format ("json" or "xml").
  • sync_interval - sync interval in seconds (from 5 to 3600 seconds).
  • report_client_ip - a number of client IPs to report (maximum 25).
  • report_user_agents - a number of user agents to report (maximum 25).
  • auth_handler_url - auth handler URL.
  • auth_concurrency - a number of concurrent connections allowed (maximum 1000).
  • allow_by_default - allow connection by default.
  • auth_handler_apps - protected applications.
  • server_id - server ID. Can be used to update/delete push API settings for specific server.

Get specific server push API settings. You can view/update these settings by navigating to "Control -> API setup -> Servers push API" section of the WMSPanel menu.

Request URL:
GET https://api.wmspanel.com/v1/push/[server_id]
Request parameters:

  • server_id - is ID of the server to set push API settings
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/push/5695b3d9fe7cd3587600000d?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "push_server_setting": {
          {
              "ppv_url": "http://myhost.com/ppv.php",
              "publish_url": "",
              "token": "e386796776eb403f9288e715940b0e83",
              "enable_pay_per_view": false,
              "send_publish_notifications": true,
              "enable_mutual_authorization": false,
              "request_format": "json",
              "sync_interval": 45,
              "report_client_ip": 1,
              "report_user_agents": 0,
              "auth_handler_url": "http://myhost.com/auth",
              "auth_concurrency": 12,
              "allow_by_default": true,
              "auth_handler_apps": [
                  "TestApp1",
                  "TestApp2",
                  "TestApp3"
              ],
              "server_id": "5695b3d9fe7cd3587600000d"
          }
Response fields:
  • ppv_url - PPV handler URL.
  • publish_url - streams (un)publish handler URL.
  • token - PPV token.
  • enable_pay_per_view - enables pay per view.
  • send_publish_notifications - enables publish/unpublish notifications.
  • enable_mutual_authorization - enables mutual authorization.
  • request_format - defines request format ("json" or "xml").
  • sync_interval - sync interval in seconds (from 5 to 3600 seconds).
  • report_client_ip - a number of client IPs to report (maximum 25).
  • report_user_agents - a number of user agents to report (maximum 25).
  • auth_handler_url - auth handler URL.
  • auth_concurrency - a number of concurrent connections allowed (maximum 1000).
  • allow_by_default - allow connection by default.
  • auth_handler_apps - protected applications.
  • server_id - server ID. Can be used to update/delete push API settings for specific server.

Set specific server push API settings. You can view/update these settings by navigating to "Control -> API setup -> Servers push API" section of the WMSPanel menu.

Request URL:
PUT https://api.wmspanel.com/v1/push/[server_id]
Request parameters:

  • server_id - is ID of the server to set push API settings
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"ppv_url": "http://myhost.com/ppv.php"}' 'https://api.wmspanel.com/v1/push/5695b3d9fe7cd3587600000d?client_id=[client_id]&api_key=[api_key]'

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • ppv_url - PPV handler URL.
  • publish_url - streams (un)publish handler URL.
  • token - PPV token. Will be generated automatically, if not available in request.
  • enable_pay_per_view - enables pay per view.
  • send_publish_notifications - enables publish/unpublish notifications.
  • enable_mutual_authorization - enables mutual authorization.
  • request_format - defines request format ("json" or "xml").
  • sync_interval - sync interval in seconds (from 5 to 3600 seconds).
  • report_client_ip - a number of client IPs to report (maximum 25).
  • report_user_agents - a number of user agents to report (maximum 25).
  • auth_handler_url - auth handler URL.
  • auth_concurrency - a number of concurrent connections allowed (maximum 1000).
  • allow_by_default - allow connection by default.
  • auth_handler_apps - protected applications.
All fieds are optional.

Response example: 
    {
    "status": "Ok",
    "push_server_setting": {
          {
              "ppv_url": "http://myhost.com/ppv.php",
              "publish_url": "",
              "token": "e386796776eb403f9288e715940b0e83",
              "enable_pay_per_view": false,
              "send_publish_notifications": true,
              "enable_mutual_authorization": false,
              "request_format": "json",
              "sync_interval": 45,
              "report_client_ip": 1,
              "report_user_agents": 0,
              "auth_handler_url": "http://myhost.com/auth",
              "auth_concurrency": 12,
              "allow_by_default": true,
              "auth_handler_apps": [
                  "TestApp1",
                  "TestApp2",
                  "TestApp3"
              ],
              "server_id": "5695b3d9fe7cd3587600000d"
          }
Response fields:
  • server_id - server ID. Can be used to update/delete push API settings for specific server.
Other fields are same as request fields.

Remove specific server push API settings.

Request URL:
DELETE https://api.wmspanel.com/v1/push/[server_id]
Request parameters:

  • server_id - is ID of the server to remove push API settings
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/push/53c710537d5c007264000243?client_id=[client_id]&api_key=[api_key]"

Response example: 
    {
      "status" : "Ok",
    }

Get Transcoder licenses for your company. You can view this information by navigating to "Settings -> Transcoder licenses" section of the WMSPanel menu.

Request URL:
GET https://api.wmspanel.com/v1/licenses/transcoder
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • active_only (optional) - should be true to get active licenses only
CURL request example:
curl 'https://api.wmspanel.com/v1/licenses/transcoder?client_id=[client_id]&api_key=[api_key]&active_only=true'
Response example: 
    {
        "status": "Ok",
        "licenses": [
            {
                "status": "Active",
                "license": "636F228029C06EE24C53AC2A7001B4633BEECF08CB4FC6352CD430DF4EA3C2E5",
                "server": "nimble-one",
                "server_id": "587289d2fe7cd31857000012",
                "started": "2020-12-03",
                "expire": "2021-12-29"
            }
          ]
    }
Response fields:
  • status - license status ("Active", "Awaiting payment", "Canceling", "Canceled")
  • license - license key
  • server - a name of the Nimble server, which uses this license.
  • server_id - ID of the Nimble server, which uses this license.
  • started - license creation date.
  • expire - license expiration date.

Create new Transcoder license for your company. License will be activated automatically. Payment for this license will be added to your WMSPanel subscription. You can perform same operation at "Settings -> Transcoder licenses" section of the WMSPanel menu.
This API is disabled by default and can be enabled by WMSPanel team for eligible customers. Please contact us to enable it for your account.

Request URL:
GET https://api.wmspanel.com/v1/licenses/transcoder/new
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/licenses/transcoder/new?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
        "status": "Ok",
        "license": [
            {
                "status": "Active",
                "license": "636F228029C06EE24C53AC2A7001B4633BEECF08CB4FC6352CD430DF4EA3C2E5",
                "server": "",
                "server_id": "",
                "started": "2020-12-03",
                "expire": "2021-12-29"
            }
          ]
    }
Response fields: The same as in "Get Transcoder licenses".

Assign active Transcoder license to Nimble server. You can perform same operation at "Settings -> Transcoder licenses" section of the WMSPanel menu.
This API is disabled by default and can be enabled by WMSPanel team for eligible customers. Please contact us to enable it for your account.

Request URL:
PUT https://api.wmspanel.com/v1/licenses/transcoder/assign
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • license - Transcoder license key
  • server_id - Nimble server ID
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"license": "636F228029C06EE24C53AC2A7001B4633BEECF08CB4FC6352CD430DF4EA3C2E5", "server_id": "587289d2fe7cd31857000012"}' "https://api.wmspanel.com/v1/licenses/transcoder/assign?client_id=[client_id]&api_key=[api_key]"
Response example: 
{
    "status": "Ok"
}

Cancel active Transcoder license. You can perform same operation at "Settings -> Transcoder licenses" section of the WMSPanel menu.
This API is disabled by default and can be enabled by WMSPanel team for eligible customers. Please contact us to enable it for your account.

Request URL:
PUT https://api.wmspanel.com/v1/licenses/transcoder/cancel
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • license - Transcoder license key
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"license": "636F228029C06EE24C53AC2A7001B4633BEECF08CB4FC6352CD430DF4EA3C2E5"}' "https://api.wmspanel.com/v1/licenses/transcoder/cancel?client_id=[client_id]&api_key=[api_key]"
Response example: 
{
    "status": "Ok"
}

Get Addenda licenses for your company. You can view this information by navigating to "Settings -> Addenda licenses" section of the WMSPanel menu.

Request URL:
GET https://api.wmspanel.com/v1/licenses/addenda
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • active_only (optional) - should be true to get active licenses only
CURL request example:
curl 'https://api.wmspanel.com/v1/licenses/addenda?client_id=[client_id]&api_key=[api_key]&active_only=true'
Response example: 
    {
        "status": "Ok",
        "licenses": [
            {
                "status": "Active",
                "license": "636F228029C06EE24C53AC2A7001B4633BEECF08CB4FC6352CD430DF4EA3C2E6",
                "server": "nimble-one",
                "server_id": "587289d2fe7cd31857000012",
                "started": "2020-12-03",
                "expire": "2021-12-29"
            }
        ]
    }
Response fields:
  • status - license status ("Active", "Awaiting payment", "Canceling", "Canceled")
  • license - license key
  • server - a name of the Nimble server, which uses this license.
  • server_id - ID of the Nimble server, which uses this license.
  • started - license creation date.
  • expire - license expiration date.

Create new Addenda license for your company. License will be activated automatically. Payment for this license will be added to your WMSPanel subscription. You can perform same operation at "Settings -> Addenda licenses" section of the WMSPanel menu.
This API is disabled by default and can be enabled by WMSPanel team for eligible customers. Please contact us to enable it for your account.

Request URL:
GET https://api.wmspanel.com/v1/licenses/addenda/new
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/licenses/addenda/new?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
        "status": "Ok",
        "license": [
            {
                "status": "Active",
                "license": "636F228029C06EE24C53AC2A7001B4633BEECF08CB4FC6352CD430DF4EA3C2E6",
                "server": "nimble-one",
                "server_id": "",
                "started": "2020-12-03",
                "expire": "2021-12-29"
            }
        ]
    }
Response fields: The same as in "Get Addenda licenses".

Assign active Addenda license to server. You can perform same operation at "Settings -> Addenda licenses" section of the WMSPanel menu.
This API is disabled by default and can be enabled by WMSPanel team for eligible customers. Please contact us to enable it for your account.

Request URL:
PUT https://api.wmspanel.com/v1/licenses/addenda/assign
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • license - Addenda license key
  • server_id - Nimble server ID
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"license": "636F228029C06EE24C53AC2A7001B4633BEECF08CB4FC6352CD430DF4EA3C2E6", "server_id": "587289d2fe7cd31857000012"}' "https://api.wmspanel.com/v1/licenses/addenda/assign?client_id=[client_id]&api_key=[api_key]"
Response example: 
{
    "status": "Ok"
}

Cancel active Addenda license. You can perform same operation at "Settings -> Addenda licenses" section of the WMSPanel menu.
This API is disabled by default and can be enabled by WMSPanel team for eligible customers. Please contact us to enable it for your account.

Request URL:
PUT https://api.wmspanel.com/v1/licenses/addenda/cancel
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • license - Addenda license key
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"license": "636F228029C06EE24C53AC2A7001B4633BEECF08CB4FC6352CD430DF4EA3C2E6"}' "https://api.wmspanel.com/v1/licenses/addenda/cancel?client_id=[client_id]&api_key=[api_key]"
Response example: 
{
    "status": "Ok"
}

Nimble Streamer control API via WMSPanel

These API calls are made via WMSPanel so please enable WMSPanel API in order to use it. Also keep in mind, that they are executed upon WMSPanel sync-up with Nimble (delivered each 30 seconds) so they will take some time to apply new settings to Nimble instance.

This is the list of routes for VOD streaming via HLS, MPEG-DASH and progressive download, and also setting up re-streaming for HLS, HDS, SmoothStreaming and PD. You can find them under "Nimble Streamer / Edit Nimble routes" menu.
Request URL:
GET https://api.wmspanel.com/v1/routes/
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/routes?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status" : "Ok",
    "routes" : [
      {
        "from" : "/desktop/",
        "id" : "e2bbf05bc3069056f6e63ee4",
        "servers" : [
          "f421d1ffeb62ceb9feb5fdff"
        ],
        "to" : "file:///Users/EasyRider/Desktop/video/"
      },
      {
        "from" : "/live/",
        "id" : "ab6b7ee6ab2b4b53fb144a6b",
        "use_ssl" : false,
        "playlist_caching_interval": 1,
        "force_caching_as_vod": true,
        "hls_keep_original_key_uri": true,
        "servers" : [
          "f421d1ffeb62ceb9feb5fdff",
          "db9caa8503eb4fd68ae561a8"
        ],
        "to" : "origin1.example.com:8081/app1/"
      },
      {
        "from" : "/vod/",
        "id" : "34aab51558387440f857df28",
        "servers" : [
          "f421d1ffeb62ceb9feb5fdff"
        ],
        "to" : "file:///var/www/video/"
      },
      {
        "from" : "edge.example.com/live/",
        "id" : "86523898a9f4b683f40327d7",
        "use_ssl" : false,
        "force_caching_as_vod": false,
        "hls_keep_original_key_uri": false,
        "servers" : [
          "f421d1ffeb62ceb9feb5fdff"
        ],
        "to" : "origin2.example.com:1935/myApp/"
      },
      "fallback_origins": [
        {
          "origin": "origin3.example.com:1935/myApp1/",
          "use_ssl": false
        },
        {
          "origin": "origin4.example.com:1935/myApp2/",
          "use_ssl": true
        }
      ]
    ]
}
Response fields:
  • id - unique ID for further usage.
  • from - the domain and path where your incoming request goes to. Domain may be blank, this means that Nimble will process requests addressed to any domain.
  • to - where incoming requests must be redirected or physical location of the VOD content (start with 'file://').
  • use_ssl - connect to origin via HTTP or HTTPS. Applicable for re-streaming routes only.
  • playlist_caching_interval - playlist caching interval in seconds (from 1 to 10). Value -1 defines behavior like VOD. Applicable for re-streaming routes only.
  • force_caching_as_vod - prevents fast live content removing from storage. Applicable for re-streaming routes only.
  • hls_keep_original_key_uri - keeps original EXT-X-KEY URI. Applicable for re-streaming routes only.
  • servers - list of servers assigned to this route.
  • fallback_origins - list of fallover origins for switching to in case of primary url is inaccessible. Applicable for re-streaming routes only.
  • aws_access_key_id - AWS access key id. Applicable for VOD and progressive download routes only.
  • aws_secret_access_key - AWS secret access key. Applicable for VOD and progressive download routes only.
  • aws_signature_version - AWS signature version ("v1" or "v4"). Applicable for VOD and progressive download routes only.
  • aws_region - AWS region. Applicable for VOD and progressive download routes only.
  • query_params - Additional parameters string. Applicable for VOD and progressive download routes only.

Pick up a route
Request URL:
GET https://api.wmspanel.com/v1/routes/[route_id]
Request parameters:

  • route_id - is ID of the route obtained at via "Get routes list" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/routes/[route_id]/?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status" : "Ok",
    "route" : {
        "from" : "/vod/",
        "id" : "34aab51558387440f857df28",
        "servers" : [
          "f421d1ffeb62ceb9feb5fdff"
        ],
        "to" : "file:///var/www/video/"
    }
Response fields:
  • id - unique route ID for further usage.
  • from - the domain and path where your incoming request goes to. Domain may be blank, this means that Nimble will process requests addressed to any domain.
  • to - where incoming requests must be redirected or physical location of the VOD content (start with 'file://').
  • use_ssl - connect to origin via HTTP or HTTPS. Applicable for re-streaming routes only.
  • playlist_caching_interval - playlist caching interval in seconds (from 1 to 10). Value -1 defines behavior like VOD. Applicable for re-streaming routes only.
  • force_caching_as_vod - prevents fast live content removing from storage. Applicable for re-streaming routes only.
  • hls_keep_original_key_uri - keeps original EXT-X-KEY URI. Applicable for re-streaming routes only.
  • servers - list of servers assigned to this route.
  • fallback_origins - list of fallover origins for switching to in case of primary url is inaccessible. Applicable for re-streaming routes only.
  • aws_access_key_id - AWS access key id. Applicable for VOD and progressive download routes only.
  • aws_secret_access_key - AWS secret access key. Applicable for VOD and progressive download routes only.
  • aws_signature_version - AWS signature version ("v1" or "v4"). Applicable for VOD and progressive download routes only.
  • aws_region - AWS region. Applicable for VOD and progressive download routes only.
  • query_params - Additional parameters string. Applicable for VOD and progressive download routes only.

This method allows creating a new route.
Request URL:
POST https://api.wmspanel.com/v1/routes/
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{"from":"/vod/","servers":["e2898a9ac866afaf5e2b3b52"],"to":"file:///var/www/video/","force_caching_as_vod": true}' "https://api.wmspanel.com/v1/routes/?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • from - the domain and path where your incoming request goes to. Domain may be blank, this means that Nimble will process requests addressed to any domain.
  • to - specify where incoming requests must be redirected or physical location of the VOD content (start with 'file://').
  • use_ssl - connect to origin via HTTP or HTTPS. Applicable for re-streaming routes only.
  • playlist_caching_interval (optional) - playlist caching interval in seconds (from 1 to 10). Value -1 defines behavior like VOD. Applicable for re-streaming routes only.
  • force_caching_as_vod (optional) - boolean value, prevents fast live content removing from storage if true. Applicable for re-streaming routes only.
  • hls_keep_original_key_uri (optional) - keeps original EXT-X-KEY URI. Applicable for re-streaming routes only.
  • servers - list of servers assigned to this route.
  • before (optional) - new route will be inserted before the route with this ID.
  • fallback_origins (optional) - list of fallover origins for switching to in case of primary url is inaccessible. Applicable for re-streaming routes only.
  • aws_access_key_id (optional) - AWS access key id. Applicable for VOD and progressive download routes only.
  • aws_secret_access_key (optional) - AWS secret access key. Applicable for VOD and progressive download routes only.
  • aws_signature_version (optional) - AWS signature version ("v1" or "v4"). Applicable for VOD and progressive download routes only.
  • aws_region (optional) - AWS region. Applicable for VOD and progressive download routes only.
  • query_params (optional) - Additional parameters string. Applicable for VOD and progressive download routes only.
Response example: 
    {
    "status" : "Ok",
    "route" : {
        "from" : "/vod/",
        "id" : "34aab51558387440f857df28",
        "force_caching_as_vod": true,
        "hls_keep_original_key_uri": false,
        "servers" : [
          "f421d1ffeb62ceb9feb5fdff"
        ],
        "to" : "file:///var/www/video/"
    }
Response fields: The same as in "Get an existing route".

This method allows updating an existing route.
Request URL:
PUT https://api.wmspanel.com/v1/routes/[route_id]
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"from":"/vod/","servers":["e2898a9ac866afaf5e2b3b52"],"to":"file:///var/www/video/"}' "https://api.wmspanel.com/v1/routes/[route_id]/?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • from - the domain and path where your incoming request goes to. Domain may be blank, this means that Nimble will process requests addressed to any domain.
  • to - specify where incoming requests must be redirected or physical location of the VOD content (start with 'file://').
  • use_ssl - connect to origin via HTTP or HTTPS. Applicable for re-streaming routes only.
  • playlist_caching_interval - playlist caching interval in seconds (from 1 to 10). Value -1 defines behavior like VOD. Applicable for re-streaming routes only.
  • force_caching_as_vod - prevents fast live content removing from storage. Applicable for re-streaming routes only.
  • hls_keep_original_key_uri - keeps original EXT-X-KEY URI. Applicable for re-streaming routes only.
  • servers - list of servers to assign to this route.
  • add_servers - list of servers to add to assigned servers to this route.
  • remove_servers - list of servers to remove from assigned servers to this route.
  • before - new route will be moved before the route with this ID
  • fallback_origins - list of fallover origins for switching to in case of primary url is inaccessible. Applicable for re-streaming routes only.
  • aws_access_key_id - AWS access key id. Applicable for VOD and progressive download routes only.
  • aws_secret_access_key - AWS secret access key. Applicable for VOD and progressive download routes only.
  • aws_signature_version - AWS signature version ("v1" or "v4"). Applicable for VOD and progressive download routes only.
  • aws_region - AWS region. Applicable for VOD and progressive download routes only.
  • query_params - Additional parameters string. Applicable for VOD and progressive download routes only.
All fields are optional.

Response example: 
    {
    "status" : "Ok",
    "route" : {
        "from" : "/vod/",
        "id" : "34aab51558387440f857df28",
        "servers" : [
          "f421d1ffeb62ceb9feb5fdff"
        ],
        "to" : "file:///var/www/video/"
    }
Response fields: The same as in "Get an existing route".

Request URL:
DELETE https://api.wmspanel.com/v1/routes/[route_id]
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/routes/[route_id]/?client_id=[client_id]&api_key=[api_key]"

Response example: 
    {
    "status" : "Ok",
}

Retrieve list of live streams for particular Nimble server. You can view this list by navigating to "Nimble Streamer / Live streams" menu item.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/live/streams
Request parameters:

  • server_id - is ID of appropriate Nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/[server_id]/live/streams?client_id=[client_id]&api_key=[api_key]'
Response example: 
{
    "status" : "Ok",
    "streams" : [
        {
            "id": "57ad54f74a0f92fdeea49e96",
            "application": "nimble_live",
            "stream": "sportbox",
            "status": "offline",
            "description": "First stream",
            "protocol": "MPEGTS",
            "video_codec": "",
            "audio_codec": "",
            "bandwidth": 0,
            "resolution": "",
            "publisher_ip": "127.0.0.1",
            "publish_time": 1578899689,
            "tags": ["Sports", "Live"]
        },
        {
            "id": "5829332945da18cfbd08fdd4",
            "application": "live",
            "stream": "buharest",
            "status": "offline",
            "description": "Second stream",
            "protocol": "RTMP",
            "video_codec": "avc1.42c00d",
            "audio_codec": "mp4a.40.2",
            "bandwidth": 560795,
            "resolution": "320x180",
            "source_url": "rtmp://127.0.0.1:1999/live/stream"
            "publish_time": 1578899691,
            "tags": ["Buharest", "Live"]
        },
        {
            "id": "582bf11682c8c4f1946031bf",
            "application": "cartoons",
            "stream": "1567",
            "status": "online",
            "description": "",
            "protocol": "RTMP",
            "video_codec": "avc1.64001e",
            "audio_codec": "mp4a.40.2",
            "bandwidth": 247804,
            "resolution": "720x304",
            "publish_time": 1578899697,
            "tags": ["Cartoons"]
        }
    ]
}
Response fields:
  • id - unique live stream ID for further usage.
  • application - application name.
  • stream - stream name.
  • status - current status of given stream. Can be either "online" or "offline".
  • publisher_ip - stream publisher IP.
  • source URL - source URL where stream was pulled.
  • description - stream description.
  • protocol - incoming stream protocol. Can be "RTMP", "RTSP", "MPEGTS" or "ICECAST".
  • video_codec - video codec name.
  • audio_codec - audio codec name.
  • bandwidth - data transmission rate measured in bits per second.
  • resolution - video resolution measured in pixels (e.g. "720x240").
  • publish_time - time when stream became available (as timestamp in seconds).
  • tags - custom tags for easy filtering on the live streams web page.

Pick up a live stream for particular Nimble server.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/live/streams/[stream_id]
Request parameters:

  • stream_id - is ID of the live stream obtained at via "Get live streams list" method
  • server_id - is ID of appropriate Nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/[server_id]/live/streams/[stream_id]?client_id=[client_id]&api_key=[api_key]'
Response example: 
  {
    "status" : "Ok",
    "stream" : {
        "id": "582bf11682c8c4f1946031bf",
        "application": "cartoons",
        "stream": "1567",
        "status": "online",
        "description": "First stream",
        "protocol": "RTMP",
        "video_codec": "avc1.64001e",
        "audio_codec": "mp4a.40.2",
        "bandwidth": 247804,
        "resolution": "720x304",
        "publisher_ip": "127.0.0.1",
        "publish_time": 1578899697,
        "tags": ["Cartoons]
  }
Response fields:
  • id - unique live stream ID for further usage.
  • application - application name.
  • stream - stream name.
  • status - current status of given stream. Can be either "online" or "offline".
  • publisher_ip - stream publisher IP.
  • source URL - source URL where stream was pulled.
  • description - stream description.
  • protocol - incoming stream protocol. Can be "RTMP", "RTSP", "MPEGTS" or "ICECAST".
  • video_codec - video codec name.
  • audio_codec - audio codec name.
  • bandwidth - data transmission rate measured in bits per second.
  • resolution - video resolution measured in pixels (e.g. "720x240").
  • publish_time - time when stream became available (as timestamp in seconds).
  • tags - custom tags for easy filtering on the live streams web page.

Delete an existing offline stream for particular Nimble server.
Request URL:
DELETE https://api.wmspanel.com/v1/server/[server_id]/live/streams/[stream_id]
Request parameters:

  • stream_id - is ID of the live stream obtained at via "Get live streams list" method
  • server_id - is ID of appropriate Nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/server/[server_id]/live/streams/[stream_id]?client_id=[client_id]&api_key=[api_key]"

Response example: 
{
    "status" : "Ok",
}

Delete multiple offline streams for particular Nimble server.
Request URL:
POST https://api.wmspanel.com/v1/server/[server_id]/live/streams/delete
Request parameters:

  • server_id - is ID of appropriate Nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{"stream_ids": ["57ad5d514a0f92fdeea49e99", "57ad54f74a0f92fdeea49e96"]}' "https://api.wmspanel.com/v1/server/[server_id]/live/streams/delete?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • stream_ids - a list of unique stream IDs you want to delete.
Response example: 
{
    "status" : "Ok",
}

Show global live settings shared by default by all RTMP, RTSP, MPEG2-TS applications of particular Nimble server. These settings can be overlapped by individual applications settings. You can view global live settings by navigating to "Nimble Streamer / Live streams" menu item, then choosing appropriate Nimble server.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/live
Request parameters:

  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/live?client_id=[client_id]&api_key=[api_key]'
Response example: 
{
    "status": "Ok",
    "settings": {
        "chunk_duration": 6,
        "chunk_count": 4,
        "protocols": [
            "HLS"
        ],
        "push_login": "",
        "push_password": "",
        "dash_template": "NUMBER",
        "dvb_subs_to_webvtt": "disabled",
        "ic_enabled": true,
        "ic_min_delay_ms": 1000,
        "ic_max_delay_ms": 3000,
        "ic_max_queue_items": 250,
        "alhls_enabled": true,
        "hls_part_duration": 500,
        "mp4_thumbnails": true,
        "mp4_thumbnails_interval": 6,
        "jpg_thumbnails": true,
        "jpg_thumbnails_interval": 6,
        "jpg_thumbnail_width": 4096,
        "jpg_thumbnail_height": 2048
    }
}
Response fields:
  • chunk_duration - default duration of chunks for each outgoing stream.
  • chunk_count - default number of chunks cached by server for each outgoing stream.
  • protocols - default list of protocols that are used for providing output streams. HLS, HLS_MPEGTS, RTMP, RTSP, MPEG2TS, ICECAST, DASH, SLDP and WebRTC (WHEP) options are available. All protocols can be used simultaneously, except HLS and HLS_MPEGTS can't be used together.
  • push_login - default login for all incoming published RTMP/RTSP streams.
  • push_password - default password for all incoming published RTMP/RTSP streams.
  • dash_template - DASH segment template defined as string ("TIME" for time-based, "NUMBER" for number-based).
  • dvb_subs_to_webvtt - DVB subtitles to WebVTT conversion mode defined as string ("disabled", "add" or "replace").
  • ic_enabled - boolean value to enable interleaving compensation.
  • ic_min_delay_ms - minimum delay in milliseconds for interleaving compensation. Applicable if ic_enabled is true.
  • ic_max_delay_ms - maximum delay in milliseconds for interleaving compensation. Applicable if ic_enabled is true.
  • ic_max_queue_items - maximum number of queue items for interleaving compensation. Applicable if ic_enabled is true.
  • gen_icecast_metadata - boolean value to enable Icecast metadata generating. Applicable for Icecast protocol only.
  • alhls_enabled - boolean value to enable Apple’s Low-Latency HLS. Applicable for HLS, HLS_MPEGTS and HLS_FMP4 protocols only.
  • hls_part_duration - HLS part duration in milliseconds for ALHLS. Should be greater or equal to 250 and less or equal to half of chunk_duration*1000 value. Applicable for HLS, HLS_MPEGTS and HLS_FMP4 protocols only, if alhls_enabled is true.
  • mp4_thumbnails - boolean value to enable MP4 thumbnails generating.
  • mp4_thumbnails_interval - MP4 thumbnails interval in seconds. Should be greater or equal to 0 and less or equal to 60.
  • jpg_thumbnails - boolean value to enable JPG thumbnails generating.
  • jpg_thumbnails_interval - Alias for mp4_thumbnails_interval. Currently both MP4 and JPG thumbnails use same interval.
  • jpg_thumbnail_width - JPEG thumbnails width.
  • jpg_thumbnail_height - JPEG thumbnails height.

Update global live settings shared by default by all RTMP, RTSP, MPEG2-TS applications of particular Nimble server. These settings can be overlapped by individual applications settings.
Request URL:
PUT https://api.wmspanel.com/v1/server/[server_id]/live
Request parameters:

  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"chunk_count": 10, "protocols": ["HLS", "RTMP", "DASH"], "push_login": "user", "push_password": "pass"}' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/live?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • chunk_duration - default duration of chunks for each outgoing stream.
  • chunk_count - default number of chunks cached by server for each outgoing stream.
  • protocols - default list of protocols that are used for providing output streams. HLS, HLS_MPEGTS, RTMP, RTSP, MPEG2TS, ICECAST, DASH, SLDP and WebRTC (WHEP) options are available. All protocols can be used simultaneously, except HLS and HLS_MPEGTS can't be used together.
  • push_login - default login for all incoming published RTMP/RTSP streams.
  • push_password - default password for all incoming published RTMP/RTSP streams.
  • dash_template - DASH segment template defined as string ("TIME" for time-based, "NUMBER" for number-based).
  • dvb_subs_to_webvtt - DVB subtitles to WebVTT conversion mode defined as string ("disabled", "add" or "replace").
  • ic_enabled - boolean value to enable interleaving compensation.
  • ic_min_delay_ms - minimum delay in milliseconds for interleaving compensation. Applicable if ic_enabled is true.
  • ic_max_delay_ms - maximum delay in milliseconds for interleaving compensation. Applicable if ic_enabled is true.
  • ic_max_queue_items - maximum number of queue items for interleaving compensation. Applicable if ic_enabled is true.
  • gen_icecast_metadata - boolean value to enable Icecast metadata generating. Applicable for Icecast protocol only.
  • alhls_enabled - boolean value to enable Apple’s Low-Latency HLS. Applicable for HLS, HLS_MPEGTS and HLS_FMP4 protocols only.
  • hls_part_duration - HLS part duration in milliseconds for ALHLS. Should be greater or equal to 250 and less or equal to half of chunk_duration*1000 value. Applicable for HLS, HLS_MPEGTS and HLS_FMP4 protocols only, if alhls_enabled is true.
  • mp4_thumbnails - boolean value to enable MP4 thumbnails generating.
  • mp4_thumbnails_interval - MP4 thumbnails interval in seconds. Should be greater or equal to 0 and less or equal to 60.
  • jpg_thumbnails - boolean value to enable JPG thumbnails generating.
  • jpg_thumbnails_interval - Alias for mp4_thumbnails_interval. Currently both MP4 and JPG thumbnails use same interval.
  • jpg_thumbnail_width - JPEG thumbnails width.
  • jpg_thumbnail_height - JPEG thumbnails height.
All fields are optional.

Response example: 
{
    "status": "Ok",
    "settings": {
        "chunk_duration": 6,
        "chunk_count": 10,
        "protocols": [
            "HLS",
            "RTMP",
            "DASH"
        ],
        "push_login": "user",
        "push_password": "pass",
        "dash_template": "NUMBER",
        "dvb_subs_to_webvtt": "add",
        "ic_enabled": true,
        "ic_min_delay_ms": 1000,
        "ic_max_delay_ms": 3000,
        "ic_max_queue_items": 250,
        "alhls_enabled": true,
        "hls_part_duration": 500,
        "mp4_thumbnails": true,
        "mp4_thumbnails_interval": 6,
        "jpg_thumbnails": true,
        "jpg_thumbnails_interval": 6,
        "jpg_thumbnail_width": 4096,
        "jpg_thumbnail_height": 2048
    }
}
Response fields: The same as in "Get get global live settings".

Retrieve list of live applications for particular Nimble server. You can view this list by navigating to "Nimble Streamer / Live streams" menu item, then choosing appropriate Nimble server and choosing "Applications" tab.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/live/app
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/552b56aa0640fd4e95000002/live/app?client_id=[client_id]&api_key=[api_key]'
Response example: 
{
    "status": "Ok",
    "applications": [
        {
            "id": "552c97320640fdd1bf000002",
            "application": "nimble-live",
            "chunk_duration": 6,
            "chunk_count": 4,
            "protocols": [
                "HLS",
                "DASH"
            ],
            "push_login": "",
            "push_password": "",
            "empty_credentials": false,
            "dash_template": "NUMBER",
            "dvb_subs_to_webvtt": "disabled",
            "ic_enabled": true,
            "ic_min_delay_ms": 1000,
            "ic_max_delay_ms": 3000,
            "ic_max_queue_items": 250,
            "alhls_enabled": true,
            "hls_part_duration": 500,
            "mp4_thumbnails": true,
            "mp4_thumbnails_interval": 6,
            "jpg_thumbnails": true,
            "jpg_thumbnails_interval": 6,
            "jpg_thumbnail_width": 4096,
            "jpg_thumbnail_height": 2048,
            "tags": ["Live sports"]
        },
        {
            "id": "552c976c0640fdd1bf000003",
            "application": "stv",
            "chunk_duration": 6,
            "chunk_count": 4,
            "protocols": [
                "HLS",
                "MPEG2TS",
                "ICECAST",
                "DASH",
                "SLDP"
            ],
            "push_login": "",
            "push_password": "",
            "empty_credentials": true,
            "dash_template": "TIME",
            "dvb_subs_to_webvtt": "replace",
            "ic_enabled": false,
            "gen_icecast_metadata": true,
            "alhls_enabled": false,
            "tags": ["Live news"]
        }
    ]
}
Response fields:
  • id - unique application ID for further usage.
  • application - streaming application name
  • chunk_duration - duration of chunks for each outgoing stream in application.
  • chunk_count - number of chunks cached by server for each outgoing stream in application.
  • protocols - list of protocols that are used for providing output streams in application. HLS, HLS_MPEGTS, HLS_FMP4, RTMP, RTSP, MPEG2TS, ICECAST, DASH, SLDP and WebRTC (WHEP) options are available. All protocols can be used simultaneously, except HLS and HLS_MPEGTS can't be used together.
  • push_login - login for all incoming published RTMP/RTSP streams in application.
  • push_password - password for all incoming published RTMP/RTSP streams in application.
  • empty_credentials - boolean flag to prevent using login and password from Global settings, when application login and password are empty.
  • dash_template - DASH segment template defined as string ("TIME" for time-based, "NUMBER" for number-based).
  • dvb_subs_to_webvtt - DVB subtitles to WebVTT conversion mode defined as string ("disabled", "add" or "replace").
  • ic_enabled - boolean value to enable interleaving compensation.
  • ic_min_delay_ms - minimum delay in milliseconds for interleaving compensation. Applicable if ic_enabled is true.
  • ic_max_delay_ms - maximum delay in milliseconds for interleaving compensation. Applicable if ic_enabled is true.
  • ic_max_queue_items - maximum number of queue items for interleaving compensation. Applicable if ic_enabled is true.
  • gen_icecast_metadata - boolean value to enable Icecast metadata generating. Applicable for Icecast protocol only.
  • alhls_enabled - boolean value to enable Apple’s Low-Latency HLS. Applicable for HLS, HLS_MPEGTS and HLS_FMP4 protocols only.
  • hls_part_duration - HLS part duration in milliseconds for ALHLS. Should be greater or equal to 250 and less or equal to half of chunk_duration*1000 value. Applicable for HLS, HLS_MPEGTS and HLS_FMP4 protocols only, if alhls_enabled is true.
  • mp4_thumbnails - boolean value to enable MP4 thumbnails generating.
  • mp4_thumbnails_interval - MP4 thumbnails interval in seconds. Should be greater or equal to 0 and less or equal to 60.
  • jpg_thumbnails - boolean value to enable JPG thumbnails generating.
  • jpg_thumbnails_interval - Alias for mp4_thumbnails_interval. Currently both MP4 and JPG thumbnails use same interval.
  • jpg_thumbnail_width - JPEG thumbnails width.
  • jpg_thumbnail_height - JPEG thumbnails height.
  • tags - custom tags for easy filtering on the settings web page.

Pick up an application
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/live/app/[app_id]
Request parameters:

  • app_id - is ID of the RTMP application obtained via "Get RTMP applcations list" method.
  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/live/app/552c97320640fdd1bf000002?client_id=[client_id]&api_key=[api_key]'
Response example: 
{
    "status": "Ok",
    "application": {
        "id": "552c97320640fdd1bf000002",
        "application": "nimble-live",
        "chunk_duration": 6,
        "chunk_count": 4,
        "protocols": [
            "HLS",
            "DASH"
        ],
        "push_login": "",
        "push_password": "",
        "empty_credentials": false,
        "dash_template": "NUMBER",
        "dvb_subs_to_webvtt": "disabled",
        "ic_enabled": true,
        "ic_min_delay_ms": 1000,
        "ic_max_delay_ms": 3000,
        "ic_max_queue_items": 250,
        "alhls_enabled": true,
        "hls_part_duration": 500,
        "mp4_thumbnails": true,
        "mp4_thumbnails_interval": 6,
        "jpg_thumbnails": true,
        "jpg_thumbnails_interval": 6,
        "jpg_thumbnail_width": 4096,
        "jpg_thumbnail_height": 2048,
        "tags": ["Live sports"]
    }
}
Response fields:
  • id - unique application ID for further usage.
  • application - streaming application name
  • chunk_duration - duration of chunks for each outgoing stream in application.
  • chunk_count - number of chunks cached by server for each outgoing stream in application.
  • protocols - list of protocols that are used for providing output streams in application. HLS, HLS_MPEGTS, HLS_FMP4, RTMP, RTSP, MPEG2TS, ICECAST, DASH, SLDP and WebRTC (WHEP) options are available. All protocols can be used simultaneously, except HLS and HLS_MPEGTS can't be used together.
  • push_login - login for all incoming published RTMP/RTSP streams in application.
  • push_password - password for all incoming published RTMP/RTSP streams in application.
  • empty_credentials - boolean flag to prevent using login and password from Global settings, when application login and password are empty.
  • dash_template - DASH segment template defined as string ("TIME" for time-based, "NUMBER" for number-based).
  • dvb_subs_to_webvtt - DVB subtitles to WebVTT conversion mode defined as string ("disabled", "add" or "replace").
  • ic_enabled - boolean value to enable interleaving compensation.
  • ic_min_delay_ms - minimum delay in milliseconds for interleaving compensation. Applicable if ic_enabled is true.
  • ic_max_delay_ms - maximum delay in milliseconds for interleaving compensation. Applicable if ic_enabled is true.
  • ic_max_queue_items - maximum number of queue items for interleaving compensation. Applicable if ic_enabled is true.
  • gen_icecast_metadata - boolean value to enable Icecast metadata generating. Applicable for Icecast protocol only.
  • alhls_enabled - boolean value to enable Apple’s Low-Latency HLS. Applicable for HLS, HLS_MPEGTS and HLS_FMP4 protocols only.
  • hls_part_duration - HLS part duration in milliseconds for ALHLS. Should be greater or equal to 250 and less or equal to half of chunk_duration*1000 value. Applicable for HLS, HLS_MPEGTS and HLS_FMP4 protocols only, if alhls_enabled is true.
  • mp4_thumbnails - boolean value to enable MP4 thumbnails generating.
  • mp4_thumbnails_interval - MP4 thumbnails interval in seconds. Should be greater or equal to 0 and less or equal to 60.
  • jpg_thumbnails - boolean value to enable JPG thumbnails generating.
  • jpg_thumbnails_interval - Alias for mp4_thumbnails_interval. Currently both MP4 and JPG thumbnails use same interval.
  • jpg_thumbnail_width - JPEG thumbnails width.
  • jpg_thumbnail_height - JPEG thumbnails height.
  • tags - custom tags for easy filtering on the settings web page.

Create a new application.
Request URL:
POST https://api.wmspanel.com/v1/server/[server_id]/live/app
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{"application": "welcome"}' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/live/app?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • application - streaming application name
  • chunk_duration (optional) - duration of chunks for each outgoing stream in application. If not specified, then default value is 6 seconds.
  • chunk_count (optional) - number of chunks cached by server for each outgoing stream in application. If not specified, then default value is 4.
  • protocols (optional) - list of protocols that are used for providing output streams in application. HLS, HLS_MPEGTS, HLS_FMP4, RTMP, RTSP, MPEG2TS, ICECAST, DASH, SLDP and WebRTC (WHEP) options are available. All protocols can be used simultaneously, except HLS and HLS_MPEGTS can't be used together. If not specified, then HLS is used by default.
  • push_login (optional) - login for all incoming published RTMP/RTSP streams in application.
  • push_password (optional) - password for all incoming published RTMP/RTSP streams in application.
  • empty_credentials (optional) - boolean flag to prevent using login and password from Global settings, when application login and password are empty.
  • dash_template (optional) - DASH segment template defined as string ("TIME" for time-based, "NUMBER" for number-based).
  • dvb_subs_to_webvtt (optional) - DVB subtitles to WebVTT conversion mode defined as string ("disabled", "add" or "replace").
  • ic_enabled (optional) - boolean value to enable interleaving compensation.
  • ic_min_delay_ms (optional) - minimum delay in milliseconds for interleaving compensation. Applicable if ic_enabled is true.
  • ic_max_delay_ms (optional) - maximum delay in milliseconds for interleaving compensation. Applicable if ic_enabled is true.
  • ic_max_queue_items (optional) - maximum number of queue items for interleaving compensation. Applicable if ic_enabled is true.
  • gen_icecast_metadata (optional) - boolean value to enable Icecast metadata generating. Applicable for Icecast protocol only.
  • alhls_enabled (optional) - boolean value to enable Apple’s Low-Latency HLS. Applicable for HLS, HLS_MPEGTS and HLS_FMP4 protocols only.
  • hls_part_duration (optional) - HLS part duration in milliseconds for ALHLS. Should be greater or equal to 250 and less or equal to half of chunk_duration*1000 value. Applicable for HLS, HLS_MPEGTS and HLS_FMP4 protocols only, if alhls_enabled is true.
  • mp4_thumbnails (optional) - boolean value to enable MP4 thumbnails generating.
  • mp4_thumbnails_interval (optional) - MP4 thumbnails interval in seconds. Should be greater or equal to 0 and less or equal to 60.
  • jpg_thumbnails (optional) - boolean value to enable JPG thumbnails generating.
  • jpg_thumbnails_interval (optional) - Alias for mp4_thumbnails_interval. Currently both MP4 and JPG thumbnails use same interval.
  • jpg_thumbnail_width (optional) - JPEG thumbnails width.
  • jpg_thumbnail_height (optional) - JPEG thumbnails height.
  • tags (optional) - custom tags for easy filtering on the settings web page.
Response example: 
{
    "status": "Ok",
    "application": {
        "id": "552c97d00640fdd1bf000004",
        "application": "welcome",
        "chunk_duration": 6,
        "chunk_count": 4,
        "protocols": [
            "HLS"
        ],
        "push_login": "",
        "push_password": "",
        "empty_credentials": false,
        "dash_template": "TIME",
        "dvb_subs_to_webvtt": "disabled",
        "ic_enabled": false,
        "alhls_enabled": false,
        "mp4_thumbnails": true,
        "mp4_thumbnails_interval": 6,
        "jpg_thumbnails": true,
        "jpg_thumbnails_interval": 6,
        "jpg_thumbnail_width": 4096,
        "jpg_thumbnail_height": 2048
    }
}
Response fields: The same as in "Get an existing application".

Update an existing application.
Request URL:
PUT https://api.wmspanel.com/v1/server/[server_id]/live/app/[app_id]
Request parameters:

  • app_id - is ID of the application obtained via "Get applications list" method.
  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"chunk_duration": 10, "chunk_count": 10, "protocols": ["HLS", "RTMP", "ICECAST", "DASH"], "push_login": "user", "push_password": "pass", "tags": ["Live sports"]}' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/live/app/552c97320640fdd1bf000002?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • application - streaming application name
  • chunk_duration - duration of chunks for each outgoing stream in application.
  • chunk_count - number of chunks cached by server for each outgoing stream in application.
  • protocols - list of protocols that are used for providing output streams in application. HLS, HLS_MPEGTS, HLS_FMP4, RTMP, RTSP, MPEG2TS, ICECAST, DASH, SLDP and WebRTC (WHEP) options are available. All protocols can be used simultaneously, except HLS and HLS_MPEGTS can't be used together.
  • push_login - login for all incoming published RTMP/RTSP streams in application.
  • push_password - password for all incoming published RTMP/RTSP streams in application.
  • empty_credentials - boolean flag to prevent using login and password from Global settings, when application login and password are empty.
  • dash_template - DASH segment template defined as string ("TIME" for time-based, "NUMBER" for number-based).
  • dvb_subs_to_webvtt - DVB subtitles to WebVTT conversion mode defined as string ("disabled", "add" or "replace").
  • ic_enabled - boolean value to enable interleaving compensation.
  • ic_min_delay_ms - minimum delay in milliseconds for interleaving compensation. Applicable if ic_enabled is true.
  • ic_max_delay_ms - maximum delay in milliseconds for interleaving compensation. Applicable if ic_enabled is true.
  • ic_max_queue_items - maximum number of queue items for interleaving compensation. Applicable if ic_enabled is true.
  • gen_icecast_metadata - boolean value to enable Icecast metadata generating. Applicable for Icecast protocol only.
  • alhls_enabled - boolean value to enable Apple’s Low-Latency HLS. Applicable for HLS, HLS_MPEGTS and HLS_FMP4 protocols only.
  • hls_part_duration - HLS part duration in milliseconds for ALHLS. Should be greater or equal to 250 and less or equal to half of chunk_duration*1000 value. Applicable for HLS, HLS_MPEGTS and HLS_FMP4 protocols only, if alhls_enabled is true.
  • mp4_thumbnails - boolean value to enable MP4 thumbnails generating.
  • mp4_thumbnails_interval - MP4 thumbnails interval in seconds. Should be greater or equal to 0 and less or equal to 60.
  • jpg_thumbnails - boolean value to enable JPG thumbnails generating.
  • jpg_thumbnails_interval - Alias for mp4_thumbnails_interval. Currently both MP4 and JPG thumbnails use same interval.
  • jpg_thumbnail_width - JPEG thumbnails width.
  • jpg_thumbnail_height - JPEG thumbnails height.
  • tags - custom tags for easy filtering on the settings web page.
All fields are optional.

Response example: 
{
    "status": "Ok",
    "application": {
        "id": "552c97320640fdd1bf000002",
        "application": "nimble-live",
        "chunk_duration": 10,
        "chunk_count": 10,
        "protocols": [
            "HLS",
            "RTMP",
            "ICECAST",
            "DASH"
        ],
        "push_login": "user",
        "push_password": "pass",
        "empty_credentials": false,
        "dash_template": "NUMBER",
        "dvb_subs_to_webvtt": "disabled",
        "ic_enabled": true,
        "ic_min_delay_ms": 1000,
        "ic_max_delay_ms": 3000,
        "ic_max_queue_items": 250,
        "gen_icecast_metadata": true,
        "alhls_enabled": true,
        "hls_part_duration": 500,
        "mp4_thumbnails": true,
        "mp4_thumbnails_interval": 6,
        "jpg_thumbnails": true,
        "jpg_thumbnails_interval": 6,
        "jpg_thumbnail_width": 4096,
        "jpg_thumbnail_height": 2048,
        "tags": ["Live sports"]
    }
}
Response fields: The same as in "Get an existing application".

Delete an existing application.
Request URL:
DELETE https://api.wmspanel.com/v1/server/[server_id]/live/app/[app_id]
Request parameters:

  • app_id - is ID of the application obtained via "Get applications list" method.
  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/server/[server_id]/live/app/552c97320640fdd1bf000002?client_id=[client_id]&api_key=[api_key]"

Response example: 
{
    "status" : "Ok",
}

Retrieve list of RTMP network interfaces for particular Nimble server. You can view this list by navigating to "Nimble Streamer / Live streams" menu item, then choosing appropriate Nimble server, then clicking on "Live streams settings" button and choosing "Interfaces" tab.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/rtmp/interface
Request parameters:

  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/552b56aa0640fd4e95000002/rtmp/interface?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "interfaces": [
        {
            "id": "552b56aa0640fd4e95000002",
            "ip": "10.0.0.2",
            "port": 1935,
            "ssl": false,
            "tags": ["main", "rtmp"]
        },
        {
            "id": "552b5a6b0640fdfc14000002",
            "ip": "Any",
            "port": 443,
            "ssl": true,
            "tags": ["secondary", "rtmp"]
        }
    ]
}
Response fields:
  • id - unique RTMP interface ID for further usage.
  • ip - ip address of network interface to listen to. If not specified, then it's automatically set to "Any", which means, that Nimble streamer listens to all interfaces on given port.
  • port - port to listen to.
  • ssl - indicates SSL usage. If not specified, then it's automatically set to false. If set to true, then correct SSL port should be specified (usually 443).
  • tags - custom tags for easy filtering on the settings web page.

Pick up a RTMP interface
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/rtmp/interface/[interface_id]
Request parameters:

  • interface_id - is ID of the RTMP interface obtained via "Get RTMP interfaces list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtmp/interface/552b56aa0640fd4e95000002?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "interface": {
        "id": "552b56aa0640fd4e95000002",
        "ip": "10.0.0.2",
        "port": 1935,
        "ssl": false,
        "tags": ["main", "rtmp"]
    }
}
Response fields:
  • id - unique RTMP interface ID for further usage.
  • ip - ip address of network interface to listen to. If not specified, then it's automatically set to "Any", which means, that Nimble streamer listens to all interfaces on given port.
  • port - port to listen to.
  • ssl - indicates SSL usage. If not specified, then it's automatically set to false. If set to true, then correct SSL port should be specified (usually 443).
  • tags - custom tags for easy filtering on the settings web page.

Create a new RTMP interface.
Request URL:
POST https://api.wmspanel.com/v1/server/[server_id]/rtmp/interface
Request parameters:

  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{"port": 1935, "other_servers_to_apply": ["555a79e6fe7cd34664000006"]}' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtmp/interface?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • ip (optional) - ip address of network interface to listen to. If not specified, then it's automatically set to "Any", which means, that Nimble streamer listens to all interfaces on given port.
  • port - port to listen to.
  • ssl (optional) - indicates SSL usage. If not specified, then it's automatically set to false. If set to true, then correct SSL port should be specified (usually 443).
  • other_servers_to_apply (optional) - array of servers IDs, where this setting also should be created. Maximum 20 additional servers IDs can be included into one API call.
  • tags (optional) - custom tags for easy filtering on the settings web page.
Response example: 
    {
    "status": "Ok",
    "interface": {
        "id": "552b5c760640fdfc14000003",
        "ip": "Any",
        "port": 1935,
        "ssl": false,
        "other_servers_applied": [
            {
                "setting_id": "62f9dc2b2c47e56ce29b9965",
                "server_id": "555a79e6fe7cd34664000006"
            }
        ]
    }
}
Response fields:
  • other_servers_applied - array containing data about settings created on other servers (from "other_servers_to_apply" request field). This field is returned, when request contained "other_servers_to_apply" field only. Each array item is a hash structure with following fields:
    • setting_id - new setting ID
    • server_id - server ID, where new setting was created
Other response fields are the same as in "Get an existing RTMP interface".

Update an existing RTMP interface.
Request URL:
PUT https://api.wmspanel.com/v1/server/[server_id]/rtmp/interface/[interface_id]
Request parameters:

  • interface_id - is ID of the RTMP interface obtained via "Get RTMP interfaces list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"ip": "10.0.0.1", "port": 3001, "other_servers_to_apply": ["555a79e6fe7cd34664000006"], "tags": ["main", "rtmp"]}' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtmp/interface/552b5c760640fdfc14000003?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • ip - ip address of network interface to listen to.
  • port - port to listen to.
  • ssl - indicates SSL usage. If not specified, then it's automatically set to false. If set to true, then correct SSL port should be specified (usually 443).
  • other_servers_to_apply - array of servers IDs, where this setting also should be created. Maximum 20 additional servers IDs can be included into one API call.
  • tags - custom tags for easy filtering on the settings web page.
All fields are optional.

Response example: 
    {
    "status": "Ok",
    "interface": {
        "id": "552b5c760640fdfc14000003",
        "ip": "10.0.0.1",
        "port": 3001,
        "ssl": false,
        "tags": ["main", "rtmp"],
        "other_servers_applied": [
          {
            "setting_id": "62f9cfb12c47e55d553b8f0b",
            "server_id": "555a79e6fe7cd34664000006"
          }
        ]
    }
}
Response fields:
  • other_servers_applied - array containing data about settings created on other servers (from "other_servers_to_apply" request field). This field is returned, when request contained "other_servers_to_apply" field only. Each array item is a hash structure with following fields:
    • setting_id - new setting ID
    • server_id - server ID, where new setting was created
Other response fields are the same as in "Get an existing RTMP interface".

Delete an existing RTMP interface.
Request URL:
DELETE https://api.wmspanel.com/v1/server/[server_id]/rtmp/interface/[interface_id]
Request parameters:

  • interface_id - is ID of the RTMP interface obtained via "Get RTMP interfaces list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/server/[server_id]/rtmp/interface/552b5c760640fdfc14000003?client_id=[client_id]&api_key=[api_key]"

Response example: 
    {
    "status" : "Ok",
}

Retrieve list of RTMP live pull settings for particular Nimble server. You can view this list by navigating to "Nimble Streamer / Live streams" menu item, then choosing appropriate Nimble server, then clicking on "Live streams settings" button and choosing "Live pull settings" tab.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/rtmp/live_pull
Request parameters:

  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtmp/live_pull?client_id=[client_id]&api_key=[api_key]'
Response example: 
{
    "status": "Ok",
    "settings": [
        {
            "id": "547d151378a6fccf4d000002",
            "url": "rtmps://r/t/m/p/with/dr222",
            "fallback_urls": [
                "rtmp://dr/one/url",
                "rtmps://dr/two/url"
            ],
            "application": "123",
            "stream": "asd",
            "paused": false,
            "idle_time" : 0,
            "dynamic_stream" : false,
            "description": "RTMP",
            "tags": ["House MD", "rtmp"],
            "status": "online",
            "active_url": "rtmps://dr/two/url",
            "bandwidth": 4551329,
            "probe_interval": 600,
            "uptime": 7219
        },
        {
            "id": "547d151378a6fccf4d000003",
            "url": "rtmp://ais2.rastamusic.com/live/rastamusic.stream",
            "fallback_urls": [],
            "application": "",
            "stream": "",
            "paused": false,
            "idle_time" : 0,
            "dynamic_stream" : false,
            "description": "Rasta music",
            "tags": ["music", "rasta"],
            "status": "offline"
        },
        {
            "id": "547d151378a6fccf4d000004",
            "url": "rtmp://ais2.rastamusic.com/live/",
            "fallback_urls": [],
            "application": "",
            "stream": "",
            "paused": true,
            "idle_time" : 10,
            "dynamic_stream" : true,
            "description": "",
            "status": "paused"
        }
    ]
}
Response fields:
  • id - unique RTMP live pull setting ID for further usage.
  • url - url of incoming RTMP stream.
  • fallback_urls - list of fallback urls of incoming RTMP stream for switching to in case of primary url is inaccessible.
  • application - application name for outgoing streams.
  • stream - stream name for outgoing streams.
  • paused - whether given setting is currently inactivated.
  • idle_time - pull timeout (seconds). Starting from the moment when nobody requests specified stream, server continues pulling that stream during the timeout interval and then cuts it off.
  • dynamic_stream - specifies whether server tries to pull any stream belonging to the specified application from the given source in case it was requested.
  • description - custom description of pull setting.
  • tags - custom tags for easy filtering on the settings web page.
  • status - current status of given stream. Can be one of the following values:
    • "pending" - appears when given stream is created, modified or resumed via UI or API call till the moment when server reports actual status of the stream
    • "online" - appears when media server reports that it was able to access given stream
    • "offline" - appears when media server reports that it has failed to access given stream
    • "paused" - appears when given stream is paused (postponed) via UI or API call
  • active_url - URL is using by Nimble at this moment. Returned only when stream has at least one fallback URL.
  • bandwidth - given stream's data transmission rate measured in bits per second.
  • probe_interval - time interval in seconds to check primary URL availability, when one of fallback URLs is used. Should be greater or equal to 30 and less or equal to 2592000 (30 days).
  • uptime - time interval in seconds showing given stream uptime. Available only for non-dynamic streams having "online" or "pending" status.

Pick up a RTMP live pull setting
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/rtmp/live_pull/[setting_id]
Request parameters:

  • setting_id - is ID of the RTMP live pull setting obtained via "Get RTMP live pull settings list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtmp/live_pull/547d151378a6fccf4d000002?client_id=[client_id]&api_key=[api_key]'
Response example: 
{
    "status": "Ok",
    "setting": {
        "id": "547d151378a6fccf4d000002",
        "url": "rtmps://r/t/m/p/with/dr222",
        "fallback_urls": [
            "rtmp://dr/one/url",
            "rtmps://dr/two/url"
        ],
        "application": "123",
        "stream": "asd",
        "paused": false,
        "idle_time" : 0,
        "dynamic_stream" : false,
        "description": "RTMP",
        "tags": ["House MD", "rtmp"],
        "status": "online",
        "active_url": "rtmps://dr/two/url",
        "bandwidth": 4551329,
        "probe_interval": 600,
        "uptime": 7219
    }
}
Response fields:
  • id - unique RTMP live pull setting ID for further usage.
  • url - url of incoming RTMP stream.
  • fallback_urls - list of fallback urls of incoming RTMP stream for switching to in case of primary url is inaccessible.
  • application - application name for outgoing streams.
  • stream - stream name for outgoing streams.
  • paused - whether given setting is currently inactivated.
  • idle_time - pull timeout (seconds). Starting from the moment when nobody requests specified stream, server continues pulling that stream during the timeout interval and then cuts it off.
  • dynamic_stream - specifies whether server tries to pull any stream belonging to the specified application from the given source in case it was requested.
  • description - custom description of pull setting.
  • tags - custom tags for easy filtering on the settings web page.
  • status - current status of given stream. Can be one of the following values:
    • "pending" - appears when given stream is created, modified or resumed via UI or API call till the moment when server reports actual status of the stream
    • "online" - appears when media server reports that it was able to access given stream
    • "offline" - appears when media server reports that it has failed to access given stream
    • "paused" - appears when given stream is paused (postponed) via UI or API call
  • active_url - URL is using by Nimble at this moment. Returned only when stream has at least one fallback URL.
  • bandwidth - given stream's data transmission rate measured in bits per second.
  • probe_interval - time interval in seconds to check primary URL availability, when one of fallback URLs is used. Should be greater or equal to 30 and less or equal to 2592000 (30 days).
  • uptime - time interval in seconds showing given stream uptime. Available only for non-dynamic streams having "online" or "pending" status.

Create a new RTMP live pull setting. Maximum 5000 settings can be created per server.
Request URL:
POST https://api.wmspanel.com/v1/server/[server_id]/rtmp/live_pull
Request parameters:

  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{"url": "rtmp://example.com/live-nimble/mystream/fairytale.audio", "description": "Fairy tale", "tags": ["Tales", "audio only"]}' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtmp/live_pull?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • url - url of incoming RTMP stream.
  • fallback_urls (optional) - list of fallback urls of incoming RTMP stream for switching to in case of primary url is inaccessible.
  • application (optional) - application name for outgoing streams. If not specified, then application name for outgoing streams is taken from the url of incoming stream. E.g. if incoming stream is rtmp://127.0.0.1:8081/live-origin/mystream/playlist.m3u8 , then "live-origin" is assigned as application name for outgoing stream. If incoming stream doesn't contain application name, then it should be explicitly specified by this parameter.
  • stream (optional) - stream name for outgoing streams. If not specified, then stream name for outgoing stream is taken from the url of incoming stream. E.g. if incoming stream is rtmp://127.0.0.1:8081/live-origin/mystream/playlist.m3u8 , then "mystream" is assigned as stream name for outgoing stream. If incoming stream doesn't contain stream name, then it should be explicitly specified by this parameter.
  • paused (optional) - whether given setting is currently inactivated. Set this parameter to true if you want to pause a particular RTMP live pull setting or to false if you want to resume it.
  • idle_time (optional) - pull timeout (seconds). Starting from the moment when nobody requests specified stream, server continues pulling that stream during the timeout interval and then cuts it off.
  • dynamic_stream (optional) - specifies whether server tries to pull any stream belonging to the specified application from the given source in case it was requested.
  • description (optional) - custom description of pull setting.
  • tags (optional) - custom tags for easy filtering on the settings web page.
  • probe_interval (optional) - time interval in seconds to check primary URL availability, when one of fallback URLs is used. Should be greater or equal to 30 and less or equal to 2592000 (30 days).
  • other_servers_to_apply (optional) - array of servers IDs, where this setting also should be created. Maximum 20 additional servers IDs can be included into one API call.
Response example: 
{
    "status": "Ok",
    "setting": {
        "id": "5526331a0640fd5ad6000002",
        "url": "rtmp://example.com/live-nimble/mystream/fairytale.audio",
        "fallback_urls": [],
        "application": "",
        "stream": "",
        "paused": false,
        "idle_time" : 0,
        "dynamic_stream" : false,
        "description": "Fairy tale",
        "tags": ["Tales", "audio only"],
        "status": "online",
        "other_servers_applied": [
            {
                "setting_id": "61fb6b3d2c47e52f12630662",
                "server_id": "555a79e6fe7cd34664000006"
            },
            {
                "setting_id": "61fb6b3d2c47e52f12630663",
                "server_id": "594a0845fe7cd3593d000005"
            }
        ]
    }
}
Response fields:
  • other_servers_applied - array containing data about settings created on other servers (from "other_servers_to_apply" request field). This field is returned, when request contained "other_servers_to_apply" field only. Each array item is a hash structure with following fields:
    • setting_id - new setting ID
    • server_id - server ID, where new setting was created
Other response fields are the same as in "Get an existing RTMP live pull setting".

Create multiple new RTMP live pull settings. Maximum 100 settings can be created by one request. Maximum 5000 settings can be created per server. This API is disabled by default. Please, contact us to enable it.
Request URL:
POST https://api.wmspanel.com/v1/server/[server_id]/rtmp/live_pull/multi
Request parameters:

  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '[{"url": "rtmp://example.com/live-nimble/mystream/fairytale.audio", "description": "Fairy tale"}, {"url": "rtmp://example.com/live-nimble/mystream/fairytale2.audio", "description": "Fairy tale 2", "tags": ["Tales", "New"]}]' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtmp/live_pull/multi?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body as array of structures.

Request data fields:
  • url - url of incoming RTMP stream.
  • fallback_urls (optional) - list of fallback urls of incoming RTMP stream for switching to in case of primary url is inaccessible.
  • application (optional) - application name for outgoing streams. If not specified, then application name for outgoing streams is taken from the url of incoming stream. E.g. if incoming stream is rtmp://127.0.0.1:8081/live-origin/mystream/playlist.m3u8 , then "live-origin" is assigned as application name for outgoing stream. If incoming stream doesn't contain application name, then it should be explicitly specified by this parameter.
  • stream (optional) - stream name for outgoing streams. If not specified, then stream name for outgoing stream is taken from the url of incoming stream. E.g. if incoming stream is rtmp://127.0.0.1:8081/live-origin/mystream/playlist.m3u8 , then "mystream" is assigned as stream name for outgoing stream. If incoming stream doesn't contain stream name, then it should be explicitly specified by this parameter.
  • paused (optional) - whether given setting is currently inactivated. Set this parameter to true if you want to pause a particular RTMP live pull setting or to false if you want to resume it.
  • idle_time (optional) - pull timeout (seconds). Starting from the moment when nobody requests specified stream, server continues pulling that stream during the timeout interval and then cuts it off.
  • dynamic_stream (optional) - specifies whether server tries to pull any stream belonging to the specified application from the given source in case it was requested.
  • description (optional) - custom description of pull setting.
  • tags (optional) - custom tags for easy filtering on the settings web page.
  • probe_interval (optional) - time interval in seconds to check primary URL availability, when one of fallback URLs is used. Should be greater or equal to 30 and less or equal to 2592000 (30 days).
Response example: 
{
    "status": "Ok",
    "settings": [
      {
          "id": "5526331a0640fd5ad6000002",
          "url": "rtmp://example.com/live-nimble/mystream/fairytale.audio",
          "fallback_urls": [],
          "application": "",
          "stream": "",
          "paused": false,
          "idle_time" : 0,
          "dynamic_stream" : false,
          "description": "Fairy tale",
          "status": "online"
      },
      {
          "id": "5526331a0640fd5ad6000003",
          "url": "rtmp://example.com/live-nimble/mystream/fairytale2.audio",
          "fallback_urls": [],
          "application": "",
          "stream": "",
          "paused": false,
          "idle_time" : 0,
          "dynamic_stream" : false,
          "description": "Fairy tale 2",
          "tags": ["Tales", "New"],
          "status": "online"
      }
    ]
}
Response fields:
The same as in "Get list".

Update an existing RTMP live pull setting.
Request URL:
PUT https://api.wmspanel.com/v1/server/[server_id]/rtmp/live_pull/[setting_id]
Request parameters:

  • setting_id - is ID of the RTMP live pull setting obtained via "Get RTMP live pull settings list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"fallback_urls": ["rtmp://example.com/live-nimble1/mystream/fairytale.audio", "rtmp://anotherexample.com/live/stream/f.audio"], "application": "nimble-live", "stream": "mystream", "apply_immediately": true, "description": "Updated tale", "tags": ["Tales", "updated"]}' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtmp/live_pull/5526331a0640fd5ad6000002/?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • url - url of incoming RTMP stream.
  • fallback_urls - list of fallback urls of incoming RTMP stream for switching to in case of primary url is inaccessible.
  • application - application name for outgoing streams.
  • stream - stream name for outgoing streams.
  • paused - whether given setting is currently inactivated. Set this parameter to true if you want to pause a particular RTMP live pull setting or to false if you want to resume it.
  • apply_immediately - whether this update must be applied immediately by corresponding Nimble server, resetting all relevant streams. If some of those streams are currently playing, then they will be restarted with new settings applied. If this parameter is not specified, then corresponding Nimble server will apply this update only after restart.
  • idle_time - pull timeout (seconds). Starting from the moment when nobody requests specified stream, server continues pulling that stream during the timeout interval and then cuts it off.
  • dynamic_stream - specifies whether server tries to pull any stream belonging to the specified application from the given source in case it was requested.
  • description - custom description of pull setting.
  • tags - custom tags for easy filtering on the settings web page.
  • probe_interval (optional) - time interval in seconds to check primary URL availability, when one of fallback URLs is used. Should be greater or equal to 30 and less or equal to 2592000 (30 days). Value 0 will remove probe_interval from setting.
  • other_servers_to_apply (optional) - array of servers IDs, where same setting also should be updated. If servers have settings with same parameters as main setting to be updated (specified in URL), then these settings will be also updated. Maximum 20 additional servers IDs can be included into one API call.
All fields are optional.

Response example: 
{
    "status": "Ok",
    "setting": {
        "id": "5526331a0640fd5ad6000002",
        "url": "rtmps://example.com/live-nimble/mystream/fairytale.audio",
        "fallback_urls": [
            "rtmps://example.com/live-nimble1/mystream/fairytale.audio",
            "rtmp://anotherexample.com/live/stream/f.audio"
        ],
        "application": "nimble-live",
        "stream": "mystream",
        "paused": false,
        "idle_time" : 0,
        "dynamic_stream" : false,
        "description": "Updated tale",
        "tags": ["Tales", "updated"],
        "status": "online",
        "active_url": "rtmps://example.com/live-nimble/mystream/fairytale.audio",
        "bandwidth": 4551329,
        "other_servers_applied": [
            {
                "setting_id": "61fb6b3d2c47e52f12630662",
                "server_id": "555a79e6fe7cd34664000006"
            },
            {
                "setting_id": "61fb6b3d2c47e52f12630663",
                "server_id": "594a0845fe7cd3593d000005"
            }
        ]
    }
}
Response fields:
  • other_servers_applied - array containing data about settings updated on other servers (from "other_servers_to_apply" request field). This field is returned, when request contained "other_servers_to_apply" field only. Each array item is a hash structure with following fields:
    • setting_id - new setting ID
    • server_id - server ID, where new setting was created
Other response fields are the same as in "Get an existing RTMP live pull setting".

Restart RTMP live pull setting.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/rtmp/live_pull/[setting_id]/restart
Request parameters:

  • setting_id - is ID of the RTMP live pull setting obtained via "Get RTMP live pull settings list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtmp/live_pull/5526331a0640fd5ad6000002/restart?client_id=[client_id]&api_key=[api_key]'
Response example: 
{
    "status": "Ok",
}

Delete an existing RTMP live pull setting.
Request URL:
DELETE https://api.wmspanel.com/v1/server/[server_id]/rtmp/live_pull/[setting_id]
Request parameters:

  • setting_id - is ID of the RTMP live pull setting obtained via "Get RTMP live pull settings list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtmp/live_pull/5526331a0640fd5ad6000002/?client_id=[client_id]&api_key=[api_key]"

Response example: 
{
    "status" : "Ok",
}

Delete multiple RTMP live pull settings. Maximum 100 settings can be deleted by one request. This API is disabled by default. Please, contact us to enable it.
Request URL:
DELETE https://api.wmspanel.com/v1/server/[server_id]/rtmp/live_pull/multi
Request parameters:

  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE -H 'Content-Type: application/json' -d '["5743e0630823899c56000001", "5743e0630823899c56000002"]' "https://api.wmspanel.com/v1/server/5742bb0a08238975a100000b/rtmp/live_pull/multi?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body as array of settings ids.

Response example: 
{
    "status" : "Ok",
    "settings_removed": 2
}

Retrieve list of RTMP republish rules for particular Nimble server. You can view this list by navigating to "Nimble Streamer / Live streams settings" menu item, then choosing appropriate Nimble server and choosing "Republishing" tab. Nimble server can republish incoming RTMP streams to edge servers or CDN with configurable parameters, such as application, stream, port, authentication schema, etc.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/rtmp/republish
Request parameters:

  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtmp/republish?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "rules": [
        {
            "id": "5458718978a6fcf15a000017",
            "src_app": "nimble-app",
            "src_strm": "stream1",
            "dest_addr": "ingest.mybeststreams.com",
            "dest_port": 1935,
            "dest_app": "live",
            "dest_strm": "stream2?key=mhhYOApVGGKKqXefE",
            "dest_app_params": "",
            "dest_strm_params": "",
            "auth_schema": "NIMBLE",
            "dest_login": "wmspanel",
            "dest_password": "password",
            "description": "Ingestion",
            "tags": ["My best", "Ingestion"],
            "paused": false,
            "keep_src_stream_params": false,
            "ssl": false
        },
        {
            "id": "5458718978a6fcf15a00001a",
            "src_app": "live",
            "src_strm": "mystream",
            "dest_addr": "",
            "dest_port": 443,
            "dest_app": "myapp",
            "dest_strm": "stream3",
            "dest_app_params": "",
            "dest_strm_params": "",
            "auth_schema": "NONE",
            "dest_login": "",
            "dest_password": "",
            "description": "",
            "paused": true,
            "keep_src_stream_params": true,
            "ssl": true
        }
    ]
}
Response fields:
  • id - unique RTMP republish rule ID for further usage.
  • src_app - source application name.
  • src_strm - source stream name. If not specified, then all streams from the source application are republished.
  • dest_addr - destination URL or IP address where the application stream/streams are published.
  • dest_port - destination port.
  • dest_app - name of destination streaming application.
  • dest_strm - destination stream name.
  • dest_app_params - special parameters for destination streaming application.
  • dest_strm_params - special parameters for destination stream.
  • description - custom description of republish rule.
  • tags - custom tags for easy filtering on the settings web page.
  • auth_schema - authentication schema for destination. Can be "NONE", "NIMBLE", "AKAMAI", "LIMELIGHT", "PERISCOPE", "TELEGRAM", "RTMP" or "TWITCH".
  • dest_login - login for authentication on destination. Relevant for "NIMBLE", "AKAMAI", "LIMELIGHT" and "RTMP" authentication schemas.
  • dest_password - password for authentication on destination. Relevant for "NIMBLE", "AKAMAI", "LIMELIGHT" and "RTMP" authentication schemas.
  • akamai_stream_id - stream ID for publishing to AKAMAI network. Relevant only for "AKAMAI" authentication schema.
  • paused - whether given rule is currently inactivated.
  • keep_src_stream_params - indicates source stream parameters handling mode. Should be true to keep source stream parameters in destination stream. Default value is false.
  • ssl - indicates SSL usage. If not specified, then it's automatically set to false (except "TELEGRAM" authentication schema, where it is always true). If set to true, then correct SSL port should be specified (usually 443). Relevant for "NONE", "NIMBLE", "TELEGRAM", "RTMP" and "TWITCH" authentication schemas.

Pick up a RTMP republish rule.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/rtmp/republish/[rule_id]
Request parameters:

  • rule_id - is ID of the RTMP republish rule obtained via "Get RTMP republish rules list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtmp/republish/5458718978a6fcf15a000017?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "rule": [
        {
            "id": "5458718978a6fcf15a000017",
            "src_app": "nimble-app",
            "src_strm": "stream1",
            "dest_addr": "ingest.mybeststreams.com",
            "dest_port": 443,
            "dest_app": "live",
            "dest_strm": "stream2?key=mhhYOApVGGKKqXefE",
            "dest_app_params": "",
            "dest_strm_params": "",
            "auth_schema": "NIMBLE",
            "dest_login": "wmspanel",
            "dest_password": "password",
            "description": "Ingestion",
            "tags": ["My best", "Ingestion"],
            "paused": false,
            "keep_src_stream_params": true,
            "ssl": true
        }
    }
}
Response fields:
  • id - unique RTMP republish rule ID for further usage.
  • src_app - source application name.
  • src_strm - source stream name. If not specified, then all streams from the source application are republished.
  • dest_addr - destination URL or IP address where the application stream/streams are published.
  • dest_port - destination port.
  • dest_app - name of destination streaming application.
  • dest_strm - destination stream name.
  • dest_app_params - special parameters for destination streaming application.
  • dest_strm_params - special parameters for destination stream.
  • description - custom description of republish rule.
  • tags - custom tags for easy filtering on the settings web page.
  • auth_schema - authentication schema for destination. Can be "NONE", "NIMBLE", "AKAMAI", "LIMELIGHT", "PERISCOPE", "TELEGRAM", "RTMP" or "TWITCH".
  • dest_login - login for authentication on destination. Relevant for "NIMBLE", "AKAMAI", "LIMELIGHT" and "RTMP" authentication schemas.
  • dest_password - password for authentication on destination. Relevant for "NIMBLE", "AKAMAI", "LIMELIGHT" and "RTMP" authentication schemas.
  • akamai_stream_id - stream ID for publishing to AKAMAI network. Relevant only for "AKAMAI" authentication schema.
  • paused - whether given rule is currently inactivated.
  • keep_src_stream_params - indicates source stream parameters handling mode. Should be true to keep source stream parameters in destination stream. Default value is false.
  • ssl - indicates SSL usage. If not specified, then it's automatically set to false (except "TELEGRAM" authentication schema, where it is always true). If set to true, then correct SSL port should be specified (usually 443). Relevant for "NONE", "NIMBLE", "TELEGRAM", "RTMP" and "TWITCH" authentication schemas.

Create a new RTMP republish rule.
Request URL:
POST https://api.wmspanel.com/v1/server/[server_id]/rtmp/republish
Request parameters:

  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{"src_app": "nimble-app", "dest_addr": "ingest.mybeststreams.com", "dest_app": "live", "description": "Ingestion", "tags": ["My best", "Ingestion"]}' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtmp/republish?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • src_app - source application name.
  • src_strm (optional) - source stream name. If not specified, then all streams from the source application are republished.
  • dest_addr - destination URL or IP address where the application stream/streams are published.
  • dest_port (optional) - destination port. If not specified, then destination port is set to 1935 by default.
  • dest_app - name of destination streaming application.
  • dest_strm (optional) - destination stream name. If source stream is not specified, then destination stream must be blank.
  • dest_app_params (optional) - special parameters for destination streaming application.
  • dest_strm_params (optional) - special parameters for destination stream.
  • description (optional) - custom description of republish rule.
  • tags (optional) - custom tags for easy filtering on the settings web page.
  • auth_schema (optional) - authentication schema for destination. Can be "NONE", "NIMBLE", "AKAMAI", "LIMELIGHT", "PERISCOPE", "TELEGRAM", "RTMP" or "TWITCH".
  • dest_login (optional) - login for authentication on destination. Relevant for "NIMBLE", "AKAMAI", "LIMELIGHT" and "RTMP" authentication schemas.
  • dest_password (optional) - password for authentication on destination. Relevant for "NIMBLE", "AKAMAI", "LIMELIGHT" and "RTMP" authentication schemas.
  • akamai_stream_id (optional) - stream ID for publishing to AKAMAI network. It must be present for "AKAMAI" authentication schema.
  • paused (optional) - whether given rule is currently inactivated. Set this parameter to true if you want to pause a particular RTMP republish rule or to false if you want to resume it.
  • keep_src_stream_params (optional) - indicates source stream parameters handling mode. Should be true to keep source stream parameters in destination stream. Default value is false.
  • ssl (optional) - indicates SSL usage. If not specified, then it's automatically set to false (except "TELEGRAM" authentication schema, where it is always true). If set to true, then correct SSL port should be specified (usually 443). Relevant for "NONE", "NIMBLE", "TELEGRAM", "RTMP" and "TWITCH" authentication schemas.
  • other_servers_to_apply (optional) - array of servers IDs, where this setting also should be created. Maximum 20 additional servers IDs can be included into one API call.
Response example: 
    {
    "status": "Ok",
    "rule": {
        "id": "5527b23d0640fd4828000003",
        "src_app": "nimble-app",
        "src_strm": "",
        "dest_addr": "ingest.mybeststreams.com",
        "dest_port": 1935,
        "dest_app": "live",
        "dest_strm": "",
        "dest_app_params": "",
        "dest_strm_params": "",
        "auth_schema": "NONE",
        "dest_login": "",
        "dest_password": "",
        "description": "Ingestion",
        "tags": ["My best", "Ingestion"],
        "paused": false,
        "keep_src_stream_params": false,
        "ssl": false,
        "other_servers_applied": [
            {
                "setting_id": "61fb6b3d2c47e52f12630662",
                "server_id": "555a79e6fe7cd34664000006"
            },
            {
                "setting_id": "61fb6b3d2c47e52f12630663",
                "server_id": "594a0845fe7cd3593d000005"
            }
        ]
    }
}
Response fields:
  • other_servers_applied - array containing data about settings created on other servers (from "other_servers_to_apply" request field). This field is returned, when request contained "other_servers_to_apply" field only. Each array item is a hash structure with following fields:
    • setting_id - new setting ID
    • server_id - server ID, where new setting was created
Other response fields are the same as in "Get an existing RTMP republish rule".

Update an existing RTMP republish rule.
Request URL:
PUT https://api.wmspanel.com/v1/server/[server_id]/rtmp/republish/[rule_id]
Request parameters:

  • rule_id - is ID of the RTMP republish rule obtained via "Get RTMP republish rules list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"auth_schema": "NIMBLE", "dest_login": "wmspanel", "dest_password": "pass", "paused": true, "src_strm": "stream1", "dest_strm": "stream2"}' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtmp/republish/5527b23d0640fd4828000003?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • src_app - source application name.
  • src_strm - source stream name. If not specified, then all streams from the source application are republished.
  • dest_addr - destination URL or IP address where the application stream/streams are published.
  • dest_port - destination port. Default value is 1935.
  • dest_app - name of destination streaming application.
  • dest_strm - destination stream name. If source stream is not specified, then destination stream must be blank.
  • dest_app_params - special parameters for destination streaming application.
  • dest_strm_params - special parameters for destination stream.
  • description - custom description of republish rule.
  • tags - custom tags for easy filtering on the settings web page.
  • auth_schema - authentication schema for destination. Can be "NONE", "NIMBLE", "AKAMAI", "LIMELIGHT", "PERISCOPE", "TELEGRAM", "RTMP" or "TWITCH".
  • dest_login - login for authentication on destination. Relevant for "NIMBLE", "AKAMAI", "LIMELIGHT" and "RTMP" authentication schemas.
  • dest_password - password for authentication on destination. Relevant for "NIMBLE", "AKAMAI", "LIMELIGHT" and "RTMP" authentication schemas.
  • akamai_stream_id - stream ID for publishing to AKAMAI network. It must be present for "AKAMAI" authentication schema.
  • paused - whether given rule is currently inactivated. Set this parameter to true if you want to pause a particular RTMP republish rule or to false if you want to resume it.
  • keep_src_stream_params - indicates source stream parameters handling mode. Should be true to keep source stream parameters in destination stream. Default value is false.
  • ssl - indicates SSL usage. If not specified, then it's automatically set to false (except "TELEGRAM" authentication schema, where it is always true). If set to true, then correct SSL port should be specified (usually 443). Relevant for "NONE", "NIMBLE", "TELEGRAM", "RTMP" and "TWITCH" authentication schemas.
  • other_servers_to_apply (optional) - array of servers IDs, where same setting also should be updated. If servers have settings with same parameters as main setting to be updated (specified in URL), then these settings will be also updated. Maximum 20 additional servers IDs can be included into one API call.
All fields are optional.

Response example: 
    {
    "status": "Ok",
    "rule": {
        "id": "5527b23d0640fd4828000003",
        "src_app": "nimble-app",
        "src_strm": "stream1",
        "dest_addr": "ingest.mybeststreams.com",
        "dest_port": 1935,
        "dest_app": "live",
        "dest_strm": "stream2",
        "dest_app_params": "",
        "dest_strm_params": "",
        "auth_schema": "NIMBLE",
        "dest_login": "wmspanel",
        "dest_password": "pass",
        "description": "Ingestion",
        "tags": ["My best", "Ingestion"],
        "paused": true,
        "keep_src_stream_params": false,
        "ssl": false,
        "other_servers_applied": [
            {
                "setting_id": "61fb6b3d2c47e52f12630662",
                "server_id": "555a79e6fe7cd34664000006"
            },
            {
                "setting_id": "61fb6b3d2c47e52f12630663",
                "server_id": "594a0845fe7cd3593d000005"
            }
        ]
    }
}
Response fields:
  • other_servers_applied - array containing data about settings updated on other servers (from "other_servers_to_apply" request field). This field is returned, when request contained "other_servers_to_apply" field only. Each array item is a hash structure with following fields:
    • setting_id - new setting ID
    • server_id - server ID, where new setting was created
Other response fields are the same as in "Get an existing RTMP republish rule".

Restart RTMP republish rule
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/rtmp/republish/[rule_id]/restart
Request parameters:

  • rule_id - is ID of the RTMP republish rule obtained via "Get RTMP republish rules list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtmp/republish/5527b23d0640fd4828000003/restart?client_id=[client_id]&api_key=[api_key]'
Response example: 
{
  "status": "Ok",
}

Delete an existing RTMP republish rule.
Request URL:
DELETE https://api.wmspanel.com/v1/server/[server_id]/rtmp/republish/[rule_id]
Request parameters:

  • rule_id - is ID of the RTMP republish rule obtained via "Get RTMP republish rules list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtmp/republish/5527b23d0640fd4828000003/?client_id=[client_id]&api_key=[api_key]"

Response example: 
{
  "status" : "Ok",
}

Retrieve list of RTSP network interfaces for particular Nimble server. You can view this list by navigating to "Nimble Streamer / Live streams" menu item, then choosing appropriate Nimble server, then clicking on "Live streams settings" button and choosing "Interfaces" tab.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/rtsp/interface
Request parameters:

  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/552b56aa0640fd4e95000002/rtsp/interface?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "interfaces": [
        {
            "id": "552b56aa0640fd4e95000002",
            "ip": "10.0.0.2",
            "port": 544,
            "tags": ["main", "rtsp"]
        },
        {
            "id": "552b5a6b0640fdfc14000002",
            "ip": "Any",
            "port": 2222,
            "tags": ["secondary", "rtsp"]
        }
    ]
}
Response fields:
  • id - unique RTSP interface ID for further usage.
  • ip - ip address of network interface to listen to. If not specified, then it's automatically set to "Any", which means, that Nimble streamer listens to all interfaces on given port.
  • port - port to listen to.
  • tags - custom tags for easy filtering on the settings web page.

Pick up a RTSP interface
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/rtsp/interface/[interface_id]
Request parameters:

  • interface_id - is ID of the RTSP interface obtained via "Get RTSP interfaces list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtsp/interface/552b56aa0640fd4e95000002?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "interface": {
        "id": "552b56aa0640fd4e95000002",
        "ip": "10.0.0.2",
        "port": 544,
        "tags": ["main", "rtsp"]
    }
}
Response fields:
  • id - unique RTSP interface ID for further usage.
  • ip - ip address of network interface to listen to. If not specified, then it's automatically set to "Any", which means, that Nimble streamer listens to all interfaces on given port.
  • port - port to listen to.
  • tags - custom tags for easy filtering on the settings web page.

Create a new RTSP interface.
Request URL:
POST https://api.wmspanel.com/v1/server/[server_id]/rtsp/interface
Request parameters:

  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{"port": 544, "other_servers_to_apply": ["555a79e6fe7cd34664000006"]}' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtsp/interface?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • ip (optional) - ip address of network interface to listen to. If not specified, then it's automatically set to "Any", which means, that Nimble streamer listens to all interfaces on given port.
  • port - port to listen to.
  • other_servers_to_apply (optional) - array of servers IDs, where this setting also should be created. Maximum 20 additional servers IDs can be included into one API call.
  • tags (optional) - custom tags for easy filtering on the settings web page.
Response example: 
    {
    "status": "Ok",
    "interface": {
        "id": "552b5c760640fdfc14000003",
        "ip": "Any",
        "port": 544,
        "other_servers_applied": [
            {
                "setting_id": "62f9e35e2c47e5781c98a101",
                "server_id": "555a79e6fe7cd34664000006"
            }
        ]
    }
}
Response fields:
  • other_servers_applied - array containing data about settings created on other servers (from "other_servers_to_apply" request field). This field is returned, when request contained "other_servers_to_apply" field only. Each array item is a hash structure with following fields:
    • setting_id - new setting ID
    • server_id - server ID, where new setting was created
Other response fields are the same as in "Get an existing RTSP interface".

Update an existing RTSP interface.
Request URL:
PUT https://api.wmspanel.com/v1/server/[server_id]/rtsp/interface/[interface_id]
Request parameters:

  • interface_id - is ID of the RTSP interface obtained via "Get RTSP interfaces list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"ip": "10.0.0.1", "port": 3001, "other_servers_to_apply": ["555a79e6fe7cd34664000006"], "tags": ["main", "rtsp"]}' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtsp/interface/552b5c760640fdfc14000003?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • ip - ip address of network interface to listen to.
  • port - port to listen to.
  • other_servers_to_apply - array of servers IDs, where this setting also should be created. Maximum 20 additional servers IDs can be included into one API call.
  • tags - custom tags for easy filtering on the settings web page.
All fields are optional.

Response example: 
    {
    "status": "Ok",
    "interface": {
        "id": "552b5c760640fdfc14000003",
        "ip": "10.0.0.1",
        "port": 3001,
        "tags": ["main", "rtsp"],
        "other_servers_applied": [
            {
                "setting_id": "62f9e35e2c47e5781c98a101",
                "server_id": "555a79e6fe7cd34664000006"
            }
        ]
    }
}
Response fields:
  • other_servers_applied - array containing data about settings created on other servers (from "other_servers_to_apply" request field). This field is returned, when request contained "other_servers_to_apply" field only. Each array item is a hash structure with following fields:
    • setting_id - new setting ID
    • server_id - server ID, where new setting was created
Other response fields are the same as in "Get an existing RTSP interface".

Delete an existing RTSP interface.
Request URL:
DELETE https://api.wmspanel.com/v1/server/[server_id]/rtsp/interface/[interface_id]
Request parameters:

  • interface_id - is ID of the RTSP interface obtained via "Get RTSP interfaces list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/server/[server_id]/rtsp/interface/552b5c760640fdfc14000003?client_id=[client_id]&api_key=[api_key]"

Response example: 
    {
    "status" : "Ok",
}

Retrieve list of RTSP live pull settings for particular Nimble server. You can view this list by navigating to "Nimble Streamer / Live streams settings" menu item, then choosing appropriate Nimble server, then clicking on "Live streams settings" button and choosing "Live pull settings" tab.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/rtsp/live_pull
Request parameters:

  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtsp/live_pull?client_id=[client_id]&api_key=[api_key]'
Response example: 
{
    "status": "Ok",
    "settings": [
        {
            "id": "547d151378a6fccf4d000002",
            "url": "rtsp://r/t/m/p/with/dr222",
            "fallback_urls": [
                "rtsp://dr/one/url",
                "rtsp://dr/two/url"
            ],
            "application": "123",
            "stream": "asd",
            "paused": false,
            "rtsp_mode": "UDP_PREFERRED",
            "idle_time" : 0,
            "dynamic_stream" : false,
            "description": "RTSP",
            "tags": ["House MD", "rtsp"],
            "status": "online",
            "active_url": "rtmps://dr/two/url",
            "bandwidth": 4551329,
            "uptime": 7219
        },
        {
            "id": "547d151378a6fccf4d000003",
            "url": "rtsp://ais2.rastamusic.com/live/rastamusic.stream",
            "fallback_urls": [],
            "application": "",
            "stream": "",
            "paused": false,
            "rtsp_mode": "TCP_ONLY",
            "idle_time" : 0,
            "dynamic_stream" : false,
            "description": "Rasta music",
            "tags": ["music", "rasta"],
            "status": "offline"
        }
    ]
}
Response fields:
  • id - unique RTSP live pull setting ID for further usage.
  • url - url of incoming RTSP stream.
  • fallback_urls - list of fallback urls of incoming RTSP stream for switching to in case of primary url is inaccessible.
  • application - application name for outgoing streams.
  • stream - stream name for outgoing streams.
  • paused - whether given setting is currently inactivated.
  • rtsp_mode - can be either "TCP_PREFERRED", "UDP_PREFERRED", "TCP_ONLY", "UDP_ONLY" or "RTSP_OVER_HTTP". "_ONLY" means that media server will use only selected protocol in any case, "_PREFERRED" means that media server will try to use selected protocol in the first place and then try another protocol in case of fail.
  • idle_time - pull timeout (seconds). Starting from the moment when nobody requests specified stream, server continues pulling that stream during the timeout interval and then cuts it off.
  • dynamic_stream - specifies whether server tries to pull any stream belonging to the specified application from the given source in case it was requested.
  • http_proxy - HTTP proxy port. Present only when rtsp_mode is RTSP_OVER_HTTP.
  • description - custom description of pull setting.
  • tags - custom tags for easy filtering on the settings web page.
  • status - current status of given stream. Can be one of the following values:
    • "pending" - appears when given stream is created, modified or resumed via UI or API call till the moment when server reports actual status of the stream
    • "online" - appears when media server reports that it was able to access given stream
    • "offline" - appears when media server reports that it has failed to access given stream
    • "paused" - appears when given stream is paused (postponed) via UI or API call
  • active_url - URL is using by Nimble at this moment. Returned only when stream has at least one fallback URL.
  • bandwidth - given stream's data transmission rate measured in bits per second.
  • uptime - time interval in seconds showing given stream uptime. Available only for non-dynamic streams having "online" or "pending" status.

Pick up a RTSP live pull setting
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/rtsp/live_pull/[setting_id]
Request parameters:

  • setting_id - is ID of the RTSP live pull setting obtained via "Get RTSP live pull settings list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtsp/live_pull/547d151378a6fccf4d000002?client_id=[client_id]&api_key=[api_key]'
Response example: 
{
    "status": "Ok",
    "setting": {
        "id": "547d151378a6fccf4d000002",
        "url": "rtsp://r/t/m/p/with/dr222",
        "fallback_urls": [
            "rtsp://dr/one/url",
            "rtsp://dr/two/url"
        ],
        "application": "123",
        "stream": "asd",
        "paused": false,
        "rtsp_mode": "UDP_PREFERRED",
        "idle_time" : 0,
        "dynamic_stream" : false,
        "description": "RTSP",
        "tags": ["House MD", "rtsp"],
        "status": "online",
        "active_url": "rtmps://dr/two/url",
        "bandwidth": 4551329,
        "uptime": 7219
    }
}
Response fields:
  • id - unique RTSP live pull setting ID for further usage.
  • url - url of incoming RTSP stream.
  • fallback_urls - list of fallback urls of incoming RTSP stream for switching to in case of primary url is inaccessible.
  • application - application name for outgoing streams.
  • stream - stream name for outgoing streams.
  • paused - whether given setting is currently inactivated.
  • rtsp_mode - can be either "TCP_PREFERRED", "UDP_PREFERRED", "TCP_ONLY", "UDP_ONLY" or "RTSP_OVER_HTTP". "_ONLY" means that media server will use only selected protocol in any case, "_PREFERRED" means that media server will try to use selected protocol in the first place and then try another protocol in case of fail.
  • idle_time - pull timeout (seconds). Starting from the moment when nobody requests specified stream, server continues pulling that stream during the timeout interval and then cuts it off.
  • dynamic_stream - specifies whether server tries to pull any stream belonging to the specified application from the given source in case it was requested.
  • http_proxy - HTTP proxy port. Can be set only if rtsp_mode is RTSP_OVER_HTTP.
  • description - custom description of pull setting.
  • tags - custom tags for easy filtering on the settings web page.
  • status - current status of given stream. Can be one of the following values:
    • "pending" - appears when given stream is created, modified or resumed via UI or API call till the moment when server reports actual status of the stream
    • "online" - appears when media server reports that it was able to access given stream
    • "offline" - appears when media server reports that it has failed to access given stream
    • "paused" - appears when given stream is paused (postponed) via UI or API call
  • active_url - URL is using by Nimble at this moment. Returned only when stream has at least one fallback URL.
  • bandwidth - given stream's data transmission rate measured in bits per second.
  • uptime - time interval in seconds showing given stream uptime. Available only for non-dynamic streams having "online" or "pending" status.

Create a new RTSP live pull setting. Maximum 5000 settings can be created per server.
Request URL:
POST https://api.wmspanel.com/v1/server/[server_id]/rtsp/live_pull
Request parameters:

  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{"url": "rtsp://example.com/live-nimble/mystream/", "description": "Fairy tale", "tags": ["Tales"]}' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtsp/live_pull?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • url - url of incoming RTSP stream.
  • fallback_urls (optional) - list of fallback urls of incoming RTSP stream for switching to in case of primary url is inaccessible.
  • application (optional) - application name for outgoing streams. If not specified, then application name for outgoing streams is taken from the url of incoming stream. E.g. if incoming stream is rtsp://127.0.0.1:8081/live-origin/mystream/playlist.m3u8 , then "live-origin" is assigned as application name for outgoing stream. If incoming stream doesn't contain application name, then it should be explicitly specified by this parameter.
  • stream (optional) - stream name for outgoing streams. If not specified, then stream name for outgoing stream is taken from the url of incoming stream. E.g. if incoming stream is rtsp://127.0.0.1:8081/live-origin/mystream/playlist.m3u8 , then "mystream" is assigned as stream name for outgoing stream. If incoming stream doesn't contain stream name, then it should be explicitly specified by this parameter.
  • paused (optional) - whether given setting is currently inactivated. Set this parameter to true if you want to pause a particular RTSP live pull setting or to false if you want to resume it.
  • rtsp_mode (optional) - can be either "TCP_PREFERRED", "UDP_PREFERRED", "TCP_ONLY", "UDP_ONLY" or "RTSP_OVER_HTTP". "_ONLY" means that media server will use only selected protocol in any case, "_PREFERRED" means that media server will try to use selected protocol in the first place and then try another protocol in case of fail. If not specified, then default value is "TCP_PREFERRED".
  • idle_time (optional) - pull timeout (seconds). Starting from the moment when nobody requests specified stream, server continues pulling that stream during the timeout interval and then cuts it off.
  • dynamic_stream (optional) - specifies whether server tries to pull any stream belonging to the specified application from the given source in case it was requested.
  • http_proxy - HTTP proxy port. Can be set only if rtsp_mode is RTSP_OVER_HTTP.
  • description (optional) - custom description of pull setting.
  • tags (optional) - custom tags for easy filtering on the settings web page.
  • other_servers_to_apply (optional) - array of servers IDs, where this setting also should be created. Maximum 20 additional servers IDs can be included into one API call.
Response example: 
{
    "status": "Ok",
    "setting": {
        "id": "5526331a0640fd5ad6000002",
        "url": "rtsp://example.com/live-nimble/mystream/fairytale.audio",
        "fallback_urls": [],
        "application": "",
        "stream": "",
        "paused": false,
        "rtsp_mode": "TCP_PREFERRED",
        "idle_time" : 0,
        "dynamic_stream" : false,
        "description": "Fairy tale",
        "tags": ["Tales"],
        "status": "online",
        "other_servers_applied": [
            {
                "setting_id": "61fb6b3d2c47e52f12630662",
                "server_id": "555a79e6fe7cd34664000006"
            },
            {
                "setting_id": "61fb6b3d2c47e52f12630663",
                "server_id": "594a0845fe7cd3593d000005"
            }
        ]
    }
}
Response fields:
  • other_servers_applied - array containing data about settings created on other servers (from "other_servers_to_apply" request field). This field is returned, when request contained "other_servers_to_apply" field only. Each array item is a hash structure with following fields:
    • setting_id - new setting ID
    • server_id - server ID, where new setting was created
Other response fields are the same as in "Get an existing RTSP live pull setting".

Create multiple new RTSP live pull settings. Maximum 100 settings can be created by one request. Maximum 5000 settings can be created per server. This API is disabled by default. Please, contact us to enable it.
Request URL:
POST https://api.wmspanel.com/v1/server/[server_id]/rtsp/live_pull/multi
Request parameters:

  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '[{"url": "rtsp://example.com/live-nimble/mystream/", "description": "Fairy tale"}, {"url": "rtsp://example.com/live-nimble/mystream2/", "description": "Fairy tale 2", "tags": ["Tales", "New"]}]' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtsp/live_pull/multi?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body as array of structures.

Request data fields:
  • url - url of incoming RTSP stream.
  • fallback_urls (optional) - list of fallback urls of incoming RTSP stream for switching to in case of primary url is inaccessible.
  • application (optional) - application name for outgoing streams. If not specified, then application name for outgoing streams is taken from the url of incoming stream. E.g. if incoming stream is rtsp://127.0.0.1:8081/live-origin/mystream/playlist.m3u8 , then "live-origin" is assigned as application name for outgoing stream. If incoming stream doesn't contain application name, then it should be explicitly specified by this parameter.
  • stream (optional) - stream name for outgoing streams. If not specified, then stream name for outgoing stream is taken from the url of incoming stream. E.g. if incoming stream is rtsp://127.0.0.1:8081/live-origin/mystream/playlist.m3u8 , then "mystream" is assigned as stream name for outgoing stream. If incoming stream doesn't contain stream name, then it should be explicitly specified by this parameter.
  • paused (optional) - whether given setting is currently inactivated. Set this parameter to true if you want to pause a particular RTSP live pull setting or to false if you want to resume it.
  • rtsp_mode (optional) - can be either "TCP_PREFERRED", "UDP_PREFERRED", "TCP_ONLY", "UDP_ONLY" or "RTSP_OVER_HTTP". "_ONLY" means that media server will use only selected protocol in any case, "_PREFERRED" means that media server will try to use selected protocol in the first place and then try another protocol in case of fail. If not specified, then default value is "TCP_PREFERRED".
  • idle_time (optional) - pull timeout (seconds). Starting from the moment when nobody requests specified stream, server continues pulling that stream during the timeout interval and then cuts it off.
  • dynamic_stream (optional) - specifies whether server tries to pull any stream belonging to the specified application from the given source in case it was requested.
  • http_proxy - HTTP proxy port. Can be set only if rtsp_mode is RTSP_OVER_HTTP.
  • description (optional) - custom description of pull setting.
  • tags (optional) - custom tags for easy filtering on the settings web page.
Response example: 
{
    "status": "Ok",
    "settings": [
      {
          "id": "5526331a0640fd5ad6000002",
          "url": "rtsp://example.com/live-nimble/mystream/fairytale.audio",
          "fallback_urls": [],
          "application": "",
          "stream": "",
          "paused": false,
          "rtsp_mode": "TCP_PREFERRED",
          "idle_time" : 0,
          "dynamic_stream" : false,
          "description": "Fairy tale",
          "status": "online"
      },
      {
          "id": "5526331a0640fd5ad6000003",
          "url": "rtsp://example.com/live-nimble/mystream2/fairytale.audio",
          "fallback_urls": [],
          "application": "",
          "stream": "",
          "paused": false,
          "rtsp_mode": "TCP_PREFERRED",
          "idle_time" : 0,
          "dynamic_stream" : false,
          "description": "Fairy tale 2",
          "tags": ["Tales", "New"],
          "status": "online"
      }
    ]
}
Response fields:
The same as in "Get list".

Update an existing RTSP live pull setting.
Request URL:
PUT https://api.wmspanel.com/v1/server/[server_id]/rtsp/live_pull/[setting_id]
Request parameters:

  • setting_id - is ID of the RTSP live pull setting obtained via "Get RTSP live pull settings list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"fallback_urls": ["rtsp://example.com/live-nimble1/mystream/fairytale.audio", "rtsp://anotherexample.com/live/stream/f.audio"], "application": "nimble-live", "stream": "mystream", "apply_immediately": true, "description": "Updated tale", "tags": ["Tales", "updated"]}' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtsp/live_pull/5526331a0640fd5ad6000002/?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • url - url of incoming RTSP stream.
  • fallback_urls - list of fallback urls of incoming RTSP stream for switching to in case of primary url is inaccessible.
  • application - application name for outgoing streams.
  • stream - stream name for outgoing streams.
  • paused - whether given setting is currently inactivated. Set this parameter to true if you want to pause a particular RTSP live pull setting or to false if you want to resume it.
  • rtsp_mode - can be either "TCP_PREFERRED", "UDP_PREFERRED", "TCP_ONLY" , "UDP_ONLY" or "RTSP_OVER_HTTP". "_ONLY" means that media server will use only selected protocol in any case, "_PREFERRED" means that media server will try to use selected protocol in the first place and then try another protocol in case of fail.
  • apply_immediately - whether this update must be applied immediately by corresponding Nimble server, resetting all relevant streams. If some of those streams are currently playing, then they will be restarted with new settings applied. If this parameter is not specified, then corresponding Nimble server will apply this update only after restart.
  • idle_time - pull timeout (seconds). Starting from the moment when nobody requests specified stream, server continues pulling that stream during the timeout interval and then cuts it off.
  • dynamic_stream - specifies whether server tries to pull any stream belonging to the specified application from the given source in case it was requested.
  • http_proxy - HTTP proxy port. Can be set only if rtsp_mode is RTSP_OVER_HTTP.
  • description - custom description of pull setting.
  • tags - custom tags for easy filtering on the settings web page.
  • other_servers_to_apply (optional) - array of servers IDs, where same setting also should be updated. If servers have settings with same parameters as main setting to be updated (specified in URL), then these settings will be also updated. Maximum 20 additional servers IDs can be included into one API call.
All fields are optional.

Response example: 
{
    "status": "Ok",
    "setting": {
        "id": "5526331a0640fd5ad6000002",
        "url": "rtsp://example.com/live-nimble/mystream/fairytale.audio",
        "fallback_urls": [
            "rtsp://example.com/live-nimble1/mystream/fairytale.audio",
            "rtsp://anotherexample.com/live/stream/f.audio"
        ],
        "application": "nimble-live",
        "stream": "mystream",
        "paused": false,
        "rtsp_mode": "TCP_PREFERRED",
        "idle_time" : 0,
        "dynamic_stream" : false,
        "description": "Updated tale",
        "tags": ["Tales", "updated"],
        "status": "online",
        "active_url": "rtsp://example.com/live-nimble/mystream/fairytale.audio",
        "bandwidth": 4551329,
        "other_servers_applied": [
            {
                "setting_id": "61fb6b3d2c47e52f12630662",
                "server_id": "555a79e6fe7cd34664000006"
            },
            {
                "setting_id": "61fb6b3d2c47e52f12630663",
                "server_id": "594a0845fe7cd3593d000005"
            }
        ]
    }
}
Response fields:
  • other_servers_applied - array containing data about settings updated on other servers (from "other_servers_to_apply" request field). This field is returned, when request contained "other_servers_to_apply" field only. Each array item is a hash structure with following fields:
    • setting_id - new setting ID
    • server_id - server ID, where new setting was created
Other response fields are the same as in "Get an existing RTSP live pull setting".

Restart RTSP live pull setting
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/rtsp/live_pull/[setting_id]/restart
Request parameters:

  • setting_id - is ID of the RTSP live pull setting obtained via "Get RTSP live pull settings list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtsp/live_pull/5526331a0640fd5ad6000002/restart?client_id=[client_id]&api_key=[api_key]'
Response example: 
{
    "status": "Ok",
}

Delete an existing RTSP live pull setting.
Request URL:
DELETE https://api.wmspanel.com/v1/server/[server_id]/rtsp/live_pull/[setting_id]
Request parameters:

  • setting_id - is ID of the RTSP live pull setting obtained via "Get RTSP live pull settings list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtsp/live_pull/5526331a0640fd5ad6000002/?client_id=[client_id]&api_key=[api_key]"

Response example: 
{
    "status" : "Ok",
}

Delete multiple RTSP live pull settings. Maximum 100 settings can be deleted by one request. This API is disabled by default. Please, contact us to enable it.
Request URL:
DELETE https://api.wmspanel.com/v1/server/[server_id]/rtsp/live_pull/multi
Request parameters:

  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE -H 'Content-Type: application/json' -d '["5743e0630823899c56000001", "5743e0630823899c56000002"]' "https://api.wmspanel.com/v1/server/5742bb0a08238975a100000b/rtsp/live_pull/multi?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body as array of settings ids.

Response example: 
{
    "status" : "Ok",
    "settings_removed": 2
}

Retrieve list of RTSP republish rules for particular Nimble server. You can view this list by navigating to "Nimble Streamer / Live streams settings" menu item, then choosing appropriate Nimble server and choosing "Republishing" tab. Nimble server can republish incoming RTSP streams to edge servers or CDN with configurable parameters, such as application, stream, port, authentication schema, etc.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/rtsp/republish
Request parameters:

  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtsp/republish?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "rules": [
        {
            "id": "5458718978a6fcf15a000017",
            "src_app": "nimble-app",
            "src_strm": "stream1",
            "dest_addr": "ingest.mybeststreams.com",
            "dest_port": 554,
            "dest_app": "live",
            "dest_strm": "stream2",
            "dest_app_params": "net_id=5859012092",
            "auth_schema": "DIGEST",
            "dest_login": "wmspanel",
            "dest_password": "password",
            "description": "Ingestion",
            "tags": ["My best", "Ingestion"],
            "paused": false
        },
        {
            "id": "5458718978a6fcf15a00001a",
            "src_app": "live",
            "src_strm": "mystream",
            "dest_addr": "eu.ex.example.net",
            "dest_port": 554,
            "dest_app": "myapp",
            "dest_strm": "stream3",
            "dest_app_params": "",
            "auth_schema": "NONE",
            "dest_login": "",
            "dest_password": "",
            "description": "",
            "paused": true
        }
    ]
}
Response fields:
  • id - unique RTSP republish rule ID for further usage.
  • src_app - source application name.
  • src_strm - source stream name. If not specified, then all streams from the source application are republished.
  • dest_addr - destination URL or IP address where the application stream/streams are published.
  • dest_port - destination port.
  • dest_app - name of destination streaming application.
  • dest_strm - destination stream name.
  • dest_app_params - special parameters for destination streaming application.
  • auth_schema - authentication schema for destination. Can be either "NONE" or "DIGEST".
  • dest_login - login for authentication on destination. Relevant only for "DIGEST" authentication schema.
  • dest_password - password for authentication on destination. Relevant only for "DIGEST" authentication schema.
  • description - custom description of republish rule.
  • tags - custom tags for easy filtering on the settings web page.
  • paused - whether given rule is currently inactivated.

Pick up a RTSP republish rule.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/rtsp/republish/[rule_id]
Request parameters:

  • rule_id - is ID of the RTSP republish rule obtained via "Get RTSP republish rules list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtsp/republish/5458718978a6fcf15a000017?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "rule": [
        {
            "id": "5458718978a6fcf15a000017",
            "src_app": "nimble-app",
            "src_strm": "stream1",
            "dest_addr": "ingest.mybeststreams.com",
            "dest_port": 554,
            "dest_app": "live",
            "dest_strm": "stream2",
            "dest_app_params": "net_id=5859012092",
            "auth_schema": "DIGEST",
            "dest_login": "wmspanel",
            "dest_password": "password",
            "description": "Ingestion",
            "tags": ["My best", "Ingestion"],
            "paused": false
        }
    }
}
Response fields:
  • id - unique RTSP republish rule ID for further usage.
  • src_app - source application name.
  • src_strm - source stream name. If not specified, then all streams from the source application are republished.
  • dest_addr - destination URL or IP address where the application stream/streams are published.
  • dest_port - destination port.
  • dest_app - name of destination streaming application.
  • dest_strm - destination stream name.
  • dest_app_params - special parameters for destination streaming application.
  • auth_schema - authentication schema for destination. Can be either "NONE" or "DIGEST".
  • dest_login - login for authentication on destination. Relevant only for "DIGEST" authentication schema.
  • dest_password - password for authentication on destination. Relevant only for "DIGEST" authentication schema.
  • description - custom description of republish rule.
  • tags - custom tags for easy filtering on the settings web page.
  • paused - whether given rule is currently inactivated.

Create a new RTSP republish rule.
Request URL:
POST https://api.wmspanel.com/v1/server/[server_id]/rtsp/republish
Request parameters:

  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{"src_app": "nimble-app", "dest_addr": "ingest.mybeststreams.com", "dest_app": "live", "description": "Ingestion", "tags": ["My best", "Ingestion"]}' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtsp/republish?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • src_app - source application name.
  • src_strm (optional) - source stream name. If not specified, then all streams from the source application are republished.
  • dest_addr - destination URL or IP address where the application stream/streams are published.
  • dest_port (optional) - destination port. If not specified, then destination port is set to 554 by default.
  • dest_app - name of destination streaming application.
  • dest_strm (optional) - destination stream name. If source stream is not specified, then destination stream must be blank.
  • dest_app_params (optional) - special parameters for destination streaming application.
  • auth_schema (optional) - authentication schema for destination. Can be either "NONE" or "DIGEST".
  • dest_login (optional) - login for authentication on destination. Relevant only for "DIGEST" authentication schema.
  • dest_password (optional) - password for authentication on destination. Relevant only for "DIGEST" authentication schema.
  • description (optional) - custom description of republish rule.
  • tags (optional) - custom tags for easy filtering on the settings web page.
  • paused (optional) - whether given rule is currently inactivated. Set this parameter to true if you want to pause a particular RTSP republish rule or to false if you want to resume it.
  • other_servers_to_apply (optional) - array of servers IDs, where this setting also should be created. Maximum 20 additional servers IDs can be included into one API call.
Response example: 
    {
    "status": "Ok",
    "rule": {
        "id": "5527b23d0640fd4828000003",
        "src_app": "nimble-app",
        "src_strm": "",
        "dest_addr": "ingest.mybeststreams.com",
        "dest_port": 554,
        "dest_app": "live",
        "dest_strm": "",
        "dest_app_params": "",
        "auth_schema": "NONE",
        "dest_login": "",
        "dest_password": "",
        "description": "Ingestion",
        "tags": ["My best", "Ingestion"],
        "paused": false,
        "other_servers_applied": [
            {
                "setting_id": "61fb6b3d2c47e52f12630662",
                "server_id": "555a79e6fe7cd34664000006"
            },
            {
                "setting_id": "61fb6b3d2c47e52f12630663",
                "server_id": "594a0845fe7cd3593d000005"
            }
        ]
    }
}
Response fields:
  • other_servers_applied - array containing data about settings created on other servers (from "other_servers_to_apply" request field). This field is returned, when request contained "other_servers_to_apply" field only. Each array item is a hash structure with following fields:
    • setting_id - new setting ID
    • server_id - server ID, where new setting was created
Other response fields are the same as in "Get an existing RTSP republish rule".

Update an existing RTSP republish rule.
Request URL:
PUT https://api.wmspanel.com/v1/server/[server_id]/rtsp/republish/[rule_id]
Request parameters:

  • rule_id - is ID of the RTSP republish rule obtained via "Get RTSP republish rules list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"auth_schema": "DIGEST", "dest_login": "wmspanel", "dest_password": "pass", "paused": true, "src_strm": "stream1", "dest_strm": "stream2"}' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtsp/republish/5527b23d0640fd4828000003?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • src_app - source application name.
  • src_strm - source stream name. If not specified, then all streams from the source application are republished.
  • dest_addr - destination URL or IP address where the application stream/streams are published.
  • dest_port - destination port. Default value is 554.
  • dest_app - name of destination streaming application.
  • dest_strm - destination stream name. If source stream is not specified, then destination stream must be blank.
  • dest_app_params - special parameters for destination streaming application.
  • auth_schema - authentication schema for destination. Can be either "NONE" or "DIGEST".
  • dest_login - login for authentication on destination. Relevant only for "DIGEST" authentication schema.
  • dest_password - password for authentication on destination. Relevant only for "DIGEST" authentication schema.
  • description - custom description of republish rule.
  • tags - custom tags for easy filtering on the settings web page.
  • paused - whether given rule is currently inactivated. Set this parameter to true if you want to pause a particular RTSP republish rule or to false if you want to resume it.
  • other_servers_to_apply (optional) - array of servers IDs, where same setting also should be updated. If servers have settings with same parameters as main setting to be updated (specified in URL), then these settings will be also updated. Maximum 20 additional servers IDs can be included into one API call.
All fields are optional.

Response example: 
    {
    "status": "Ok",
    "rule": {
        "id": "5527b23d0640fd4828000003",
        "src_app": "nimble-app",
        "src_strm": "stream1",
        "dest_addr": "ingest.mybeststreams.com",
        "dest_port": 554,
        "dest_app": "live",
        "dest_strm": "stream2",
        "dest_app_params": "",
        "auth_schema": "DIGEST",
        "dest_login": "wmspanel",
        "dest_password": "pass",
        "description": "Ingestion",
        "tags": ["My best", "Ingestion"],
        "paused": true,
        "other_servers_applied": [
            {
                "setting_id": "61fb6b3d2c47e52f12630662",
                "server_id": "555a79e6fe7cd34664000006"
            },
            {
                "setting_id": "61fb6b3d2c47e52f12630663",
                "server_id": "594a0845fe7cd3593d000005"
            }
        ]
    }
}
Response fields:
  • other_servers_applied - array containing data about settings updated on other servers (from "other_servers_to_apply" request field). This field is returned, when request contained "other_servers_to_apply" field only. Each array item is a hash structure with following fields:
    • setting_id - new setting ID
    • server_id - server ID, where new setting was created
Other response fields are the same as in "Get an existing RTSP republish rule".

Restart RTSP republish rule
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/rtsp/republish/[rule_id]/restart
Request parameters:

  • rule_id - is ID of the RTSP republish rule obtained via "Get RTSP republish rules list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtsp/republish/5527b23d0640fd4828000003/restart?client_id=[client_id]&api_key=[api_key]'
Response example: 
{
  "status": "Ok",
}

Delete an existing RTSP republish rule.
Request URL:
DELETE https://api.wmspanel.com/v1/server/[server_id]/rtsp/republish/[rule_id]
Request parameters:

  • rule_id - is ID of the RTSP republish rule obtained via "Get RTSP republish rules list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/rtsp/republish/5527b23d0640fd4828000003/?client_id=[client_id]&api_key=[api_key]"

Response example: 
{
  "status" : "Ok",
}

Retrieve list of HLS republish rules for particular Nimble server. You can view this list by navigating to "Nimble Streamer / Live streams settings" menu item, then choosing appropriate Nimble server and choosing "Republishing" tab. Nimble server can republish incoming HLS streams to edge servers or CDN with configurable parameters, such as application, stream, url.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/hls/republish
Request parameters:

  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/hls/republish?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "rules": [
        {
            "id": "5458718978a6fcf15a000017",
            "src_app": "nimble-app",
            "src_strm": "stream1",
            "dest_url": "https://ingest.mybeststreams.com",
            "description": "Ingestion",
            "tags": ["My best", "Ingestion"],
            "paused": false
        },
        {
            "id": "5458718978a6fcf15a00001a",
            "src_app": "live",
            "src_strm": "mystream",
            "dest_url": "https://ingest2.mybeststreams.com",
            "description": "",
            "paused": true
        }
    ]
}
Response fields:
  • id - unique HLS republish rule ID for further usage.
  • src_app - source application name.
  • src_strm - source stream name. If not specified, then all streams from the source application are republished.
  • dest_url - destination URL where the application stream is published.
  • description - custom description of republish rule.
  • tags - custom tags for easy filtering on the settings web page.
  • paused - whether given rule is currently inactivated.

Pick up a HLS republish rule.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/hls/republish/[rule_id]
Request parameters:

  • rule_id - is ID of the HLS republish rule obtained via "Get HLS re-publish rules list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/hls/republish/5458718978a6fcf15a000017?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "rule": [
        {
            "id": "5458718978a6fcf15a000017",
            "src_app": "nimble-app",
            "src_strm": "stream1",
            "dest_url": "https://ingest.mybeststreams.com",
            "description": "Ingestion",
            "tags": ["My best", "Ingestion"],
            "paused": false
        }
    }
}
Response fields:

The same as for "Get list" method.

Create a new HLS republish rule.
Request URL:
POST https://api.wmspanel.com/v1/server/[server_id]/hls/republish
Request parameters:

  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{"src_app": "nimble-app", "src_strm": "source-stream", "dest_url": "https://ingest.mybeststreams.com", "description": "Ingestion", "tags": ["My best", "Ingestion"]}' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/hls/republish?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • src_app - source application name.
  • src_strm - source stream name. If not specified, then all streams from the source application are republished.
  • dest_url - destination URL address where the application stream is published.
  • description (optional) - custom description of republish rule.
  • tags (optional) - custom tags for easy filtering on the settings web page.
  • paused (optional) - whether given rule is currently inactivated. Set this parameter to true if you want to pause a particular HLS republish rule or to false if you want to resume it.
  • other_servers_to_apply (optional) - array of servers IDs, where this setting also should be created. Maximum 20 additional servers IDs can be included into one API call.
Response example: 
    {
    "status": "Ok",
    "rule": {
        "id": "5527b23d0640fd4828000003",
        "src_app": "nimble-app",
        "src_strm": "source-stream",
        "dest_url": "https://ingest.mybeststreams.com",
        "description": "Ingestion",
        "tags": ["My best", "Ingestion"],
        "paused": false,
        "other_servers_applied": [
            {
                "setting_id": "61fb6b3d2c47e52f12630662",
                "server_id": "555a79e6fe7cd34664000006"
            },
            {
                "setting_id": "61fb6b3d2c47e52f12630663",
                "server_id": "594a0845fe7cd3593d000005"
            }
        ]
    }
}
Response fields:
  • other_servers_applied - array containing data about settings created on other servers (from "other_servers_to_apply" request field). This field is returned, when request contained "other_servers_to_apply" field only. Each array item is a hash structure with following fields:
    • setting_id - new setting ID
    • server_id - server ID, where new setting was created
Other response fields are the same as in "Get an existing HLS republish rule".

Update an existing HLS republish rule.
Request URL:
PUT https://api.wmspanel.com/v1/server/[server_id]/hls/republish/[rule_id]
Request parameters:

  • rule_id - is ID of the HLS republish rule obtained via "Get HLS republish rules list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"paused": true, "src_strm": "stream1"}' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/hls/republish/5527b23d0640fd4828000003?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:

The same as for "Create" method. All fields are optional.

Response example: 
    {
    "status": "Ok",
    "rule": {
        "id": "5527b23d0640fd4828000003",
        "src_app": "nimble-app",
        "src_strm": "stream1",
        "dest_url": "https://ingest.mybeststreams.com",
        "description": "Ingestion",
        "tags": ["My best", "Ingestion"],
        "paused": true,
        "other_servers_applied": [
            {
                "setting_id": "61fb6b3d2c47e52f12630662",
                "server_id": "555a79e6fe7cd34664000006"
            },
            {
                "setting_id": "61fb6b3d2c47e52f12630663",
                "server_id": "594a0845fe7cd3593d000005"
            }
        ]
    }
}
Response fields:
  • other_servers_applied - array containing data about settings updated on other servers (from "other_servers_to_apply" request field). This field is returned, when request contained "other_servers_to_apply" field only. Each array item is a hash structure with following fields:
    • setting_id - new setting ID
    • server_id - server ID, where new setting was created
Other response fields are the same as in "Get an existing HLS republish rule".

Restart HLS republish rule
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/hls/republish/[rule_id]/restart
Request parameters:

  • rule_id - is ID of the HLS republish rule obtained via "Get HLS republish rules list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/hls/republish/5527b23d0640fd4828000003/restart?client_id=[client_id]&api_key=[api_key]'
Response example: 
{
  "status": "Ok",
}

Delete an existing HLS republish rule.
Request URL:
DELETE https://api.wmspanel.com/v1/server/[server_id]/hls/republish/[rule_id]
Request parameters:

  • rule_id - is ID of the HLS republish rule obtained via "Get HLS republish rules list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/hls/republish/5527b23d0640fd4828000003/?client_id=[client_id]&api_key=[api_key]"

Response example: 
{
  "status" : "Ok",
}

Retrieve list of Icecast network interfaces for particular Nimble server. You can view this list by navigating to "Nimble Streamer / Live streams" menu item, then choosing appropriate Nimble server, then clicking on "Live streams settings" button and choosing "Interfaces" tab.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/icecast/interface
Request parameters:

  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/552b56aa0640fd4e95000002/icecast/interface?client_id=[client_id]&api_key=[api_key]'
Response example: 
{
    "status": "Ok",
    "interfaces": [
        {
            "id": "552b56aa0640fd4e95000002",
            "ip": "10.0.0.2",
            "port": 8000,
            "tags": ["main", "icecast"]
        },
        {
            "id": "552b5a6b0640fdfc14000002",
            "ip": "Any",
            "port": 8001,
            "tags": ["secondary", "icecast"]
        }
    ]
}
Response fields:
  • id - unique Icecast interface ID for further usage.
  • ip - IP address of network interface to listen to. If not specified, then it's automatically set to "Any", which means, that Nimble Streamer listens to all interfaces on given port.
  • port - port to listen to.
  • tags - custom tags for easy filtering on the settings web page.

Pick up a Icecast interface
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/icecast/interface/[interface_id]
Request parameters:

  • interface_id - is ID of the Icecast interface obtained via "Get Icecast interfaces list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/icecast/interface/552b56aa0640fd4e95000002?client_id=[client_id]&api_key=[api_key]'
Response example: 
{
    "status": "Ok",
    "interface": {
        "id": "552b56aa0640fd4e95000002",
        "ip": "10.0.0.2",
        "port": 8000,
        "tags": ["main", "icecast"]
    }
}
Response fields:
  • id - unique Icecast interface ID for further usage.
  • ip - IP address of network interface to listen to. If not specified, then it's automatically set to "Any", which means, that Nimble streamer listens to all interfaces on given port.
  • port - port to listen to.
  • tags - custom tags for easy filtering on the settings web page.

Create a new Icecast interface.
Request URL:
POST https://api.wmspanel.com/v1/server/[server_id]/icecast/interface
Request parameters:

  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{"port": 8002, "other_servers_to_apply": ["555a79e6fe7cd34664000006"]}' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/icecast/interface?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • ip (optional) - IP address of network interface to listen to. If not specified, then it's automatically set to "Any", which means, that Nimble streamer listens to all interfaces on given port.
  • port - port to listen to.
  • other_servers_to_apply (optional) - array of servers IDs, where this setting also should be created. Maximum 20 additional servers IDs can be included into one API call.
  • tags (optional) - custom tags for easy filtering on the settings web page.
Response example: 
{
    "status": "Ok",
    "interface": {
        "id": "552b5c760640fdfc14000003",
        "ip": "Any",
        "port": 8002,
        "other_servers_applied": [
          {
            "setting_id": "62f9cfb12c47e55d553b8f0b",
            "server_id": "555a79e6fe7cd34664000006"
          }
        ]
    }
}
Response fields:
  • other_servers_applied - array containing data about settings created on other servers (from "other_servers_to_apply" request field). This field is returned, when request contained "other_servers_to_apply" field only. Each array item is a hash structure with following fields:
    • setting_id - new setting ID
    • server_id - server ID, where new setting was created
Other response fields are the same as in "Get an existing Icecast interface".

Update an existing Icecast interface.
Request URL:
PUT https://api.wmspanel.com/v1/server/[server_id]/icecast/interface/[interface_id]
Request parameters:

  • interface_id - is ID of the Icecast interface obtained via "Get Icecast interfaces list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"ip": "10.0.0.1", "port": 3001, "other_servers_to_apply": ["555a79e6fe7cd34664000006"]}' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/icecast/interface/552b5c760640fdfc14000003?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • ip - IP address of network interface to listen to.
  • port - port to listen to.
  • other_servers_to_apply - array of servers IDs, where this setting also should be created. Maximum 20 additional servers IDs can be included into one API call.
  • tags - custom tags for easy filtering on the settings web page.
All fields are optional.

Response example: 
{
    "status": "Ok",
    "interface": {
        "id": "552b5c760640fdfc14000003",
        "ip": "10.0.0.1",
        "port": 3001,
        "other_servers_applied": [
          {
            "setting_id": "62f9cfb12c47e55d553b8f0b",
            "server_id": "555a79e6fe7cd34664000006"
          }
        ]
    }
}
Response fields:
  • other_servers_applied - array containing data about settings created on other servers (from "other_servers_to_apply" request field). This field is returned, when request contained "other_servers_to_apply" field only. Each array item is a hash structure with following fields:
    • setting_id - new setting ID
    • server_id - server ID, where new setting was created
Other response fields are the same as in "Get an existing Icecast interface".

Delete an existing Icecast interface.
Request URL:
DELETE https://api.wmspanel.com/v1/server/[server_id]/icecast/interface/[interface_id]
Request parameters:

  • interface_id - is ID of the Icecast interface obtained via "Get Icecast interfaces list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/server/[server_id]/icecast/interface/552b5c760640fdfc14000003?client_id=[client_id]&api_key=[api_key]"

Response example: 
{
  "status" : "Ok",
}

Retrieve list of Icecast live pull settings for particular Nimble server. You can view this list by navigating to "Nimble Streamer / Live streams" menu item, then choosing appropriate Nimble server, then clicking on "Live streams settings" button and choosing "Live pull settings" tab.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/icecast/live_pull
Request parameters:

  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/icecast/live_pull?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "settings": [
        {
            "id": "547d151378a6fccf4d000002",
            "url": "http://example.com/live/ice/example.audio",
            "fallback_urls": [],
            "application": "123",
            "stream": "asd",
            "paused": true,
            "idle_time" : 0,
            "dynamic_stream" : false,
            "description": "Example",
            "tags": ["Examples"],
            "status": "paused"
        },
        {
            "id": "547d151378a6fccf4d000003",
            "url": "http://example.com/live/stream/fairytale.audio",
            "fallback_urls": [
                "http://yetanotherexample.com/live2/stream/fairytale.audio",
                "http://ihaveadream.example.com/live3/stream/fairytale.audio"
            ],
            "application": "nimble-app",
            "stream": "icecast",
            "paused": false,
            "idle_time" : 0,
            "dynamic_stream" : false,
            "description": "Fairy tale",
            "tags": ["Tales", "with fallback"],
            "status": "online",
            "active_url": "http://ihaveadream.example.com/live3/stream/fairytale.audio",
            "bandwidth": 4551329,
            "probe_interval": 600,
            "uptime": 7219
        },
        {
            "id": "547d151378a6fccf4d000004",
            "url": "http://ais2.rastamusic.com/live.audio",
            "fallback_urls": [],
            "application": "",
            "stream": "",
            "paused": false
            "idle_time" : 10,
            "dynamic_stream" : true,
            "description": "",
            "status": "online"
        }
    ]
}
Response fields:
  • id - unique Icecast live pull setting ID for further usage.
  • url - URL of incoming Icecast/SHOUTcast stream.
  • fallback_urls - list of fallback URLs of incoming Icecast/SHOUTcast stream for switching to in case of primary URL is inaccessible.
  • application - application name for outgoing streams.
  • stream - stream name for outgoing streams.
  • paused - whether given setting is currently inactivated.
  • idle_time - pull timeout (seconds). Starting from the moment when nobody requests specified stream, server continues pulling that stream during the timeout interval and then cuts it off.
  • dynamic_stream - specifies whether server tries to pull any stream belonging to the specified application from the given source in case it was requested.
  • description - custom description of pull setting.
  • status - current status of given stream. Can be one of the following values:
    • "pending" - appears when given stream is created, modified or resumed via UI or API call till the moment when server reports actual status of the stream
    • "online" - appears when media server reports that it was able to access given stream
    • "offline" - appears when media server reports that it has failed to access given stream
    • "paused" - appears when given stream is paused (postponed) via UI or API call
  • active_url - URL is using by Nimble at this moment. Returned only when stream has at least one fallback URL.
  • bandwidth - given stream's data transmission rate measured in bits per second.
  • probe_interval - time interval in seconds to check primary URL availability, when one of fallback URLs is used. Should be greater or equal to 30 and less or equal to 2592000 (30 days).
  • tags - custom tags for easy filtering on the settings web page.
  • uptime - time interval in seconds showing given stream uptime. Available only for non-dynamic streams having "online" or "pending" status.

Pick up a Icecast live pull setting
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/icecast/live_pull/[setting_id]
Request parameters:

  • setting_id - is ID of the Icecast live pull setting obtained via "Get Icecast live pull settings list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/icecast/live_pull/547d151378a6fccf4d000002?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "setting": {
        "id": "547d151378a6fccf4d000002",
        "url": "http://example.com/live/ice/example.audio",
        "fallback_urls": [],
        "application": "123",
        "stream": "asd",
        "paused": true,
        "idle_time" : 0,
        "dynamic_stream" : false,
        "description": "Example",
        "tags": ["Examples"],
        "status": "paused"
    }
}
Response fields:
  • id - unique Icecast live pull setting ID for further usage.
  • url - URL of incoming Icecast/SHOUTcast stream.
  • fallback_urls - list of fallback URLs of incoming Icecast/SHOUTcast stream for switching to in case of primary URL is inaccessible.
  • application - application name for outgoing streams.
  • stream - stream name for outgoing streams.
  • paused - whether given setting is currently inactivated.
  • idle_time - pull timeout (seconds). Starting from the moment when nobody requests specified stream, server continues pulling that stream during the timeout interval and then cuts it off.
  • dynamic_stream - specifies whether server tries to pull any stream belonging to the specified application from the given source in case it was requested.
  • description - custom description of pull setting.
  • tags - custom tags for easy filtering on the settings web page.
  • status - current status of given stream. Can be one of the following values:
    • "pending" - appears when given stream is created, modified or resumed via UI or API call till the moment when server reports actual status of the stream
    • "online" - appears when media server reports that it was able to access given stream
    • "offline" - appears when media server reports that it has failed to access given stream
    • "paused" - appears when given stream is paused (postponed) via UI or API call
  • active_url - URL is using by Nimble at this moment. Returned only when stream has at least one fallback URL.
  • bandwidth - given stream's data transmission rate measured in bits per second.
  • probe_interval - time interval in seconds to check primary URL availability, when one of fallback URLs is used. Should be greater or equal to 30 and less or equal to 2592000 (30 days).
  • uptime - time interval in seconds showing given stream uptime. Available only for non-dynamic streams having "online" or "pending" status.

Create a new Icecast live pull setting. Maximum 5000 settings can be created per server.
Request URL:
POST https://api.wmspanel.com/v1/server/[server_id]/icecast/live_pull
Request parameters:

  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{"url": "http://example.com/live-nimble/mystream/fairytale.audio", "description": "Fairy tale", "tags": ["Tales"]}' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/icecast/live_pull?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • url - URL of incoming Icecast/SHOUTcast stream.
  • fallback_urls (optional) - list of fallback URLs of incoming Icecast/SHOUTcast stream for switching to in case of primary URL is inaccessible.
  • application (optional) - application name for outgoing streams. If not specified, then application name for outgoing streams is taken from the URL of incoming stream. E.g. if incoming stream is http://127.0.0.1:8081/live-origin/mystream/playlist.m3u8 , then "live-origin" is assigned as application name for outgoing stream. If incoming stream doesn't contain application name, then it should be explicitly specified by this parameter.
  • stream (optional) - stream name for outgoing streams. If not specified, then stream name for outgoing stream is taken from the URL of incoming stream. E.g. if incoming stream is http://127.0.0.1:8081/live-origin/mystream/playlist.m3u8 , then "mystream" is assigned as stream name for outgoing stream. If incoming stream doesn't contain stream name, then it should be explicitly specified by this parameter.
  • paused (optional) - whether given setting is currently inactivated. Set this parameter to true if you want to pause a particular Icecast live pull setting or to false if you want to resume it.
  • idle_time (optional) - pull timeout (seconds). Starting from the moment when nobody requests specified stream, server continues pulling that stream during the timeout interval and then cuts it off.
  • dynamic_stream (optional) - specifies whether server tries to pull any stream belonging to the specified application from the given source in case it was requested.
  • description (optional) - custom description of pull setting.
  • tags (optional) - custom tags for easy filtering on the settings web page.
  • probe_interval - time interval in seconds to check primary URL availability, when one of fallback URLs is used. Should be greater or equal to 30 and less or equal to 2592000 (30 days).
  • other_servers_to_apply (optional) - array of servers IDs, where this setting also should be created. Maximum 20 additional servers IDs can be included into one API call.
Response example: 
    {
    "status": "Ok",
    "setting": {
        "id": "5526331a0640fd5ad6000002",
        "url": "http://example.com/live-nimble/mystream/fairytale.audio",
        "fallback_urls": [],
        "application": "",
        "stream": "",
        "paused": false,
        "idle_time" : 0,
        "dynamic_stream" : false,
        "description": "Fairy tale",
        "tags": ["Tales"],
        "status": "online",
        "other_servers_applied": [
            {
                "setting_id": "61fb6b3d2c47e52f12630662",
                "server_id": "555a79e6fe7cd34664000006"
            },
            {
                "setting_id": "61fb6b3d2c47e52f12630663",
                "server_id": "594a0845fe7cd3593d000005"
            }
        ]
    }
}
Response fields:
  • other_servers_applied - array containing data about settings created on other servers (from "other_servers_to_apply" request field). This field is returned, when request contained "other_servers_to_apply" field only. Each array item is a hash structure with following fields:
    • setting_id - new setting ID
    • server_id - server ID, where new setting was created
Other response fields are the same as in "Get an existing Icecast live pull setting".

Update an existing Icecast live pull setting.
Request URL:
PUT https://api.wmspanel.com/v1/server/[server_id]/icecast/live_pull/[setting_id]
Request parameters:

  • setting_id - is ID of the Icecast live pull setting obtained via "Get Icecast live pull settings list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"fallback_urls": ["http://example.com/live-nimble1/mystream/fairytale.audio", "http://anotherexample.com/live/stream/f.audio"], "application": "nimble-live", "stream": "mystream", "apply_immediately": true, "description": "Updated tale", "tags": ["Tales", "Updated"]}' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/icecast/live_pull/5526331a0640fd5ad6000002/?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • url - URL of incoming Icecast/SHOUTcast stream.
  • fallback_urls - list of fallback URLs of incoming Icecast/SHOUTcast stream for switching to in case of primary URL is inaccessible.
  • application - application name for outgoing streams.
  • stream - stream name for outgoing streams.
  • paused - whether given setting is currently inactivated. Set this parameter to true if you want to pause a particular Icecast live pull setting or to false if you want to resume it.
  • apply_immediately - whether this update must be applied immediately by corresponding Nimble server, resetting all relevant streams. If some of those streams are currently playing, then they will be restarted with new settings applied. If this parameter is not specified, then corresponding Nimble server will apply this update only after restart.
  • idle_time - pull timeout (seconds). Starting from the moment when nobody requests specified stream, server continues pulling that stream during the timeout interval and then cuts it off.
  • dynamic_stream - specifies whether server tries to pull any stream belonging to the specified application from the given source in case it was requested.
  • description - custom description of pull setting.
  • tags - custom tags for easy filtering on the settings web page.
  • probe_interval - time interval in seconds to check primary URL availability, when one of fallback URLs is used. Should be greater or equal to 30 and less or equal to 2592000 (30 days). Value 0 will remove probe_interval from setting.
  • other_servers_to_apply (optional) - array of servers IDs, where same setting also should be updated. If servers have settings with same parameters as main setting to be updated (specified in URL), then these settings will be also updated. Maximum 20 additional servers IDs can be included into one API call.
All fields are optional.

Response example: 
    {
    "status": "Ok",
    "setting": {
        "id": "5526331a0640fd5ad6000002",
        "url": "http://example.com/live-nimble/mystream/fairytale.audio",
        "fallback_urls": [
            "http://example.com/live-nimble1/mystream/fairytale.audio",
            "http://anotherexample.com/live/stream/f.audio"
        ],
        "application": "nimble-live",
        "stream": "mystream",
        "paused": false,
        "idle_time" : 0,
        "dynamic_stream" : false,
        "description": "Updated tale",
        "tags": ["Tales", "Updated"],
        "status": "online",
        "active_url": "http://example.com/live-nimble/mystream/fairytale.audio",
        "bandwidth": 4551329,
        "other_servers_applied": [
            {
                "setting_id": "61fb6b3d2c47e52f12630662",
                "server_id": "555a79e6fe7cd34664000006"
            },
            {
                "setting_id": "61fb6b3d2c47e52f12630663",
                "server_id": "594a0845fe7cd3593d000005"
            }
        ]
    }
}
Response fields:
  • other_servers_applied - array containing data about settings updated on other servers (from "other_servers_to_apply" request field). This field is returned, when request contained "other_servers_to_apply" field only. Each array item is a hash structure with following fields:
    • setting_id - new setting ID
    • server_id - server ID, where new setting was created
Other response fields are the same as in "Get an existing Icecast live pull setting".

Restart and existing Icecast live pull setting.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/icecast/live_pull/[setting_id]/restart
Request parameters:

  • setting_id - is ID of the Icecast live pull setting obtained via "Get Icecast live pull settings list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/icecast/live_pull/5526331a0640fd5ad6000002/restart?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
}

Delete an existing Icecast live pull setting.
Request URL:
DELETE https://api.wmspanel.com/v1/server/[server_id]/icecast/live_pull/[setting_id]
Request parameters:

  • setting_id - is ID of the Icecast live pull setting obtained via "Get Icecast live pull settings list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/icecast/live_pull/5526331a0640fd5ad6000002/?client_id=[client_id]&api_key=[api_key]"

Response example: 
    {
    "status" : "Ok",
}

Retrieve list of Icecast metadata settings for particular Nimble server. You can view this list by navigating to "Nimble Streamer / Live pull settings / Icecast metadata" menu item, then choosing appropriate Nimble server.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/icecast/metadata
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/552b56aa0640fd4e95000002/icecast/metadata?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
      "status": "Ok",
      "metadata": [
        {
          "id": "5b2313492c47e56f52a4d4c4",
          "application": "myapp1",
          "stream": "mystream1",
          "params": [
            {
              "name": "icy-name",
              "value": "My channel"
            },
            {
              "name": "icy-pub",
              "value": "1"
            },
            {
              "name": "icy-br",
              "value": "128"
            }
          ]
        },
        {
          "id": "5b2313512c47e56f52a4d4cc",
          "application": "myapp2",
          "stream": "mystream2",
          "params": [
            {
              "name": "icy-name",
              "value": "My second channel"
            },
            {
              "name": "icy-pub",
              "value": "1"
            },
            {
              "name": "ice-audio-info",
              "value": "bitrate=12"
            }
          ]
        }
      ]
    }
Response fields:
  • id - unique Icecast metadata ID for further usage.
  • application - application name.
  • stream - stream name.
  • params - An array of icecast metadata parameters.

Pick up a specific Icecast metadata setting
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/icecast/metadata/[metadata_id]
Request parameters:

  • metadata_id - is ID of the Icecast metadata setting obtained via "Get Icecast metadata list" method.
  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/icecast/metadata/5b2313492c47e56f52a4d4c4?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
      "status": "Ok",
      "metadata": {
        "id": "5b2313492c47e56f52a4d4c4",
        "application": "myapp1",
        "stream": "mystream1",
        "params": [
          {
            "name": "icy-name",
            "value": "My channel"
          },
          {
            "name": "icy-pub",
            "value": "1"
          },
          {
            "name": "icy-br",
            "value": "128"
          }
        ]
      }
    }
Response fields:
  • id - unique Icecast metadata ID for further usage.
  • application - application name.
  • stream - stream name.
  • params - An array of icecast metadata parameters.

Create a new Icecast metadata setting.
Request URL:
POST https://api.wmspanel.com/v1/server/[server_id]/icecast/metadata
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '[json_parameters]' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/icecast/metadata?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

JSON parameters for request example: 
    {
      "application": "myapp3",
      "stream": "mystream3",
      "params": [
          {
            "name": "icy-name",
            "value": "My channel"
          },
          {
            "name": "icy-pub",
            "value": "1"
          }
       ],
       "other_servers_to_apply": ["555a79e6fe7cd34664000006"]
    }


Request data fields:
  • application - application name.
  • stream - stream name.
  • params - An array of icecast metadata parameters.
  • other_servers_to_apply (optional) - array of servers IDs, where this setting also should be created. Maximum 20 additional servers IDs can be included into one API call.
Response example: 
    {
      "status": "Ok",
      "metadata": {
        "id": "5b2367b62c47e5103906eb55",
        "application": "myapp3",
        "stream": "mystream3",
        "params": [
          {
            "name": "icy-name",
            "value": "My channel"
          },
          {
            "name": "icy-pub",
            "value": "1"
          }
        ],
        "other_servers_applied": [
            {
                "setting_id": "62fb23d92c47e54cb770a9a7",
                "server_id": "555a79e6fe7cd34664000006"
            }
        ]
      }
    }
Response fields:
  • other_servers_applied - array containing data about settings created on other servers (from "other_servers_to_apply" request field). This field is returned, when request contained "other_servers_to_apply" field only. Each array item is a hash structure with following fields:
    • setting_id - new setting ID
    • server_id - server ID, where new setting was created
Other response fields are the same as in "Get an existing Icecast metadata setting".

Update an existing Icecast metadata setting.
Request URL:
PUT https://api.wmspanel.com/v1/server/[server_id]/icecast/metadata/[metadata_id]
Request parameters:

  • metadata_id - is ID of the Icecast metadata setting obtained via "Get Icecast metadata list" method.
  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '[json_parameters]' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/icecast/metadata/5b2367b62c47e5103906eb55?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

JSON parameters for request example: 
    {
      "application": "myapp3",
      "stream": "mystream3",
      "params": [
          {
            "name": "icy-name",
            "value": "My channel"
          },
          {
            "name": "icy-pub",
            "value": "0"
          },
          {
            "name": "icy-description",
            "value": "This is my description"
          }
       ],
       "other_servers_to_apply": ["555a79e6fe7cd34664000006"]
    }


Request data fields:
  • application - application name.
  • stream - stream name.
  • params - An array of icecast metadata parameters.
  • other_servers_to_apply - array of servers IDs, where this setting also should be created. Maximum 20 additional servers IDs can be included into one API call.
All fields are optional.

Response example: 
    {
      "status": "Ok",
      "metadata": {
        "id": "5b2367b62c47e5103906eb55",
        "application": "myapp3",
        "stream": "mystream3",
        "params": [
          {
            "name": "icy-name",
            "value": "My channel"
          },
          {
            "name": "icy-pub",
            "value": "0"
          },
          {
            "name": "icy-description",
            "value": "This is my description"
          }
        ],
        "other_servers_applied": [
            {
                "setting_id": "62fb23d92c47e54cb770a9a7",
                "server_id": "555a79e6fe7cd34664000006"
            }
        ]
      }
    }
Response fields:
  • other_servers_applied - array containing data about settings created on other servers (from "other_servers_to_apply" request field). This field is returned, when request contained "other_servers_to_apply" field only. Each array item is a hash structure with following fields:
    • setting_id - new setting ID
    • server_id - server ID, where new setting was created
Other response fields are the same as in "Get an existing Icecast metadata setting".

Delete an existing Icecast metadata setting.
Request URL:
DELETE https://api.wmspanel.com/v1/server/[server_id]/icecast/metadata/[metadata_id]
Request parameters:

  • metadata_id - is ID of the Icecast metadata metadata obtained via "Get Icecast metadata list" method.
  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/server/[server_id]/icecast/metadata/5b2313492c47e56f52a4d4c4?client_id=[client_id]&api_key=[api_key]"

Response example: 
    {
      "status" : "Ok",
    }

Retrieve list of incoming MPEGTS streams for particular Nimble server. You can view this list by navigating to "Nimble Streamer / Live streams" menu item, then choosing appropriate Nimble server, then clicking on "Live streams settings" button and choosing "MPEGTS In" tab.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/mpegts/incoming
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/[server_id]/mpegts/incoming?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "streams": [
        {
            "id": "5747cf450823891317000001",
            "status": "online",
            "protocol": "http",
            "probe_interval": 600,
            "url": "http://84.141.37.68:2233/udp/223.68.114.183:44444",
            "fallback_urls": [
              "http://84.141.37.69:2233/udp/st1",
              "http://84.141.37.70:8081/hls/fb/playlist.m3u8"
            ],
            "fallbacks": [{
              url: "http://84.141.37.69:2233/udp/st1",
              protocol: 'http'
            }, {
              url: "http://84.141.37.70:8081/hls/fb/playlist.m3u8",
              protocol: 'hls'
            }],
            "name": "NSGTRK",
            "active_url": "http://84.141.37.70:8081/hls/fb/playlist.m3u8",
            "description": "TV Channel #1",
            "pmts": [
                {
                    "id": 32,
                    "pids": [
                        {
                            "pid": 33,
                            "type": "H.264 Video"
                        },
                        {
                            "pid": 36,
                            "type": "MPEG-2 AAC Audio"
                        }
                    ]
                }
            ],
            "bandwidth": 32699,
            "tags": ["TV"]
        },
        {
            "id": "5748307e0823891558000001",
            "status": "pending",
            "protocol": "udp",
            "ip": "224.168.1.2",
            "port": 2222,
            "multicast_ip": "10.10.10.21",
            "multicast_source_ip": "10.10.10.22",
            "socket_reuse": "Enabled",
            "description": "Meeting room main camera",
            "tags": ["office", "meeting room"]
        },
        {
          "id": "5b35c6dd2c47e50c372a982e",
          "status": "pending",
          "protocol": "srt",
          "ip": "127.0.0.7",
          "port": 4321,
          "receive_mode": "rendezvous",
          "rendezvous_ip": "127.0.0.4",
          "rendezvous_port": 1234,
          "parameters": {
            "custom_param1": "custom_value1",
            "custom_param2": "custom_value2",
            "custom_param3": "custom_value3",
          },
          "redundancy_addresses": [
            {
              "address": "127.0.0.1",
              "port": 2327
            },
            {
              "address": "fallback.test.com",
              "port": 1234
            }
          ],
          "name": "SRT Stream 4",
          "description": "Warehouse entrance",
          "tags": ['warehouse', 'entrance']
        }
    ]
}
Response fields:
  • id - unique incoming MPEGTS stream ID for further usage.
  • name - a name of given stream in the MPEGTS In section of Live streams settings UI.
  • description - custom description of the MPEGTS stream.
  • tags - custom tags for easy filtering on the settings web page.
  • status - current status of given stream. Can be one of the following values:
    • "pending" - appears when given stream is created, modified or resumed via UI or API call till the moment when server reports actual status of the stream
    • "online" - appears when media server reports that it was able to access given stream
    • "offline" - appears when media server reports that it has failed to access given stream
    • "paused" - appears when given stream is paused (postponed) via UI or API call
  • protocol - given stream's protocol. Can be HTTP, HLS, UDP, SRT, RIST or Zixi.
  • ip - IP address (unicast or multicast) that given stream is targeted to. Applicable only for UDP, SRT, RIST or Zixi streams. For SRT streams with receive_mode parameter set to 'pull', the ip parameter can be represented as a domain name. For Zixi streams with receive_mode parameter set to 'listen', the ip parameter is empty.
  • port - port number that given stream is targeted to. Applicable only for UDP, SRT, RIST and Zixi streams. For Zixi streams with receive_mode parameter set to 'listen', the port parameter is empty.
  • socket_reuse - defines whether Nimble Streamer should allow other applications to connect to the same IP address and port as defined for given stream. Applicable only for UDP streams. Can be one of the following values: "Enabled", "Disabled" and "Default" (default operating system behavior).
  • multicast_ip - IP address of multicast interface that given stream should be received from. Applicable only for multicast UDP streams.
  • multicast_source_ip - source IP address of multicast interface (RFC 4607 "Source-Specific Multicast"). Applicable only for multicast UDP streams.
  • url - URL of given stream. Applicable only for HTTP and HLS streams.
  • fallback_urls (deprecated in favor of 'fallbacks' field) - list of fallback URLs of incoming HTTP/HLS stream for switching to in case of primary URL is inaccessible. Applicable only for HTTP and HLS streams.
  • fallbacks - array of fallback objects. Each object consists of two fields:
    • "url" - fallback stream URL for switching to in case of primary URL is inaccessible
    • "protocol" - fallback stream protocol (can be either 'http' or 'hls')
    Applicable only for HTTP and HLS streams.
  • probe_interval - time interval in seconds to check primary URL availability, when one of fallback URLs is used. Should be greater or equal to 30 and less or equal to 2592000 (30 days). Applicable only for HTTP, HLS and SRT (in pull receive mode) streams.
  • active_url - URL is using by Nimble at this moment. Returned only when stream has at least one fallback URL or redundancy address. Applicable only for HTTP, HLS and SRT (in pull mode) streams.
  • pmts - array of PMT (Program Map Table) entries for every program of given stream containing PID (Packet ID) numbers for each elementary stream inside each program. PID values can be used for setting specific elementary streams in outgoing MPEGTS streams.
  • bandwidth - given stream's data transmission rate measured in bits per second.
  • receive_mode - stream's receive mode. Applicable for SRT, RIST and Zixi streams only. Can be "listen", "pull" or "rendezvous" for SRT, "listen" or "pull" for RIST and Zixi.
  • rendezvous_ip - IP address in rendezvous mode. Applicable for SRT streams only.
  • rendezvous_port - port number in rendezvous mode. Applicable for SRT streams only.
  • parameters - JSON object containing custom parameters. Applicable for SRT, RIST and Zixi streams only.
  • redundancy_addresses - array of SRT pull redundancy addresses. Each address is represented by JSON object with two fields:
    • "address" - IP address or domain name
    • "port" - port number
    Applicable for SRT streams in pull receive mode only.

Pick up an existing incoming MPEGTS stream.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/mpegts/incoming/[stream_id]
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • stream_id - is ID of incoming MPEGTS stream obtained via "Get incoming MPEGTS streams list" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/[server_id]/mpegts/incoming/5747cf450823891317000001?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "stream": {
        "id": "5747cf450823891317000001",
        "status": "online",
        "protocol": "http",
        "probe_interval": 600,
        "url": "http://84.141.37.68:2233/udp/223.68.114.183:44444",
        "fallback_urls": [
          "http://84.141.37.69:2233/udp/st1",
          "http://84.141.37.70:8081/hls/fb/playlist.m3u8"
        ],
        "fallbacks": [{
          url: "http://84.141.37.69:2233/udp/st1",
          protocol: 'http'
        }, {
          url: "http://84.141.37.70:8081/hls/fb/playlist.m3u8",
          protocol: 'hls'
        }],
        "name": "NSGTRK",
        "description": "TV Channel #1",
        "active_url": "http://84.141.37.70:8081/hls/fb/playlist.m3u8",
        "pmts": [
            {
                "id": 32,
                "pids": [
                    {
                        "pid": 33,
                        "type": "H.264 Video"
                    },
                    {
                        "pid": 36,
                        "type": "MPEG-2 AAC Audio"
                    }
                ]
            }
        ],
        "bandwidth": 32699,
        "tags": ["TV"]
    }
}
Response fields:
  • id - unique incoming MPEGTS stream ID for further usage.
  • name - a name of given stream in the MPEGTS In section of Live streams settings UI.
  • description - custom description of the MPEGTS stream.
  • tags - custom tags for easy filtering on the settings web page.
  • status - current status of given stream. Can be one of the following values:
    • "pending" - appears when given stream is created, modified or resumed via UI or API call till the moment when server reports actual status of the stream
    • "online" - appears when media server reports that it was able to access given stream
    • "offline" - appears when media server reports that it has failed to access given stream
    • "paused" - appears when given stream is paused (postponed) via UI or API call
  • protocol - given stream's protocol. Can be HTTP, HLS, UDP, SRT, RIST or Zixi.
  • ip - IP address (unicast or multicast) that given stream is targeted to. Applicable only for UDP, SRT, RIST and Zixi streams. For SRT streams with the receive_mode parameter set to 'pull', the ip parameter can be represented as a domain name. For Zixi streams with receive_mode parameter set to 'listen', the ip parameter is empty.
  • port - port number that given stream is targeted to. Applicable only for UDP, SRT, RIST and Zixi streams. For Zixi streams with receive_mode parameter set to 'listen', the port parameter is empty.
  • socket_reuse - defines whether Nimble Streamer should allow other applications to connect to the same IP address and port as defined for given stream. Applicable only for UDP streams. Can be one of the following values: "Enabled", "Disabled" and "Default" (default operating system behavior).
  • multicast_ip - IP address of multicast interface that given stream should be received from. Applicable only for multicast UDP streams.
  • multicast_source_ip - source IP address of multicast interface (RFC 4607 "Source-Specific Multicast"). Applicable only for multicast UDP streams.
  • url - URL of given stream. Applicable only for HTTP and HLS streams.
  • fallback_urls (deprecated in favor of 'fallbacks' field) - list of fallback URLs of incoming HTTP/HLS stream for switching to in case of primary URL is inaccessible. Applicable only for HTTP and HLS streams.
  • fallbacks - array of fallback objects. Each object consists of two fields:
    • "url" - fallback stream URL for switching to in case of primary URL is inaccessible
    • "protocol" - fallback stream protocol (can be either 'http' or 'hls')
    Applicable only for HTTP and HLS streams.
  • probe_interval - time interval in seconds to check primary URL availability, when one of fallback URLs is used. Should be greater or equal to 30 and less or equal to 2592000 (30 days). Applicable only for HTTP, HLS and SRT (in pull receive mode) streams.
  • active_url - URL is using by Nimble at this moment. Returned only when stream has at least one fallback URL or redundancy address. Applicable only for HTTP, HLS and SRT (in pull mode) streams.
  • pmts - array of PMT (Program Map Table) entries for every program of given stream containing PID (Packet ID) numbers for each elementary stream inside each program. PID values can be used for setting specific elementary streams in outgoing MPEGTS streams.
  • bandwidth - given stream's data transmission rate measured in bits per second.
  • receive_mode - stream's receive mode. Applicable for SRT, RIST and Zixi streams only. Can be "listen", "pull" or "rendezvous" for SRT, "listen" or "pull" for RIST and Zixi.
  • rendezvous_ip - IP address in rendezvous mode. Applicable for SRT streams only.
  • rendezvous_port - port number in rendezvous mode. Applicable for SRT streams only.
  • parameters - JSON object containing custom parameters. Applicable for SRT, RIST and Zixi streams only.
  • redundancy_addresses - array of SRT pull redundancy addresses. Each address is represented by JSON object with two fields:
    • "address" - IP address or domain name
    • "port" - port number
    Applicable for SRT streams in pull receive mode only.

Create a new incoming MPEGTS stream.
Request URL:
POST https://api.wmspanel.com/v1/server/[server_id]/mpegts/incoming
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{"protocol": "udp", "ip": "224.22.22.22", "multicast_ip": "10.10.10.21", "port": 1234, "other_servers_to_apply": ["555a79e6fe7cd34664000006"]}' "https://api.wmspanel.com/v1/server/[server_id]/mpegts/incoming?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • protocol - given stream's protocol. Can be "http", "hls", "udp", "srt", "rist" or "zixi". It's not possible to change it after a stream creation.
  • ip - IP address (unicast or multicast) that given stream is targeted to. Applicable for UDP, SRT, RIST and Zixi streams. For SRT streams with the receive_mode parameter set to 'pull', the ip parameter can be represented as a domain name. For Zixi streams with receive_mode parameter set to 'listen', the ip parameter is empty.
  • port - port number that given stream is targeted to. Applicable for UDP, SRT, RIST and Zixi streams. For Zixi streams with receive_mode parameter set to 'listen', the port parameter is empty.
  • url - URL of given stream. Applicable only for HTTP and HLS streams.
  • fallback_urls (deprecated in favor of 'fallbacks' field) - list of fallback URLs of incoming HTTP/HLS stream for switching to in case of primary URL is inaccessible. Applicable only for HTTP and HLS streams.
  • fallbacks - (optional) array of fallback objects. Each object consists of two fields:
    • "url" - fallback stream URL for switching to in case of primary URL is inaccessible
    • "protocol" - fallback stream protocol (can be either 'http' or 'hls')
    Applicable only for HTTP and HLS streams.
  • probe_interval - (optional) time interval in seconds to check primary URL availability, when one of fallback URLs is used. Should be greater or equal to 30 and less or equal to 2592000 (30 days). Value 0 will remove this setting. Applicable only for HTTP, HLS and SRT (in pull receive mode) streams.
  • name (optional) - a name of given stream in the MPEGTS In section of Live streams settings UI.
  • description (optional) - custom description of the MPEGTS stream.
  • tags (optional) - custom tags for easy filtering on the settings web page.
  • socket_reuse (optional) - defines whether Nimble Streamer should allow other applications to connect to the same IP address and port as defined for given stream. Applicable only for UDP streams. Can be one of the following values: "Enabled", "Disabled" and "Default" (default operating system behavior).
  • multicast_ip (optional) - IP address of multicast interface that given stream should be received from. Applicable only for multicast UDP streams.
  • multicast_source_ip (optional) - source IP address of multicast interface (RFC 4607 "Source-Specific Multicast"). Applicable only for multicast UDP streams.
  • add_outgoing_stream (optional) - requires to create corresponding outgoing MPEGTS stream automaticlly. Can be true or false.
  • outgoing_app_name (optional) - application name for corresponding outgoing MPEGTS stream. Can be omitted for HLS and HTTP streams. In this case app name parsed from URL will be used.
  • outgoing_stream_name (optional) - stream name for corresponding outgoing MPEGTS stream. Can be omitted for HLS and HTTP streams. In this case stream name parsed from URL will be used.
  • receive_mode - stream's receive mode. Applicable for SRT, RIST and Zixi streams only. Can be "listen", "pull" or "rendezvous" for SRT, "listen" or "pull" for RIST and Zixi.
  • rendezvous_ip (optional) - IP address in rendezvous mode. Applicable for SRT streams only.
  • rendezvous_port (optional) - port number in rendezvous mode. Applicable for SRT streams only.
  • parameters (optional) - JSON object containing custom parameters. Applicable for SRT, RIST and Zixi streams. For Zixi in 'listen' mode not empty 'stream' parameter must be included. For Zixi in 'pull' mode both 'stream' and 'source' parameters must be included.
  • redundancy_addresses (optional) - array of SRT pull redundancy addresses. Each address is represented by JSON object with two fields:
    • "address" - IP address or domain name
    • "port" - port number
    Applicable for SRT streams in pull receive mode only.
  • other_servers_to_apply (optional) - array of servers IDs, where this setting also should be created. Maximum 20 additional servers IDs can be included into one API call.
Response example: 
    {
    "status": "Ok",
    "stream": {
        "id": "574d3f84082389251f000021",
        "status": "pending",
        "protocol": "udp",
        "ip": "224.22.22.22",
        "port": 1234,
        "multicast_ip": "10.10.10.21",
        "socket_reuse": "Default",
        "description": "Meeting room main camera",
        "tags": ["office", "meeting room"],
        "other_servers_applied": [
            {
                "setting_id": "62fef6b52c47e50c4a60e8ea",
                "server_id": "555a79e6fe7cd34664000006"
            }
        ]
    }
}
Response fields:
  • other_servers_applied - array containing data about settings created on other servers (from "other_servers_to_apply" request field). This field is returned, when request contained "other_servers_to_apply" field only. Each array item is a hash structure with following fields:
    • setting_id - new setting ID
    • server_id - server ID, where new setting was created
Other response fields are the same as in "Get an existing incoming MPEGTS stream".

Update an existing incoming MPEGTS stream.
Request URL:
PUT https://api.wmspanel.com/v1/server/[server_id]/mpegts/incoming/[stream_id]
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • stream_id - is ID of incoming MPEGTS stream obtained via "Get incoming MPEGTS streams list" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"name": "Local video", "socket_reuse": "Enabled", "other_servers_to_apply": ["555a79e6fe7cd34664000006"]}' "https://api.wmspanel.com/v1/server/[server_id]/mpegts/incoming/57465df0082389437a000009?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • ip - IP address (unicast or multicast) that given stream is targeted to. Applicable for UDP, SRT, RIST and Zixi streams. For SRT streams with the receive_mode parameter set to 'pull', the ip parameter can be represented as a domain name. For Zixi streams with receive_mode parameter set to 'listen', the ip parameter is empty.
  • port - port number that given stream is targeted to. Applicable for UDP, SRT, RIST and Zixi streams. For Zixi streams with receive_mode parameter set to 'listen', the port parameter is empty.
  • url - URL of given stream. Applicable only for HTTP and HLS streams.
  • fallback_urls (deprecated in favor of 'fallbacks' field) - list of fallback URLs of incoming HTTP/HLS stream for switching to in case of primary URL is inaccessible. Applicable only for HTTP and HLS streams.
  • fallbacks - array of fallback objects. Each object consists of two fields:
    • "url" - fallback stream URL for switching to in case of primary URL is inaccessible
    • "protocol" - fallback stream protocol (can be either 'http' or 'hls')
    Applicable only for HTTP and HLS streams.
  • probe_interval - time interval in seconds to check primary URL availability, when one of fallback URLs is used. Should be greater or equal to 30 and less or equal to 2592000 (30 days). Value 0 will remove this setting. Applicable only for HTTP, HLS and SRT (in pull receive mode) streams.
  • name - name of given stream in the MPEGTS In section of Live streams settings UI.
  • description - custom description of the MPEGTS stream.
  • tags - custom tags for easy filtering on the settings web page.
  • socket_reuse - defines whether Nimble Streamer should allow other applications to connect to the same IP address and port as defined for given stream. Applicable only for UDP streams. Can be one of the following values: "Enabled", "Disabled" and "Default" (default operating system behavior).
  • multicast_ip - IP address of multicast interface that given stream should be received from. Applicable only for multicast UDP streams.
  • multicast_source_ip - source IP address of multicast interface (RFC 4607 "Source-Specific Multicast"). Applicable only for multicast UDP streams.
  • receive_mode - stream's receive mode. Applicable for SRT, RIST and Zixi streams only. Can be "listen", "pull" or "rendezvous" for SRT, "listen" or "pull" for RIST and Zixi.
  • rendezvous_ip - IP address in rendezvous mode. Applicable for SRT streams only.
  • rendezvous_port - port number in rendezvous mode. Applicable for SRT streams only.
  • parameters - JSON object containing custom parameters. Applicable for SRT, RIST and Zixi streams. For Zixi in 'listen' mode not empty 'stream' parameter must be included. For Zixi in 'pull' mode both 'stream' and 'source' parameters must be included.
  • redundancy_addresses - array of SRT pull redundancy addresses. Each address is represented by JSON object with two fields:
    • "address" - IP address or domain name
    • "port" - port number
    Applicable for SRT streams in pull receive mode only.
  • other_servers_to_apply - array of servers IDs, where this setting also should be created. Maximum 20 additional servers IDs can be included into one API call.
All fields are optional.

Response example: 
    {
    "status": "Ok",
    "stream": {
        "id": "574d3f84082389251f000021",
        "status": "pending",
        "protocol": "udp",
        "ip": "224.22.22.22",
        "port": 1234,
        "multicast_ip": "10.10.10.21",
        "socket_reuse": "Enabled",
        "name": "Local video",
        "description": "",
        "other_servers_applied": [
            {
                "setting_id": "62fef6b52c47e50c4a60e8ea",
                "server_id": "555a79e6fe7cd34664000006"
            }
        ]
    }
}
Response fields:
  • other_servers_applied - array containing data about settings created on other servers (from "other_servers_to_apply" request field). This field is returned, when request contained "other_servers_to_apply" field only. Each array item is a hash structure with following fields:
    • setting_id - new setting ID
    • server_id - server ID, where new setting was created
Other response fields are the same as in "Get an existing incoming MPEGTS stream".

Delete an existing incoming MPEGTS stream.
Request URL:
DELETE https://api.wmspanel.com/v1/server/[server_id]/mpegts/incoming/[stream_id]
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • stream_id - is ID of incoming MPEGTS stream obtained via "Get incoming MPEGTS streams list" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/server/[server_id]/mpegts/incoming/574d3f84082389251f000021/?client_id=[client_id]&api_key=[api_key]"

Response example: 
  {
    "status" : "Ok",
  }

Pause specific incoming MPEGTS stream.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/mpegts/incoming/[stream_id]/pause
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • stream_id - is ID of incoming MPEGTS stream obtained via "Get incoming MPEGTS streams list" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl "https://api.wmspanel.com/v1/server/[server_id]/mpegts/incoming/574d3f84082389251f000021/pause?client_id=[client_id]&api_key=[api_key]"

Response example: 
  {
    "status" : "Ok",
  }

Resume specific incoming MPEGTS stream.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/mpegts/incoming/[stream_id]/resume
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • stream_id - is ID of incoming MPEGTS stream obtained via "Get incoming MPEGTS streams list" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl "https://api.wmspanel.com/v1/server/[server_id]/mpegts/incoming/574d3f84082389251f000021/resume?client_id=[client_id]&api_key=[api_key]"

Response example: 
  {
    "status" : "Ok",
  }

Restart an existing incoming MPEGTS stream
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/mpegts/incoming/[stream_id]/restart
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • stream_id - is ID of incoming MPEGTS stream obtained via "Get incoming MPEGTS streams list" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/mpegts/incoming/574d5482082389251f000022/restart?client_id=[client_id]&api_key=[api_key]'
Response example: 
  {
    "status": "Ok",
  }

Retrieve list of outgoing MPEGTS streams for particular Nimble server. You can view this list by navigating to "Nimble Streamer / Live streams" menu item, then choosing appropriate Nimble server, then clicking on "Live streams settings" button and choosing "MPEGTS Out" tab.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/mpegts/outgoing
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/[server_id]/mpegts/outgoing?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "streams": [
        {
            "id": "574be1c2082389251f000001",
            "status": "synced",
            "application": "nimble_live",
            "stream": "nsgtv",
            "description": "World of Tanks",
            "tags": ["WOT", "regular"],
            "paused": false,
            "video_source": {
                "id": "5747cf450823891317000001"
            },
            "audio_source": {
                "id": "5747cf450823891317000001",
                "language_code": "eng"
            }
        },
        {
            "id": "574be1fa082389251f000003",
            "status": "synced",
            "application": "nimble_live",
            "stream": "nsgtv_full",
            "description": "World of Tanks (premium)",
            "tags": ["WOT", "premium"],
            "paused": true,
            "raw_source_id": "5747cf450823891317000001"
        },
        {
            "id": "574be212082389251f000004",
            "status": "synced",
            "application": "nimble_live",
            "stream": "nsgtv_vonly",
            "description": "Boxing Live",
            "tags": ["Live sports", "Boxing"],
            "paused": false,
            "video_source": {
                "id": "5747cf450823891317000001",
                "pid": 33
            }
        },
        {
            "id": "574be222082389251f000005",
            "status": "synced",
            "application": "nimble_live",
            "stream": "nsgtv_aonly",
            "description": "Sports News",
            "tags": ["Live sports", "News"],
            "paused": false,
            "audio_source": {
                "id": "5747cf450823891317000001"
            }
        }
    ]
}
Response fields:
  • id - unique outgoing MPEGTS stream ID for further usage.
  • status - current status of given stream. Can be either "pending" (not yet synchronized with media server) or "synced" (synchronized with media server).
  • application - application name of given stream.
  • stream - stream name of given stream.
  • description - custom description of given stream.
  • tags - custom tags for easy filtering on the settings web page.
  • paused - defines whether given setting isn't active at the moment.
  • video_source - video source object containing the following parameters:
    • id - incoming MPEGTS stream ID, that can be obtained via "Get incoming MPEGTS streams list" API call
    • pid - PID (Packet ID) of specific elementary stream from given incoming MPEGTS stream. If not specified, then first elementary video stream is implied. If PID value is 0, then stream index will be used from "index" parameter.
    • index - elementary stream index from given incoming MPEGTS stream. Should be from 0 to 64 range.
  • audio_source - audio source object containing the following parameters:
    • id - incoming MPEGTS stream ID, that can be obtained via "Get incoming MPEGTS streams list" API call
    • pid - PID (Packet ID) of specific elementary stream from given incoming MPEGTS stream. If not specified, then first elementary audio stream is implied. If PID value is 0, then stream index will be used from "index" parameter.
    • index - elementary stream index from given incoming MPEGTS stream. Should be from 0 to 64 range.
    • language_code - three characters language code, e.g. "eng".
  • raw_source_id - incoming MPEGTS stream ID, that can be obtained via "Get incoming MPEGTS streams list" API call. This field is used to set single source without any additional video/audio details.

Pick up an existing outgoing MPEGTS stream.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/mpegts/outgoing/[stream_id]
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • stream_id - is ID of outgoing MPEGTS stream obtained via "Get outgoing MPEGTS streams list" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/[server_id]/mpegts/outgoing/574be1fa082389251f000003?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "stream": {
        "id": "574be1fa082389251f000003",
        "status": "synced",
        "application": "nimble_live",
        "stream": "nsgtv_full",
        "description": "World of Tanks (premium)",
        "tags": ["WOT", "premium"],
        "paused": false,
        "video_source": {
            "id": "5747cf450823891317000001",
            "pid": 33
        },
        "audio_source": {
            "id": "5747cf450823891317000001",
            "pid": 0,
            "index": 1,
            "language_code": "eng"
        }
    }
}
Response fields:
  • id - unique outgoing MPEGTS stream ID for further usage.
  • status - current status of given stream. Can be either "pending" (not yet synchronized with media server) or "synced" (synchronized with media server).
  • application - application name of given stream.
  • stream - stream name of given stream.
  • description - custom description of given stream.
  • tags - custom tags for easy filtering on the settings web page.
  • paused - defines whether given setting isn't active at the moment.
  • video_source - video source object containing the following parameters:
    • id - incoming MPEGTS stream ID, that can be obtained via "Get incoming MPEGTS streams list" API call
    • pid - PID (Packet ID) of specific elementary stream from given incoming MPEGTS stream. If not specified, then first elementary video stream is implied. If PID value is 0, then stream index will be used from "index" parameter.
    • index - elementary stream index from given incoming MPEGTS stream. Should be from 0 to 64 range.
  • audio_source - audio source object containing the following parameters:
    • id - incoming MPEGTS stream ID, that can be obtained via "Get incoming MPEGTS streams list" API call
    • pid - PID (Packet ID) of specific elementary stream from given incoming MPEGTS stream. If not specified, then first elementary audio stream is implied. If PID value is 0, then stream index will be used from "index" parameter.
    • index - elementary stream index from given incoming MPEGTS stream. Should be from 0 to 64 range.
    • language_code - three characters language code, e.g. "eng".
  • raw_source_id - incoming MPEGTS stream ID, that can be obtained via "Get incoming MPEGTS streams list" API call. This field is used to set single source without any additional video/audio details.

Create a new outgoing MPEGTS stream.
Request URL:
POST https://api.wmspanel.com/v1/server/[server_id]/mpegts/outgoing
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{"application": "opentv", "stream": "tvbox", "description": "CS:GO", "tags": ["Games", "CS"], "video_source": {"id": "5747cf450823891317000001"}, "audio_source": {"id": "5747cf450823891317000001"}, "other_servers_to_apply": ["555a79e6fe7cd34664000006"]}' "https://api.wmspanel.com/v1/server/[server_id]/mpegts/outgoing?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • application - application name of given stream.
  • stream - stream name of given stream.
  • description (optional) - custom description of given stream.
  • tags (optional) - custom tags for easy filtering on the settings web page.
  • video_source (optional) - video source object containing the following parameters:
    • id - incoming MPEGTS stream ID, that can be obtained via "Get incoming MPEGTS streams list" API call
    • pid - PID (Packet ID) of specific elementary stream from given incoming MPEGTS stream. If not specified, then first elementary video stream is implied. If PID value is 0, then stream index will be used from "index" parameter.
    • index - elementary stream index from given incoming MPEGTS stream. Should be from 0 to 64 range.
  • audio_source (optional) - audio source object containing the following parameters:
    • id - incoming MPEGTS stream ID, that can be obtained via "Get incoming MPEGTS streams list" API call
    • pid - PID (Packet ID) of specific elementary stream from given incoming MPEGTS stream. If not specified, then first elementary audio stream is implied. If PID value is 0, then stream index will be used from "index" parameter.
    • index - elementary stream index from given incoming MPEGTS stream. Should be from 0 to 64 range.
    • language_code (optional) - three characters language code, e.g. "eng".
  • raw_source_id (optional) - incoming MPEGTS stream ID, that can be obtained via "Get incoming MPEGTS streams list" API call. This field is used to set single source without any additional video/audio details. If this parameter is specified, then "video_source" and "audio_source" will be ignored.
  • other_servers_to_apply (optional) - array of servers IDs, where this setting also should be created. Maximum 20 additional servers IDs can be included into one API call.
Response example: 
    {
    "status": "Ok",
    "stream": {
        "id": "574d5482082389251f000022",
        "status": "pending",
        "application": "opentv",
        "stream": "tvbox",
        "description": "CS:GO",
        "tags": ["Games", "CS"],
        "video_source": {
            "id": "5747cf450823891317000001"
        },
        "audio_source": {
            "id": "5747cf450823891317000001"
        },
        "other_servers_applied": [
          {
              "setting_id": "6304659f2c47e51fe8ffb51f",
              "server_id": "555a79e6fe7cd34664000006"
          }
        ]
    }
}
Response fields:
  • other_servers_applied - array containing data about settings created on other servers (from "other_servers_to_apply" request field). This field is returned, when request contained "other_servers_to_apply" field only. Each array item is a hash structure with following fields:
    • setting_id - new setting ID
    • server_id - server ID, where new setting was created
Other response fields are the same as in "Get an existing outgoing MPEGTS stream".

Update an existing outgoing MPEGTS stream.
Request URL:
PUT https://api.wmspanel.com/v1/server/[server_id]/mpegts/outgoing/[stream_id]
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • stream_id - is ID of outgoing MPEGTS stream obtained via "Get outgoing MPEGTS streams list" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"stream": "tvbox_vonly", "video_source": {"id": "5747cf450823891317000001", "pid": 33}, "audio_source": {}, "other_servers_to_apply": ["555a79e6fe7cd34664000006"]}' "https://api.wmspanel.com/v1/server/[server_id]/mpegts/outgoing/574d5482082389251f000022?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • application - application name of given stream.
  • stream - stream name of given stream.
  • description - custom description of given stream.
  • tags - custom tags for easy filtering on the settings web page.
  • video_source - video source object containing the following parameters:
    • id - incoming MPEGTS stream ID, that can be obtained via "Get incoming MPEGTS streams list" API call
    • pid - PID (Packet ID) of specific elementary stream from given incoming MPEGTS stream. If not specified, then first elementary video stream is implied. If PID value is 0, then stream index will be used from "index" parameter.
    • index - elementary stream index from given incoming MPEGTS stream. Should be from 0 to 64 range.
    If you wish to remove video_source, then empty object value should be passed (i.e. video_source: {})
  • audio_source - audio source object containing the following parameters:
    • id - incoming MPEGTS stream ID, that can be obtained via "Get incoming MPEGTS streams list" API call
    • pid - PID (Packet ID) of specific elementary stream from given incoming MPEGTS stream. If not specified, then first elementary audio stream is implied. If PID value is 0, then stream index will be used from "index" parameter.
    • index - elementary stream index from given incoming MPEGTS stream. Should be from 0 to 64 range.
    • language_code - three characters language code, e.g. "eng".
    If you wish to remove audio_source, then empty object value should be passed (i.e. audio_source: {})
  • raw_source_id - incoming MPEGTS stream ID, that can be obtained via "Get incoming MPEGTS streams list" API call. This field is used to set single source without any additional video/audio details. If this parameter is specified, then "video_source" and "audio_source" will be ignored. If you wish to remove raw_source_id, then send update request with valid video_source or audio_source and without raw_source_id. In this case raw_source_id will be removed.
  • other_servers_to_apply - array of servers IDs, where this setting also should be created. Maximum 20 additional servers IDs can be included into one API call.
All fields are optional.

Response example: 
    {
    "status": "Ok",
    "stream": {
        "id": "574d5482082389251f000022",
        "status": "pending",
        "application": "opentv",
        "stream": "tvbox_vonly",
        "description": "",
        "video_source": {
            "id": "5747cf450823891317000001",
            "pid": 33
        },
        "other_servers_applied": [
          {
            "setting_id": "62f9cfb12c47e55d553b8f0b",
            "server_id": "555a79e6fe7cd34664000006"
          }
        ]
    }
}
Response fields:
  • other_servers_applied - array containing data about settings created on other servers (from "other_servers_to_apply" request field). This field is returned, when request contained "other_servers_to_apply" field only. Each array item is a hash structure with following fields:
    • setting_id - new setting ID
    • server_id - server ID, where new setting was created
Other response fields are the same as in "Get an existing outgoing MPEGTS stream".

Delete an existing outgoing MPEGTS stream.
Request URL:
DELETE https://api.wmspanel.com/v1/server/[server_id]/mpegts/outgoing/[stream_id]
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • stream_id - is ID of outgoing MPEGTS stream obtained via "Get outgoing MPEGTS streams list" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/server/[server_id]/mpegts/outgoing/574d5482082389251f000022/?client_id=[client_id]&api_key=[api_key]"

Response example: 
  {
    "status" : "Ok",
  }

Pause specific outgoing MPEGTS stream.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/mpegts/outgoing/[stream_id]/pause
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • stream_id - is ID of outgoing MPEGTS stream obtained via "Get outgoing MPEGTS streams list" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl "https://api.wmspanel.com/v1/server/[server_id]/mpegts/outgoing/574d3f84082389251f000021/pause?client_id=[client_id]&api_key=[api_key]"

Response example: 
  {
    "status" : "Ok",
  }

Resume specific outgoing MPEGTS stream.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/mpegts/outgoing/[stream_id]/resume
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • stream_id - is ID of outgoing MPEGTS stream obtained via "Get outgoing MPEGTS streams list" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl "https://api.wmspanel.com/v1/server/[server_id]/mpegts/outgoing/574d3f84082389251f000021/resume?client_id=[client_id]&api_key=[api_key]"

Response example: 
  {
    "status" : "Ok",
  }

Restart an existing outgoing MPEGTS stream
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/mpegts/outgoing/[stream_id]/restart
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • stream_id - is ID of outgoing MPEGTS stream obtained via "Get outgoing MPEGTS streams list" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/[server_id]/mpegts/outgoing/574d5482082389251f000022/restart?client_id=[client_id]&api_key=[api_key]'
Response example: 
  {
    "status": "Ok",
  }

Retrieve list of UDP settings for particular Nimble server. You can view this list by navigating to "Nimble Streamer / Live streams" menu item, then choosing appropriate Nimble server, then clicking on "Live streams settings" button and choosing "UDP streaming" tab.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/mpegts/udp
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/[server_id]/mpegts/udp?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "settings": [
        {
            "id": "574bf530082389251f000008",
            "protocol": "udp",
            "ip": "224.222.222.100",
            "port": 2222,
            "name": "TV Box 1",
            "description": "UDP based stream",
            "tags": ["Cartoons"],
            "ttl": 1,
            "join_audio_frames": true,
            "paused": false,
            "mux_delay": 700,
            "max_mux_delay": 10000,
            "mux_rate": 2000,
            "start_cbr_buffer": 200,
            "max_cbr_buffer": 1000,
            "local_ip": "127.1.1.1",
            "local_port": 1111,
            "transport_stream_id": 32,
            "original_network_id": 54,
            "source_streams": [
                {
                    "application": "live",
                    "stream": "bunny",
                    "pmt_pid": 7166,
                    "video_pid": 256,
                    "audio_pid": 257,
                    "program_number": 7,
                    "service_type": 3,
                    "provider_name": "Test Provider",
                    "service_name": "Test Service"
                },
                {
                    "application": "live",
                    "stream": "ice",
                    "pmt_pid": 7167,
                    "video_pid": 258,
                    "audio_pid": 259
                }
            ]
        },
        {
            "id": "574c05d6082389251f000018",
            "protocol": "srt",
            "ip": "224.168.1.2",
            "port": 1234,
            "name": "TV Box 2",
            "description": "SRT based stream",
            "tags": ["netflix"],
            "ttl": 1,
            "paused": true,
            "mux_delay": 700,
            "max_mux_delay": 10000,
            "mux_rate": 2000,
            "send_mode": "rendezvous",
            "rendezvous_ip": "127.0.0.2",
            "rendezvous_port": 5678,
            "parameters": {
              "custom_param1": "custom_value1",
              "custom_param2": "custom_value2"
            },
            "source_id": "5efd77852c47e57c6c993fee"
        }
    ]
}
Response fields:
  • id - unique UDP setting ID for further usage.
  • protocol - given stream's protocol. Can be UDP, SRT, RIST or Zixi.
  • ip - target IP address. For SRT streams with the send_mode parameter set to 'push', the ip parameter can be represented as a domain name. For Zixi streams with the send_mode parameter set to 'push', the ip parameter is empty.
  • port - target port number. For Zixi streams with the send_mode parameter set to 'push', the port parameter is empty.
  • name - name of given setting in the UDP streaming section of Live streams settings UI.
  • description - custom description of the UDP setting.
  • tags - custom tags for easy filtering on the settings web page.
  • local_ip - local IP address, if particular local interface was binded. Applicable for UDP streams only.
  • local_port - local port number, if particular local interface was binded. Applicable for UDP streams only.
  • mux_delay - Mux delay value in milliseconds
  • max_mux_delay - Maximum mux delay value in milliseconds
  • mux_rate - Mux rate value in Kbit/sec
  • join_audio_frames - boolean flag to enable "Join audio frames" feature
  • start_cbr_buffer - Start CBR buffer value in milliseconds. Applicable for UDP and SRT streams only.
  • max_cbr_buffer - Maximum CBR buffer value in milliseconds. Applicable for UDP and SRT streams only.
  • send_mode - stream's send mode. Applicable for SRT, RIST and Zixi streams only. Can be "listen", "push" or "rendezvous" for SRT, "listen" or "push" for RIST and Zixi.
  • rendezvous_ip - local IP address in rendezvous mode. Applicable for SRT streams only.
  • rendezvous_port - local port number in rendezvous mode. Applicable for SRT streams only.
  • ttl - Time-To-Live value for outgoing UDP packets. Applicable for UDP streams only.
  • paused - defines whether given setting isn't active at the moment.
  • transport_stream_id - Transport stream ID. Applicable for UDP streams only.
  • original_network_id - Original network ID. Applicable for UDP streams only.
  • parameters - JSON object containing custom parameters. Applicable for SRT, RIST and Zixi streams.
  • source_id - Incoming MPEGTS stream ID, that can be obtained via "Get incoming MPEGTS streams list" API call.
  • source_streams - array of source streams those are combined into given stream. Each stream consists of the following parameters:
    • application - source application name
    • stream - source stream name
    • pmt_pid - PID (Packet ID) value that is assigned to PMT (Program Map Table) for given source in resulting UDP stream. Must be in range from 16 to 8190. It is possible to use same pmt_pid for different source streams, but it should not be the same as any video_pid or audio_pid inside the resulting UDP stream.
    • video_pid - PID (Packet ID) value that is assigned to elementary video stream that comes from given source. Must be in range from 16 to 8190. All video_pid and audio_pid values must be unique inside the resulting UDP stream.
    • audio_pid - PID (Packet ID) value that is assigned to elementary audio stream that comes from given source. Must be in range from 16 to 8190. All video_pid and audio_pid values must be unique inside the resulting UDP stream.
    • program_number - Stream program number. Must be unique inside resulting stream. Applicable for UDP and SRT streams only.
    • service_type - Stream service type. Must be in range from 1 to 65535. Applicable for UDP and SRT streams only.
    • provider_name - Stream provider name. Applicable for UDP and SRT streams only.
    • service_name - Stream service name. Applicable for UDP and SRT streams only.

Pick up an existing UDP setting.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/mpegts/udp/[setting_id]
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • setting_id - is ID of UDP setting obtained via "Get UDP settings list" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/[server_id]/mpegts/udp/574bf530082389251f000008?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "setting": {
        "id": "574bf530082389251f000008",
        "protocol": "udp",
        "ip": "224.222.222.100",
        "port": 2222,
        "name": "TV Box 1",
        "description": "UDP based stream",
        "tags": ["Cartoons"],
        "ttl": 1,
        "join_audio_frames": true,
        "paused": false,
        "mux_delay": 700,
        "mux_rate": 2000,
        "max_mux_delay": 10000,
        "start_cbr_buffer": 200,
        "max_cbr_buffer": 1000,
        "local_ip": "127.1.1.1",
        "local_port": 1111,
        "transport_stream_id": 32,
        "original_network_id": 54,
        "source_streams": [
            {
                "application": "live",
                "stream": "bunny",
                "pmt_pid": 7166,
                "video_pid": 256,
                "audio_pid": 257,
                "program_number": 7,
                "service_type": 3,
                "provider_name": "Test Provider",
                "service_name": "Test Service"
            },
            {
                "application": "live",
                "stream": "ice",
                "pmt_pid": 7167,
                "video_pid": 258,
                "audio_pid": 259
            }
        ]
    }
}
Response fields:
  • id - unique UDP setting ID for further usage.
  • protocol - given stream's protocol. Can be UDP, SRT, RIST or Zixi.
  • ip - target IP address. For SRT streams with the send_mode parameter set to 'push', the ip parameter can be represented as a domain name. For Zixi streams with the send_mode parameter set to 'push', the ip parameter is empty.
  • port - target port number. For Zixi streams with the send_mode parameter set to 'push', the port parameter is empty.
  • name - name of given setting in the UDP streaming section of Live streams settings UI.
  • description - custom description of the UDP setting.
  • tags - custom tags for easy filtering on the settings web page.
  • local_ip - local IP address, if particular local interface was binded. Applicable for UDP streams only.
  • local_port - local port number, if particular local interface was binded. Applicable for UDP streams only.
  • mux_delay - Mux delay value in milliseconds
  • max_mux_delay - Maximum mux delay value in milliseconds
  • mux_rate - Mux rate value in Kbit/sec
  • join_audio_frames - boolean flag to enable "Join audio frames" feature
  • start_cbr_buffer - Start CBR buffer value in milliseconds. Applicable for UDP and SRT streams only.
  • max_cbr_buffer - Maximum CBR buffer value in milliseconds. Applicable for UDP and SRT streams only.
  • send_mode - stream's send mode. Applicable for SRT, RIST and Zixi streams only. Can be "listen", "push" or "rendezvous" for SRT, "listen" or "push" for RIST and Zixi.
  • rendezvous_ip - local IP address in rendezvous mode. Applicable for SRT streams only.
  • rendezvous_port - local port number in rendezvous mode. Applicable for SRT streams only.
  • ttl - Time-To-Live value for outgoing UDP packets. Applicable for UDP streams only.
  • paused - defines whether given setting isn't active at the moment.
  • transport_stream_id - Transport stream ID. Applicable for UDP streams only.
  • original_network_id - Original network ID. Applicable for UDP streams only.
  • parameters - JSON object containing custom parameters. Applicable for SRT, RIST and Zixi streams.
  • source_id - Incoming MPEGTS stream ID, that can be obtained via "Get incoming MPEGTS streams list" API call.
  • source_streams - array of source streams those are combined into given stream. Each stream consists of the following parameters:
    • application - source application name
    • stream - source stream name
    • pmt_pid - PID (Packet ID) value that is assigned to PMT (Program Map Table) for given source in resulting UDP stream. Must be in range from 16 to 8190. It is possible to use same pmt_pid for different source streams, but it should not be the same as any video_pid or audio_pid inside the resulting UDP stream.
    • video_pid - PID (Packet ID) value that is assigned to elementary video stream that comes from given source. Must be in range from 16 to 8190. All video_pid and audio_pid values must be unique inside the resulting UDP stream.
    • audio_pid - PID (Packet ID) value that is assigned to elementary audio stream that comes from given source. Must be in range from 16 to 8190. All video_pid and audio_pid values must be unique inside the resulting UDP stream.
    • program_number - Stream program number. Must be unique inside resulting stream. Applicable for UDP and SRT streams only.
    • service_type - Stream service type. Must be in range from 1 to 65535. Applicable for UDP and SRT streams only.
    • provider_name - Stream provider name. Applicable for UDP and SRT streams only.
    • service_name - Stream service name. Applicable for UDP and SRT streams only.

Create a new UDP setting. Nimble Streamer is able to transmux up to 256 RTMP, RTSP and MPEG-TS streams into single multi-program MPEG-TS UDP stream. For each incoming stream the unique PMT PID, Video PID and Audio PID values must be assigned. You can take RTMP, RTSP and MPEG-TS streams from any sources, transmux them into a single UDP MPEG-TS stream and transmit via multicast.
Request URL:
POST https://api.wmspanel.com/v1/server/[server_id]/mpegts/udp
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{ "ip": "192.168.1.2", "port": 5555, "name": "Home stream", "source_streams": [ {"application": "home", "stream": "room1", "pmt_pid": 7166, "video_pid": 256, "audio_pid": 257} ]}' "https://api.wmspanel.com/v1/server/[server_id]/mpegts/udp?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • protocol (optional) - given stream's protocol ("udp", "srt", "rist", "zixi"). It's not possible to change it after a stream creation. By default will be set to UDP.
  • ip - target IP address. For SRT streams with the send_mode parameter set to 'push', the ip parameter can be represented as a domain name. For Zixi streams with the send_mode parameter set to 'push', the ip parameter is empty.
  • port - target port number. For Zixi streams with the send_mode parameter set to 'push', the port parameter is empty.
  • name (optional) - name of given setting.
  • description (optional) - custom description of given setting.
  • tags (optional) - custom tags for easy filtering on the settings web page.
  • local_ip (optional) - local IP address, if particular local interface should be binded. Applicable for UDP streams only.
  • local_port (optional) - local port number, if particular local interface should be binded. Applicable for UDP streams only. To remove local port, just set its value to 0.
  • set_mux_rate (optional) - Boolean flag to enable and disable Mux settings usage. Applicable without "source_id" field only.
  • mux_delay (optional) - Mux delay value in milliseconds. Applicable without "source_id" field only.
  • max_mux_delay (optional) - Maximum mux delay value in milliseconds. Applicable without "source_id" field only.
  • mux_rate (optional) - Mux rate value in Kbit/sec. Applicable without "source_id" field only.
  • join_audio_frames (optional) - boolean flag to enable "Join audio frames" feature
  • start_cbr_buffer (optional) - Start CBR buffer value in milliseconds. Applicable for UDP and SRT streams and without "source_id" field only.
  • max_cbr_buffer (optional) - Maximum CBR buffer value in milliseconds. Applicable for UDP and SRT streams and without "source_id" field only.
  • send_mode - stream's send mode. Applicable for SRT, RIST and Zixi streams only. Can be "listen", "push" or "rendezvous" for SRT, "listen" or "push" for RIST and Zixi.
  • rendezvous_ip (optional) - local IP address in rendezvous mode. Applicable for SRT streams only.
  • rendezvous_port (optional) - local port number in rendezvous mode. Applicable for SRT streams only.
  • ttl (optional) - Time-To-Live value for outgoing UDP packets.
  • paused (optional) - defines whether given setting isn't active at the moment.
  • transport_stream_id (optional) - Transport stream ID. Applicable for UDP streams only.
  • original_network_id (optional) - Original network ID. Applicable for UDP streams only.
  • parameters (optional) - JSON object containing custom parameters. Applicable for SRT, RIST and Zixi streams. For Zixi in 'push' mode not empty 'stream' parameter must be included. For Zixi in 'listen' mode both 'stream' and 'remote_id' parameters must be included.
  • source_id (optional) - Incoming MPEGTS stream ID, that can be obtained via "Get incoming MPEGTS streams list" API call. Either "source_id", or "source_streams" parameter must be provided, but not both of them.
  • source_streams (optional) - array of source streams those are combined into given UDP stream. Either "source_id", or "source_streams" parameter must be provided, but not both of them. Each stream consists of the following parameters:
    • application - source application name
    • stream - source stream name
    • pmt_pid - PID (Packet ID) value that is assigned to PMT (Program Map Table) for given source in resulting UDP stream. Must be in range from 16 to 8190. It is possible to use same pmt_pid for different source streams, but it should not be the same as any video_pid or audio_pid inside the resulting UDP stream.
    • video_pid - PID (Packet ID) value that is assigned to elementary video stream that comes from given source. Must be in range from 16 to 8190. All video_pid and audio_pid values must be unique inside the resulting UDP stream.
    • audio_pid - PID (Packet ID) value that is assigned to elementary audio stream that comes from given source. Must be in range from 16 to 8190. All video_pid and audio_pid values must be unique inside the resulting UDP stream.
    • program_number (optional) - Stream program number. Must be unique inside resulting stream. Applicable for UDP and SRT streams only.
    • service_type (optional) - Stream service type. Must be in range from 1 to 65535. Applicable for UDP and SRT streams only.
    • provider_name (optional) - Stream provider name. Applicable for UDP and SRT streams only.
    • service_name (optional) - Stream service name. Applicable for UDP and SRT streams only.
Response example: 
    {
    "status": "Ok",
    "setting": {
        "id": "574e252a082389382a000005",
        "protocol": "udp",
        "ip": "192.168.1.2",
        "port": 5555,
        "name": "Home stream",
        "description": "",
        "ttl": 1,
        "paused": false,
        "source_streams": [
            {
                "application": "home",
                "stream": "room1",
                "pmt_pid": 7166,
                "video_pid": 256,
                "audio_pid": 257
            }
        ]
    }
}
Response fields: The same as in "Get an existing UDP setting".

Update an existing UDP setting.
Request URL:
PUT https://api.wmspanel.com/v1/server/[server_id]/mpegts/udp/[setting_id]
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • setting_id - is ID of UDP setting obtained via "Get UDP settings list" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"ip": "192.168.1.22", "description": "Children's room", "tags": ["Larix Apt", "children"], "source_streams": [ {"application": "home", "stream": "room1", "pmt_pid": 7166, "video_pid": 256, "audio_pid": 257}, {"application": "home", "stream": "child_room", "pmt_pid": 7167, "video_pid": 258, "audio_pid": 259} ]}' "https://api.wmspanel.com/v1/server/[server_id]/mpegts/udp/574e252a082389382a000005?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • ip - target IP address. For SRT streams with the send_mode parameter set to 'push', the ip parameter can be represented as a domain name. For Zixi streams with the send_mode parameter set to 'push', the ip parameter is empty.
  • port - target port number. For Zixi streams with the send_mode parameter set to 'push', the port parameter is empty.
  • name - name of given setting.
  • description - custom description of given setting.
  • tags - custom tags for easy filtering on the settings web page.
  • local_ip - local IP address, if particular local interface should be binded. Applicable for UDP streams only.
  • local_port - local port number, if particular local interface should be binded. Applicable for UDP streams only. To remove local port, just set its value to 0.
  • set_mux_rate - Boolean flag to enable and disable Mux settings usage. Applicable without "source_id" field only.
  • mux_delay - Mux delay value in milliseconds. Applicable without "source_id" field only.
  • max_mux_delay - Maximum mux delay value in milliseconds. Applicable without "source_id" field only.
  • mux_rate - Mux rate value in Kbit/sec. Applicable without "source_id" field only.
  • join_audio_frames - boolean flag to enable "Join audio frames" feature
  • start_cbr_buffer (optional) - Start CBR buffer value in milliseconds. Applicable for UDP and SRT streams and without "source_id" field only.
  • max_cbr_buffer (optional) - Maximum CBR buffer value in milliseconds. Applicable for UDP and SRT streams and without "source_id" field only.
  • send_mode - stream's send mode. Applicable for SRT, RIST and Zixi streams only. Can be "listen", "push" or "rendezvous" for SRT, "listen" or "push" for RIST and Zixi.
  • rendezvous_ip - local IP address in rendezvous mode. Applicable for SRT streams only.
  • rendezvous_port - local port number in rendezvous mode. Applicable for SRT streams only.
  • ttl - Time-To-Live value for outgoing UDP packets. Applicable for UDP streams only.
  • paused - defines whether given setting isn't active at the moment.
  • transport_stream_id - Transport stream ID. Applicable for UDP streams only.
  • original_network_id - Original network ID. Applicable for UDP streams only.
  • parameters - JSON object containing custom parameters. Applicable for SRT, RIST and Zixi streams. For Zixi in 'push' mode not empty 'stream' parameter must be included. For Zixi in 'listen' mode both 'stream' and 'remote_id' parameters must be included.
  • source_id - Incoming MPEGTS stream ID, that can be obtained via "Get incoming MPEGTS streams list" API call. Both "source_id" and "source_streams" parameters cannot be set by same request. If "source_id" only is provided, then "source_streams" will be removed from the setting.
  • source_streams - array of source streams those are combined into given UDP stream. If "source_streams" is provided, then "source_id" will be removed from the setting. Each stream consists of the following parameters:
    • application - source application name
    • stream - source stream name
    • pmt_pid - PID (Packet ID) value that is assigned to PMT (Program Map Table) for given source in resulting UDP stream. Must be in range from 16 to 8190. It is possible to use same pmt_pid for different source streams, but it should not be the same as any video_pid or audio_pid inside the resulting UDP stream.
    • video_pid - PID (Packet ID) value that is assigned to elementary video stream that comes from given source. Must be in range from 16 to 8190. All video_pid and audio_pid values must be unique inside the resulting UDP stream.
    • audio_pid - PID (Packet ID) value that is assigned to elementary audio stream that comes from given source. Must be in range from 16 to 8190. All video_pid and audio_pid values must be unique inside the resulting UDP stream.
    • program_number - Stream program number. Must be unique inside resulting stream. Applicable for UDP and SRT streams only.
    • service_type - Stream service type. Must be in range from 1 to 65535. Applicable for UDP and SRT streams only.
    • provider_name - Stream provider name. Applicable for UDP and SRT streams only.
    • service_name - Stream service name. Applicable for UDP and SRT streams only.
All fields are optional.

Response example: 
    {
    "status": "Ok",
    "setting": {
        "id": "574e252a082389382a000005",
        "protocol": "udp",
        "ip": "192.168.1.22",
        "port": 5555,
        "name": "Home stream",
        "description": "Children's room",
        "tags": ["Larix Apt", "Children"],
        "ttl": 1,
        "paused": false,
        "source_streams": [
            {
                "application": "home",
                "stream": "room1",
                "pmt_pid": 7166,
                "video_pid": 256,
                "audio_pid": 257
            },
            {
                "application": "home",
                "stream": "child_room",
                "pmt_pid": 7167,
                "video_pid": 258,
                "audio_pid": 259
            }
        ]
    }
}
Response fields: The same as in "Get an existing UDP setting".

Delete an existing UDP setting.
Request URL:
DELETE https://api.wmspanel.com/v1/server/[server_id]/mpegts/udp/[setting_id]
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • setting_id - is ID of UDP setting obtained via "Get UDP settings list" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/server/[server_id]/mpegts/udp/574e252a082389382a000005/?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Response example: 
    {
    "status" : "Ok",
}

Retrieve list of all ABR settings. If server id is specified as optional parameter in request url, then returned list contains only settings concerned with that server. You can view this list by navigating to "Nimble Streamer / Live streams" menu item, then choosing appropriate Nimble server and then navigating to "ABR" link (to see ABR settings for all servers, you can select "All servers" option in the dropdown menu on the final page).
Request URL:
GET https://api.wmspanel.com/v1/abr
Request parameters:

  • server_id - (optional) is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/abr?client_id=[client_id]&api_key=[api_key]&server_id=[server_id]'
Response example: 
    {
    "status": "Ok",
    "settings": [
        {
            "id": "5453564178a6fc475b00003e",
            "application": "server",
            "server_ids": [
                "538bcbd3f5aef0bed900000d",
                "538bcbd3f5aef0bed9000003",
                "538bcbd3f5aef0bed9000007"
            ],
            "source_streams": [
                {
                    "application": "app2",
                    "stream": "strm2"
                },
                {
                    "application": "e",
                    "stream": "fhd"
                },
                {
                    "application": "live",
                    "stream": "55"
                }
            ],
            "stream": "experiment",
            "hls_order": "DESC",
            "tags": ["experiment"]
        },
        {
            "id": "5456f10a7d5c008aa0000001",
            "application": "abr_app",
            "server_ids": [
                "538bcbd3f5aef0bed900000d",
                "53d0abf77303913484000004",
                "54396b04f5aef090ea00000a",
                "543dd991f5aef0bffb000008"
            ],
            "source_streams": [
                {
                    "application": "src_app1",
                    "stream": "src_str"
                    "bandwidth": 72,
                    "audio_only": true,
                    "language": "English",
                    "description": "Test audio stream 1",
                    "is_default": false,
                    "is_autoselect": true
                },
                {
                    "application": "src_app2",
                    "stream": "src_str2"
                }
            ],
            "stream": "abr_str",
            "hls_order": "NONE"
        }
    }
}
Response fields:
  • id - unique ABR setting ID for further usage.
  • application - application name for outgoing ABR stream.
  • stream - stream name for outgoing ABR stream.
  • server_ids - list of ids of servers those particular setting is applied to.
  • hls_order (optional) - streams sorting in HLS playlist (may be "NONE" - as streams defined, "DESC" - By bandwidth descending, "ASC" - By bandwidth ascending).
  • tags (optional) - custom tags for easy filtering on the settings web page.
  • source_streams (optional) - list of source streams. Each stream is presented by following parameters:
    • application - application name of the source stream.
    • stream - stream name of the source stream.
    • bandwidth (optional) - bandwidth of the source stream.
    • audio_only (optional) - true if the source stream is audio only.
    • is_default (optional) - true if the source stream is default. Can be used for audio streams only. It is possible to have one default source stream only for each ABR stream.
    • is_autoselect (optional) - true if the source stream can be selected automatically. Can be used for audio streams only. All streams with autoselect must have "language" attributes with unique values.
    • language (optional) - the source stream language. Can be used for audio streams only.
    • description (optional) - the source stream description. Can be used for audio streams only.

Pick up an ABR setting
Request URL:
GET https://api.wmspanel.com/v1/abr/[setting_id]
Request parameters:

  • setting_id - is ID of the ABR setting obtained via "Get ABR settings list" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/abr/5453564178a6fc475b00003e?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "setting": {
        "id": "5453564178a6fc475b00003e",
        "application": "server",
        "server_ids": [
            "538bcbd3f5aef0bed900000d",
            "538bcbd3f5aef0bed9000003",
            "538bcbd3f5aef0bed9000007"
        ],
        "source_streams": [
            {
                "application": "app2",
                "stream": "strm2"
            },
            {
                "application": "e",
                "stream": "fhd"
            },
            {
                "application": "live",
                "stream": "55"
            }
        ],
        "stream": "experiment",
        "hls_order": "ASC",
        "tags": ["experiment"]
    }
}
Response fields:
  • id - unique ABR setting ID for further usage.
  • application - application name for outgoing ABR stream.
  • stream - stream name for outgoing ABR stream.
  • server_ids - list of ids of servers those particular setting is applied to.
  • hls_order (optional) - streams sorting in HLS playlist (may be "NONE" - as streams defined, "DESC" - By bandwidth descending, "ASC" - By bandwidth ascending).
  • tags (optional) - custom tags for easy filtering on the settings web page.
  • source_streams (optional) - list of source streams. Each stream is presented by following parameters:
    • application - application name of the source stream.
    • stream - stream name of the source stream.
    • bandwidth (optional) - bandwidth of the source stream.
    • audio_only (optional) - true if the source stream is audio only.
    • is_default (optional) - true if the source stream is default. Can be used for audio streams only. It is possible to have one default source stream only for each ABR stream.
    • is_autoselect (optional) - true if the source stream can be selected automatically. Can be used for audio streams only. All streams with autoselect must have "language" attributes with unique values.
    • language (optional) - the source stream language. Can be used for audio streams only.
    • description (optional) - the source stream description. Can be used for audio streams only.

Create a new ABR setting.
Request URL:
POST https://api.wmspanel.com/v1/abr
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{"application": "tennis", "stream": "rg"}' "https://api.wmspanel.com/v1/abr?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • application - application name for outgoing ABR stream.
  • stream - stream name for outgoing ABR stream.
  • server_ids (optional) - list of ids of servers those particular setting is applied to.
  • hls_order (optional) - streams sorting in HLS playlist (may be "NONE" - as streams defined, "DESC" - By bandwidth descending, "ASC" - By bandwidth ascending).
  • tags (optional) - custom tags for easy filtering on the settings web page.
  • source_streams (optional) - list of source streams. Each stream is presented by following parameters:
    • application - application name of the source stream.
    • stream - stream name of the source stream.
    • bandwidth (optional) - bandwidth of the source stream.
    • audio_only (optional) - true if the source stream is audio only.
    • is_default (optional) - true if the source stream is default. Can be used for audio streams only. It is possible to have one default source stream only for each ABR stream.
    • is_autoselect (optional) - true if the source stream can be selected automatically. Can be used for audio streams only. All streams with autoselect must have "language" attributes with unique values.
    • language (optional) - the source stream language. Can be used for audio streams only.
    • description (optional) - the source stream description. Can be used for audio streams only.
Response example: 
    {
    "status": "Ok",
    "setting": {
        "id": "552e17070640fdd1bf000015",
        "application": "tennis",
        "server_ids": [],
        "source_streams": [],
        "stream": "rg"
    }
}
Response fields: The same as in "Get an existing ABR setting".

Update an existing ABR setting.
Request URL:
PUT https://api.wmspanel.com/v1/abr/[setting_id]
Request parameters:

  • setting_id - is ID of the ABR setting obtained via "Get ABR settings list" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"server_ids": ["538bcbd3f5aef0bed9000003", "538bcbd3f5aef0bed9000009", "538bcbd3f5aef0bed900000c", "538bcbd3f5aef0bed900000e"], "tags": ["updated"], "source_streams": [{ "application": "tennis", "stream": "rg480p" }, {"application": "tennis", "stream": "rg720p" }, { "application": "tennis", "stream": "rgfhd"}]}' "https://api.wmspanel.com/v1/abr/552e17070640fdd1bf000015?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • application - application name for outgoing ABR stream.
  • stream - stream name for outgoing ABR stream.
  • server_ids - list of ids of servers those particular setting is applied to. Can be empty.
  • hls_order - streams sorting in HLS playlist (may be "NONE" - as streams defined, "DESC" - By bandwidth descending, "ASC" - By bandwidth ascending).
  • tags - custom tags for easy filtering on the settings web page.
  • source_streams - list of source streams. Each stream is presented by following parameters:
    • application - application name of the source stream.
    • stream - stream name of the source stream.
    • bandwidth - bandwidth of the source stream.
    • audio_only - true if the source stream is audio only.
    • is_default - true if the source stream is default. Can be used for audio streams only. It is possible to have one default source stream only for each ABR stream.
    • is_autoselect - true if the source stream can be selected automatically. Can be used for audio streams only. All streams with autoselect must have "language" attributes with unique values.
    • language - the source stream language. Can be used for audio streams only.
    • description - the source stream description. Can be used for audio streams only.
All fields are optional.

Response example: 
    {
    "status": "Ok",
    "setting": {
        "id": "552e17070640fdd1bf000015",
        "application": "tennis",
        "server_ids": [
            "538bcbd3f5aef0bed9000003",
            "538bcbd3f5aef0bed9000009",
            "538bcbd3f5aef0bed900000c",
            "538bcbd3f5aef0bed900000e"
        ],
        "source_streams": [
            {
                "application": "tennis",
                "stream": "rg480p"
            },
            {
                "application": "tennis",
                "stream": "rg720p"
            },
            {
                "application": "tennis",
                "stream": "rgfhd"
            }
        ],
        "stream": "rg",
        "hls_order": "DESC",
        "tags": ["updated"]
    }
}
Response fields: The same as in "Get an existing ABR setting".

Delete an existing ABR setting.
Request URL:
DELETE https://api.wmspanel.com/v1/abr/[setting_id]
Request parameters:

  • setting_id - is ID of the ABR setting obtained via "Get ABR settings list" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/abr/552e17070640fdd1bf000015/?client_id=[client_id]&api_key=[api_key]"

Response example: 
    {
    "status" : "Ok",
}

Retrieve list of DVR settings for particular Nimble server. You can view this list by navigating to "Nimble Streamer / Live streams" menu item, then choosing appropriate Nimble server, then clicking on "Live streams settings" button and choosing "DVR" tab.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/dvr
Request parameters:

  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/dvr?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
      "status": "Ok",
      "settings": [
        {
          "id": "55cae7f2e2cd281ea8000026",
          "application": "live",
          "stream": "",
          "path": "/data/dvr1",
          "max_duration": 3600,
          "max_size": 0,
          "segment_duration": 3,
          "thread_name": "default",
          "paused": false,
          "read_only": true,
          "drop_invalid_segments": true,
          "keep_protocol_timestamps": false,
          "check_segment_sizes_on_load": false,
          "align_pdt": true,
          "storage_format": 1,
          "max_bucket_size": 1024,
          "max_file_size": 64,
          "jpg_thumbnails": false,
          "jpg_thumbnails_playlist": false,
          "jpg_thumbnail_width": 0,
          "jpg_thumbnail_height": 0,
          "scte35_markers": true,
          "id3_info": true,
          "dvb_subtitles": true,
          "webvtt_subtitles": true,
          "klv_metadata": true,
          "iframe_playlist": false,
          "min_free_space_mb": 1024,
          "cleanup_older_than": 24,
          "tags": ["live", "with subtitles"]
        },
        {
          "id": "561f2e3de2cd281667000007",
          "application": "live",
          "stream": "event",
          "path": "",
          "max_duration": 300,
          "max_size": 2048,
          "segment_duration": 3,
          "thread_name": "default",
          "paused": true,
          "drop_invalid_segments": true,
          "keep_protocol_timestamps": false,
          "check_segment_sizes_on_load": false,
          "align_pdt": true,
          "storage_format": 2,
          "max_bucket_size": 2048,
          "max_file_size": 256,
          "jpg_thumbnails": true,
          "jpg_thumbnails_playlist": true,
          "jpg_thumbnail_width": 640,
          "jpg_thumbnail_height": 480,
          "scte35_markers": false,
          "id3_info": false,
          "dvb_subtitles": false,
          "webvtt_subtitles": false,
          "klv_metadata": false,
          "iframe_playlist": true,
          "min_free_space_percents": 23,
          "tags": ["Events", "with thumbnails"]
        }
      ]
    }
Response fields:
  • id - unique DVR setting ID for further usage.
  • application - application name for recording.
  • stream - stream name for recording.
  • path - recording path is the location of the storage which you'd like to use. It needs to be a file system location. If you don't specify it, the default cache path of Nimble Streamer will be used.
  • max_duration - loop recording duration is the maximum time window that keeps the content. E.g. if you set this to 1 hour, start streaming and your stream lasts for 1 hour and 10 minutes, then first 10 minutes of recording will be erased to keep the last 10 minutes. This duration mostly depends on your storage capacity. If you don't specify the duration then Nimble will keep recording until it has space at the specified location.
  • max_size - loop recording size is the maximum size in MB that keeps the content.
  • segment_duration - is the duration of the chunk being used for media storage.
  • thread_name - used for splitting recording process among several threads.
  • paused - defines whether given DVR setting isn't active at the moment.
  • read_only - defines whether given DVR setting is in read-only mode.
  • drop_invalid_segments - defines whether "Drop invalid segments" option in DVR error correction is enabled.
  • keep_protocol_timestamps - defines whether "Keep protocol timestamps" option in DVR error correction is enabled.
  • check_segment_sizes_on_load - defines whether "Check segment sizes on load" option in DVR error correction is enabled.
  • align_pdt - defines whether "Align segment time (PROGRAM-DATE-TIME)" option in DVR error correction is enabled.
  • storage_format - defines storage format version (1 or 2).
  • max_bucket_size - maximum size in MB of the bucket directory with DVR files. Applicable for storage format version 2 only.
  • max_file_size - maximum size in MB of the file with segments. Applicable for storage format version 2 only.
  • jpg_thumbnails - defines whether JPEG thumbnails generation is enabled. If this parameter is true, then at least one of jpg_thumbnail_width and jpg_thumbnail_height parameters should be specified. If width or height only is specified, then Nimble will calculate second parameter automatically. Live Transcoder should be installed to support this feature.
  • jpg_thumbnails_playlist - defines whether JPEG thumbnails playlist generation is enabled. It is applicable if jpg_thumbnails parameter is true only. Live Transcoder should be installed to support this feature.
  • jpg_thumbnail_width - JPEG thumbnails width.
  • jpg_thumbnail_height - JPEG thumbnails height.
  • scte35_markers - defines whether keep SCTE-35 markers mode is enabled.
  • id3_info - defines whether keep ID3 metadata mode is enabled.
  • dvb_subtitles - defines whether keep DVB subtitles mode is enabled.
  • webvtt_subtitles - defines whether keep WebVTT subtitles mode is enabled.
  • klv_metadata - defines whether keep KLV metadata mode is enabled.
  • iframe_playlist - defines whether generate I-Frame playlist mode is enabled.
  • min_free_space_mb - minimum free storage space in megabytes required to continue DVR recording.
  • min_free_space_percents - minimum free storage space in percents required to continue DVR recording.
  • cleanup_older_than - time in hours to keep DVR archive. Older files will be removed.
  • tags - custom tags for easy filtering on the settings web page.

Pick up a DVR setting
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/dvr/[setting_id]
Request parameters:

  • setting_id - is ID of the DVR setting obtained via "Get DVR settings list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/dvr/547d151378a6fccf4d000002?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "setting":
        {
          "id": "561f2e3de2cd281667000007",
          "application": "live",
          "stream": "event",
          "path": "",
          "max_duration": 300,
          "max_size": 0,
          "segment_duration": 3,
          "thread_name": "default",
          "paused": true,
          "drop_invalid_segments": true,
          "keep_protocol_timestamps": false,
          "check_segment_sizes_on_load": false,
          "align_pdt": true,
          "storage_format": 2,
          "max_bucket_size": 2048,
          "max_file_size": 256,
          "jpg_thumbnails": true,
          "jpg_thumbnails_playlist": true,
          "jpg_thumbnail_width": 640,
          "jpg_thumbnail_height": 480,
          "scte35_markers": true,
          "id3_info": true,
          "dvb_subtitles": true,
          "webvtt_subtitles": true,
          "klv_metadata": true,
          "iframe_playlist": false,
          "tags": ["Events", "with thumbnails"]
        }
}
Response fields: The same as at "Get DVR settings list".

Create a new DVR setting.
Request URL:
POST https://api.wmspanel.com/v1/server/[server_id]/dvr
Request parameters:

  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{"application": "live", "stream": "event", "other_servers_to_apply": ["555a79e6fe7cd34664000006"], "tags": ["Events", "with thumbnails"]}' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/dvr?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • application - application name for recording.
  • stream (optional) - stream name for recording.
  • path (optional) - recording path is the location of the storage which you'd like to use. It needs to be a file system location. If you don't specify it, the default cache path of Nimble Streamer will be used.
  • max_duration (optional) - loop recording duration is the maximum time window that keeps the content. E.g. if you set this to 1 hour, start streaming and your stream lasts for 1 hour and 10 minutes, then first 10 minutes of recording will be erased to keep the last 10 minutes. This duration mostly depends on your storage capacity. If you don't specify the duration then Nimble will keep recording until it has space at the specified location.
  • max_size (optional) - loop recording size is the maximum size in MB that keeps the content.
  • segment_duration (optional) - is the duration of the chunk being used for media storage.
  • thread_name (optional) - used for splitting recording process among several threads.
  • paused (optional) - defines whether given DVR setting isn't active at the moment.
  • read_only (optional) - defines whether given DVR setting is in read-only mode.
  • drop_invalid_segments (optional) - defines whether "Drop invalid segments" option in DVR error correction is enabled.
  • keep_protocol_timestamps (optional) - defines whether "Keep protocol timestamps" option in DVR error correction is enabled.
  • check_segment_sizes_on_load (optional) - defines whether "Check segment sizes on load" option in DVR error correction is enabled.
  • align_pdt - defines whether "Align segment time (PROGRAM-DATE-TIME)" option in DVR error correction is enabled.
  • storage_format (optional) - defines storage format version (1 or 2).
  • max_bucket_size (optional) - maximum size in MB of the bucket directory with DVR files. Applicable for storage format version 2 only.
  • max_file_size (optional) - maximum size in MB of the file with segments. Applicable for storage format version 2 only.
  • jpg_thumbnails (optional) - defines whether JPEG thumbnails generation is enabled. If this parameter is true, then at least one of jpg_thumbnail_width and jpg_thumbnail_height parameters should be specified. If width or height only is specified, then Nimble will calculate second parameter automatically. Live Transcoder should be installed to support this feature.
  • jpg_thumbnails_playlist (optional) - defines whether JPEG thumbnails playlist generation is enabled. It is applicable if jpg_thumbnails parameter is true only. Live Transcoder should be installed to support this feature.
  • jpg_thumbnail_width (optional) - JPEG thumbnails width.
  • jpg_thumbnail_height (optional) - JPEG thumbnails height.
  • scte35_markers (optional) - defines whether keep SCTE-35 markers mode is enabled.
  • id3_info (optional) - defines whether keep ID3 metadata mode is enabled.
  • dvb_subtitles (optional) - defines whether keep DVB subtitles mode is enabled.
  • webvtt_subtitles - defines whether keep WebVTT subtitles mode is enabled.
  • klv_metadata (optional) - defines whether keep KLV metadata mode is enabled.
  • iframe_playlist (optional) - defines whether generate I-Frame playlist mode is enabled.
  • min_free_space_mb (optional) - minimum free storage space in megabytes required to continue DVR recording. Cannot be set in same request with min_free_space_percents. Use value 0 to make this field empty.
  • min_free_space_percents (optional) - minimum free storage space in percents required to continue DVR recording. Cannot be set in same request with min_free_space_mb. Use value 0 to make this field empty.
  • cleanup_older_than (optional) - time in hours to keep DVR archive. Older files will be removed. Use value 0 to make this field empty.
  • other_servers_to_apply (optional) - array of servers IDs, where this setting also should be created. Maximum 20 additional servers IDs can be included into one API call.
  • tags (optional) - custom tags for easy filtering on the settings web page.
Response example: 
    {
    "status": "Ok",
    "setting": {
          "id": "561f2e3de2cd281667000007",
          "application": "live",
          "stream": "event",
          "path": "",
          "max_duration": 300,
          "max_size": 0,
          "segment_duration": 3,
          "thread_name": "default"
          "paused": true,
          "drop_invalid_segments": true,
          "keep_protocol_timestamps": false,
          "check_segment_sizes_on_load": false,
          "align_pdt": true,
          "storage_format": 2,
          "max_bucket_size": 2048,
          "max_file_size": 256,
          "jpg_thumbnails": true,
          "jpg_thumbnails_playlist": true,
          "jpg_thumbnail_width": 640,
          "jpg_thumbnail_height": 480,
          "scte35_markers": false,
          "id3_info": false,
          "dvb_subtitles": false,
          "webvtt_subtitles": true,
          "klv_metadata": false,
          "iframe_playlist": false,
          "tags": ["Events", "with thumbnails"],
          "other_servers_applied": [
            {
                "setting_id": "62f9a4852c47e537fede1e50",
                "server_id": "555a79e6fe7cd34664000006"
            }
          ]
        }
}
Response fields:
  • other_servers_applied - array containing data about settings created on other servers (from "other_servers_to_apply" request field). This field is returned, when request contained "other_servers_to_apply" field only. Each array item is a hash structure with following fields:
    • setting_id - new setting ID
    • server_id - server ID, where new setting was created
Other response fields are the same as in "Get DVR settings list".

Create multiple DVR settings. Maximum 100 settings can be created by one request. This API is disabled by default. Please, contact us to enable it.
Request URL:
POST https://api.wmspanel.com/v1/server/[server_id]/dvr/multi
Request parameters:

  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '[{"application": "live", "stream": "event"}, {"application": "live", "stream": "event2"}]' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/dvr/multi?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body as array of structures.

Request data fields:
  • application - application name for recording.
  • stream (optional) - stream name for recording.
  • path (optional) - recording path is the location of the storage which you'd like to use. It needs to be a file system location. If you don't specify it, the default cache path of Nimble Streamer will be used.
  • max_duration (optional) - loop recording duration is the maximum time window that keeps the content. E.g. if you set this to 1 hour, start streaming and your stream lasts for 1 hour and 10 minutes, then first 10 minutes of recording will be erased to keep the last 10 minutes. This duration mostly depends on your storage capacity. If you don't specify the duration then Nimble will keep recording until it has space at the specified location.
  • max_size (optional) - loop recording size is the maximum size in MB that keeps the content.
  • segment_duration (optional) - is the duration of the chunk being used for media storage.
  • thread_name (optional) - used for splitting recording process among several threads.
  • paused (optional) - defines whether given DVR setting isn't active at the moment.
  • read_only (optional) - defines whether given DVR setting is in read-only mode.
  • drop_invalid_segments (optional) - defines whether "Drop invalid segments" option in DVR error correction is enabled.
  • keep_protocol_timestamps (optional) - defines whether "Keep protocol timestamps" option in DVR error correction is enabled.
  • check_segment_sizes_on_load (optional) - defines whether "Check segment sizes on load" option in DVR error correction is enabled.
  • align_pdt - defines whether "Align segment time (PROGRAM-DATE-TIME)" option in DVR error correction is enabled.
  • storage_format (optional) - defines storage format version (1 or 2).
  • max_bucket_size (optional) - maximum size in MB of the bucket directory with DVR files. Applicable for storage format version 2 only.
  • max_file_size (optional) - maximum size in MB of the file with segments. Applicable for storage format version 2 only.
  • jpg_thumbnails (optional) - defines whether JPEG thumbnails generation is enabled. If this parameter is true, then at least one of jpg_thumbnail_width and jpg_thumbnail_height parameters should be specified. If width or height only is specified, then Nimble will calculate second parameter automatically. Live Transcoder should be installed to support this feature.
  • jpg_thumbnails_playlist (optional) - defines whether JPEG thumbnails playlist generation is enabled. It is applicable if jpg_thumbnails parameter is true only. Live Transcoder should be installed to support this feature.
  • jpg_thumbnail_width (optional) - JPEG thumbnails width.
  • jpg_thumbnail_height (optional) - JPEG thumbnails height.
  • scte35_markers (optional) - defines whether keep SCTE-35 markers mode is enabled.
  • id3_info (optional) - defines whether keep ID3 metadata mode is enabled.
  • dvb_subtitles (optional) - defines whether keep DVB subtitles mode is enabled.
  • webvtt_subtitles - defines whether keep WebVTT subtitles mode is enabled.
  • klv_metadata (optional) - defines whether keep KLV metadata mode is enabled.
  • iframe_playlist (optional) - defines whether generate I-Frame playlist mode is enabled.
  • min_free_space_mb (optional) - minimum free storage space in megabytes required to continue DVR recording. Cannot be set in same request with min_free_space_percents. Use value 0 to make this field empty.
  • min_free_space_percents (optional) - minimum free storage space in percents required to continue DVR recording. Cannot be set in same request with min_free_space_mb. Use value 0 to make this field empty.
  • cleanup_older_than (optional) - time in hours to keep DVR archive. Older files will be removed. Use value 0 to make this field empty.
  • other_servers_to_apply (optional) - array of servers IDs, where this setting also should be created. Maximum 20 additional servers IDs can be included into one API call.
  • tags (optional) - custom tags for easy filtering on the settings web page.
Response example: 
    {
    "status": "Ok",
    "settings": [
      {
            "id": "561f2e3de2cd281667000007",
            "application": "live",
            "stream": "event",
            "path": "",
            "max_duration": 300,
            "max_size": 0,
            "segment_duration": 3,
            "thread_name": "default"
            "paused": true,
            "drop_invalid_segments": true,
            "keep_protocol_timestamps": false,
            "check_segment_sizes_on_load": false,
            "align_pdt": true,
            "storage_format": 2,
            "max_bucket_size": 2048,
            "max_file_size": 256,
            "jpg_thumbnails": true,
            "jpg_thumbnails_playlist": true,
            "jpg_thumbnail_width": 640,
            "jpg_thumbnail_height": 480,
            "scte35_markers": false,
            "id3_info": false,
            "dvb_subtitles": false,
            "webvtt_subtitles": false,
            "klv_metadata": false,
            "iframe_playlist": false,
            "tags": ["Events", "with thumbnails"]
      },
      {
            "id": "561f2e3de2cd281667000008",
            "application": "live",
            "stream": "event2",
            "path": "",
            "max_duration": 300,
            "max_size": 0,
            "segment_duration": 3,
            "thread_name": "default"
            "paused": true,
            "drop_invalid_segments": true,
            "keep_protocol_timestamps": false,
            "check_segment_sizes_on_load": false,
            "align_pdt": true,
            "storage_format": 2,
            "max_bucket_size": 2048,
            "max_file_size": 256,
            "jpg_thumbnails": true,
            "jpg_thumbnails_playlist": true,
            "jpg_thumbnail_width": 640,
            "jpg_thumbnail_height": 480,
            "scte35_markers": false,
            "id3_info": false,
            "dvb_subtitles": false,
            "webvtt_subtitles": false,
            "klv_metadata": false,
            "iframe_playlist": false,
            "tags": ["Events", "Second"]
        }
    ]
}
Response fields:
The same as in "Get list".

Update an existing DVR setting.
Request URL:
PUT https://api.wmspanel.com/v1/server/[server_id]/dvr/[setting_id]
Request parameters:

  • setting_id - is ID of the DVR setting obtained via "Get DVR settings list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"application": "nimble-live", "other_servers_to_apply": ["555a79e6fe7cd34664000006"]}' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/dvr/5526331a0640fd5ad6000002/?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields the same as in "Create a new DVR setting". All fields are optional.

Response example: 
    {
    "status": "Ok",
    "setting": {
          "id": "561f2e3de2cd281667000007",
          "application": "live",
          "stream": "event",
          "path": "",
          "max_duration": 300,
          "max_size": 0,
          "segment_duration": 3,
          "thread_name": "default",
          "paused": false,
          "drop_invalid_segments": true,
          "keep_protocol_timestamps": false,
          "check_segment_sizes_on_load": false,
          "align_pdt": true,
          "storage_format": 2,
          "max_bucket_size": 2048,
          "max_file_size": 256,
          "jpg_thumbnails": true,
          "jpg_thumbnails_playlist": true,
          "jpg_thumbnail_width": 640,
          "jpg_thumbnail_height": 480,
          "scte35_markers": false,
          "id3_info": false,
          "dvb_subtitles": false,
          "webvtt_subtitles": false,
          "klv_metadata": false,
          "iframe_playlist": false,
          "tags": ["Events", "with thumbnails"],
          "other_servers_applied": [
            {
                "setting_id": "62f9a4852c47e537fede1e50",
                "server_id": "555a79e6fe7cd34664000006"
            }
          ]
        }
}
Response fields:
  • other_servers_applied - array containing data about settings created on other servers (from "other_servers_to_apply" request field). This field is returned, when request contained "other_servers_to_apply" field only. Each array item is a hash structure with following fields:
    • setting_id - new setting ID
    • server_id - server ID, where new setting was created
Other response fields are the same as in "Get DVR settings list".

Update multiple existing DVR settings. Maximum 100 settings can be updated by one request. This API is disabled by default. Please, contact us to enable it.
Request URL:
PUT https://api.wmspanel.com/v1/server/[server_id]/dvr/multi
Request parameters:

  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '[{id: "5526331a0640fd5ad6000002","application": "nimble-live"}, {id: "5526331a0640fd5ad6000003","application": "nimble-live2"}]' "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/dvr/multi/?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body as array of structures.

Request data fields the same as in "Create a new DVR setting". All fields are optional except "id".

Response example: 
    {
    "status": "Ok",
    "settings": [
      {
          "id": "5526331a0640fd5ad6000002",
          "application": "nimble-live",
          "stream": "event",
          "path": "",
          "max_duration": 300,
          "max_size": 0,
          "segment_duration": 3,
          "thread_name": "default",
          "paused": false,
          "drop_invalid_segments": true,
          "keep_protocol_timestamps": false,
          "check_segment_sizes_on_load": false,
          "align_pdt": true,
          "storage_format": 2,
          "max_bucket_size": 2048,
          "max_file_size": 256,
          "jpg_thumbnails": true,
          "jpg_thumbnails_playlist": true,
          "jpg_thumbnail_width": 640,
          "jpg_thumbnail_height": 480,
          "scte35_markers": false,
          "id3_info": false,
          "dvb_subtitles": false,
          "webvtt_subtitles": true,
          "klv_metadata": false,
          "iframe_playlist": false
      },
      {
          "id": "5526331a0640fd5ad6000002",
          "application": "nimble-live2",
          "stream": "event",
          "path": "",
          "max_duration": 300,
          "max_size": 0,
          "segment_duration": 3,
          "thread_name": "default",
          "paused": false,
          "drop_invalid_segments": true,
          "keep_protocol_timestamps": false,
          "check_segment_sizes_on_load": false,
          "align_pdt": true,
          "storage_format": 2,
          "max_bucket_size": 2048,
          "max_file_size": 256,
          "jpg_thumbnails": true,
          "jpg_thumbnails_playlist": true,
          "jpg_thumbnail_width": 640,
          "jpg_thumbnail_height": 480,
          "scte35_markers": false,
          "id3_info": false,
          "dvb_subtitles": false,
          "webvtt_subtitles": false,
          "klv_metadata": false,
          "iframe_playlist": false
      }
    ]
}
Response fields:
The same as in "Get list".

Delete an existing DVR setting.
Request URL:
DELETE https://api.wmspanel.com/v1/server/[server_id]/dvr/[setting_id]
Request parameters:

  • setting_id - is ID of the DVR setting obtained via "Get DVR settings list" method.
  • server_id - is id of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/server/538bcbd3f5aef0bed900000d/dvr/5526331a0640fd5ad6000002/?client_id=[client_id]&api_key=[api_key]"

Response example: 
    {
    "status" : "Ok",
}

Retrieve a list of DVR recorded streams. You can view this list by navigating to "Nimble Streamer / DVR recorded streams" menu item.
Request URL:
GET https://api.wmspanel.com/v1/dvr_streams/
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • server_id - (optional) is ID of appropriate Nimble server, you can get it from the "Get servers list" API call. If not set, then DVR recorded streams from all Nimble servers will be returned.
  • app - (optional) application name to filter DVR recorded streams.
  • stream - (optional) stream name to filter DVR recorded streams. It is applicable if "app" parameter is not empty only.
CURL request example:
curl 'https://api.wmspanel.com/v1/dvr_streams?client_id=[client_id]&api_key=[api_key]&server_id=[server_id]'
Response example: 
    {
    "status" : "Ok",
    "dvr_streams" : [
      {
          "id": "248004473",
          "server_id": "5af93ff52c47e533b846a039",
          "stream": "app1/stream1",
          "path": "/dvr/video1",
          "duration": 12345,
          "size": 256000,
          "bandwidth": 1234,
          "resolution": "640x480",
          "video_codec": "testvcodec",
          "audio_codec": "testacodec",
          "read_only": true,
          "dvr_setting_id": "62900b882c47e57e45629835"
      },
      {
          "id": "248004473",
          "server_id": "5af93ff52c47e533b846a039",
          "stream": "app2/stream2",
          "path": "/dvr/video2",
          "duration": 54321,
          "size": 512000,
          "bandwidth": 1234,
          "resolution": "640x480",
          "video_codec": "testvcodec",
          "audio_codec": "testacodec",
          "read_only": false,
          "dvr_setting_id": "62900b872c47e57e45629833",
          "tags": ["Second stream", "With subtitles"]
      }
    ]
}
Response fields:
  • id - unique DVR stream ID for further usage.
  • server_id - stream's server ID.
  • stream - "application/stream" value.
  • path - recodring path on the server.
  • duration - record duration in seconds.
  • size - record size in bytes.
  • bandwidth - data transmission rate measured in bits per second.
  • resolution - video resolution measured in pixels (e.g. "720x240").
  • video_codec - video codec name.
  • audio_codec - audio codec name.
  • read_only - boolean flag indicating DVR stream, which is not currently recording.
  • dvr_setting_id - related DVR setting unique ID.
  • tags - custom tags of the related DVR setting used for easy filtering on the DVR streams web page.

Delete an existing DVR recorded stream.
Request URL:
DELETE https://api.wmspanel.com/v1/dvr_streams/[stream_id]
Request parameters:

  • stream_id - is ID of the DVR stream obtained at via "Get DVR recorded streams list" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/dvr_streams/[stream_id]?client_id=[client_id]&api_key=[api_key]"

Response example: 
{
    "status" : "Ok",
}

Retrieve list of server-side tasks for particular Nimble server. You can view this list by navigating to "Control / Server-side tasks control" menu item and choosing appropriate Nimble server in the server select box.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/tasks
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/5742bb0a08238975a100000b/tasks?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "tasks": [
        {
            "id": "542d024e78a6fc4ab4000052",
            "command": "ffmpeg -re -i test/content/mp4/sample.mp4 -c copy -f flv rtmp://127.0.0.1:1999/live/stream",
            "alias": "Stream to 1999 port",
            "status": "failed",
            "autorestart": true,
            "restart_if_no_output": true,
            "restart_interval": 14,
            "restart_if_no_output_interval": 8,
            "tags": ["ffmpeg", "rtmp push"]
        },
        {
            "id": "546071ce78a6fcd151000011",
            "command": "ps -e",
            "alias": "",
            "status": "starting",
            "autorestart": false,
            "restart_if_no_output": false,
            "tags": ["utilities"]
        },
        {
            "id": "546076e77d5c00db60000001",
            "command": "ffmpeg -re -i test/content/mp4/sample.mp4 -c copy -f flv rtmp://127.0.0.1:1999/live/stream2",
            "alias": "",
            "status": "stopped",
            "autorestart": true,
            "restart_if_no_output": false,
            "restart_interval": 5
        },
        {
            "id": "546076e77d5c00db60000002",
            "command": "ffmpeg -re -i test/content/mp4/sample.mp4 -c copy -f flv rtmp://127.0.0.1:1999/live/stream1",
            "alias": "Very important task",
            "status": "stopped",
            "autorestart": true,
            "restart_if_no_output": false,
            "restart_interval": 5,
            "tags": ["ffmpeg", "high priority"]
        }
    ]
}
Response fields:
  • id - unique server-side task ID for further usage.
  • command - a command that should be run on given server.
  • alias - task alias, which is used as a name of given task in the Server-side tasks list UI.
  • tags - custom tags for easy filtering on the tasks web page.
  • status - current status of given task. Can be one of the following values:
    • "starting" - appears when task start is initiated via UI or API call till the moment when server reports actual status of the task
    • "stopping" - appears when task stop is initiated via UI or API call till the moment when server reports actual status of the task
    • "restarting" - appears when task restart is initiated via UI or API call till the moment when server reports actual status of the task
    • "running" - appears when server reports that given task is running at the moment
    • "stopped" - appears when server reports that given task has been stopped at the moment without any error
    • "failed" - appears when server reports that given task has failed at the moment
  • autorestart - defines whether Nimble Streamer should restart task automatically after it has finished or failed.
  • restart_interval - a number of seconds that Nimble Streamer must wait for to restart the task after it has finished or failed. This parameter is presented only if "autorestart" parameter is set to true.
  • restart_if_no_output - defines whether Nimble Streamer should restart task automatically in case of no output from the task.
  • restart_if_no_output_interval - a number of seconds that Nimble Streamer must wait for to restart the task in case of no output from the task. This parameter is presented only if "restart_if_no_output" parameter is set to true.
  • info - an error output of the task in case of failure. This parameter is presented only if status of the task is either "failed" or "failed_pending".

Pick up a server-side task.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/tasks/[task_id]
Request parameters:

  • task_id - is ID of a server-side task obtained via "Get tasks list" method
  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/5742bb0a08238975a100000b/tasks/546076e77d5c00db60000001?client_id=[client_id]&api_key=[api_key]'
Response example: 
{
    "status": "Ok",
    "task": {
        "id": "546076e77d5c00db60000001",
        "command": "ffmpeg -re -i test/content/mp4/sample.mp4 -c copy -f flv rtmp://127.0.0.1:1999/live/stream2",
        "alias": "",
        "status": "stopped",
        "autorestart": true,
        "restart_if_no_output": false,
        "restart_interval": 5
    }
}
Response fields:
  • id - unique server-side task ID for further usage.
  • command - a command that should be run on given server.
  • alias - task alias, which is used as a name of given task in the Server-side tasks list UI.
  • tags - custom tags for easy filtering on the tasks web page.
  • status - current status of given task. Can be one of the following values:
    • "starting" - appears when task start is initiated via UI or API call till the moment when server reports actual status of the task
    • "stopping" - appears when task stop is initiated via UI or API call till the moment when server reports actual status of the task
    • "restarting" - appears when task restart is initiated via UI or API call till the moment when server reports actual status of the task
    • "running" - appears when server reports that given task is running at the moment
    • "stopped" - appears when server reports that given task has been stopped at the moment without any error
    • "failed" - appears when server reports that given task has failed at the moment
  • autorestart - defines whether Nimble Streamer should restart task automatically after it has finished or failed.
  • restart_interval - a number of seconds that Nimble Streamer must wait for to restart the task after it has finished or failed. This parameter is presented only if "autorestart" parameter is set to true.
  • restart_if_no_output - defines whether Nimble Streamer should restart task automatically in case of no output from the task.
  • restart_if_no_output_interval - a number of seconds that Nimble Streamer must wait for to restart the task in case of no output from the task. This parameter is presented only if "restart_if_no_output" parameter is set to true.
  • info - an error output of the task in case of failure. This parameter is presented only if status of the task is either "failed" or "failed_pending".

Create a new server-side task.
Request URL:
POST https://api.wmspanel.com/v1/server/[server_id]/tasks
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{"command": "top -n 1 -b > /usr/local/processtable.txt"}' "https://api.wmspanel.com/v1/server/5742bb0a08238975a100000b/tasks?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • command - a command that should be run on given server.
  • alias (optional) - task alias, which is used as a name of given task in the Server-side tasks list UI.
  • tags (optional) - custom tags for easy filtering on the tasks web page.
  • autorestart (optional) - defines whether Nimble Streamer should restart task automatically after it has finished or failed. By default, it's set to false.
  • restart_interval (optional) - a number of seconds that Nimble Streamer must wait for to restart the task after it has finished or failed. This parameter is presented only if "autorestart" parameter is set to true. By default, it's set to 15 seconds.
  • restart_if_no_output (optional) - defines whether Nimble Streamer should restart task automatically in case of no output from the task. By default, it's set to false.
  • restart_if_no_output_interval (optional) - a number of seconds that Nimble Streamer must wait for to restart the task in case of no output from the task. This parameter is presented only if "restart_if_no_output" parameter is set to true. By default, it's set to 10 seconds.
Response example: 
{
    "status": "Ok",
    "task": {
        "id": "5743e0630823899c56000001",
        "command": "top -n 1 -b > /usr/local/processtable.txt",
        "alias": "",
        "status": "starting",
        "autorestart": false,
        "restart_if_no_output": false
    }
}
Response fields:
The same as in "Get an existing task".

Create multiple new server-side tasks. Maximum 100 server-side tasks can be created by one request. This API is disabled by default. Please, contact us to enable it.
Request URL:
POST https://api.wmspanel.com/v1/server/[server_id]/tasks/multi
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '[{"command": "top -n 1 -b > /usr/local/processtable.txt", "tags": ["snapshot"]},{"command": "top -n 1 -b > /usr/local/processtable2.txt", "tags": ["snapshot"]}]' "https://api.wmspanel.com/v1/server/5742bb0a08238975a100000b/tasks/multi?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body as array of structures.

Request data fields:
  • command - a command that should be run on given server.
  • alias (optional) - task alias, which is used as a name of given task in the Server-side tasks list UI.
  • tags (optional) - custom tags for easy filtering on the tasks web page.
  • autorestart (optional) - defines whether Nimble Streamer should restart task automatically after it has finished or failed. By default, it's set to false.
  • restart_interval (optional) - a number of seconds that Nimble Streamer must wait for to restart the task after it has finished or failed. This parameter is presented only if "autorestart" parameter is set to true. By default, it's set to 15 seconds.
  • restart_if_no_output (optional) - defines whether Nimble Streamer should restart task automatically in case of no output from the task. By default, it's set to false.
  • restart_if_no_output_interval (optional) - a number of seconds that Nimble Streamer must wait for to restart the task in case of no output from the task. This parameter is presented only if "restart_if_no_output" parameter is set to true. By default, it's set to 10 seconds.
Response example: 
{
    "status": "Ok",
    "tasks": [
      {
          "id": "5743e0630823899c56000001",
          "command": "top -n 1 -b > /usr/local/processtable.txt",
          "alias": "",
          "status": "starting",
          "autorestart": false,
          "restart_if_no_output": false,
          "tags": ["snapshot"]
      },
      {
          "id": "5743e0630823899c56000002",
          "command": "top -n 1 -b > /usr/local/processtable2.txt",
          "alias": "",
          "status": "starting",
          "autorestart": false,
          "restart_if_no_output": false,
          "tags": ["snapshot"]
      }
    ]
}
Response fields:
The same as in "Get list".

Update specific server-side task.
Request URL:
PUT https://api.wmspanel.com/v1/server/[server_id]/tasks/[task_id]
Request parameters:

  • task_id - is ID of a server-side task obtained via "Get tasks list" method
  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"autorestart": true, "restart_interval": 1, "alias": "Process table snapshot", "tags": ["snapshot", "performance"]}' "https://api.wmspanel.com/v1/server/5742bb0a08238975a100000b/tasks/5743e0630823899c56000001?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • command - a command that should be run on given server.
  • alias - task alias, which is used as a name of given task in the Server-side tasks list UI.
  • tags - custom tags for easy filtering on the tasks web page.
  • autorestart - defines whether Nimble Streamer should restart task automatically after it has finished or failed. By default, it's set to false.
  • restart_interval - a number of seconds that Nimble Streamer must wait for to restart the task after it has finished or failed. This parameter is presented only if "autorestart" parameter is set to true. By default, it's set to 15 seconds.
  • restart_if_no_output - defines whether Nimble Streamer should restart task automatically in case of no output from the task. By default, it's set to false.
  • restart_if_no_output_interval - a number of seconds that Nimble Streamer must wait for to restart the task in case of no output from the task. This parameter is presented only if "restart_if_no_output" parameter is set to true. By default, it's set to 10 seconds.
All fields are optional.

Response example: 
{
    "status": "Ok",
    "task": {
        "id": "5743e0630823899c56000001",
        "command": "top -n 1 -b > /usr/local/processtable.txt",
        "alias": "Process table snapshot",
        "status": "stopped",
        "autorestart": true,
        "restart_if_no_output": false,
        "restart_interval": 1,
        "tags": ["snapshot", "performance"]
    }
}
Response fields: The same as in "Get an existing task".

Update multiple server-side tasks. Maximum 100 server-side tasks can be updated by one request. This API is disabled by default. Please, contact us to enable it.
Request URL:
PUT https://api.wmspanel.com/v1/server/[server_id]/tasks/multi
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '[{"id": "5743e0630823899c56000001", "autorestart": true, "restart_interval": 1, "alias": "Process table snapshot", "tags": ["primary"]}, {"id": "5743e0630823899c56000002", "alias": "Second task", "tags": ["secondary"]}]' "https://api.wmspanel.com/v1/server/5742bb0a08238975a100000b/tasks/multi?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body as array of structures.

Request data fields:
  • id - unique server-side task ID.
  • command - a command that should be run on given server.
  • alias - task alias, which is used as a name of given task in the Server-side tasks list UI.
  • tags - custom tags for easy filtering on the tasks web page.
  • autorestart - defines whether Nimble Streamer should restart task automatically after it has finished or failed. By default, it's set to false.
  • restart_interval - a number of seconds that Nimble Streamer must wait for to restart the task after it has finished or failed. This parameter is presented only if "autorestart" parameter is set to true. By default, it's set to 15 seconds.
  • restart_if_no_output - defines whether Nimble Streamer should restart task automatically in case of no output from the task. By default, it's set to false.
  • restart_if_no_output_interval - a number of seconds that Nimble Streamer must wait for to restart the task in case of no output from the task. This parameter is presented only if "restart_if_no_output" parameter is set to true. By default, it's set to 10 seconds.
All fields except "id" are optional.

Response example: 
{
    "status": "Ok",
    "tasks": [
      {
          "id": "5743e0630823899c56000001",
          "command": "top -n 1 -b > /usr/local/processtable.txt",
          "alias": "Process table snapshot",
          "status": "stopped",
          "autorestart": true,
          "restart_if_no_output": false,
          "restart_interval": 1,
          "tags": ["primary"]
      },
      {
          "id": "5743e0630823899c56000002",
          "command": "top -n 1 -b > /usr/local/processtable.txt",
          "alias": "Second task",
          "status": "stopped",
          "autorestart": true,
          "restart_if_no_output": false,
          "restart_interval": 1,
          "tags": ["secondary"]
      }
    ]
}
Response fields: The same as in "Get list".

Delete specific server-side task.
Request URL:
DELETE https://api.wmspanel.com/v1/server/[server_id]/tasks/[task_id]
Request parameters:

  • task_id - is ID of a server-side task obtained via "Get tasks list" method
  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/server/5742bb0a08238975a100000b/tasks/5742bb6a08238975a100000d?client_id=[client_id]&api_key=[api_key]"

Response example: 
{
    "status" : "Ok",
}

Delete multiple server-side tasks. Maximum 100 server-side tasks can be deleted by one request. This API is disabled by default. Please, contact us to enable it.
Request URL:
DELETE https://api.wmspanel.com/v1/server/[server_id]/tasks/multi
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE -H 'Content-Type: application/json' -d '["5743e0630823899c56000001", "5743e0630823899c56000002"]' "https://api.wmspanel.com/v1/server/5742bb0a08238975a100000b/tasks/multi?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body as array of server-side tasks ids.

Response example: 
{
    "status" : "Ok",
    "settings_removed": 2
}

Start specific server-side task.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/tasks/[task_id]/start
Request parameters:

  • task_id - is ID of a server-side task obtained via "Get tasks list" method
  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl "https://api.wmspanel.com/v1/server/5742bb0a08238975a100000b/tasks/5743e0630823899c56000001/start?client_id=[client_id]&api_key=[api_key]"

Response example: 
{
    "status" : "Ok",
}

Stop specific server-side task.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/tasks/[task_id]/stop
Request parameters:

  • task_id - is ID of a server-side task obtained via "Get tasks list" method
  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl "https://api.wmspanel.com/v1/server/5742bb0a08238975a100000b/tasks/5743e0630823899c56000001/stop?client_id=[client_id]&api_key=[api_key]"

Response example: 
{
    "status" : "Ok",
}

Restart specific server-side task.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/tasks/[task_id]/restart
Request parameters:

  • task_id - is ID of a server-side task obtained via "Get tasks list" method
  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl "https://api.wmspanel.com/v1/server/5742bb0a08238975a100000b/tasks/5743e0630823899c56000001/restart?client_id=[client_id]&api_key=[api_key]"

Response example: 
{
    "status" : "Ok",
}

Retrieve list of all alias settings for your company. If server ID is specified as optional parameter in the request url, then returned list contains only aliases concerned with that server. You can view this list by navigating to "Nimble Streamer / Aliases" section of the main menu.
Request URL:
GET https://api.wmspanel.com/v1/aliases
Request parameters:

  • server_id - (optional) is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/aliases?client_id=[client_id]&api_key=[api_key]&server_id=[server_id]'
Response example: 
    {
    "status": "Ok",
    "settings": [
        {
            "id": "57451d7f08238907ca000008",
            "application": "live",
            "protocols": [
                "HTTP",
                "RTMP"
            ],
            "paused": false,
            "aliases": [
                {
                    "application": "user-[a-z0-9]+",
                    "regexp": true
                },
                {
                    "application": "live-admin"
                },
                {
                    "application": "start-trial"
                }
            ],
            "server_ids": [
                "538bcbd3f5aef0bed9000003",
                "538bcbd3f5aef0bed9000007",
                "538bcbd3f5aef0bed9000009"
            ],
            "description": "Live alias",
            "tags": ["start", "live", "user"]
        },
        {
            "id": "574512ca08238907ca000003",
            "application": "nimble_live",
            "protocols": [
                "HTTP",
                "RTMP",
                "RTSP"
            ],
            "paused": false,
            "aliases": [
                {
                    "application": "auto-event"
                },
                {
                    "application": "-live$",
                    "regexp": true
                }
            ],
            "server_ids": [
                "538bcbd3f5aef0bed9000003",
                "538bcbd3f5aef0bed9000004",
                "538bcbd3f5aef0bed9000007",
                "538bcbd3f5aef0bed9000009",
                "538bcbd3f5aef0bed900000c",
                "538bcbd3f5aef0bed900000d",
                "538bcbd3f5aef0bed900000e",
                "539e84a75cc8f54c53000003",
                "53c709f55cc8f51a2f00000f",
                "53e97fbd7303917ee7000004",
                "54396b04f5aef090ea00000a",
                "54fcfbb0639bbd6c77000007",
                "5742bb0a08238975a100000b"
            ],
            "description": "",
            "tags": ["auto", "live"]
        }
    ]
}
Response fields:
  • id - unique alias setting ID for further usage.
  • application - name of application which the following aliases are set for.
  • protocols - list of protocols those given alias setting is applied to. Possible values are: "HTTP", "RTMP" and "RTSP".
  • paused - defines whether given alias setting isn't active at the moment.
  • aliases - list of application aliases. Each alias is specified by two parameters:
    • "application" — either single application name or regular expression string.
    • "regexp" — boolean value, that defines whether "application" parameter should be treated as regular expression. If not specified, then its value is treated as false.
  • server_ids - list of IDs of servers where given alias setting is applied.
  • description - custom description of the alias.
  • tags - custom tags for easy filtering on the settings web page.

Pick up an alias setting.
Request URL:
GET https://api.wmspanel.com/v1/aliases/[setting_id]
Request parameters:

  • setting_id - is ID of an alias setting obtained via "Get alias settings list" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/aliases/57451d7f08238907ca000008?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "setting": {
        "id": "574512ca08238907ca000003",
        "application": "nimble_live",
        "protocols": [
            "HTTP",
            "RTMP",
            "RTSP"
        ],
        "paused": false,
        "aliases": [
            {
                "application": "auto-event"
            },
            {
                "application": "-live$",
                "regexp": true
            }
        ],
        "server_ids": [
            "538bcbd3f5aef0bed9000003",
            "538bcbd3f5aef0bed9000004",
            "538bcbd3f5aef0bed9000007",
            "538bcbd3f5aef0bed9000009",
            "538bcbd3f5aef0bed900000c",
            "538bcbd3f5aef0bed900000d",
            "538bcbd3f5aef0bed900000e",
            "539e84a75cc8f54c53000003",
            "53c709f55cc8f51a2f00000f",
            "53e97fbd7303917ee7000004",
            "54396b04f5aef090ea00000a",
            "54fcfbb0639bbd6c77000007",
            "5742bb0a08238975a100000b"
        ],
        "description": "",
        "tags": ["auto", "live"]
    }
}
Response fields:
  • id - unique alias setting ID for further usage.
  • application - name of application which the following aliases are set for.
  • protocols - list of protocols those given alias setting is applied to. Possible values are: "HTTP", "RTMP" and "RTSP".
  • paused - defines whether given alias setting isn't active at the moment.
  • aliases - list of application aliases. Each alias is specified by two parameters:
    • "application" — either single application name or regular expression string.
    • "regexp" — boolean value, that defines whether "application" parameter should be treated as regular expression. If not specified, then its value is treated as false.
  • server_ids - list of IDs of servers where given alias setting is applied.
  • description - custom description of the alias.
  • tags - custom tags for easy filtering on the settings web page.

Create a new alias setting.
Request URL:
POST https://api.wmspanel.com/v1/aliases
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{"application": "rollandgarros", "aliases": [{"application": "tennis-tv-1"}, {"application": "sport-vl"}, {"application": "french-open"}], "description": "Rolland Garros", "tags": ["tennis", "sports", "france"]}' "https://api.wmspanel.com/v1/aliases?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • application - name of application which the following aliases are set for.
  • aliases - list of application aliases. Each alias is specified by two parameters:
    • "application" — either single application name or regular expression string.
    • "regexp" — boolean value, that defines whether "application" parameter should be treated as regular expression. If not specified, then its value is treated as false.
  • protocols (optional) - list of protocols those given alias setting is applied to. Possible values are: "HTTP", "RTMP" and "RTSP".
  • paused (optional) - defines whether given alias setting isn't active at the moment.
  • server_ids (optional) - list of IDs of servers where given alias setting is applied.
  • description (optional) - custom description of the alias.
  • tags (optional) - custom tags for easy filtering on the settings web page.
Response example: 
    {
    "status": "Ok",
    "setting": {
        "id": "57465df0082389437a000009",
        "application": "rollandgarros",
        "protocols": [
            "HTTP",
            "RTMP",
            "RTSP"
        ],
        "paused": false,
        "aliases": [
            {
                "application": "tennis-tv-1"
            },
            {
                "application": "sport-vl"
            },
            {
                "application": "french-open"
            }
        ],
        "server_ids": [],
        "description": "Rolland Garros",
        "tags": ["tennis", "sports", "france"]
    }
}
Response fields: The same as in "Get an existing alias setting".

Update an existing alias setting.
Request URL:
PUT https://api.wmspanel.com/v1/aliases/[setting_id]
Request parameters:

  • setting_id - is ID of an alias setting obtained via "Get alias settings list" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"protocols": ["HTTP", "RTMP"], "server_ids": ["53e97fbd7303917ee7000004", "54396b04f5aef090ea00000a", "54fcfbb0639bbd6c77000007", "5742bb0a08238975a100000b"]}' "https://api.wmspanel.com/v1/aliases/57465df0082389437a000009?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • application - name of application which the following aliases are set for.
  • aliases - list of application aliases. Each alias is specified by two parameters:
    • "application" — either single application name or regular expression string.
    • "regexp" — boolean value, that defines whether "application" parameter should be treated as regular expression. If not specified, then its value is treated as false.
  • protocols - list of protocols those given alias setting is applied to. Possible values are: "HTTP", "RTMP" and "RTSP".
  • paused - defines whether given alias setting isn't active at the moment.
  • server_ids - list of IDs of servers where given alias setting is applied.
  • description - custom description of the alias.
  • tags - custom tags for easy filtering on the settings web page.
All fields are optional.

Response example: 
    {
    "status": "Ok",
    "setting": {
        "id": "57465df0082389437a000009",
        "application": "rollandgarros",
        "protocols": [
            "HTTP",
            "RTMP"
        ],
        "paused": false,
        "aliases": [
            {
                "application": "tennis-tv-1"
            },
            {
                "application": "sport-vl"
            },
            {
                "application": "french-open"
            }
        ],
        "server_ids": [
            "53e97fbd7303917ee7000004",
            "54396b04f5aef090ea00000a",
            "54fcfbb0639bbd6c77000007",
            "5742bb0a08238975a100000b"
        ],
        "description": "Rolland Garros",
        "tags": ["tennis", "sports", "france"]
    }
}
Response fields: The same as in "Get an existing alias setting".

Delete an existing alias setting.
Request URL:
DELETE https://api.wmspanel.com/v1/aliases/[setting_id]
Request parameters:

  • setting_id - is ID of an alias setting obtained via "Get alias settings list" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/aliases/57465df0082389437a000009/?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Response example: 
    {
    "status" : "Ok",
}

Set priority order for all alias settings by listing them from the most important to the least important. You may specify some general alias via regular expression, and then override it with specific alias for some specific stream.
Request URL:
PUT https://api.wmspanel.com/v1/aliases/set_priority_order
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"ids": ["57465df0082389437a000009", "574512ca08238907ca000003", "57451d7f08238907ca000008"]}' "https://api.wmspanel.com/v1/aliases/set_priority_order/?client_id=[client_id]&api_key=[api_key]"

Response example: 
    {
    "status" : "Ok",
}

Retrieve a list of all HTTP origin applications for your company. You can view this list by navigating to "Nimble Streamer / HTTP origin applications".
Request URL:
GET https://api.wmspanel.com/v1/origin_apps
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/origin_apps?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "settings": [
        {
            "id": "54f903dc639bbdf32b000016",
            "application": "1214_singapore",
            "server_ids": [
                "538bcbd3f5aef0bed900000e"
            ],
            "tags": ["singapore", "tv"]
        },
        {
            "id": "54f9076e639bbdf32b00001a",
            "application": "sportbox2016",
            "server_ids": [
                "538bcbd3f5aef0bed900000d",
                "538bcbd3f5aef0bed9000003"
            ],
            "tags": ["sport", "tv"]
        },
        {
            "id": "54f9184a639bbd0a72000006",
            "application": "qwe_ts",
            "server_ids": [
                "538bcbd3f5aef0bed900000d"
            ]
        }
    ]
}
Response fields:
  • id - unique origin application setting ID for further usage.
  • application - application name that target media servers should process as HTTP origin.
  • tags - custom tags for easy filtering on the settings web page.
  • server_ids - a list of IDs of servers those given setting is applied to.

Pick up specific HTTP origin application.
Request URL:
GET https://api.wmspanel.com/v1/origin_apps/[setting_id]
Request parameters:

  • setting_id - is ID of the HTTP origin application obtained via "Get list of HTTP origin applications" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl "https://api.wmspanel.com/v1/origin_apps/54f903dc639bbdf32b000016?client_id=[client_id]&api_key=[api_key]"
Response example: 
    {
    "status": "Ok",
    "setting": {
        "id": "54f903dc639bbdf32b000016",
        "application": "1214_singapore",
        "server_ids": [
            "538bcbd3f5aef0bed900000e"
        ],
        "tags": ["singapore", "tv"]
    }
}
Response fields:
  • id - unique origin application setting ID for further usage.
  • application - application name that target media servers should process as HTTP origin.
  • tags - custom tags for easy filtering on the settings web page.
  • server_ids - a list of IDs of servers those given setting is applied to.

Specify new HTTP origin application.
Request URL:
POST https://api.wmspanel.com/v1/origin_apps
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{"application": "smart_start_eu", "tags": ["new"], "server_ids": ["538bcbd3f5aef0bed900000d", "538bcbd3f5aef0bed9000003"]}' "https://api.wmspanel.com/v1/origin_apps?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • application - application name that target media servers should process as HTTP origin.
  • tags (optional) - custom tags for easy filtering on the settings web page.
  • server_ids (optional) - a list of IDs of servers those given setting is applied to. You can retrieve all of your server IDs from the "Get servers list" API call.
Response example: 
    {
    "status": "Ok",
    "setting": {
        "id": "5784543208238947aa000001",
        "application": "smart_start_eu",
        "server_ids": [
            "538bcbd3f5aef0bed900000d",
            "538bcbd3f5aef0bed9000003"
        ],
        "tags": ["new"]
    }
}
Response fields: The same as in "Get an existing origin application".

Update an existing HTTP origin application setting.
Request URL:
PUT https://api.wmspanel.com/v1/origin_apps/[setting_id]
Request parameters:

  • setting_id - is ID of the HTTP origin application obtained via "Get list of HTTP origin applications" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"application": "isencour_ts", "tags": ["isencour"], "server_ids": ["538bcbd3f5aef0bed900000d"]}' "https://api.wmspanel.com/v1/origin_apps/54f9184a639bbd0a72000006/?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • application - application name that target media servers should process as HTTP origin.
  • tags - custom tags for easy filtering on the settings web page.
  • server_ids - a list of IDs of servers those given setting is applied to. You can retrieve all of your server IDs from the "Get servers list" API call.
Both fields are optional.

Response example: 
    {
    "status": "Ok",
    "setting": {
        "id": "54f9184a639bbd0a72000006",
        "application": "isencour_ts",
        "server_ids": [
            "538bcbd3f5aef0bed900000d"
        ],
        "tags": ["isencour"]
    }
}
Response fields: The same as in "Get an existing origin application".

Delete an existing HTTP origin application.
Request URL:
DELETE https://api.wmspanel.com/v1/origin_apps/[setting_id]
Request parameters:

  • setting_id - is ID of the HTTP origin application obtained via "Get list of HTTP origin applications" method.
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/origin_apps/54f9184a639bbd0a72000006?client_id=[client_id]&api_key=[api_key]"

Response example: 
    {
    "status" : "Ok",
}

Retrieve publish control handler settings for given Nimble server. You can view these setting by navigating to "Control / Publish control" main menu item, choosing appropriate Nimble server in the server select box and clicking on "Handler settings" tab.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/publish_control/handler
Request parameters:

  • server_id - is ID of appropriate Nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl "https://api.wmspanel.com/v1/server/5742bb0a08238975a100000b/publish_control/handler?client_id=[client_id]&api_key=[api_key]"

Response example: 
    {
    "status": "Ok",
    "handler": {
        "url": "http://isengard.exp/publ_handler",
        "group_interval": 500
    }
}
Response fields:
  • url - URL to handler application which is able to process POST requests and return the response according to your business logic.
  • group_interval - grouping interval for the incoming streams. The handler is called with some timeout to aggregate several requests in one.

Update publish control handler settings for given Nimble server.
Request URL:
PUT https://api.wmspanel.com/v1/server/[server_id]/publish_control/handler
Request parameters:

  • server_id - is ID of appropriate Nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"url": "http://isengard.exp/ppp_h", group_interval: 300}' "https://api.wmspanel.com/v1/server/5742bb0a08238975a100000b/publish_control/handler?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • url - URL to handler application which is able to process POST requests and return the response according to your business logic. If this parameter is empty then given server will not try to call the handler.
  • group_interval - grouping interval for the incoming streams.


Response example: 
    {
    "status": "Ok",
    "handler": {
        "url": "http://isengard.exp/ppp_h",
        "group_interval": 300
    }
}
Response fields: The same as in "Get publish control handler settings".

Retrieve list of publish application settings for particular Nimble server. You can view these settings by navigating to "Control / Publish control" main menu item and choosing appropriate Nimble server in the server select box.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/publish_control/applications
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/5742bb0a08238975a100000b/publish_control/applications?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "settings": [
        {
            "id": "57830b3a082389d270000004",
            "application": "watched",
            "password": "strong_password",
            "allow_by_default": true,
            "signature_free_mode": true
        },
        {
            "id": "57830b50082389d270000007",
            "application": "closed",
            "password": "der_parol",
            "allow_by_default": false,
            "signature_free_mode": false
        },
        {
            "id": "57830dfd082389d270000009",
            "application": "music_box_eu",
            "password": "QvbxP23P@s",
            "allow_by_default": true,
            "signature_free_mode": false
        }
    ]
}
Response fields:
  • id - unique application setting ID for further usage.
  • application - publishing application name.
  • password - a secret key which is used for generating publish signature and ensures its strength.
  • allow_by_default - defines whether requested stream should be served if publish control handler isn't available. If this parameter is set to false, then the stream will be blocked in such case.
  • signature_free_mode - defines whether password should be used. If this parameter is set to true, then password field will not be synced to Nimble.

Pick up an application setting.
Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/publish_control/applications/[setting_id]
Request parameters:

  • setting_id - is ID of an application setting obtained via "Get application settings list" method
  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/5742bb0a08238975a100000b/publish_control/applications/57830dfd082389d270000009?client_id=[client_id]&api_key=[api_key]'
Response example: 
    {
    "status": "Ok",
    "setting": {
        "id": "57830dfd082389d270000009",
        "application": "music_box_eu",
        "password": "QvbxP23P@s",
        "allow_by_default": true,
        "signature_free_mode": false
    }
}
Response fields:
  • id - unique application setting ID for further usage.
  • application - publishing application name.
  • password - a secret key which is used for generating publish signature and ensures its strength.
  • allow_by_default - defines whether requested stream should be served if publish control handler isn't available. If this parameter is set to false, then the stream will be blocked in such case.
  • signature_free_mode - defines whether password should be used. If this parameter is set to true, then password field will not be synced to Nimble.

Create a new application setting.
Request URL:
POST https://api.wmspanel.com/v1/server/[server_id]/publish_control/applications
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{"application": "publ_users", "password": "St@ge13a"}' "https://api.wmspanel.com/v1/server/5742bb0a08238975a100000b/publish_control/applications?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • application - publishing application name.
  • password (optional) - a secret key which is used for generating publish signature and ensures its strength.
  • allow_by_default (optional) - defines whether requested stream should be served if publish control handler isn't available. If this parameter is set to false, then the stream will be blocked in such case. By default, it's set to false.
  • signature_free_mode (optional) - defines whether password should be used. If this parameter is set to true, then password field will not be synced to Nimble.
Response example: 
    {
    "status": "Ok",
    "setting": {
        "id": "57847ba308238980b2000001",
        "application": "publ_users",
        "password": "St@ge13a",
        "allow_by_default": false,
        "signature_free_mode": false
    }
}
Response fields: The same as in "Get an existing application setting".

Update specific application setting.
Request URL:
PUT https://api.wmspanel.com/v1/server/[server_id]/publish_control/applications/[setting_id]
Request parameters:

  • setting_id - is ID of an application setting obtained via "Get application settings list" method
  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"allow_by_default": false, "password": "QvbxP23P@XstB"}' "https://api.wmspanel.com/v1/server/5742bb0a08238975a100000b/publish_control/applications/57830dfd082389d270000009?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • application - publishing application name.
  • password - a secret key which is used for generating publish signature and ensures its strength.
  • allow_by_default - defines whether requested stream should be served if publish control handler isn't available. If this parameter is set to false, then the stream will be blocked in such case.
  • signature_free_mode - defines whether password should be used. If this parameter is set to true, then password field will not be synced to Nimble.
All fields are optional.

Response example: 
    {
    "status": "Ok",
    "setting": {
        "id": "57830dfd082389d270000009",
        "application": "music_box_eu",
        "password": "QvbxP23P@XstB",
        "allow_by_default": false,
        "signature_free_mode": false
    }
}
Response fields: The same as in "Get an existing application setting".

Delete specific application setting.
Request URL:
DELETE https://api.wmspanel.com/v1/server/[server_id]/publish_control/applications/[setting_id]
Request parameters:

  • setting_id - is ID of an application setting obtained via "Get application settings list" method
  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/server/5742bb0a08238975a100000b/publish_control/applications/57830dfd082389d270000009?client_id=[client_id]&api_key=[api_key]"

Response example: 
    {
    "status" : "Ok",
}

The overall approach for Transcoder API usage is as follows.

  • Use web UI to create some general-purpose scenarios which you consider as templates. You may use your existing scenarios as well. The rest is done via the API calls.
  • Clone a designated scenario on the same server. This is what you will change via further API calls.
  • Apply any scenario to multiple servers just like you would do via the web UI by making its update and setting servers_to_apply parameter in your call.
  • Besides an update, each scenarios can be paused, resumed and even removed.
  • Each scenario has its video and audio pipelines (you can see them via UI) and you can remove them if they are not needed in some particular case.
  • For each pipeline you will be able to change applications and streams names for encoders input and decoders output, decoder, encoder, codec and some other parameters.
  • For each pipeline you can change some basic parameters of existing filters.
  • This way you may create some general purpose scenarios, pause them to make them to be templates, then clone as many as you want and then narrow them to specific cases.

Retrieve list of transcoder scenarios for company or particular Nimble server. You can view this list by navigating to "Transcoders" menu item.
Request URL:
GET https://api.wmspanel.com/v1/transcoder
Request parameters:

  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • server_id (optional) - is ID of appropriate Nimble server, you can get it from the "Get servers list" API call. If server_id is not set, then transcoder scenarios for all servers will be returned
CURL request example:
curl 'https://api.wmspanel.com/v1/transcoder?client_id=[client_id]&api_key=[api_key]&server_id=[server_id]'
Response example: 
  {
    "status": "Ok",
    "transcoders": [
      {
          "id": "570df4d9fe7cd3b15f000001",
          "name": "Main transcoder",
          "description": "This is main transcoder",
          "paused": false,
          "server_id": "560b7d8cfe7cd32ecc000001",
          "out_of_process": true,
          "tags": ["main", "off"],
      },
      {
          "id": "5768c9c8fe7cd393f3000007",
          "name": "Test transcoder",
          "description": "Test",
          "paused": true,
          "server_id": "5768c6ccfe7cd3a09a000015",
          "tags": ["test"],
      }
    ]
  }
Response fields:
  • id - unique transcoder scenario ID for further usage
  • name - transcoder scenario name
  • description - transcoder scenario description
  • tags - custom tags for easy filtering on the settings web page
  • paused - current status of the transcoder scenario (is it paused or not)
  • server_id - unique Nimble server ID, where this transcoder scenario is assigned
  • out_of_process - is scenario out-of-process or not. Out-of-process scenario is executed in external process unlike default running "inside" of Nimble Streamer.

Pick up an existing transcoder scenario.
Request URL:
GET https://api.wmspanel.com/v1/transcoder/[transcoder_id]
Request parameters:

  • transcoder_id - is ID of transcoder scenario obtained via "Get list" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • details (optional) - transcoder scenario pipelines details will be returned, if this parameter is true
CURL request example:
curl 'https://api.wmspanel.com/v1/transcoder/570df4d9fe7cd3b15f000001?client_id=[client_id]&api_key=[api_key]&details=true'
Response example: 
  {
    "status": "Ok",
    "transcoder": {
      "id": "570df4d9fe7cd3b15f000001",
      "name": "New transcoder",
      "description": "",
      "paused": false,
      "server_id": "560b7d8cfe7cd32ecc000001",
      "out_of_process": true,
      "tags": ["new", "off"],
      "video_pipelines": [
          {
              "id": "5e5ddce92c47e5425c7f8248",
              "inputs": [
                  {
                      "id": "5e5ddce92c47e5425c7f8244",
                      "main": true,
                      "app": "app1",
                      "stream": "stream1",
                      "forward_scte35": false,
                      "forward_dvb_subtitles": false,
                      "forward_webvtt_subtitles": false,
                      "forward_klv_metadata": true,
                      "type": "stream",
                      "filter": {
                        mode: "GEQ",
                        width: 1280,
                        height: 960
                      }
                  }
              ],
              "outputs": [
                  {
                      "id": "5e5ddce92c47e5425c7f8245",
                      "app": "app2",
                      "stream": "stream2",
                      "codec": "h264",
                      "encoder": "quicksync",
                      "params": [
                          {
                              "name": "preset",
                              "value": "ultrafast"
                          }
                      ],
                      "forward_scte35": false,
                      "forward_dvb_subtitles": false,
                      "forward_webvtt_subtitles": false,
                      "forward_klv_metadata": true,
                      "key_frame_alignment": "source",
                      "forward_cea708": false,
                      "type": "stream"
                  }
              ],
              "filters": [
                  {
                      "id": "f91c8e78eb9c63cc5cbf8bed224285d5",
                      "type": "scale",
                      "kind": "default",
                      "width": 640,
                      "height": 480
                  }
              ]
          }
      ],
      "audio_pipelines": [
          {
              "id": "5e5ddce92c47e5425c7f824c",
              "inputs": [
                  {
                      "id": "5fab6be52c47e563d161d5bf",
                      "main": true,
                      "app": "app3",
                      "stream": "stream3",
                      "forward_scte35": false,
                      "forward_dvb_subtitles": false,
                      "forward_webvtt_subtitles": false,
                      "forward_metadata": false,
                      "forward_klv_metadata": true,
                      "type": "stream"
                  }
              ],
              "outputs": [
                  {
                      "id": "5fab6be52c47e563d161d5c0",
                      "app": "app4",
                      "stream": "stream4",
                      "codec": "AAC",
                      "encoder": "FFmpeg",
                      "params": [],
                      "forward_scte35": false,
                      "forward_dvb_subtitles": false,
                      "forward_webvtt_subtitles": false,
                      "forward_metadata": false,
                      "forward_klv_metadata": true,
                      "type": "stream"
                  }
              ],
              "filters": [
                  {
                      "id": "c97ac7dc1bf8c9527cb93c3554179372",
                      "type": "volume",
                      "value": 80
                  }
              ]
          }
      ]
    }
  }
Response fields:
  • id - unique transcoder scenario ID for further usage
  • name - transcoder scenario name
  • description - transcoder scenario description
  • paused - current status of the transcoder scenario (is it paused or not)
  • server_id - unique Nimble server ID, where this transcoder scenario is assigned
  • out_of_process - is scenario out-of-process or not. Out-of-process scenario is executed in external process unlike default running "inside" of Nimble Streamer
  • tags - custom tags for easy filtering on the settings web page.
  • video_pipelines - array of video pipelines contained by this transcoder. Available with 'details' parameter set to true only
    • id - pipeline unique ID
    • passthrough - boolean flag to indicate passthrough pipeline
    • inputs - array of pipeline inputs
      • id - input unique ID
      • main - boolean flag to indicate main input stream
      • type - input type. Can be "stream", "file" and "ndi"
      • app - application name. Available for "stream" type only
      • stream - stream name. Available for "stream" type only
      • file_name - media file name. Available for "file" type only
      • stream_id - stream ID. Available for "file" type only
      • origin_fps - media file FPS. Available for "file" type only
      • ndi_name - NDI input name. Available for "ndi" type only
      • decoder - decoder used. Can be "NVENC", "NVENC-ffmpeg", "amd-alveo", "quicksync" and "quicksync-ffmpeg". Available, if non-default decoder was set only
      • gpu - gpu device index. Available for "NVENC", "NVENC-ffmpeg" and "amd-alveo" decoders only
      • deinterlacing - deinterlacing mode. Available for "NVENC" and "NVENC-ffmpeg" decoders only. Can be "weave", "bob" or "adaptive"
      • forward_cea708 - boolean flag to indicate forwarding CEA-708 subtitles. Available for "NVENC" decoder only
      • params - custom parameters array. Available for "NVENC-ffmpeg" and "amd-alveo" decoder only
      • threads - a number of threads used. Available for default decoder only
      • forward_scte35 - boolean flag to indicate forwarding SCTE-35 markers.
      • forward_dvb_subtitles - boolean flag to indicate forwarding DVB subtitles.
      • forward_webvtt_subtitles - boolean flag to indicate forwarding WebVTT subtitles.
      • forward_klv_metadata - boolean flag to indicate forwarding KLV (Key-Length-Value) metadata.
      • forward_metadata - boolean flag to indicate forwarding Icecast metadata. Applicable for audio inputs only
      • forward_sei_timecodes - boolean flag to indicate forwarding SEI timecodes. Applicable for video inputs only with "Default", "NVENC", "NVENC-ffmpeg", "amd-alveo" and "quicksync-ffmpeg" decoders.
      • pts_adjustment_enabled - boolean flag to enable adjustment of given input stream timestamps to the corresponding main stream timeline. For example, overlay filter requires that stream being overlayed have the same timeline as the primary stream. Applicable only for secondary inputs, i.e. having "main" flag set to false.
      • filter - conditional transcoding settings. Specifies width and/or height condition which target stream must met in order to be processed by transcoder. Available for "stream" type only. 3 parameters are supported:
        • mode - comparison mode: "GE" (greater than), "GEQ" (greater or equal to), "EQ" (equal to), "LE" (less than), "LEQ" (less or equal to)
        • width - video width in pixels to meet the comparison. Must be integer greater than 0
        • height - video height in pixels to meet the comparison. Must be integer greater than 0
    • outputs - array of pipeline outputs
      • id - output unique ID
      • type - output type. Can be "stream", "ndi" and "dante"
      • app - application name. Available for "stream" type only
      • stream - stream name. Available for "stream" type only
      • ndi_name - NDI output name. Available for "ndi" type only
      • dante_name - Dante output name. Available for "dante" type only
      • sync_stream - sync related streams mode. Can be "audio_to_video" or "video_to_audio". Available if not "Leave as is" option was selected
      • encoder - encoder used. Can be "libx264", "quicksync", "nvenc", "vaapi", "libvpx", "libsvthevc" or "FFmpeg". Available if not "Leave as is" option was selected
      • codec - codec used. Can be "h264", "h265", "vp8" or "vp9"
      • params - custom parameters array
      • forward_cea708 - boolean flag to indicate forwarding CEA-708 subtitles. Applicable for video outputs only
      • forward_scte35 - boolean flag to indicate forwarding SCTE-35 markers.
      • forward_dvb_subtitles - boolean flag to indicate forwarding DVB subtitles.
      • forward_webvtt_subtitles - boolean flag to indicate forwarding WebVTT subtitles.
      • forward_klv_metadata - boolean flag to indicate forwarding KLV (Key-Length-Value) metadata.
      • forward_metadata - boolean flag to indicate forwarding Icecast metadata. Applicable for audio outputs only
      • key_frame_alignment - key frame alignment mode. Can be "source", "fps", "interval" or "none". Applicable for video outputs only
      • key_frame_alignment_value - fps value for "fps" key_frame_alignment and interval in millisecodns for "interval" key_frame_alignment. Applicable for video outputs only
      • forward_sei_timecodes - boolean flag to indicate forwarding SEI timecodes. Applicable for video outputs only with "libx264" and "nvenc" encoders.
      • ndi_sei_timecode_delay - NDI SEI timecodes delay in millisecodns. Applicable for NDI and Dante video outputs only. Should be an integer value between 500 and 9000. Can be empty.
    • filters - array of pipeline filters
      • id - filter unique ID
      • type - filter type. Can be "crop", "scale", "overlay", "picture", "split", "hflip", "vflip" and "custom"
      • kind - filter kind. Available for "crop" and "scale" types only.
        Following kinds are available for "crop" type:
        • "rectangle" - defines crop by left top corner position, width and height
        • "offset" - defines crop by sides offsets
        Following kinds are available for "scale" type:
        • "default" - defines scale by width and height
        • "crop" - defines scale by width and height and crops video to fit specified size while maintaining aspect ratio
        • "padding" - defines scale by width and height and maintains aspect ratio and fit to specified size with black bars to fill empty space
      • x - a number to define horizontal position of the media top left corner (or other corner for "picture" filter depending on "x_from" and "y_from" parameters). Should be greater or equal to 0. Available for filter types "overlay", "picture" and "crop" (kind "rectangle") only
      • y - a number to define vertical position of the media top left corner (or other corner for "picture" filter depending on "x_from" and "y_from" parameters). Should be greater or equal to 0. Available for filter types "overlay", "picture" and "crop" (kind "rectangle") only
      • x_from - defines a side, from which "x" parameter is measured. Can be "left" or "right". Available for "picture" filter type only. This parameter has value "left" always, when "picture" filter uses CUDA encoding hardware
      • y_from - defines a side, from which "y" parameter is measured. Can be "top" or "bottom". Available for "picture" filter type only. This parameter has value "top" always, when "picture" filter uses CUDA encoding hardware
      • width - a number to define media width. Should be positive, except special value -2. For "scale" filter it must be also even. Also, for scale filter type "default" special value -2 can be used to preserve aspect ratio. Available for filter type "crop", kind "rectangle", filter type "scale" and filter type "picture" only
      • height - a number to define media height. Should be positive, except special value -2. For "scale" filter it must be also even. Also, for scale filter type "default" special value -2 can be used to preserve aspect ratio. Available for filter type "crop", kind "rectangle" and filter type "scale" only
      • left - a number to define left offset for crop. Should be greater or equal to 0. Available for filter type "crop", kind "offset" only
      • top - a number to define top offset for crop. Should be greater or equal to 0. Available for filter type "crop", kind "offset" only
      • right - a number to define right offset for crop. Should be greater or equal to 0. Available for filter type "crop", kind "offset" only
      • bottom - a number to define bottom offset for crop. Should be greater or equal to 0. Available for filter type "crop", kind "offset" only
      • filename - a string with full path to image file. Cannot be empty. Available for filter type "picture" only
      • outputs_number - shows a number of outputs for filter type "split"
      • name - filter name. Cannot be empty. Available for filter type "custom" only
      • params - filter parameters. Cannot be empty. Available for filter type "custom" only
  • audio_pipelines - array of audio pipelines contained by this transcoder. Available with 'details' parameter set to true only
    • id - pipeline unique ID
    • passthrough - boolean flag to indicate passthrough pipeline
    • inputs - array of pipeline inputs
      • id - input unique ID
      • main - boolean flag to indicate main input stream
      • type - input type. Can be "stream", "file", "ndi" and "dante"
      • app - application name. Available for "stream" type only
      • stream - stream name. Available for "stream" type only
      • file_name - Media file name. Available for "file" type only
      • stream_id - Stream ID. Available for "file" type only
      • ndi_name - NDI input name. Available for "ndi" type only
      • dante_name - Dante input name. Available for "dante" type only
      • decoder - decoder used. Can be "libfdk_aac". Available for "stream" and "file" types, if non-default decoder was set only.
      • params - custom parameters array. Available for "dante" type only
      • forward_klv_metadata - boolean flag to indicate forwarding KLV (Key-Length-Value) metadata.
      • pts_adjustment_enabled - boolean flag to enable adjustment of given input stream timestamps to the corresponding main stream timeline. For example, overlay filter requires that stream being overlayed have the same timeline as the primary stream. Applicable only for secondary inputs, i.e. having "main" flag set to false.
      • filter - conditional transcoding settings. Specifies width and/or height condition which target stream must met in order to be processed by transcoder. Available for "stream" type only. 3 parameters are supported:
        • mode - comparison mode: "GE" (greater than), "GEQ" (greater or equal to), "EQ" (equal to), "LE" (less than), "LEQ" (less or equal to)
        • width - video width in pixels to meet the comparison. Must be integer greater than 0
        • height - video height in pixels to meet the comparison. Must be integer greater than 0
    • outputs - array of pipeline outputs
      • id - output unique ID
      • type - output type. Can be "stream", "ndi" and "dante"
      • app - application name. Available for "stream" type only
      • stream - stream name. Available for "stream" type only
      • ndi_name - NDI output name. Available for "ndi" type only
      • dante_name - Dante output name. Available for "dante" type only
      • encoder - encoder used. Can be "FFmpeg", "libfdk_aac" and "lame_mp3". Available for "stream" type only.
      • codec - codec used. Can be "AAC", "MP3", "mp2" or "libopus".
      • params - custom parameters array
    • filters - array of pipeline filters
      • id - filter unique ID
      • type - filter type. Can be "amix", "asplit", "volume" and "custom"
      • value - a float number from range [0.0000001, 10000000] to set volume level in percents. Applicable for filter type "volume" only
      • inputs_number - shows a number of inputs for filter type "amix"
      • outputs_number - shows a number of outputs for filter type "asplit"
      • name - filter name. Cannot be empty. Available for filter type "custom" only
      • params - filter parameters. Cannot be empty. Available for filter type "custom" only

Update existing transcoder scenario.
Request URL:
PUT https://api.wmspanel.com/v1/transcoder/[transcoder_id]
Request parameters:

  • transcoder_id - is ID of transcoder scenario obtained via "Get list" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • details (optional) - transcoder scenario pipelines details will be returned in response, if this parameter is true
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"name": "Test name", servers_to_apply: ["5af93ff52c47e533b846a037", "5af93ff52c47e533b846a038"]}' "https://api.wmspanel.com/v1/transcoder/5742bb0a08238975a100000b?client_id=[client_id]&api_key=[api_key]&details=true"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • name - transcoder scenario name
  • description - transcoder scenario description
  • tags - custom tags for easy filtering on the settings web page
  • out_of_process - is scenario out-of-process or not. Out-of-process scenario is executed in external process unlike default running "inside" of Nimble Streamer
  • servers_to_apply - array of server IDs strings. Maximum 50 servers can be used in one request
All fields are optional.

Response example: 
  {
    "status": "Ok",
    "transcoder": {
      "id": "570df4d9fe7cd3b15f000001",
      "name": "Test name",
      "description": "",
      "paused": false,
      "server_id": "560b7d8cfe7cd32ecc000001",
      "out_of_process": true,
      "video_pipelines": [
          {
              "id": "5e5ddce92c47e5425c7f8248",
              "inputs": [
                  {
                      "id": "5e5ddce92c47e5425c7f8244",
                      "main": true,
                      "type": "stream",
                      "app": "app1",
                      "stream": "stream1"
                  }
              ],
              "outputs": [
                  {
                      "id": "5e5ddce92c47e5425c7f8245",
                      "type": "stream",
                      "app": "app2",
                      "stream": "stream2"
                  }
              ],
              "filters": [
                  {
                      "id": "f91c8e78eb9c63cc5cbf8bed224285d5",
                      "type": "scale",
                      "kind": "default",
                      "width": 640,
                      "height": 480
                  }
              ]
          }
      ],
      "audio_pipelines": [
          {
              "id": "5e5ddce92c47e5425c7f824c",
              "inputs": [
                  {
                      "id": "5fab6be52c47e563d161d5bf",
                      "main": true,
                      "type": "stream",
                      "app": "app3",
                      "stream": "stream3"
                  }
              ],
              "outputs": [
                  {
                      "id": "5fab6be52c47e563d161d5c0",
                      "type": "stream",
                      "app": "app4",
                      "stream": "stream4"
                  }
              ],
              "filters": [
                  {
                      "id": "c97ac7dc1bf8c9527cb93c3554179372",
                      "type": "volume",
                      "value": 80
                  }
              ]
          }
      ]
    },
    "created_transcoders_ids": ["5e5ddce92c47e5425c7f8241", "5e5ddce92c47e5425c7f8242"]
  }
Response fields:
  • created_transcoders_ids - array of transcoder scenarios created for servers requested to apply.
Other fields are same as for "Get transcoder scenario".

Delete an existing transcoder scenario.
Request URL:
DELETE https://api.wmspanel.com/v1/transcoder/[transcoder_id]
Request parameters:

  • transcoder_id - is ID of transcoder scenario obtained via "Get list" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/transcoder/570df4d9fe7cd3b15f000001/?client_id=[client_id]&api_key=[api_key]"

Response example: 
  {
    "status" : "Ok"
  }

Pause specific transcoder scenario.
Request URL:
GET https://api.wmspanel.com/v1/transcoder/[transcoder_id]/pause
Request parameters:

  • transcoder_id - is ID of transcoder scenario obtained via "Get list" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl "https://api.wmspanel.com/v1/transcoder/570df4d9fe7cd3b15f000001/pause?client_id=[client_id]&api_key=[api_key]"

Response example: 
  {
    "status" : "Ok"
  }

Resume specific transcoder scenario.
Request URL:
GET https://api.wmspanel.com/v1/transcoder/[transcoder_id]/resume
Request parameters:

  • transcoder_id - is ID of transcoder scenario obtained via "Get list" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl "https://api.wmspanel.com/v1/transcoder/570df4d9fe7cd3b15f000001/resume?client_id=[client_id]&api_key=[api_key]"

Response example: 
  {
    "status" : "Ok"
  }

Clones existing transcoder scenario on same server.
Request URL:
GET https://api.wmspanel.com/v1/transcoder/[transcoder_id]/clone
Request parameters:

  • transcoder_id - is ID of transcoder scenario obtained via "Get list" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
  • details (optional) - transcoder scenario pipelines details will be returned, if this parameter is true
CURL request example:
curl 'https://api.wmspanel.com/v1/transcoder/570df4d9fe7cd3b15f000001/clone?client_id=[client_id]&api_key=[api_key]&details=true'
Response example: 
  {
    "status": "Ok",
    "transcoder": {
      "id": "570df4d9fe7cd3b15f000001",
      "name": "New transcoder (cloned)",
      "description": "",
      "paused": false,
      "server_id": "560b7d8cfe7cd32ecc000001"
      "video_pipelines": [
          {
              "id": "5e5ddce92c47e5425c7f8248",
              "inputs": [
                  {
                      "id": "5e5ddce92c47e5425c7f8244",
                      "main": true,
                      "type": "stream",
                      "app": "app1",
                      "stream": "stream1"
                  }
              ],
              "outputs": [
                  {
                      "id": "5e5ddce92c47e5425c7f8245",
                      "type": "stream",
                      "app": "app2",
                      "stream": "stream2"
                  }
              ],
              "filters": [
                  {
                      "id": "f91c8e78eb9c63cc5cbf8bed224285d5",
                      "type": "scale",
                      "kind": "default",
                      "width": 640,
                      "height": 480
                  }
              ]
          }
      ],
      "audio_pipelines": [
          {
              "id": "5e5ddce92c47e5425c7f824c",
              "inputs": [
                  {
                      "id": "5fab6be52c47e563d161d5bf",
                      "main": true,
                      "type": "stream",
                      "app": "app3",
                      "stream": "stream3"
                  }
              ],
              "outputs": [
                  {
                      "id": "5fab6be52c47e563d161d5c0",
                      "type": "stream",
                      "app": "app4",
                      "stream": "stream4"
                  }
              ],
              "filters": [
                  {
                      "id": "c97ac7dc1bf8c9527cb93c3554179372",
                      "type": "volume",
                      "value": 80
                  }
              ]
          }
      ]
    }
  }
Response fields:
Same as for "Get transcoder scenario".

Pick up an existing video pipeline.
Request URL:
GET https://api.wmspanel.com/v1/transcoder/[transcoder_id]/pipeline/video/[pipeline_id]
Request parameters:

  • transcoder_id - is ID of transcoder scenario obtained via "Get list" method
  • pipeline_id - is ID of video pipeline obtained via "Get transcoder scenario" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/transcoder/570df4d9fe7cd3b15f000001/pipeline/video/5e5ddce92c47e5425c7f8248?client_id=[client_id]&api_key=[api_key]'
Response example: 
  {
    "status": "Ok",
    "video_pipeline": {
      "id": "5e5ddce92c47e5425c7f8248",
      "inputs": [
        {
          "id": "5e5ddce92c47e5425c7f8244",
          "main": true,
          "type": "stream",
          "app": "app1",
          "stream": "stream1"
        }
      ],
      "outputs": [
        {
          "id": "5e5ddce92c47e5425c7f8245",
          "type": "stream",
          "app": "app2",
          "stream": "stream2"
        }
      ],
      "filters": [
        {
          "id": "f91c8e78eb9c63cc5cbf8bed224285d5",
          "type": "scale",
          "kind": "default",
          "width": 640,
          "height": 480
        }
      ]
    }
  }
Response fields:
See "Get transcoder scenario" section for video pipeline fields description.

Delete an existing video pipeline.
Request URL:
DELETE https://api.wmspanel.com/v1/transcoder/[transcoder_id]/pipeline/video/[pipeline_id]
Request parameters:

  • transcoder_id - is ID of transcoder scenario obtained via "Get list" method
  • pipeline_id - is ID of video pipeline obtained via "Get transcoder scenario" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/transcoder/570df4d9fe7cd3b15f000001/pipeline/video/5e5ddce92c47e5425c7f8248?client_id=[client_id]&api_key=[api_key]"

Response example: 
  {
    "status" : "Ok"
  }

Pick up an existing video input.
Request URL:
GET https://api.wmspanel.com/v1/transcoder/[transcoder_id]/pipeline/video/[pipeline_id]/input/[input_id]
Request parameters:

  • transcoder_id - is ID of transcoder scenario obtained via "Get list" method
  • pipeline_id - is ID of video pipeline obtained via "Get transcoder scenario" method
  • input_id - is ID of video input obtained via "Get transcoder scenario" or "Get video pipeline" methods
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/transcoder/570df4d9fe7cd3b15f000001/pipeline/video/5e5ddce92c47e5425c7f8248/input/5e5ddce92c47e5425c7f8244?client_id=[client_id]&api_key=[api_key]'
Response example: 
  {
    "status": "Ok",
    "input":
      {
        "id": "5e5ddce92c47e5425c7f8244",
        "main": true,
        "type": "stream",
        "app": "app1",
        "stream": "stream1",
        "forward_scte35": false,
        "forward_dvb_subtitles": false,
        "forward_webvtt_subtitles": false,
        "forward_klv_metadata": false,
        "forward_sei_timecodes": true
      }
  }
Response fields:
See "Get transcoder scenario" section for video pipeline fields description.

Update existing video input.
Request URL:
PUT https://api.wmspanel.com/v1/transcoder/[transcoder_id]/pipeline/video/[pipeline_id]/input/[input_id]
Request parameters:

  • transcoder_id - is ID of transcoder scenario obtained via "Get list" method
  • pipeline_id - is ID of video pipeline obtained via "Get transcoder scenario" method
  • input_id - is ID of video input obtained via "Get transcoder scenario" or "Get video pipeline" methods
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"app": "NewApp", stream: "NewStream"}' "https://api.wmspanel.com/v1/transcoder/570df4d9fe7cd3b15f000001/pipeline/video/5e5ddce92c47e5425c7f8248/input/5e5ddce92c47e5425c7f8244?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • app - application name. Applicable for "stream" type only
  • stream - stream name. Changing stream to empty string will convert input to multistream. "{STREAM}" anchor will be prepended to all output stream names and NDI names (if these stream names and NDI names had no such anchor). Input will be set as main. Each pipeline can have one multistream input only. Changing multistream input stream name to not empty value will convert multistream input to normal input. "{STREAM}" anchor will be removed from all output stream names and NDI names. Applicable for "stream" type only
  • file_name - media file name. Applicable for "file" type only
  • stream_id - stream ID. Should be an integer value between 0 and 255. Applicable for "file" type only
  • origin_fps - Media file FPS. Should be an integer value between 0 and 100. Applicable for "file" type only
  • ndi_name - NDI input name. Applicable for "ndi" type only
  • decoder - decoder used. Can be "default", "NVENC", "NVENC-ffmpeg", "amd-alveo", "quicksync" and "quicksync-ffmpeg".
  • gpu - gpu device index. Available for "NVENC", "NVENC-ffmpeg" and "amd-alveo" decoders only. Should be a string containing a number from "0" to "255" or "auto".
  • deinterlacing - deinterlacing mode. Available for "NVENC" and "NVENC-ffmpeg" decoders only. Can be "weave", "bob" or "adaptive".
  • params - custom parameters array. Available for "NVENC-ffmpeg" and "amd-alveo" decoder only. Each array element is a hash map with two fields: "name" and "value" (for example, [{"name": "p1", "value": "v1"}, {"name": "p2", "value": "v2"}]).
  • forward_cea708 - boolean flag to indicate forwarding CEA-708 subtitles. Applicable for "NVENC" decoder only
  • forward_scte35 - boolean flag to indicate forwarding SCTE-35 markers.
  • forward_dvb_subtitles - boolean flag to indicate forwarding DVB subtitles.
  • forward_webvtt_subtitles - boolean flag to indicate forwarding WebVTT subtitles.
  • forward_klv_metadata - boolean flag to indicate forwarding KLV (Key-Length-Value) metadata.
  • forward_metadata - boolean flag to indicate forwarding Icecast metadata. Applicable for audio inputs only
  • forward_sei_timecodes - boolean flag to indicate forwarding SEI timecodes. Applicable for video inputs only with "Default", "NVENC", "NVENC-ffmpeg", "amd-alveo" and "quicksync-ffmpeg" decoders.
  • pts_adjustment_enabled - boolean flag to enable adjustment of given input stream timestamps to the corresponding main stream timeline. For example, overlay filter requires that stream being overlayed have the same timeline as the primary stream. Applicable only for secondary inputs, i.e. having "main" flag set to false.
  • filter - conditional transcoding settings. Specifies width and/or height condition which target stream must met in order to be processed by transcoder. Available for "stream" type only. 3 parameters are supported:
    • mode - comparison mode: "GE" (greater than), "GEQ" (greater or equal to), "EQ" (equal to), "LE" (less than), "LEQ" (less or equal to)
    • width - video width in pixels to meet the comparison. Must be integer greater than 0
    • height - video height in pixels to meet the comparison. Must be integer greater than 0
    One or both of "width" and "height" and "mode" must be specified. If "width" or "height" isn't specified it will be unset. To clear filter settings, update it with empty object, i.e. "filter": {}
All fields are optional.

Response example: 
  {
    "status": "Ok",
    "input":
      {
        "id": "5e5ddce92c47e5425c7f8244",
        "main": true,
        "type": "stream",
        "app": "NewApp",
        "stream": "NewStream",
        "forward_scte35": false,
        "forward_dvb_subtitles": false,
        "forward_webvtt_subtitles": false,
        "forward_klv_metadata": false,
        "forward_sei_timecodes": true
      }
  }
Response fields:
See "Get transcoder scenario" section for video pipeline fields description.

Pick up an existing video output.
Request URL:
GET https://api.wmspanel.com/v1/transcoder/[transcoder_id]/pipeline/video/[pipeline_id]/output/[output_id]
Request parameters:

  • transcoder_id - is ID of transcoder scenario obtained via "Get list" method
  • pipeline_id - is ID of video pipeline obtained via "Get transcoder scenario" method
  • output_id - is ID of video output obtained via "Get transcoder scenario" or "Get video pipeline" methods
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/transcoder/570df4d9fe7cd3b15f000001/pipeline/video/5e5ddce92c47e5425c7f8248/output/5e5ddce92c47e5425c7f8245?client_id=[client_id]&api_key=[api_key]'
Response example: 
  {
    "status": "Ok",
    "output":
      {
        "id": "5e5ddce92c47e5425c7f8245",
        "type": "stream",
        "app": "app2",
        "stream": "stream2",
        "forward_scte35": false,
        "forward_dvb_subtitles": false,
        "forward_webvtt_subtitles": false,
        "forward_klv_metadata": true,
        "forward_sei_timecodes": true
      }
  }
Response fields:
See "Get transcoder scenario" section for video pipeline fields description.

Update existing video output.
Request URL:
PUT https://api.wmspanel.com/v1/transcoder/[transcoder_id]/pipeline/video/[pipeline_id]/output/[output_id]
Request parameters:

  • transcoder_id - is ID of transcoder scenario obtained via "Get list" method
  • pipeline_id - is ID of video pipeline obtained via "Get transcoder scenario" method
  • output_id - is ID of video output obtained via "Get transcoder scenario" or "Get video pipeline" methods
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"app": "NewApp", stream: "NewStream"}' "https://api.wmspanel.com/v1/transcoder/570df4d9fe7cd3b15f000001/pipeline/video/5e5ddce92c47e5425c7f8248/output/5e5ddce92c47e5425c7f8245?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • app - application name. Available for "stream" type only
  • stream - stream name. Should include "{STREAM}" anchor for pipelines with multistream inputs. Available for "stream" type only
  • ndi_name - NDI output name. Should include "{STREAM}" anchor for pipelines with multistream inputs. Available for "ndi" type only
  • dante_name - Dante output name. Should include "{STREAM}" anchor for pipelines with multistream inputs. Available for "dante" type only
  • encoder - encoder used. Can be "libx264", "quicksync", "nvenc", "vaapi", "libvpx", "libsvthevc" or "FFmpeg".
  • codec - codec used. Can be "h264", "h265", "vp8" or "vp9".
  • params - custom parameters array. Available for "stream" type only. Each array element is a hash map with two fields: "name" and "value" (for example, [{"name": "p1", "value": "v1"}, {"name": "p2", "value": "v2"}]).
  • forward_cea708 - boolean flag to indicate forwarding CEA-708 subtitles.
  • forward_scte35 - boolean flag to indicate forwarding SCTE-35 markers.
  • forward_dvb_subtitles - boolean flag to indicate forwarding DVB subtitles.
  • forward_webvtt_subtitles - boolean flag to indicate forwarding WebVTT subtitles.
  • forward_klv_metadata - boolean flag to indicate forwarding KLV (Key-Length-Value) metadata.
  • forward_sei_timecodes - boolean flag to indicate forwarding SEI timecodes. Applicable for video inputs with "libx264" and "nvenc" encoders only.
  • ndi_sei_timecode_delay - NDI SEI timecodes delay in millisecodns. Applicable for NDI video outputs only. Should be an integer value between 500 and 9000. To remove this option need to set it to 0.
All fields are optional.

Response example: 
  {
    "status": "Ok",
    "output":
      {
        "id": "5e5ddce92c47e5425c7f8245",
        "type": "stream",
        "app": "NewApp",
        "stream": "NewStream",
        "codec": "h264",
        "encoder": "libx264",
        "forward_scte35": false,
        "forward_dvb_subtitles": false,
        "forward_webvtt_subtitles": false,
        "forward_klv_metadata": true,
        "forward_sei_timecodes": true
      }
  }
Response fields:
See "Get transcoder scenario" section for video pipeline fields description.

Pick up an existing video filter.
Request URL:
GET https://api.wmspanel.com/v1/transcoder/[transcoder_id]/pipeline/video/[pipeline_id]/filter/[filter_id]
Request parameters:

  • transcoder_id - is ID of transcoder scenario obtained via "Get list" method
  • pipeline_id - is ID of video pipeline obtained via "Get transcoder scenario" method
  • filter_id - is ID of video filter obtained via "Get transcoder scenario" or "Get video pipeline" methods
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/transcoder/570df4d9fe7cd3b15f000001/pipeline/video/5e5ddce92c47e5425c7f8248/filter/f91c8e78eb9c63cc5cbf8bed224285d5?client_id=[client_id]&api_key=[api_key]'
Response example: 
  {
    "status": "Ok",
    "filter":
      {
        "id": "f91c8e78eb9c63cc5cbf8bed224285d5",
        "type": "scale",
        "kind": "default",
        "width": 640,
        "height": 480
      }
  }
Response fields:
See "Get transcoder scenario" section for video pipeline fields description.

Update existing video filter.
Request URL:
PUT https://api.wmspanel.com/v1/transcoder/[transcoder_id]/pipeline/video/[pipeline_id]/filter/[filter_id]
Request parameters:

  • transcoder_id - is ID of transcoder scenario obtained via "Get list" method
  • pipeline_id - is ID of video pipeline obtained via "Get transcoder scenario" method
  • filter_id - is ID of video filter obtained via "Get transcoder scenario" or "Get video pipeline" methods
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"width": 320, height: 240}' "https://api.wmspanel.com/v1/transcoder/570df4d9fe7cd3b15f000001/pipeline/video/5e5ddce92c47e5425c7f8248/filter/f91c8e78eb9c63cc5cbf8bed224285d5?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • kind - filter kind. Can be updated for "crop" filter type only.
    Following kinds are available for "crop" type:
    • "rectangle" - defines crop by left top corner position, width and height
    • "offset" - defines crop by sides offsets
  • x - a number to define horizontal position of the media top left corner (or other corner for "picture" filter depending on "x_from" and "y_from" parameters). Should be greater or equal to 0. Available for filter types "overlay", "picture" and "crop" (kind "rectangle") only
  • y - a number to define vertical position of the media top left corner (or other corner for "picture" filter depending on "x_from" and "y_from" parameters). Should be greater or equal to 0. Available for filter types "overlay", "picture" and "crop" (kind "rectangle") only
  • x_from - defines a side, from which "x" parameter is measured. Can be "left" or "right". Available for "picture" filter type only. This parameter is ignored and set to "left" always, when "picture" filter uses CUDA encoding hardware
  • y_from - defines a side, from which "y" parameter is measured. Can be "top" or "bottom". Available for "picture" filter type only. This parameter is ignored and set to "top" always, when "picture" filter uses CUDA encoding hardware
  • width - a number to define media width. Should be positive, except special value -2. For "scale" filter it must be also even. Also, for scale filter type "default" special value -2 can be used to preserve aspect ratio. Available for filter type "crop", kind "rectangle", filter type "scale" and filter type "picture" only
  • height - a number to define media height. Should be positive, except special value -2. For "scale" filter it must be also even. Also, for scale filter type "default" special value -2 can be used to preserve aspect ratio. Available for filter type "crop", kind "rectangle" and filter type "scale" only
  • left - a number to define left offset for crop. Should be greater or equal to 0. Available for filter type "crop", kind "offset" only
  • top - a number to define top offset for crop. Should be greater or equal to 0. Available for filter type "crop", kind "offset" only
  • right - a number to define right offset for crop. Should be greater or equal to 0. Available for filter type "crop", kind "offset" only
  • bottom - a number to define bottom offset for crop. Should be greater or equal to 0. Available for filter type "crop", kind "offset" only
  • filename - a string with full path to image file. Cannot be empty. Available for filter type "picture" only
  • name - filter name. Cannot be empty. Available for filter type "custom" only
  • params - filter parameters. Cannot be empty. Available for filter type "custom" only
All fields are optional. But if "kind" was changed for filter type "crop", then all corresponding crop parameters should be provided

Response example: 
  {
    "status": "Ok",
    "filter":
      {
        "id": "f91c8e78eb9c63cc5cbf8bed224285d5",
        "type": "scale",
        "kind": "default",
        "width": 320,
        "height": 240
      }
  }
Response fields:
See "Get transcoder scenario" section for video pipeline fields description.

Pick up an existing audio pipeline.
Request URL:
GET https://api.wmspanel.com/v1/transcoder/[transcoder_id]/pipeline/audio/[pipeline_id]
Request parameters:

  • transcoder_id - is ID of transcoder scenario obtained via "Get list" method
  • pipeline_id - is ID of audio pipeline obtained via "Get transcoder scenario" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/transcoder/570df4d9fe7cd3b15f000001/pipeline/audio/5e5ddce92c47e5425c7f824c?client_id=[client_id]&api_key=[api_key]'
Response example: 
  {
    "status": "Ok",
    "audio_pipeline": {
      id": "5e5ddce92c47e5425c7f824c",
      "inputs": [
        {
          "id": "5fab6be52c47e563d161d5bf",
          "main": true,
          "type": "stream",
          "app": "app3",
          "stream": "stream3"
        }
      ],
      "outputs": [
        {
          "id": "5fab6be52c47e563d161d5c0",
          "type": "stream",
          "app": "app4",
          "stream": "stream4"
        }
      ],
      "filters": [
        {
          "id": "c97ac7dc1bf8c9527cb93c3554179372",
          "type": "volume",
          "value": 80
        }
      ]
    }
  }
Response fields:
See "Get transcoder scenario" section for audio pipeline fields description.

Delete an existing audio pipeline.
Request URL:
DELETE https://api.wmspanel.com/v1/transcoder/[transcoder_id]/pipeline/audio/[pipeline_id]
Request parameters:

  • transcoder_id - is ID of transcoder scenario obtained via "Get list" method
  • pipeline_id - is ID of audio pipeline obtained via "Get transcoder scenario" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/transcoder/570df4d9fe7cd3b15f000001/pipeline/audio/5e5ddce92c47e5425c7f824c?client_id=[client_id]&api_key=[api_key]"

Response example: 
  {
    "status" : "Ok"
  }

Pick up an existing audio input.
Request URL:
GET https://api.wmspanel.com/v1/transcoder/[transcoder_id]/pipeline/audio/[pipeline_id]/input/[input_id]
Request parameters:

  • transcoder_id - is ID of transcoder scenario obtained via "Get list" method
  • pipeline_id - is ID of audio pipeline obtained via "Get transcoder scenario" method
  • input_id - is ID of audio input obtained via "Get transcoder scenario" or "Get audio pipeline" methods
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/transcoder/570df4d9fe7cd3b15f000001/pipeline/audio/5e5ddce92c47e5425c7f8248/input/5fab6be52c47e563d161d5bf?client_id=[client_id]&api_key=[api_key]'
Response example: 
  {
    "status": "Ok",
    "input":
      {
        "id": "5fab6be52c47e563d161d5bf",
        "main": true,
        "type": "stream",
        "app": "app3",
        "stream": "stream3",
        "forward_scte35": false,
        "forward_dvb_subtitles": false,
        "forward_webvtt_subtitles": false,
        "forward_klv_metadata": false,
        "forward_metadata": true
      }
  }
Response fields:
See "Get transcoder scenario" section for audio pipeline fields description.

Update existing audio input.
Request URL:
PUT https://api.wmspanel.com/v1/transcoder/[transcoder_id]/pipeline/audio/[pipeline_id]/input/[input_id]
Request parameters:

  • transcoder_id - is ID of transcoder scenario obtained via "Get list" method
  • pipeline_id - is ID of audio pipeline obtained via "Get transcoder scenario" method
  • input_id - is ID of audio input obtained via "Get transcoder scenario" or "Get audio pipeline" methods
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"app": "NewApp", stream: "NewStream"}' "https://api.wmspanel.com/v1/transcoder/570df4d9fe7cd3b15f000001/pipeline/audio/5e5ddce92c47e5425c7f8248/input/5e5ddce92c47e5425c7f824c?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • app - application name. Available for "stream" type only
  • stream - stream name. Changing stream to empty string will convert input to multistream. "{STREAM}" anchor will be prepended to all output stream names and NDI names (if these stream names and NDI names had no such anchor). Input will be set as main. Each pipeline can have one multistream input only. Changing multistream input stream name to not empty value will convert multistream input to normal input. "{STREAM}" anchor will be removed from all output stream names and NDI names. Available for "stream" type only
  • file_name - media file name. Available for "file" type only
  • stream_id - stream ID. Should be an integer value between 0 and 255. Available for "file" type only
  • ndi_name - NDI input name. Available for "ndi" type only
  • dante_name - Dante input name. Available for "dante" type only
  • decoder - decoder used. Can be "default" and "libfdk_aac".
  • params - custom parameters array. Available for "dante" type only. Each array element is a hash map with two fields: "name" and "value" (for example, [{"name": "p1", "value": "v1"}, {"name": "p2", "value": "v2"}]).
  • forward_scte35 - boolean flag to indicate forwarding SCTE-35 markers.
  • forward_dvb_subtitles - boolean flag to indicate forwarding DVB subtitles.
  • forward_webvtt_subtitles - boolean flag to indicate forwarding WebVTT subtitles.
  • forward_klv_metadata - boolean flag to indicate forwarding KLV (Key-Length-Value) metadata.
  • forward_metadata - boolean flag to indicate forwarding Icecast metadata.
  • pts_adjustment_enabled - boolean flag to enable adjustment of given input stream timestamps to the corresponding main stream timeline. For example, overlay filter requires that stream being overlayed have the same timeline as the primary stream. Applicable only for secondary inputs, i.e. having "main" flag set to false.
  • filter - conditional transcoding settings. Specifies width and/or height condition which target stream must met in order to be processed by transcoder. Available for "stream" type only. 3 parameters are supported:
    • mode - comparison mode: "GE" (greater than), "GEQ" (greater or equal to), "EQ" (equal to), "LE" (less than), "LEQ" (less or equal to)
    • width - video width in pixels to meet the comparison. Must be integer greater than 0
    • height - video height in pixels to meet the comparison. Must be integer greater than 0
    One or both of "width" and "height" and "mode" must be specified. If "width" or "height" isn't specified it will be unset. To clear filter settings, update it with empty object, i.e. "filter": {}
All fields are optional.

Response example: 
  {
    "status": "Ok",
    "input":
      {
        "id": "5fab6be52c47e563d161d5bf",
        "main": true,
        "type": "stream",
        "app": "NewApp",
        "decoder": "libfdk_aac",
        "stream": "NewStream",
        "forward_scte35": true,
        "forward_dvb_subtitles": true,
        "forward_webvtt_subtitles": false,
        "forward_klv_metadata": true,
        "forward_metadata": false,
        "params": [
          {
            "name": "param1",
            "value": "value1"
          }
        ]
      }
  }
Response fields:
See "Get transcoder scenario" section for audio pipeline fields description.

Pick up an existing audio output.
Request URL:
GET https://api.wmspanel.com/v1/transcoder/[transcoder_id]/pipeline/audio/[pipeline_id]/output/[output_id]
Request parameters:

  • transcoder_id - is ID of transcoder scenario obtained via "Get list" method
  • pipeline_id - is ID of audio pipeline obtained via "Get transcoder scenario" method
  • output_id - is ID of audio output obtained via "Get transcoder scenario" or "Get audio pipeline" methods
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/transcoder/570df4d9fe7cd3b15f000001/pipeline/audio/5e5ddce92c47e5425c7f8248/output/5fab6be52c47e563d161d5c0?client_id=[client_id]&api_key=[api_key]'
Response example: 
  {
    "status": "Ok",
    "output":
      {
        "id": "5fab6be52c47e563d161d5c0",
        "type": "stream",
        "app": "app4",
        "stream": "stream4",
        "forward_scte35": true,
        "forward_dvb_subtitles": true,
        "forward_webvtt_subtitles": true,
        "forward_klv_metadata": true,
        "forward_metadata": false,
      }
  }
Response fields:
See "Get transcoder scenario" section for audio pipeline fields description.

Update existing audio output.
Request URL:
PUT https://api.wmspanel.com/v1/transcoder/[transcoder_id]/pipeline/audio/[pipeline_id]/output/[output_id]
Request parameters:

  • transcoder_id - is ID of transcoder scenario obtained via "Get list" method
  • pipeline_id - is ID of audio pipeline obtained via "Get transcoder scenario" method
  • output_id - is ID of audio output obtained via "Get transcoder scenario" or "Get audio pipeline" methods
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"app": "NewApp", stream: "NewStream"}' "https://api.wmspanel.com/v1/transcoder/570df4d9fe7cd3b15f000001/pipeline/audio/5e5ddce92c47e5425c7f8248/output/5fab6be52c47e563d161d5c0?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • app - application name. Available for "stream" type only
  • stream - stream name. Should include "{STREAM}" anchor for pipelines with multistream inputs. Available for "stream" type only
  • ndi_name - NDI output name. Should include "{STREAM}" anchor for pipelines with multistream inputs. Available for "ndi" type only
  • dante_name - Dante output name. Should include "{STREAM}" anchor for pipelines with multistream inputs. Available for "dante" type only
  • encoder - encoder used. Can be "libfdk_aac", "lame_mp3" or "FFmpeg". Available for "stream" type only.
  • codec - codec used. Can be "AAC", "MP3", "mp2" or "libopus". Available for "stream" type only.
  • params - custom parameters array. Available for "stream" and "dante" types only. Each array element is a hash map with two fields: "name" and "value" (for example, [{"name": "p1", "value": "v1"}, {"name": "p2", "value": "v2"}]).
  • forward_scte35 - boolean flag to indicate forwarding SCTE-35 markers.
  • forward_dvb_subtitles - boolean flag to indicate forwarding DVB subtitles.
  • forward_webvtt_subtitles - boolean flag to indicate forwarding WebVTT subtitles.
  • forward_klv_metadata - boolean flag to indicate forwarding KLV (Key-Length-Value) metadata.
  • forward_metadata - boolean flag to indicate forwarding Icecast metadata.
All fields are optional.

Response example: 
  {
    "status": "Ok",
    "output":
      {
        "id": "5fab6be52c47e563d161d5c0",
        "type": "stream",
        "app": "NewApp",
        "codec": "MP3",
        "encoder": "lame_mp3",
        "stream": "NewStream",
        "forward_scte35": true,
        "forward_dvb_subtitles": true,
        "forward_webvtt_subtitles": true,
        "forward_klv_metadata": true,
        "forward_metadata": false,
        "params": [
          {
            "name": "param1",
            "value": "value1"
          },
          {
            "name": "param2",
            "value": "value2"
          }
        ]
      }
  }
Response fields:
See "Get transcoder scenario" section for audio pipeline fields description.

Pick up an existing audio filter.
Request URL:
GET https://api.wmspanel.com/v1/transcoder/[transcoder_id]/pipeline/audio/[pipeline_id]/filter/[filter_id]
Request parameters:

  • transcoder_id - is ID of transcoder scenario obtained via "Get list" method
  • pipeline_id - is ID of audio pipeline obtained via "Get transcoder scenario" method
  • filter_id - is ID of audio filter obtained via "Get transcoder scenario" or "Get audio pipeline" methods
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/transcoder/570df4d9fe7cd3b15f000001/pipeline/audio/5e5ddce92c47e5425c7f8248/filter/c97ac7dc1bf8c9527cb93c3554179372?client_id=[client_id]&api_key=[api_key]'
Response example: 
  {
    "status": "Ok",
    "filter":
      {
        "id": "c97ac7dc1bf8c9527cb93c3554179372",
        "type": "volume",
        "value": 80
      }
  }
Response fields:
See "Get transcoder scenario" section for audio pipeline fields description.

Update existing audio filter.
Request URL:
PUT https://api.wmspanel.com/v1/transcoder/[transcoder_id]/pipeline/audio/[pipeline_id]/filter/[filter_id]
Request parameters:

  • transcoder_id - is ID of transcoder scenario obtained via "Get list" method
  • pipeline_id - is ID of audio pipeline obtained via "Get transcoder scenario" method
  • filter_id - is ID of audio filter obtained via "Get transcoder scenario" or "Get audio pipeline" methods
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"value": 78.12}' "https://api.wmspanel.com/v1/transcoder/570df4d9fe7cd3b15f000001/pipeline/audio/5e5ddce92c47e5425c7f8248/filter/c97ac7dc1bf8c9527cb93c3554179372?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • value - a float number from range [0.0000001, 10000000] to set volume level in percents. Applicable for filter type "volume" only
  • name - filter name. Cannot be empty. Available for filter type "custom" only
  • params - filter parameters. Cannot be empty. Available for filter type "custom" only
All fields are optional.

Response example: 
  {
    "status": "Ok",
    "filter":
      {
        "id": "c97ac7dc1bf8c9527cb93c3554179372",
        "type": "volume",
        "value": 78.12
      }
  }
Response fields:
See "Get transcoder scenario" section for audio pipeline fields description.

Retrieve list of Hot swap settings for particular Nimble server. You can view this list by navigating to "Transcoders" menu, then clicking on "Hot swap settings" button and choosing appropriate Nimble server.

Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/hotswap
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/[server_id]/hotswap?client_id=[client_id]&api_key=[api_key]'
Response example: 
{
    "status": "Ok",
    "settings": [
        {
            "id": "5b6a6afb2c47e50fa31862b4",
            "emergency": false,
            "paused": false,
            "original_app": "app1",
            "original_stream": "stream1",
            "substitute_app": "app2",
            "substitute_stream": "stream2"
        },
        {
            "id": "5fa89ac82c47e5189a9a810c",
            "emergency": true,
            "paused": true,
            "original_ndi_name": "NDI_IN",
            "substitute_ndi_name": "NDI_OUT"
        },
        {
            "id": "5fa89ac82c47e5189a9a810d",
            "emergency": false,
            "paused": false,
            "original_app": "app3",
            "original_stream": "stream3",
            "substitute_dante_name": "DANTE_OUT",
            "parameters": {
              "param1": "value1",
              "param2": "value2"
            }
        }
    ]
}
Response fields:
  • id - unique Hot swap setting ID for further usage.
  • original_app - original application name to be substituted. May be empty for emergency setting. Not required, if original_ndi_name is set.
  • original_stream - original stream name to be substituted. May be empty for emergency setting. Not required, if original_ndi_name is set.
  • original_ndi_name - original NDI name to be substituted. May be empty for emergency setting. Not required, if original_app/original_stream or original_dante_name are set. Hot swap setting cannot have original_app/original_stream, original_ndi_name and original_dante_name at same time.
  • original_dante_name - original Dante name to be substituted. May be empty for emergency setting. Not required, if original_app/original_stream or original_ndi_name are set. Hot swap setting cannot have original_app/original_stream, original_ndi_name and original_dante_name at same time.
  • substitute_app - substitute application name. Not required, if substitute_ndi_name is set.
  • substitute_stream - substitute stream name. Not required, if substitute_ndi_name is set.
  • substitute_ndi_name - substitute NDI name. Not required, if substitute_app/substitute_stream or substitute_dante_name are set. Hot swap setting cannot have substitute_app/substitute_stream, substitute_ndi_name and substitute_dante_name at same time.
  • substitute_dante_name - substitute Dante name. Not required, if substitute_app/substitute_stream or substitute_ndi_name are set. Hot swap setting cannot have substitute_app/substitute_stream, substitute_ndi_name and substitute_dante_name at same time.
  • parameters - JSON object containing custom parameters. Applicable for substitute Dante case only.
  • emergency - boolean flag indicating emergency setting. It is true for emergency setting and false for failover setting.
  • paused - boolean flag indicating setting status. It is true for paused setting and false for active setting.

Pick up an existing Hot swap setting.

Request URL:
GET https://api.wmspanel.com/v1/server/[server_id]/hotswap/[setting_id]
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • setting_id - is ID of hot swap setting obtained via "Get list" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl 'https://api.wmspanel.com/v1/server/[server_id]/hotswap/5b6a6afb2c47e50fa31862b4?client_id=[client_id]&api_key=[api_key]'
Response example: 
{
  "status": "Ok",
  "setting": {
      "id": "5b6a6afb2c47e50fa31862b4",
      "emergency": false,
      "paused": false,
      "original_app": "app1",
      "original_stream": "stream1",
      "substitute_app": "app2",
      "substitute_stream": "stream2"
    }
}
Response fields:
Same as for "Get list" API call.

Create a new Hot swap setting. It is possible to create up to 500 hot swap settings per each Nimble server via API.

Request URL:
POST https://api.wmspanel.com/v1/server/[server_id]/hotswap
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X POST -H 'Content-Type: application/json' -d '{ "original_app": "app1", "original_stream": "stream1", "substitute_app": "app2", "substitute_stream": "stream2"}' "https://api.wmspanel.com/v1/server/[server_id]/hotswap?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
  • original_app (optional) - original application name to be substituted. May be empty for emergency setting. Not required, if original_ndi_name is set.
  • original_stream (optional) - original stream name to be substituted. May be empty for emergency setting. Not required, if original_ndi_name is set.
  • original_ndi_name (optional) - original NDI name to be substituted. May be empty for emergency setting. Not required, if original_app/original_stream or original_dante_name are set. Hot swap setting cannot have original_app/original_stream, original_ndi_name and original_dante_name at same time.
  • original_dante_name (optional) - original Dante name to be substituted. May be empty for emergency setting. Not required, if original_app/original_stream or original_ndi_name are set. Hot swap setting cannot have original_app/original_stream, original_ndi_name and original_dante_name at same time.
  • substitute_app (optional) - substitute application name. Not required, if substitute_ndi_name is set.
  • substitute_stream (optional) - substitute stream name. Not required, if substitute_ndi_name is set.
  • substitute_ndi_name (optional) - substitute NDI name. Not required, if substitute_app/substitute_stream or substitute_dante_name are set. Hot swap setting cannot have substitute_app/substitute_stream, substitute_ndi_name and substitute_dante_name at same time.
  • substitute_dante_name (optional) - substitute Dante name. Not required, if substitute_app/substitute_stream or substitute_ndi_name are set. Hot swap setting cannot have substitute_app/substitute_stream, substitute_ndi_name and substitute_dante_name at same time.
  • parameters (optional) - JSON object containing custom parameters. Applicable for substitute Dante case only.
  • emergency (optional) - boolean flag to create emergency setting. It is true for emergency setting and false for failover setting. It is false by default.
  • paused (optional) - boolean flag to set setting status. It is true for paused setting and false for active setting. It is false by default.
Response example: 
{
  "status": "Ok",
  "setting": {
      "id": "5b6a6afb2c47e50fa31862b4",
      "emergency": false,
      "paused": false,
      "original_app": "app1",
      "original_stream": "stream1",
      "substitute_app": "app2",
      "substitute_stream": "stream2"
  }
}
Response fields:
The same as in "Get" API call.

Update an existing Hot swap setting.

Request URL:
PUT https://api.wmspanel.com/v1/server/[server_id]/hotswap/[setting_id]
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • setting_id - is ID of Hot swap setting obtained via "Get list" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X PUT -H 'Content-Type: application/json' -d '{"paused": true}' "https://api.wmspanel.com/v1/server/[server_id]/hotswap/5b6a6afb2c47e50fa31862b4?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Request data fields:
Same as for "Create" API call.
All fields are optional.

Response example: 
{
  "status": "Ok",
  "setting": {
      "id": "5b6a6afb2c47e50fa31862b4",
      "emergency": false,
      "paused": true,
      "original_app": "app1",
      "original_stream": "stream1",
      "substitute_app": "app2",
      "substitute_stream": "stream2"
  }
}
Response fields:
The same as in "Get" API call.

Delete an existing Hot swap setting.

Request URL:
DELETE https://api.wmspanel.com/v1/server/[server_id]/hotswap/[setting_id]
Request parameters:

  • server_id - is ID of appropriate nimble server, you can get it from the "Get servers list" API call
  • setting_id - is ID of Hot swap setting obtained via "Get list" method
  • client_id - is [client_id] you've copied previously from UI
  • api_key - is [api_key] from UI
CURL request example:
curl -X DELETE "https://api.wmspanel.com/v1/server/[server_id]/hotswap/5b6a6afb2c47e50fa31862b4/?client_id=[client_id]&api_key=[api_key]"

The 'Content-Type: application/json' header is important. Request data is sent within request body.

Response example: 
{
  "status" : "Ok",
}

Nimble Streamer native API

Nimble Streamer native API allows making several types of calls directly to Nimble Streamer instance without any delay or dependency from WMSPanel.

Pay-per-view API

WMSPanel provides Paywall framework which includes pay-per-view feature set.
Read the following articles about pay-per-view framework for Nimble Streamer.

Notifications push API

WMSPanel provides capabilities for tracking the status of streams and servers. This is done via push API. A customer creates a handler which is able to receive JSON data via POST requests. When a designated event happens, WMSPanel posts the data to the handler for further processing. Each request has a token which can be used to check the credibility of incoming request.

Streams publish / unpublish streams alerts

Nimble Streamer provides push API for stream (un)availability notifications.
Read this article to learn more about notifications for RTMP, RTSP, MPEG-TS, SRT and Icecast.

Media server offline alerts

WMSPanel is able to monitor stats from multiple servers or different types. Each server sends sync-ups to bring data to the panel. If a server is not sending information, the panel considers this server to be inactive, or "offline". When this happens, WMSPanel is able to initiate POST request with server offline alert.
Read this article to see how you can use these alerts.

Daily statistics push API

WMSPanel is able to post data on a daily basis to provide statistics for further use within customer's environment.
Read this article to learn more about its usage.

Dispersa streams alerts push API

Dispersa streams monitoring service performs periodical checks of designated media streams via distributed checkpoints network.
Read Dispersa push API setup and usage article to learn more.

Try WMSPanel for Free
Free trial. No credit card required.

This website or its third-party tools use cookies, which are necessary to its functioning and required to achieve the purposes illustrated in the Privacy Policy. If you want to know more or withdraw your consent to all or some of the cookies, please refer to the Privacy Policy.
By closing this banner, scrolling this page, clicking a link or continuing to browse otherwise, you agree to the use of cookies.