⚠️ Experimental: The Moverse Capture Remote Control API is in an experimental stage. For usage with Moverse Capture Studio, click here.

Update Stream State

PATCH

/api/v1/streams/{id}

Streaming

Last modified:2026-02-09 10:16:35

Updates the configuration (IP/Port) and/or the running state of a stream.

⚠️ Important: Redundant ID

You must provide the stream's id in both the URL path and the JSON request body.

🔄 Behavior

This endpoint echoes back the replicated request body upon success.

If you only update state, only state (plus IDs) is returned.

If you update ipv4/port, those are returned.

Request

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Update applied successfully. Response echoes the request fields.

Body

🟠400

🟠404

🟠422

🔴501

Request Example

Shell

JavaScript

Java

Swift

cURL

Update Config & Start StreamingStop Streaming OnlyUpdate IP/Port Only

curl --location --request PATCH '/api/v1/streams/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": 1,
    "actor_id": 0,
    "port": 22345,
    "ipv4": {
        "octet1": 192,
        "octet2": 168,
        "octet3": 1,
        "octet4": 25
    },
    "state": 1
}'

Response Example

200 - Config & Start Response

{
    "id": 1,
    "actor_id": 0,
    "state": 1,
    "ipv4": {
        "octet1": 192,
        "octet2": 168,
        "octet3": 1,
        "octet4": 25
    },
    "port": 22345
}

Modified at 2026-02-09 10:16:35

Remove Data Stream

Configuration

Update Stream State

⚠️ Important: Redundant ID#

🔄 Behavior#

Request

Responses

⚠️ Important: Redundant ID

🔄 Behavior