Skip to content

EyesOnItDocumentation6.1

Select theme

Documentation home
Genetec plugin
- Start with Genetec
- Cameras and video
- Detections and alerts
- People and identities
- Monitoring and investigations
- Find the problem
Get started
- How EyesOnIt works
- Installation and initial setup
Cameras and video
Detections and alerts
- Regions, lines, and line crossing
- Starter templates
- Choose what to detect
- Conditions and rules
- Test and tune
  - Motion and timing
  - Image Lab
- Notifications and evidence
People and identities
Monitoring and investigations
Deployment and recovery
Administration
REST API
- Developer overview
- Get started
  - overview
    REST API overview
  - authentication-and-permissions
    Authentication and permissions
  - make-your-first-request
    Make your first request
  - api-concepts-and-conventions
    API concepts and conventions
- Integration guides
  - Integration guides
  - connect-and-manage-cameras
    Connect and manage cameras
  - configure-detections-and-rules
    Configure detections and rules
  - receive-alerts-and-review-incidents
    Receive alerts and review incidents
  - retrieve-snapshots-and-video
    Retrieve snapshots and video
  - search-recorded-video
    Search recorded video
  - analyze-images-and-video-files
    Analyze images and video files
  - manage-people-and-identities
    Manage people and identities
  - manage-customer-workspaces-and-access
    Manage customer workspaces and access
  - import-and-export-configurations
    Import and export configurations
  - handle-errors-retries-and-background-work
    Handle errors, retries, and background work
- API reference
  - Reference overview
  - Conventions
    API conventions
    authentication
    Authentication
    requests-and-responses
    Requests and responses
    errors-and-status-codes
    Errors and status codes
    versions-and-compatibility
    Versions and compatibility
  - Cameras and video
    camera-organization
    Get Camera Organization
    Camera organization
    Export Camera Organization
    Preview Camera Organization Import
    Apply Camera Organization Import
    Create Camera Hierarchy
    Update Camera Hierarchy
    Delete Camera Hierarchy
    Create Camera Folder
    Update Camera Folder
    Delete Camera Folder
    Change Camera Folder Memberships
    recordings-and-playback
    List Recordings
    Get Archive Camera Availability
    Remove Camera From Archive
    Recordings and playback
    Get Continuous Recording Playback
    Get Continuous Recording Segment
    Get Recording Playback
    Get Recording Artifact
    rtsp-gateways
    Create Pool
    Get Pool
    Update Pool
    Get Pool
    Update Pool
    RTSP gateways
    Discover rtsp gateways
    Discover integration rtsp gateways
    Start Apply
    Start Apply
    Get Apply
    Cancel Apply
    Get Apply
    Cancel Apply
    Get rtsp gateway status
    Get integration rtsp gateway status
    Probe rtsp gateway
    Probe integration rtsp gateway
    Get Probe
    Cancel Probe
    Get Probe
    Cancel Probe
    Get Route
    Update Route
    snapshots-and-live-preview
    Get Stream Snapshot
    Create Live Preview Session
    Snapshots and live preview
    Delete Live Preview Session
    streams
    Streams
    Confirm integration association
    Get integration association
    List Streams
    Create Stream
    List Stream Runtime Status
    Get Stream
    Replace Stream
    Delete Stream
    Reveal Stream Connection
    Command Stream
    video-files
    List Video Source Nodes
    List Video Files
    Probe Video File
    Video files
    Cameras and video
  - Analytics and investigations
    alerts-and-consumers
    Get alert consumer status
    Register alert consumer
    Claim alert deliveries
    Acknowledge alert delivery
    List Alerts
    Alerts and consumers
    detection-models
    Get Model Catalog
    Detection models
    image-analysis
    Create Image Analysis
    Get Image Analysis
    Cancel Image Analysis
    Image analysis
    incidents-and-evidence
    List Incidents
    Bulk Update Incidents
    Get Incident
    Update Incident
    Add Incident Note
    List Incident Notes
    List Incident History
    Get Incident Evidence
    Get Incident Snapshot
    Incidents and evidence
    live-searches
    List Live Searches
    Create Live Search
    List Retired Live Search History
    Get Live Search
    Update Live Search
    Cancel Live Search
    List Live Search Matches
    List Live Search Coverage Gaps
    List Live Search Source Gaps
    Export Live Search Coverage
    Live searches
    recorded-video-searches
    Get Archive Record Thumbnail
    List Searches
    Create Search
    Ppe Search Coverage
    Create Uploaded Similarity Search
    Get Search
    Cancel Search
    Recorded-video searches
    stream-analytics
    Get Stream Analytics
    Replace Stream Analytics
    Stream analytics
    visual-references
    List Visual References
    Create Visual Reference
    Get Visual Reference
    Delete Visual Reference
    Visual references
    warehouse-sites-and-events
    List Warehouse Sites
    Create Warehouse Site
    Get Warehouse Site
    Replace Warehouse Site
    Delete Warehouse Site
    Get Warehouse Site Readiness
    Approve Warehouse Site
    Revoke Warehouse Site Approval
    List Warehouse Site Notes
    Add Warehouse Site Note
    List Warehouse Events
    Summarize Warehouse Events
    Get Warehouse Event Heatmap
    Export Warehouse Events
    Warehouse sites and events
    Get Warehouse Event
    Review Warehouse Event
    Request Warehouse Event Clip
    Analytics and investigations
  - People and identities
    face-recognition-events
    List Face Recognition Events
    Face-recognition events
    identities-and-samples
    Query Face Identities
    List Face Identities
    Create Face Identity
    Get Face Identity
    Replace Face Identity
    Delete Face Identity
    Grant Shared Face Identity
    Revoke Shared Face Identity
    Enroll Archive Face
    Enroll Face Image
    List Face Samples
    Get Face Sample Thumbnail
    Select Primary Face Sample
    Delete Face Sample
    Identities and samples
    identity-groups
    Query Face Groups
    List Face Groups
    Create Face Group
    Get Face Group
    Replace Face Group
    Delete Face Group
    Identity groups
    identity-imports-and-exports
    Export Identities
    Inspect Identity Import
    Preview Identity Import
    Apply Identity Import
    Identity imports and exports
    People and identities
  - Accounts and administration
    audit-events
    List Audit Events
    Audit events
    authentication-and-sessions
    Create Session
    Request Password Reset
    Complete Password Reset
    Accept Account Invitation
    Get Current Principal
    Switch Current Workspace
    Revoke Current Session
    Reauthenticate Session
    Change Current Password
    Enroll Current Principal Mfa
    Confirm Current Principal Mfa
    Authentication and sessions
    notification-profiles
    List Notification Profile Options
    Get Notification Approval
    Set Notification Approval
    Get Notification Test Options
    Request Notification Test
    List Notification Tests
    List Notification Profiles
    Create Notification Profile
    Get Notification Profile
    Replace Notification Profile
    Delete Notification Profile
    Notification profiles
    organizations-and-workspaces
    List Organizations
    Create Organization
    Get Organization
    Update Organization
    Delete Organization
    Get Organization Resource Budget
    Set Organization Resource Budget
    Export Organization Usage
    List Organization Camera Grants
    Get Invitation Camera Options
    List Account Invitations
    Create Account Invitation
    Check Invitation Delivery
    Reissue Account Invitation
    Cancel Account Invitation
    Get Invitation Fallback Token
    Get Organization Camera Assignments
    Set Organization Camera Assignments
    Grant Organization Camera
    Revoke Organization Camera
    Set Camera Configuration Delegation
    Organizations and workspaces
    service-tokens
    List Service Tokens
    Revoke Service Token
    Service tokens
    settings-and-vault-references
    Get Runtime Settings
    Patch Runtime Settings
    Save Delivery Credential
    List Vault References
    Settings and vault references
    users-and-camera-access
    List Users
    Create User
    Remove User Authenticator
    Reset Customer Mfa
    Update User
    Get User Camera Access
    Replace User Camera Access
    List User Sessions
    Revoke User Sessions
    Revoke Session
    Users and camera access
    Accounts and administration
  - System and operations
    health-and-diagnostics
    Get liveness
    Get readiness
    Get Deployment Identity
    Get Diagnostics Metrics
    Health and diagnostics
    imports-and-exports
    Export Streams
    Inspect Stream Import File
    Preview Stream Import File
    Preview Stream Import
    List Stream Import Preview Items
    Apply Stream Import
    Preview Stream Replacement Import
    Apply Stream Replacement Import
    Imports and exports
    licensing
    Get License Status
    Licensing
    operations-and-recovery
    List Embedding Recoveries
    Create Embedding Recovery
    Get Archive Integrity Status
    Get Embedding Recovery
    Cancel Embedding Recovery
    Get Operations Snapshot
    Operations and recovery
    recording-storage-and-retention
    Get Recording Retention
    Provider Budget
    Set Provider Budget
    Query recording storage
    Preview recording cleanup
    Preview Items
    List recording cleanup jobs
    Confirm recording cleanup
    Retention Preview
    Retention Confirm
    Get recording cleanup job
    Control recording cleanup job
    Protect recording storage
    Recording storage and retention
    remote-management
    Get Remote Management Status
    Remote management
    telemetry-and-nodes
    Get Live Search History Status
    Get System Telemetry
    Update Node Display Name
    Telemetry and nodes
    System and operations
  - Edge devices
    device-protocol
    Poll View Requests
    Reply View Request
    Claim edge device
    Analysis Lease
    Get edge desired configuration
    Acknowledge edge configuration
    Report edge heartbeat
    Report edge losses
    Report edge windows
    Admit Media
    Media Receipt
    Media Content
    Device protocol
    devices
    Preview edge device organization
    Set edge device organization
    List Devices
    Create Device
    Set edge device settings
    Revoke edge device
    Camera Retention
    Set Camera Retention
    Devices
    prepared-cameras
    List Cameras
    Create Camera
    Get prepared camera configuration
    Save prepared camera configuration
    Apply prepared camera configuration
    Link prepared camera
    Delete prepared camera
    Prepared cameras
    Edge devices
Troubleshooting and support

Select theme

On this page

Overview

On this page

Overview

Remote management

Read the server’s remote-management status.

Operation	Request
Get Remote Management Status	`GET /api/v1/remote-management/status`

EyesOnIt / Documentation 6.1EyesOnIt 6.1

Image preview