Skip to content
EyesOnItDocumentation6.1

PreparedCameraConfiguration

Fields

Section titled “Fields”
Field Type Required Description and constraints
name string Yes minimum length 1. maximum length 128
location string or null No
description string or null No
externalId string or null No
tags object No Shared integration metadata. At most 32 public entries; keys up to 64 characters and values up to 256 characters. The additional server-managed eyesonit.rtsp.routing.v1 entry may contain up to 4096 characters and must be preserved unchanged on replacement. Camera organization uses its dedicated hierarchy APIs. maximum properties 33
timeZone string or null No
targetAnalyzedFps number No greater than 0.0. maximum 120.0. default 5
enabled boolean No default true
processingResolution VideoResolutionPolicyModel No
scene StreamSceneModel No
recording LocalRecordingPolicyModel No
archiveIndexing ArchiveIndexingPolicyModel No
faceRecognition FaceRecognitionPolicyModel No
sourceRouting RtspSourceRoutingBody or null No
source string or null No
fileSource FileSourceBody or null No
customer CustomerStreamCreationBody or null No Atomically create a disabled camera owned by this customer. Requires a signed-in provider and Idempotency-Key. Configure analytics and enable monitoring after creation. Identical retries return the current camera without restoring access or configuration.

Additional properties are rejected by this schema.

JSON schema

Section titled “JSON schema”
{
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 128,
      "minLength": 1,
      "title": "Name"
    },
    "location": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 256
        },
        {
          "type": "null"
        }
      ],
      "title": "Location"
    },
    "description": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2048
        },
        {
          "type": "null"
        }
      ],
      "title": "Description"
    },
    "externalId": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 128
        },
        {
          "type": "null"
        }
      ],
      "title": "Externalid"
    },
    "tags": {
      "if": {
        "not": {
          "required": [
            "eyesonit.rtsp.routing.v1"
          ]
        }
      },
      "then": {
        "maxProperties": 32
      },
      "patternProperties": {
        "^(?!eyesonit\\.rtsp\\.routing\\.v1$)[A-Za-z0-9][A-Za-z0-9._-]*$": {
          "type": "string",
          "maxLength": 256,
          "minLength": 1
        },
        "^eyesonit\\.rtsp\\.routing\\.v1$": {
          "type": "string",
          "maxLength": 4096,
          "minLength": 1
        }
      },
      "propertyNames": {
        "maxLength": 64,
        "minLength": 1,
        "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]*$"
      },
      "type": "object",
      "maxProperties": 33,
      "title": "Tags",
      "description": "Shared integration metadata. At most 32 public entries; keys up to 64 characters and values up to 256 characters. The additional server-managed eyesonit.rtsp.routing.v1 entry may contain up to 4096 characters and must be preserved unchanged on replacement. Camera organization uses its dedicated hierarchy APIs."
    },
    "timeZone": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 128,
          "minLength": 1
        },
        {
          "type": "null"
        }
      ],
      "title": "Timezone"
    },
    "targetAnalyzedFps": {
      "type": "number",
      "maximum": 120.0,
      "exclusiveMinimum": 0.0,
      "title": "Targetanalyzedfps",
      "default": 5
    },
    "enabled": {
      "type": "boolean",
      "title": "Enabled",
      "default": true
    },
    "processingResolution": {
      "$ref": "#/components/schemas/VideoResolutionPolicyModel"
    },
    "scene": {
      "$ref": "#/components/schemas/StreamSceneModel"
    },
    "recording": {
      "$ref": "#/components/schemas/LocalRecordingPolicyModel"
    },
    "archiveIndexing": {
      "$ref": "#/components/schemas/ArchiveIndexingPolicyModel"
    },
    "faceRecognition": {
      "$ref": "#/components/schemas/FaceRecognitionPolicyModel"
    },
    "sourceRouting": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/RtspSourceRoutingBody"
        },
        {
          "type": "null"
        }
      ]
    },
    "source": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1
        },
        {
          "type": "null"
        }
      ],
      "title": "Source"
    },
    "fileSource": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/FileSourceBody"
        },
        {
          "type": "null"
        }
      ]
    },
    "customer": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/CustomerStreamCreationBody"
        },
        {
          "type": "null"
        }
      ],
      "description": "Atomically create a disabled camera owned by this customer. Requires a signed-in provider and Idempotency-Key. Configure analytics and enable monitoring after creation. Identical retries return the current camera without restoring access or configuration."
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "name"
  ],
  "title": "PreparedCameraConfiguration"
}
Section titled “Related models”
Image preview