Creates a new service.

API Parameter Table

Parameter Name Type Mandatory Default Value Description
ip string true null The IP address to bind on
port string true null The port to bind on
protocol string true null The protocol stack name to bind on
sslCert string false null The SSL certificate to be used
sslKey string false null The SSL certificate key to be used

API Call Template

createService ip=<ipAddress> port=<portNumber> protocol=<protocolName>

Sample API Call

createService ip= port=9556 protocol=inboundRtmp

This will create a service called inboundRtmp which will use port 9556 and can be accessed by IP.

Success Response in JSON

"description":"Service created",

JSON Response

The JSON response contains the following details:

  • data –  The data to parse.
    • acceptedConnectionsCount – The number of active connections using the service
    • appId – The ID of the application using the service
    • appName – The name of the application using the service
    • droppedConnectionsCount – The number of dropped connections
    • enabled - true if the service is enabled, false if not
    • id = ID of the service
    • ip = The IP address bound to the service
    • port – The port bound to the service
    • protocol – The protocol bound to the service
  • description– Describes the result of parsing/executing the command
  • status – SUCCESS if the command was parsed and executed successfully, FAIL if not.


  • The created service will not be added in config.lua