Jump to Content

Documentation API Reference

Terms and Conditions Visit een.com

API Reference

Terms and Conditions Visit een.com

Documentation API Reference

Shared

Authentication

Cameras

CameraSim
Camera Status
- Get the status of the camera.get
- Get the status of all cameras.get
Camera Mode
Cameras Recording
Sequence
Camera
Camera Addition Status
- Wait for camera status to change to a terminal state (success or failure).get
- Get the addition status of all cameras of the account.get
Camera Streams
- Get the streams of the camera.get
Camera Device Info
- Get device info of cameraget
Camera Video Stream Settings
Camera Footage Settings
Camera Location
Camera Firmware
Camera Snapshot
- Get the snapshot of the camera.get
Camera Microphone
Camera PTZ
- Sets a camera PTZ.post
Subscription Rights
- Get the subscription rights for this camera.get
- Get the subscriptions rights for all camerasget
Camera Jobs
- Get the list of currently active or previously finished camera related jobs.get
- Get the details of a single camera related job.get
Schedule
Video Summary
- Triggers the generation of a video summary.post
- Retrieve video summary mp4 file by job id.get
Camera Capabilities
Edge Storage
Camera Wifi

GeneRic API

Account Timezone
- Get account timezone of the user.get
- Update the account timezone of the requesting user.patch
Time Zone
- Get list of supported time zonesget
Language
- Get a list of supported languagesget
Video Export
- Triggers the generation of a video to be startedpost
- Retrieve generated video footage mov file by job id.get
Schedule
Video Analytics
Device Type
- Get the list of all supported device types.get
Zone
GPS
- Get GPS data for all the devices the calling user can access among a list (if provided) or from all the devices in the account (if the list is not provided).post
- Get current GPS data for all the devices the calling user can access among a list (if provided) or from all the devices in the account (if the list is not provided).post
Country
- Get a list of supported countriesget
SequenceV24
Detections
Video Motion Detection
- Get video detection enabled camera attribute.get
- Set video motion detection enabled camera attribute.put
PIR Detection
- Get PIR detection enabled camera attribute.get
- Set PIR detection enabled camera attribute.put
Audio Detection
- Get audio detection enabled camera attribute.get
- Set audio detection enabled camera attribute.put
Doorbell
- Get doorbell detection enabled camera attribute.get
- Set doorbell detection enabled camera attribute.put
Camera Detection Capabilities
- Get whether the different detection capabilities of a camera are available.get

Events

Event Search
- Searches for events.post
Event
Event Available Types
- Retrieve available event types for an account.get
Event Searchable Fields
- Retrieve the searchable fieldsget
Event Snapshot
- Retrieve the snapshot associated to an event.get
Faces
Face Sample Images
- Get a face sample imageget
Face Samples
Event Webhooks

Users

User Notification Settings
User Status
- Get the status of the current user.get
- Updates the status of the current user.patch
User Rights
User Password Reset
- Request a password reset for a given email address.post
User Base
User Details
- Get details information about the user.get
- Updates details information about the user.patch
User Credentials
- Get the status of user credentials.get
- Updates credentials for the user.patch
UserMfa
- Get the multi-factor authentication settings for the current user.get
- Updates the multi-factor authentication settings for the current user.patch

Devices

Device IO
Device Channel Snapshot
- Get the snapshot of the channel of the given device the user has access to.get
Add Device Status
- Wait for device status to change to a terminal state (success or failure).get
- Get the addition status of all devices of the account.get
Device Firmware
Device Channel Camera
- Adds a camera to a device channel.post
Device Info
- Get device info of a deviceget
Device Maintenance
- Device maintenanceput
Device Jobs
- Get the list of currently active or previously finished device related jobs.get
- Get the details of a single device related job.get
Device Channel
- Get the list of all channels of the given device the user has access to.get
- Get one of the channels of the given device the user has access to.get
Device Status
- Retrieves the status of a specific deviceget
Device Connection Details
- Get the details needed to establish a connectionget
- Update the device connection details and optionally run connection test.patch
Device Connection Credentials
- Get the credentials needed to establish a connection with a device.get
- Update the device connection credentials in the backend.patch
DeviceType Credentials
- Get the default credentials of the device, given the device's type ID.get

dEALER dASHBOARD

Account
Account Camera Slots
- Retrieves camera slots for accountget
Account User
Account Subscriptions
Camera Summary
- Get all cameras for accountget
- Get single camera summary for the accountget
Current User
- Get base info about current userget
Distributors
Helpdesk
- Get JNLP file to open helpdeskget
Mobile Helpdesk
- Get URL for mobile client to open helpdeskget
Profiles
Resellers
Reseller Subscription
- Get available subscriptionsget
Token Generation
- Generate token for a user by user IDpost
WebApp Helpdesk
- Get URL for webapp client to open helpdeskget

Powered by

Shared

Authentication

Cameras

CameraSim
Camera Status
- Get the status of the camera.get
- Get the status of all cameras.get
Camera Mode
Cameras Recording
Sequence
Camera
Camera Addition Status
- Wait for camera status to change to a terminal state (success or failure).get
- Get the addition status of all cameras of the account.get
Camera Streams
- Get the streams of the camera.get
Camera Device Info
- Get device info of cameraget
Camera Video Stream Settings
Camera Footage Settings
Camera Location
Camera Firmware
Camera Snapshot
- Get the snapshot of the camera.get
Camera Microphone
Camera PTZ
- Sets a camera PTZ.post
Subscription Rights
- Get the subscription rights for this camera.get
- Get the subscriptions rights for all camerasget
Camera Jobs
- Get the list of currently active or previously finished camera related jobs.get
- Get the details of a single camera related job.get
Schedule
Video Summary
- Triggers the generation of a video summary.post
- Retrieve video summary mp4 file by job id.get
Camera Capabilities
Edge Storage
Camera Wifi

GeneRic API

Account Timezone
- Get account timezone of the user.get
- Update the account timezone of the requesting user.patch
Time Zone
- Get list of supported time zonesget
Language
- Get a list of supported languagesget
Video Export
- Triggers the generation of a video to be startedpost
- Retrieve generated video footage mov file by job id.get
Schedule
Video Analytics
Device Type
- Get the list of all supported device types.get
Zone
GPS
- Get GPS data for all the devices the calling user can access among a list (if provided) or from all the devices in the account (if the list is not provided).post
- Get current GPS data for all the devices the calling user can access among a list (if provided) or from all the devices in the account (if the list is not provided).post
Country
- Get a list of supported countriesget
SequenceV24
Detections
Video Motion Detection
- Get video detection enabled camera attribute.get
- Set video motion detection enabled camera attribute.put
PIR Detection
- Get PIR detection enabled camera attribute.get
- Set PIR detection enabled camera attribute.put
Audio Detection
- Get audio detection enabled camera attribute.get
- Set audio detection enabled camera attribute.put
Doorbell
- Get doorbell detection enabled camera attribute.get
- Set doorbell detection enabled camera attribute.put
Camera Detection Capabilities
- Get whether the different detection capabilities of a camera are available.get

Events

Event Search
- Searches for events.post
Event
Event Available Types
- Retrieve available event types for an account.get
Event Searchable Fields
- Retrieve the searchable fieldsget
Event Snapshot
- Retrieve the snapshot associated to an event.get
Faces
Face Sample Images
- Get a face sample imageget
Face Samples
Event Webhooks

Users

User Notification Settings
User Status
- Get the status of the current user.get
- Updates the status of the current user.patch
User Rights
User Password Reset
- Request a password reset for a given email address.post
User Base
User Details
- Get details information about the user.get
- Updates details information about the user.patch
User Credentials
- Get the status of user credentials.get
- Updates credentials for the user.patch
UserMfa
- Get the multi-factor authentication settings for the current user.get
- Updates the multi-factor authentication settings for the current user.patch

Devices

Device IO
Device Channel Snapshot
- Get the snapshot of the channel of the given device the user has access to.get
Add Device Status
- Wait for device status to change to a terminal state (success or failure).get
- Get the addition status of all devices of the account.get
Device Firmware
Device Channel Camera
- Adds a camera to a device channel.post
Device Info
- Get device info of a deviceget
Device Maintenance
- Device maintenanceput
Device Jobs
- Get the list of currently active or previously finished device related jobs.get
- Get the details of a single device related job.get
Device Channel
- Get the list of all channels of the given device the user has access to.get
- Get one of the channels of the given device the user has access to.get
Device Status
- Retrieves the status of a specific deviceget
Device Connection Details
- Get the details needed to establish a connectionget
- Update the device connection details and optionally run connection test.patch
Device Connection Credentials
- Get the credentials needed to establish a connection with a device.get
- Update the device connection credentials in the backend.patch
DeviceType Credentials
- Get the default credentials of the device, given the device's type ID.get

dEALER dASHBOARD

Account
Account Camera Slots
- Retrieves camera slots for accountget
Account User
Account Subscriptions
Camera Summary
- Get all cameras for accountget
- Get single camera summary for the accountget
Current User
- Get base info about current userget
Distributors
Helpdesk
- Get JNLP file to open helpdeskget
Mobile Helpdesk
- Get URL for mobile client to open helpdeskget
Profiles
Resellers
Reseller Subscription
- Get available subscriptionsget
Token Generation
- Generate token for a user by user IDpost
WebApp Helpdesk
- Get URL for webapp client to open helpdeskget

Powered by

Delete a specific user.

delete http://rest.cameramanager.com/rest/v2.4/users/{userId}

Delete a specific user from the system.

Language

URL

Click Try It! to start a request and see the response here!