endLiveStream

DELETE

/api/v1/screens/{id}/live-stream/{sessionId}

const url = 'https://example.com/api/v1/screens/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/live-stream/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'DELETE', headers: {'X-CSRF-Token': 'example'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://example.com/api/v1/screens/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/live-stream/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'X-CSRF-Token: example'

End a live MJPEG relay session. Requires an authenticated dashboard user with the write scope. Cookie-authenticated unsafe requests require X-CSRF-Token.

Parameters

Path Parameters

required

string format: uuid

sessionId

required

string format: uuid

Header Parameters

X-CSRF-Token

required

string

Responses

204

Live stream session ended

401

Dashboard authentication required

403

Screen scope forbids this screen

404

Live stream session not found