{"schemaVersion":"1.0","sourceCommit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca","sourceVisibility":"private","article":{"id":"api-mansoq-onvif-console-stream-kick-24338ec5","title":"Stream Kick API reference · mansoq-onvif-console","summary":"Static source contract for Stream Kick: 1 declared or inherited operation mappings, schema/field evidence and authorization/refusal references. Deployment and behavioral review remain explicit.","module":"IT & integrations","roles":["IT administrator","Developer","Integration engineer"],"facilities":["All configured facility types"],"kind":"reference","minutes":3,"prerequisites":["Use the API contract from the installed deployment and an authorized synthetic test environment.","Confirm facility/organization scope, action permissions and optional app enablement.","This reference is static source evidence; complete payload, authorization, failure and end-to-end review remains recorded as pending."],"steps":[],"sections":[{"title":"Declared route and availability","body":"This resource is declared in **mansoq-onvif-console** at `/api/stream/kick`. service-local decorator; application/router mount prefix and deployment base require verification A registered path and an indexed handler do not prove deployment availability, user permission or production readiness."},{"title":"Operation map","body":"| Method | Path | Action | Evidence |\n| --- | --- | --- | --- |\n| POST | `/api/stream/kick` | stream_kick | service HTTP decorator |"},{"title":"stream_kick · POST","body":"Force-restart the go2rtc producer (drops all consumers). Useful when a\ncamera only emits keyframes on RTSP session start and the player is stuck\non a black frame.\n\n**POST /api/stream/kick** — action `stream_kick`. static function declaration extracted; request/runtime review pending.\n\n**Authorization:** no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.\n\n**Declared refusal/error evidence:** HTTPException (dynamic detail; inspect source)."},{"title":"Integration review checklist","body":"Confirm the installed route and full schema; review authentication, organization/facility scoping, all accepted fields, value-state and date/time semantics, idempotency, pagination, response/exception branches and the allowed correction/reversal workflow. Test positive and negative cases with synthetic data. This source reference does not establish external certification or replace an illustrated user procedure."}],"troubleshooting":[{"problem":"A declared route is unavailable or a request is rejected","solution":"Compare the installed revision, actual API schema, optional plugin mount, HTTP-method restrictions and recorded validation/permission evidence. Do not bypass a refusal or send a production transaction to test documentation."}],"sources":[{"path":"repositories/teleicu/mansoq-onvif-console/backend/server.py","line":397,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-onvif-console/backend/server.py","line":398,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}],"related":["it-api-contract","it-api-auth","security-rcm-roles"],"verification":"Static API contract — behavior review pending","version":"f6e9f05f76d4","apiReferenceIds":["backend-service-40b3155124338ec5","backend-service-40b3155124338ec5:POST:stream_kick"]},"backend":{"resources":[{"id":"backend-service-40b3155124338ec5","declaredPath":"/api/stream/kick","dynamicPath":false,"source":{"path":"repositories/teleicu/mansoq-onvif-console/backend/server.py","line":397,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"conditions":[],"kind":"service-decorator","view":"stream_kick","classId":"repositories/teleicu/mansoq-onvif-console:server.stream_kick","handlerOwner":null,"handlerName":"stream_kick","actionMapping":null,"httpMethods":["POST"],"serviceLocal":true,"decoratorPolicy":{},"explicitDecoratorStatus":null,"decoratorResponseSchema":null,"operationIds":["backend-service-40b3155124338ec5:POST:stream_kick"],"path":"/api/stream/kick","mountStatus":"service-local decorator; application/router mount prefix and deployment base require verification","reviewStatus":"direct route enumerated; behavioral review pending"}],"operations":[{"id":"backend-service-40b3155124338ec5:POST:stream_kick","resourceId":"backend-service-40b3155124338ec5","repository":"repositories/teleicu/mansoq-onvif-console","boundary":"optional-plugin/local-service","method":"POST","path":"/api/stream/kick","declaredPattern":"/api/stream/kick","action":"stream_kick","viewset":"stream_kick","classId":"repositories/teleicu/mansoq-onvif-console:server.stream_kick","detail":null,"mountStatus":"service-local decorator; application/router mount prefix and deployment base require verification","routeEvidence":{"path":"repositories/teleicu/mansoq-onvif-console/backend/server.py","line":397,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":{"path":"repositories/teleicu/mansoq-onvif-console/backend/server.py","line":398,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"registrationConditions":[],"evidenceKind":"service HTTP decorator","decoratorStatus":null,"decoratorPolicy":{},"methodEvidenceIds":["repositories/teleicu/mansoq-onvif-console/backend/server.py:398:stream_kick"],"schemaIds":{},"classPermissionEvidence":[],"filterEvidence":[],"reviewStatus":"static function declaration extracted; request/runtime review pending","pathParameters":[]}],"methodEvidence":[{"id":"repositories/teleicu/mansoq-onvif-console/backend/server.py:398:stream_kick","name":"stream_kick","owner":"repositories/teleicu/mansoq-onvif-console:server.stream_kick","summary":"Force-restart the go2rtc producer (drops all consumers). Useful when a\ncamera only emits keyframes on RTSP session start and the player is stuck\non a black frame.","source":{"path":"repositories/teleicu/mansoq-onvif-console/backend/server.py","line":398,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[],"parametersRead":[],"permissionChecks":[],"declaredErrors":[{"exception":"HTTPException","message":null,"dynamicMessage":false,"source":{"path":"repositories/teleicu/mansoq-onvif-console/backend/server.py","line":410,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"exception":"HTTPException","message":null,"dynamicMessage":false,"source":{"path":"repositories/teleicu/mansoq-onvif-console/backend/server.py","line":416,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"explicitResponseStatuses":[],"conditions":[],"schemaIds":[],"schemaUsages":[],"unconditionalRaise":false,"reviewStatus":"static declaration extracted; behavioral/security review pending"}],"schemas":[],"frameworkSettings":[]},"frontend":{"operations":[],"schemas":[]},"services":{"operations":[]},"boundaries":[]}