Jump to Content
Documentation
API Reference
v2.0.0
v2.1.0
v2.2.0
v2.3.0
v2.4.0
v2.4.1
Terms and Conditions
Visit een.com
API Reference
Terms and Conditions
Visit een.com
Moon (Dark Mode)
Sun (Light Mode)
v2.4.1
Documentation
API Reference
Retrieve a specific event.
Search
JUMP TO
Shared
Authentication
Get access token
post
Get authorization code
post
Create a new session for the authenticated user
post
Deletes the token of the logged in user.
delete
Cameras
Camera
Get the list of all cameras the user has access to.
get
Adds a camera.
post
Get info of a specific camera.
get
Modify the details of a specific camera.
patch
Deletes a specific camera.
delete
CameraSim
Get currently used SIM card.
get
Wait till camera is in given state.
put
Set SIM card details
put
Camera Status
Get the status of the camera.
get
Get the status of all cameras.
get
Camera Mode
Update the camera mode
patch
Get the camera mode per camera Id
get
Get the camera mode for all cameras
get
Cameras Recording
Get the list of all recordings of this camera.
get
Get the list of all recordings of the user.
get
Get a single recording.
get
Sequence
Get sequences for the account
get
Add sequence for the account
post
update sequence for the account
patch
delete sequence for the account.
delete
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 camera
get
Camera Video Stream Settings
Get the video settings of the camera
get
Update the video settings of the camera
patch
Reset the video stream settings of a camera back to defaults.
delete
Camera Footage Settings
Get the footage settings of the camera
get
Update the footage settings of the camera
patch
Get the footage capabilities of the camera
get
Camera Location
Get location of all the cameras in the account.
get
Get location of a specific camera.
get
Update location a specific camera.
patch
Camera Firmware
Get the firmware status for the given camera.
get
Start firmware upgrade for the given camera.
post
Get the list of firmware statuses for all cameras the user has access to.
get
Camera Snapshot
Get the snapshot of the camera.
get
Camera Microphone
Get microphoneEnable camera attribute.
get
Set microphoneEnabled camera attribute.
put
Get the camera microphoneEnable attributes for all cameras.
get
Camera PTZ
Sets a camera PTZ.
post
Subscription Rights
Get the subscription rights for this camera.
get
Get the subscriptions rights for all cameras
get
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
Get week-long camera reocording schedule
get
save week-long camera recording schedule
put
Get week-long mail notification schedule
get
save week-long mail notification schedule
put
Get week-long push notification schedule
get
save week-long push notification schedule
put
Video Summary
Triggers the generation of a video summary.
post
Retrieve video summary mp4 file by job id.
get
Camera Capabilities
Get the device capabilities
get
Get image modification capabilities
get
Get the system capabilities
get
Get the fine-grained ptz capabilities
get
Get the fine-grained Wi-Fi capabilities
get
Get the fine-grained Edge Storage capabilities
get
Get the fine-grained capabilities for device inputs and outputs
get
Get the fine-grained capabilities for a specific relay output of the camera
get
Get the fine-grained capabilities for a specific digital input of the camera
get
Edge Storage
Get edge storage info of the camera
get
Get edge storage recording configuration
get
Update edge storage recording configuration
patch
Format the edge storage location
post
Starts a recording sync job
post
Get edge recording status for specific storage location on a given camera.
get
Camera Wifi
Get the Wi-Fi connection status for the given camera.
get
Request a Wi-Fi status update such as enabling or disabling the functionality or requesting the camera to connect to a certain known network.
patch
Get a list of Wi-Fi networks currently visible to the camera.
get
Get a list of Wi-Fi networks saved to the camera.
get
Save the given network to the camera and for most cameras request the camera to connect to the given network.
post
Connect to an already saved network
put
Remove a network from the set of saved networks on the camera.
delete
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 zones
get
Language
Get a list of supported languages
get
Video Export
Triggers the generation of a video to be started
post
Retrieve generated video footage mov file by job id.
get
Schedule
Get week-long camera reocording schedule
get
save week-long camera recording schedule
put
Get week-long mail notification schedule
get
save week-long mail notification schedule
put
Get week-long push notification schedule
get
save week-long push notification schedule
put
Video Analytics
Get video analytics settings for the camera.
get
Update video analytics settings of the camera.
put
Add a new area for the camera
post
Update an area for the camera
put
Partially update an area for the camera
patch
Delete an area for the camera
delete
Device Type
Get the list of all supported device types.
get
Zone
Get the list of all zones the user has access to.
get
Creates a new zone.
post
Get info of a specific zone.
get
Partially updates info of a specific zone.
patch
Updates all the info of a specific zone.
put
Deletes a specific zone.
delete
Get cameras of a specific zone.
get
Move cameras into the zone.
patch
Updates the zone of a specific camera.
put
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 countries
get
SequenceV24
Get sequences for the account
get
Add sequence for the account
post
update sequence for the account
patch
delete sequence for the account.
delete
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
Get all events
get
Creates a new event.
post
Retrieve a specific event.
get
Update an event.
patch
Event Available Types
Retrieve available event types for an account.
get
Event Searchable Fields
Retrieve the searchable fields
get
Event Snapshot
Retrieve the snapshot associated to an event.
get
Faces
Get all faces
get
Create a face
post
Get a face
get
Update a face.
patch
Face Sample Images
Get a face sample image
get
Face Samples
Get all face samples
get
Upload a face sample
post
Get a face sample
get
Update a face sample
patch
Deletes a face sample
delete
Event Webhooks
Create a new webhook.
post
Get all event webhooks.
get
Get information of a specific webhook event.
get
Deletes a specific webhook.
delete
Users
User Notification Settings
Get user notification settings
get
Get user notification setting for a given notification type.
get
Update user notification setting for a given notification type.
patch
User Status
Get the status of the current user.
get
Updates the status of the current user.
patch
User Rights
Get permissions of the current user.
get
Get permissions of a specified user.
get
Update permissions of a specified user.
patch
User Password Reset
Request a password reset for a given email address.
post
User Base
Get a list of all users the user has access to.
get
Create a new user.
post
Get basic information about the current user.
get
Update basic information about the current user.
patch
Get basic information about a specific user.
get
Update basic information about a specific user.
patch
Delete a specific user.
delete
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
Adds a device.
post
Get the list of all devices the user has access to.
get
Get information of a single device.
get
Deletes a specific device.
delete
Updates parameters of a specific device.
patch
Device IO
Get the current settings for all the existing digital inputs in the given device
get
Get the current settings for the given digital input
get
Change the settings for the given digital input
patch
Get the status of the device input.
get
Get the status of all device inputs.
get
Set the status of the device output.
put
Get the status of the device output.
get
Get the status of all device outputs.
get
Get the current settings for the given relay output
get
Change the settings for the given relay output
patch
Get the current settings for all relay outputs of the device
get
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
Get the firmware status for the given device.
get
Start firmware upgrade for the given device.
post
Get the list of firmware statuses for all devices the user has access to.
get
Device Channel Camera
Adds a camera to a device channel.
post
Device Info
Get device info of a device
get
Device Maintenance
Device maintenance
put
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 device
get
Device Connection Details
Get the details needed to establish a connection
get
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
Get a list of accounts
get
Adds an account.
post
Retrieves a single account and details about the account owner
get
Updates an account and/or the account owner's information
patch
Moves account to reseller
put
Account Camera Slots
Retrieves camera slots for account
get
Account User
Get a list of users
get
Adds a user.
post
Retrieves a single user
get
Updates a user
patch
Delete a single user.
delete
Get the status of user credentials.
get
Updates a user credentials
patch
Get all users from all accounts of all resellers belonging to the logged in distributor
get
Get all users from all accounts belonging to the logged in reseller
get
Account Subscriptions
Get the list of subscriptions
get
Create a new subscription
post
Get a specific subscription
get
Delete a subscription
delete
Modify an existing subscription
patch
Camera Summary
Get all cameras for account
get
Get single camera summary for the account
get
Current User
Get base info about current user
get
Distributors
Get a list of distributors
get
Adds a Distributor.
post
Retrieves a single distributor
get
Updates one or more of the distributors core information
patch
Retrieves a single distributor's more in depth details
get
Partly updates a single distributor's details
patch
Retrieves counts of objects related the distributor
get
Helpdesk
Get JNLP file to open helpdesk
get
Mobile Helpdesk
Get URL for mobile client to open helpdesk
get
Profiles
Get profiles of an account
get
Adds a profile.
post
Get profile by ID
get
Updates a single profile
patch
Deletes a single profile
delete
Updates a set of permissions
patch
Resellers
Get a list of resellers
get
Adds a reseller.
post
Retrieves a single reseller
get
(Partly) updates a single reseller's core information
patch
Moves reseller to distributor
put
Retrieves a single reseller's more in depth details
get
(Partly) updates a single reseller's details
patch
Retrieves counts of objects related to the reseller
get
Reseller Subscription
Get available subscriptions
get
Token Generation
Generate token for a user by user ID
post
WebApp Helpdesk
Get URL for webapp client to open helpdesk
get
Powered by
Retrieve a specific event.
get
http://rest.cameramanager.com/rest/v2.4/events/
{eventId}
Language
Shell
Node
Ruby
PHP
Python
URL
Base URL
http://rest.cameramanager.com/rest/v2.4
/events/{eventId}
RESPONSE
Click
Try It!
to start a request and see the response here!
