Delete a stream: Stream.Delete | AIPIX documentation

Deletes stream by their unique identifiers

Parameters

params: object

params.delete: boolean

optional

Default:

JSON

false

No description

params.cameras: object

List of streams UIDs to delete

params.cameras...

params.cameras{}: UidArray aka array

Min size: 1

List of UIDs

params.cameras{}[]: Uid aka string

Pattern: ^[a-zA-Z0-9_-]+$

Unique identifier used throughout the system

Result

result: object

Map of streams UIDs to deletion success status

result{}: any

No description

POST /api/

JSON

{
  "jsonrpc": "2.0",
  "method": "Stream.Delete",
  "params": {
    "cameras": {
      "camera_uuid": [
        "stream_uuid"
      ]
    },
    "delete": true
  },
  "id": 123
}

cURL

Bash

curl -k --request POST \
    --url 'https://your-domain/api/' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <api-authorization-token>' \
    --data '{
  "jsonrpc": "2.0",
  "method": "Stream.Delete",
  "params": {
    "cameras": {
      "camera_uuid": [
        "stream_uuid"
      ]
    },
    "delete": true
  },
  "id": 123
}'

200 OK

JSON

{
  "jsonrpc": "2.0",
  "result": {
    "camera_uuid": {
      "stream_uuid": true
    }
  },
  "id": 123
}

400 Bad Request

JSON

{
  "jsonrpc": "2.0",
  "error": {
    "code": -32601,
    "message": "Method not found"
  },
  "id": 123
}

500 Internal Server Error

Server error