RTMP servers

Use RTMP servers to receive OBS, encoder, and guest publishers at stable RTMP ingest endpoints. Control publishing and playback access, then inspect live bitrate and connection data.

What it doesReceive an RTMP contribution feed

Choose this whenOBS, an RTMP encoder, or a guest needs a stable push URL, access control, and live connection analytics.

Use another module whenUse SRT Servers for SRT transport and failover; use Streams only for identities inside an existing server.

1RTMP publisher2Control access3Route or playback

POST /api/rtmp-servers/create

Filter endpoints10 endpoints

Before you start

All management methods require a valid x-access-token. Reserve a reachable listen port and choose the server's stream-control and access settings before sharing connection details.

What you can do

create and update configure the listen port, player buffer, and stream access policy.
getAll, getCount, and getById inspect servers and allowed stream records.
start and stop control the RTMP listener.
getStatistics reports input and output bitrate, publisher and receiver counts, plus available client address, region, and application metadata.
getStatisticHistory returns the available recent statistics history.
remove deletes the server.

Example workflow

Create the RTMP server with its listen port and player buffer.
Choose stream-key or IP-based access, or allow guest connections only when the workflow calls for it.
Start the listener and give each publisher the intended connection details.
Call getStatistics to verify bitrate, roles, and connection origin.
Connect the ingest to a recording, restream, or web player.

Common use cases

Receive recurring OBS or encoder contributions at one stable endpoint.
Let approved guest publishers and receivers create their own stream keys under the selected access policy.
Monitor customer or venue connections by bitrate, role, address, and region.
Turn an RTMP contribution feed into HLS or DASH browser playback.

Limits and troubleshooting

The port must be free and reachable. Access rules, stream keys, and publisher or receiver roles must match the connection. Recent statistics are operational data rather than a durable analytics store; export them when longer retention or alerting is required.

Next steps

Validate a publisher with getStatistics, then connect the server to Restreams, Recordings, or Web players.

REST solution recipe

Accept RTMP publishers and inspect live bitrate

Provision an RTMP entry point with the required access policy, start it, and read current and recent process statistics from the same server resource.

Create RTMP ingestChoose the listen port, buffer, and open, stream-id, or IP access pattern.POST /api/rtmp-servers/create
Start the serverEnable the entry point before connecting OBS, an encoder, or another publisher.POST /api/rtmp-servers/start
Read live statisticsInspect current bitrate and connection data, then use history for recent samples.POST /api/rtmp-servers/getStatistics

A successful create response confirms configuration, not media health. Start the resource, then verify its runtime statistics before sending production traffic.

See the RTMP Server product

POST

/api/rtmp-servers/create

API token required

Create an RTMP ingest server with its listen port, player buffer, active state, and optional stream-key or IP access rules. Send the dashboard-issued JWT in the x-access-token header.

server_buflen is measured in seconds. The default is 5, and accepted values are 1 through 120.

When stream_control_type and access_settings are supplied, Callaba creates the access rules with the server. The create response can still contain access: []; call getById to read the populated access list.

Request examples

Choose a preset for open ingest, explicit stream keys, or fixed IP addresses. A vMix Script example is available for operator-driven provisioning.

Common use cases

Give OBS or another software encoder a stable RTMP contribution endpoint.
Restrict partner or studio publishing with stream keys or an IP allowlist.
Provision an ingest boundary that can feed browser playback through its associated HLS or DASH delivery.

Allow only specified stream keys

Use this pattern when publishers and receivers should authenticate with explicit RTMP stream keys instead of open ingest. It mirrors the dashboard preset that seeds one publisher key and one receiver key.

Allow only specified stream keys

curl --request POST \
  --url http://localhost/api/rtmp-servers/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "server_name": "Live Protected",
  "server_type": "SERVER_TYPE_RTMP",
  "server_port": 1945,
  "server_buflen": 5,
  "server_active": true,
  "stream_control_type": "CONTROL_ACCESS_STREAM_ID",
  "access_settings": [
    {
      "stream_id": "rtmp-stream-01",
      "role_name": "publisher"
    },
    {
      "stream_id": "rtmp-stream-01",
      "role_name": "receiver"
    }
  ]
}'

Allow only specified IP addresses

Use this pattern when the RTMP peers are known fixed hosts. The dashboard preset creates publisher and receiver rules keyed by host instead of stream id.

Allow only specified IP addresses

curl --request POST \
  --url http://localhost/api/rtmp-servers/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "server_name": "Live Allowlisted",
  "server_type": "SERVER_TYPE_RTMP",
  "server_port": 1945,
  "server_buflen": 5,
  "server_active": true,
  "stream_control_type": "CONTROL_ACCESS_IP_ADDRESS",
  "access_settings": [
    {
      "host": "127.0.0.1",
      "role_name": "publisher"
    },
    {
      "host": "127.0.0.1",
      "role_name": "receiver"
    }
  ]
}'

Request body parameters

Basic settings

server_name

string

Dashboard label: Name.

The form defaults to Live. Validation requires a non-empty value and rejects slashes.

server_type

string

Current validated API contract accepts SERVER_TYPE_RTMP.

server_active

boolean

Dashboard label: Enable once created.

Enabled is the server state. Turning it off disconnects all publishers and receivers attached to the RTMP server.

Runtime settings

server_port

integer

Dashboard label: Port.

The dashboard starts at 1945. The REST API accepts ports from 1 to 65535. Choose a free port that is reachable by your publishers and viewers.

server_buflen

integer

Dashboard label: Buffer length (s).

This value is configured in seconds. The dashboard starts at 5 and the accepted range is 1 to 120.

This setting controls how much media the player buffers before playback starts.

Access control

stream_control_type

string

Dashboard section: Allowed streams.

Controls whether the RTMP server validates incoming publishers and receivers by explicit stream key or by host allowlist. The live create flow currently uses values such as CONTROL_ACCESS_STREAM_ID and CONTROL_ACCESS_IP_ADDRESS.

access_settings

array

Optional set of access rules to create together with the server.

For stream-key mode, each item typically contains stream_id and role_name. For IP-based mode, each item uses host and role_name.

Create RTMP server

Response

Identity and runtime

_id

string

Resource id returned when you create or list the RTMP server.

string

Convenience alias for _id.

server_name

string

Name stored for the RTMP server.

server_type

string

Type of the server. The live product returns SERVER_TYPE_RTMP.

server_port

string

Listening RTMP port returned by the product.

server_buflen

integer

Configured RTMP buffer length.

server_active

boolean

Current running state flag stored on the server object.

server_port_id

string

Port document attached to the RTMP listener.

server_created

string

Creation timestamp.

server_modified

string

Last modification timestamp.

Access control

stream_control_type

string

Access-control mode stored on the RTMP server, when provided.

access

array

The live create response currently returns this as an empty array even when access_settings were submitted. Use getById to retrieve the populated related access records.

Operation result

success

boolean

The model exposes success: true as a virtual field in successful responses.

Response: Create RTMP server

JSON

POST

/api/rtmp-servers/getCount

API token required

POST

/api/rtmp-servers/getAll

API token required

Returns the RTMP server list for the current user context.

The request body can include pagination and sorting fields such as { server_created: 1 }.

The response is a bare array of RTMP server objects. Unlike getById, this list response does not populate related access records.

Request body parameters

limit

integer

Optional page size for the list query.

skip

integer

Optional offset for paginated listing.

sort

object

Optional sort descriptor. The dashboard store defaults to { server_created: 1 }.

filter

object

Optional filter object forwarded to the backend query.

Get all RTMP servers

Response

array of RTMP server objects

array

The live product returns a bare array, not a wrapped object. Each item follows the same top-level shape as the create/update/start/stop response.

Response: Get all RTMP servers

JSON

POST

/api/rtmp-servers/getById

API token required

Loads one RTMP server by id.

This is the method to use when you need the full RTMP server object together with the populated access list.

The create response can show access: [] even when access rules were created, while getById returns those related stream records.

Request body parameters

string

Identifier of the RTMP server to load.

Get RTMP server by id

Response

Server object

server fields

object

The top-level RTMP server fields match the create response shape.

Populated access list

access[]

array

Unlike the live create response, getById populates the related access records.

access[].role_name

string

Role attached to the access record, for example publisher or receiver.

access[].stream_id

string

RTMP stream key when stream-id based access control is used.

access[].host

string

Allowed host when IP-based access control is used.

access[].name

string

Human-readable stream/access label generated by the backend, such as Server name: publisher.

Response: Get RTMP server by id

JSON

{
  "_id": "69c1fb2f28c95839e0e02359",
  "__v": 0,
  "access": [
    {
      "_id": "69c1fb2f28c95839e0e0235e",
      "__v": 0,
      "active": true,
      "audio_settings": {
        "streams": []
      },
      "created": "2026-03-24T02:47:11.807Z",
      "entityModel": "RTMPServerModel",
      "entity_id": "69c1fb2f28c95839e0e02359",
      "host": "",
      "module_name": "MODULE_RTMP_SERVERS",
      "name": "Docs RTMP Protected: publisher",
      "role_name": "publisher",
      "stream_id": "rtmp-stream-01",
      "user_id": "69360341db559495f643de6a",
      "id": "69c1fb2f28c95839e0e0235e",
      "success": true
    },
    {
      "_id": "69c1fb2f28c95839e0e02361",
      "__v": 0,
      "active": true,
      "audio_settings": {
        "streams": []
      },
      "created": "2026-03-24T02:47:11.807Z",
      "entityModel": "RTMPServerModel",
      "entity_id": "69c1fb2f28c95839e0e02359",
      "host": "",
      "module_name": "MODULE_RTMP_SERVERS",
      "name": "Docs RTMP Protected: receiver",
      "role_name": "receiver",
      "stream_id": "rtmp-stream-01",
      "user_id": "69360341db559495f643de6a",
      "id": "69c1fb2f28c95839e0e02361",
      "success": true
    }
  ],
  "server_active": true,
  "server_buflen": 5,
  "server_created": "2026-03-24T02:47:11.801Z",
  "server_name": "Docs RTMP Protected",
  "server_port": "1946",
  "server_type": "SERVER_TYPE_RTMP",
  "server_user_id": "69360341db559495f643de6a",
  "stream_control_type": "CONTROL_ACCESS_STREAM_ID",
  "server_modified": "2026-03-24T02:47:11.804Z",
  "server_port_id": "69c1fb2f28c95839e0e0235b",
  "id": "69c1fb2f28c95839e0e02359",
  "success": true
}

{
  "_id": "69c1fb2f28c95839e0e02359",
  "__v": 0,
  "access": [
    {
      "_id": "69c1fb2f28c95839e0e0235e",
      "__v": 0,
      "active": true,
      "audio_settings": {
        "streams": []
      },
      "created": "2026-03-24T02:47:11.807Z",
      "entityModel": "RTMPServerModel",
      "entity_id": "69c1fb2f28c95839e0e02359",
      "host": "",
      "module_name": "MODULE_RTMP_SERVERS",
      "name": "Docs RTMP Protected: publisher",
      "role_name": "publisher",
      "stream_id": "rtmp-stream-01",
      "user_id": "69360341db559495f643de6a",
      "id": "69c1fb2f28c95839e0e0235e",
      "success": true
    },
    {
      "_id": "69c1fb2f28c95839e0e02361",
      "__v": 0,
      "active": true,
      "audio_settings": {
        "streams": []
      },
      "created": "2026-03-24T02:47:11.807Z",
      "entityModel": "RTMPServerModel",
      "entity_id": "69c1fb2f28c95839e0e02359",
      "host": "",
      "module_name": "MODULE_RTMP_SERVERS",
      "name": "Docs RTMP Protected: receiver",
      "role_name": "receiver",
      "stream_id": "rtmp-stream-01",
      "user_id": "69360341db559495f643de6a",
      "id": "69c1fb2f28c95839e0e02361",
      "success": true
    }
  ],
  "server_active": true,
  "server_buflen": 5,
  "server_created": "2026-03-24T02:47:11.801Z",
  "server_name": "Docs RTMP Protected",
  "server_port": "1946",
  "server_type": "SERVER_TYPE_RTMP",
  "server_user_id": "69360341db559495f643de6a",
  "stream_control_type": "CONTROL_ACCESS_STREAM_ID",
  "server_modified": "2026-03-24T02:47:11.804Z",
  "server_port_id": "69c1fb2f28c95839e0e0235b",
  "id": "69c1fb2f28c95839e0e02359",
  "success": true
}

POST

/api/rtmp-servers/getStatistics

API token required

Read aggregate and per-server bitrate, active streams, publisher and receiver counts, plus client IP and geographic enrichment when available.

Omit id to include every RTMP server owned by the token, or pass one server id for a focused result. Each call also adds a short-lived snapshot for getStatisticHistory.

If statistics are unavailable, the endpoint can return success: false with zeroed server entries and an error field.

Common use cases

Confirm that an expected publisher is connected and sending bitrate.
Compare publisher and receiver counts during a live event.
Enrich an operational view with client IP, city, and country when those fields are available.

Request body parameters

Optional scope

string

Optional RTMP server id. Omit it to read live statistics for every RTMP server owned by the authenticated user.

Get live RTMP statistics

Response

Aggregate

success

boolean

Whether the runtime statistics collector returned a normal snapshot.

input_bitrate_kbps

number

Aggregate incoming RTMP bitrate in kbit/s.

output_bitrate_kbps

number

Aggregate outgoing RTMP bitrate in kbit/s.

Server rows

servers[]

array

Per-server bitrate, publisher, receiver, stream-count, and stream-detail rows.

Stream rows

streams[]

array

Flattened stream snapshots with duration, byte counters, bitrate, codec, and client-role arrays.

Client rows

publishers[] / receivers[] / clients[]

array

Connection records include role, client id, IP/address, city, country, location, page URL, client software, timing, dropped frames, and A/V sync where the runtime exposes them.

Response: Get live RTMP statistics

JSON

{
  "success": true,
  "nginx_version": "1.25.x",
  "nginx_rtmp_version": "1.2.x",
  "uptime": 86400,
  "input_bitrate_kbps": 2380,
  "output_bitrate_kbps": 4760,
  "servers": [
    {
      "entity_id": "69c1fb0128c95839e0e022d5",
      "server_id": "69c1fb0128c95839e0e022d5",
      "server_name": "Docs RTMP Server",
      "server_port": "1945",
      "app_name": "docs-rtmp-server",
      "input_bitrate_kbps": 2380,
      "output_bitrate_kbps": 4760,
      "publishers_count": 1,
      "receivers_count": 2,
      "streams_count": 1,
      "streams": [
        {
          "entity_id": "69c1fb0128c95839e0e022d5",
          "server_id": "69c1fb0128c95839e0e022d5",
          "server_name": "Docs RTMP Server",
          "server_port": "1945",
          "app_name": "docs-rtmp-server",
          "stream_id": "main-stage",
          "duration_ms": 42000,
          "bytes_in": 12400000,
          "bytes_out": 24800000,
          "input_bitrate_kbps": 2380,
          "output_bitrate_kbps": 4760,
          "bitrate_kbps": 7140,
          "codec": "H264",
          "publishers_count": 1,
          "receivers_count": 2,
          "publishers": [
            {
              "id": "rtmp-client-17",
              "client_id": "rtmp-client-17",
              "role_name": "publisher",
              "address": "198.51.100.24",
              "ip": "198.51.100.24",
              "country": "DE",
              "city": "Frankfurt am Main",
              "location": "Frankfurt am Main, DE",
              "pageurl": "",
              "flashver": "FMLE/3.0",
              "time": 42000,
              "dropped": 0,
              "avsync": 0,
              "internal": false
            }
          ],
          "receivers": [
            {
              "id": "rtmp-client-18",
              "client_id": "rtmp-client-18",
              "role_name": "receiver",
              "address": "203.0.113.31",
              "ip": "203.0.113.31",
              "country": "GB",
              "city": "London",
              "location": "London, GB",
              "pageurl": "",
              "flashver": "FMLE/3.0",
              "time": 42000,
              "dropped": 0,
              "avsync": 0,
              "internal": false
            }
          ]
        }
      ]
    }
  ],
  "streams": [
    {
      "entity_id": "69c1fb0128c95839e0e022d5",
      "server_id": "69c1fb0128c95839e0e022d5",
      "server_name": "Docs RTMP Server",
      "server_port": "1945",
      "app_name": "docs-rtmp-server",
      "stream_id": "main-stage",
      "duration_ms": 42000,
      "bytes_in": 12400000,
      "bytes_out": 24800000,
      "input_bitrate_kbps": 2380,
      "output_bitrate_kbps": 4760,
      "bitrate_kbps": 7140,
      "codec": "H264",
      "publishers_count": 1,
      "receivers_count": 2,
      "publishers": [
        {
          "id": "rtmp-client-17",
          "client_id": "rtmp-client-17",
          "role_name": "publisher",
          "address": "198.51.100.24",
          "ip": "198.51.100.24",
          "country": "DE",
          "city": "Frankfurt am Main",
          "location": "Frankfurt am Main, DE",
          "pageurl": "",
          "flashver": "FMLE/3.0",
          "time": 42000,
          "dropped": 0,
          "avsync": 0,
          "internal": false
        }
      ],
      "receivers": [
        {
          "id": "rtmp-client-18",
          "client_id": "rtmp-client-18",
          "role_name": "receiver",
          "address": "203.0.113.31",
          "ip": "203.0.113.31",
          "country": "GB",
          "city": "London",
          "location": "London, GB",
          "pageurl": "",
          "flashver": "FMLE/3.0",
          "time": 42000,
          "dropped": 0,
          "avsync": 0,
          "internal": false
        }
      ]
    }
  ]
}

{
  "success": true,
  "nginx_version": "1.25.x",
  "nginx_rtmp_version": "1.2.x",
  "uptime": 86400,
  "input_bitrate_kbps": 2380,
  "output_bitrate_kbps": 4760,
  "servers": [
    {
      "entity_id": "69c1fb0128c95839e0e022d5",
      "server_id": "69c1fb0128c95839e0e022d5",
      "server_name": "Docs RTMP Server",
      "server_port": "1945",
      "app_name": "docs-rtmp-server",
      "input_bitrate_kbps": 2380,
      "output_bitrate_kbps": 4760,
      "publishers_count": 1,
      "receivers_count": 2,
      "streams_count": 1,
      "streams": [
        {
          "entity_id": "69c1fb0128c95839e0e022d5",
          "server_id": "69c1fb0128c95839e0e022d5",
          "server_name": "Docs RTMP Server",
          "server_port": "1945",
          "app_name": "docs-rtmp-server",
          "stream_id": "main-stage",
          "duration_ms": 42000,
          "bytes_in": 12400000,
          "bytes_out": 24800000,
          "input_bitrate_kbps": 2380,
          "output_bitrate_kbps": 4760,
          "bitrate_kbps": 7140,
          "codec": "H264",
          "publishers_count": 1,
          "receivers_count": 2,
          "publishers": [
            {
              "id": "rtmp-client-17",
              "client_id": "rtmp-client-17",
              "role_name": "publisher",
              "address": "198.51.100.24",
              "ip": "198.51.100.24",
              "country": "DE",
              "city": "Frankfurt am Main",
              "location": "Frankfurt am Main, DE",
              "pageurl": "",
              "flashver": "FMLE/3.0",
              "time": 42000,
              "dropped": 0,
              "avsync": 0,
              "internal": false
            }
          ],
          "receivers": [
            {
              "id": "rtmp-client-18",
              "client_id": "rtmp-client-18",
              "role_name": "receiver",
              "address": "203.0.113.31",
              "ip": "203.0.113.31",
              "country": "GB",
              "city": "London",
              "location": "London, GB",
              "pageurl": "",
              "flashver": "FMLE/3.0",
              "time": 42000,
              "dropped": 0,
              "avsync": 0,
              "internal": false
            }
          ]
        }
      ]
    }
  ],
  "streams": [
    {
      "entity_id": "69c1fb0128c95839e0e022d5",
      "server_id": "69c1fb0128c95839e0e022d5",
      "server_name": "Docs RTMP Server",
      "server_port": "1945",
      "app_name": "docs-rtmp-server",
      "stream_id": "main-stage",
      "duration_ms": 42000,
      "bytes_in": 12400000,
      "bytes_out": 24800000,
      "input_bitrate_kbps": 2380,
      "output_bitrate_kbps": 4760,
      "bitrate_kbps": 7140,
      "codec": "H264",
      "publishers_count": 1,
      "receivers_count": 2,
      "publishers": [
        {
          "id": "rtmp-client-17",
          "client_id": "rtmp-client-17",
          "role_name": "publisher",
          "address": "198.51.100.24",
          "ip": "198.51.100.24",
          "country": "DE",
          "city": "Frankfurt am Main",
          "location": "Frankfurt am Main, DE",
          "pageurl": "",
          "flashver": "FMLE/3.0",
          "time": 42000,
          "dropped": 0,
          "avsync": 0,
          "internal": false
        }
      ],
      "receivers": [
        {
          "id": "rtmp-client-18",
          "client_id": "rtmp-client-18",
          "role_name": "receiver",
          "address": "203.0.113.31",
          "ip": "203.0.113.31",
          "country": "GB",
          "city": "London",
          "location": "London, GB",
          "pageurl": "",
          "flashver": "FMLE/3.0",
          "time": 42000,
          "dropped": 0,
          "avsync": 0,
          "internal": false
        }
      ]
    }
  ]
}

GET

/api/rtmp-servers/:serverPort/getStatisticHistory

API token required

Read recent RTMP snapshots for a server port owned by the authenticated user. The response is keyed by stream id.

getStatistics populates this short-lived history, and an Engine restart clears it. Export measurements to your monitoring system when longer retention is required.

Query parameters

Path parameter

serverPort

string

Listen port of an RTMP server owned by the authenticated user.

Get RTMP statistics history by server port

Response

Top-level object

stream_id

object key

Each top-level key identifies one stream observed on the selected RTMP port.

History

[]

array

In-memory snapshot history produced by calls to getStatistics. It is not durable storage and resets with the Engine process.

Response: Get RTMP statistics history by server port

JSON

{
  "main-stage": [
    {
      "entity_id": "69c1fb0128c95839e0e022d5",
      "server_id": "69c1fb0128c95839e0e022d5",
      "server_name": "Docs RTMP Server",
      "server_port": "1945",
      "app_name": "docs-rtmp-server",
      "stream_id": "main-stage",
      "duration_ms": 42000,
      "bytes_in": 12400000,
      "bytes_out": 24800000,
      "input_bitrate_kbps": 2380,
      "output_bitrate_kbps": 4760,
      "bitrate_kbps": 7140,
      "codec": "H264",
      "publishers_count": 1,
      "receivers_count": 2,
      "publishers": [
        {
          "id": "rtmp-client-17",
          "client_id": "rtmp-client-17",
          "role_name": "publisher",
          "address": "198.51.100.24",
          "ip": "198.51.100.24",
          "country": "DE",
          "city": "Frankfurt am Main",
          "location": "Frankfurt am Main, DE",
          "pageurl": "",
          "flashver": "FMLE/3.0",
          "time": 42000,
          "dropped": 0,
          "avsync": 0,
          "internal": false
        }
      ],
      "receivers": [
        {
          "id": "rtmp-client-18",
          "client_id": "rtmp-client-18",
          "role_name": "receiver",
          "address": "203.0.113.31",
          "ip": "203.0.113.31",
          "country": "GB",
          "city": "London",
          "location": "London, GB",
          "pageurl": "",
          "flashver": "FMLE/3.0",
          "time": 42000,
          "dropped": 0,
          "avsync": 0,
          "internal": false
        }
      ],
      "sequence": 1774330100000
    }
  ]
}

{
  "main-stage": [
    {
      "entity_id": "69c1fb0128c95839e0e022d5",
      "server_id": "69c1fb0128c95839e0e022d5",
      "server_name": "Docs RTMP Server",
      "server_port": "1945",
      "app_name": "docs-rtmp-server",
      "stream_id": "main-stage",
      "duration_ms": 42000,
      "bytes_in": 12400000,
      "bytes_out": 24800000,
      "input_bitrate_kbps": 2380,
      "output_bitrate_kbps": 4760,
      "bitrate_kbps": 7140,
      "codec": "H264",
      "publishers_count": 1,
      "receivers_count": 2,
      "publishers": [
        {
          "id": "rtmp-client-17",
          "client_id": "rtmp-client-17",
          "role_name": "publisher",
          "address": "198.51.100.24",
          "ip": "198.51.100.24",
          "country": "DE",
          "city": "Frankfurt am Main",
          "location": "Frankfurt am Main, DE",
          "pageurl": "",
          "flashver": "FMLE/3.0",
          "time": 42000,
          "dropped": 0,
          "avsync": 0,
          "internal": false
        }
      ],
      "receivers": [
        {
          "id": "rtmp-client-18",
          "client_id": "rtmp-client-18",
          "role_name": "receiver",
          "address": "203.0.113.31",
          "ip": "203.0.113.31",
          "country": "GB",
          "city": "London",
          "location": "London, GB",
          "pageurl": "",
          "flashver": "FMLE/3.0",
          "time": 42000,
          "dropped": 0,
          "avsync": 0,
          "internal": false
        }
      ],
      "sequence": 1774330100000
    }
  ]
}

POST

/api/rtmp-servers/update

API token required

Updates an existing RTMP server.

The update contract mirrors create and adds the server id. Send the complete desired listen, buffer, active-state, and access-policy fields.

Use this method when you need to change the listen port, player buffer length, active state, or allowed-stream policy without deleting and recreating the ingest boundary.

Request body parameters

string

Identifier of the RTMP server being updated.

server_name / server_port / server_buflen / server_active

mixed

The update contract mirrors create. The service reuses the same validation path and regenerates the RTMP config after the document is saved.

Update RTMP server

Response

updated RTMP server object

object

The live product returns the updated server object on the top level together with success: true.

Response: Update RTMP server

JSON

POST

/api/rtmp-servers/start

API token required

POST

/api/rtmp-servers/stop

API token required

DELETE

/api/rtmp-servers/remove

API token required

Back toAuthorization Next toSRT routes