Create / Enable / Disable / Update Stream Forwarder - FlightHub 2 OpenAPI V2.0 (On-Premises)

This endpoint executes four operations based on the request body:

① Create Forwarder (no converter_id)
Create a new bypass push-stream transcoder. schema defaults to rtmp if omitted. auto_push_stream=false persists config without starting the stream (can be enabled later via ②); omitting the field or setting auto_push_stream=true starts streaming immediately (default).

② Enable Streaming (converter_id + auto_push_stream=true)
Resume streaming for a created-but-not-started or stopped forwarder. Configuration is reused — no need to re-supply device parameters.

③ Disable Streaming (converter_id + auto_push_stream=false)
Stop streaming for the specified forwarder while retaining configuration. Can be re-enabled at any time. Unlike DELETE, which destroys the configuration.

④ Update Configuration (converter_id, no auto_push_stream)
Update converter_name, sn, camera, video_type, schema/bypass_option. The forwarder must be in stopped state (error returned otherwise). schema update supports rtmp (requires bypass_option.url) and gb28181 (requires bypass_option.server_id); updating to rtsp is not supported.

Note: sn and camera are binding required fields and must be provided in all scenarios.

Request

Header Params

Body Params application/json

Example

{
    "sn": "7CTDL9K00A0009",
    "camera": "165-0-7",
    "schema": "rtmp",
    "bypass_option": {
        "url": "rtmp://10.88.200.3:1935/uav/6QCDL5R0000128"
    },
    "converter_name": "test-transcoder",
    "auto_push_stream": false,
    "video": "normal-0"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200

application/json

Bodyapplication/json

Example

{
    "code": 0,
    "message": "OK",
    "data": {
        "converter_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "create_ts": 1718400000,
        "update_ts": 1718400000,
        "converter_state": "running"
    }
}

🟠400

🔴500