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

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

Get info of a specific camera.

get http://rest.cameramanager.com/rest/v2.4/cameras/{cameraId}

Retrieves information of a specific camera.

URL Expired

The URL for this request expired after 30 days.

Path Params

cameraId

integer

required

ID of the camera.

Responses

Response body

object

cameraId

integer

required

Unique identifier for the camera.

name

string

required

length between 1 and 32

Name the user has given to this camera.

deviceTypeId

integer

ID of the device type

ethMacAddress

string

Mac-address of the device (Not to be confused with the wireless Mac-address).

zoneId

integer

required

ID of the zone where the camera is assigned.

accountId

integer

required

ID of the account where the camera is registered.

parentDeviceId

integer

ID of the parent device to which the camera is connected. The field is null when the camera is connected directly to cloud.

Response body

object

code

integer

required

Error code within the system.

title

string

required

This title is not meant to be shown to users and is not guaranteed to stay the same. Please use the code to parse the error.

detail

string

Error details, to help developers detect what went wrong.

Response body

object

error

string

required

A single ASCII error code conforming the pattern.

error_description

string

Human-readable ASCII text providing additional information, used to assist the client developer in understanding the error that occurred.

Response body

object

code

integer

required

Error code within the system.

title

string

required

This title is not meant to be shown to users and is not guaranteed to stay the same. Please use the code to parse the error.

detail

string

Error details, to help developers detect what went wrong.

Response body

object

code

integer

required

Error code within the system.

title

string

required

This title is not meant to be shown to users and is not guaranteed to stay the same. Please use the code to parse the error.

detail

string

Error details, to help developers detect what went wrong.

Response body

object

code

integer

required

Error code within the system.

title

string

required

This title is not meant to be shown to users and is not guaranteed to stay the same. Please use the code to parse the error.

detail

string

Error details, to help developers detect what went wrong.

Response body

object

code

integer

required

Error code within the system.

title

string

required

This title is not meant to be shown to users and is not guaranteed to stay the same. Please use the code to parse the error.

detail

string

Error details, to help developers detect what went wrong.

Updated about 2 years ago

Adds a camera.

Modify the details of a specific camera.

Did this page help you?

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url http://rest.cameramanager.com/rest/v2.4/cameras/cameraId \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated about 2 years ago

Adds a camera.

Modify the details of a specific camera.

Did this page help you?

Shared
Authentication
Deletes the token of the logged in user.delete
Create a new session for the authenticated userpost
Get authorization codepost
Get access tokenpost

Cameras
CameraSim
Set SIM card detailsput
Wait till camera is in given state.put
Get currently used SIM card.get
Camera Status
Get the status of all cameras.get
Get the status of the camera.get
Camera Mode
Get the camera mode for all camerasget
Get the camera mode per camera Idget
Update the camera modepatch
Cameras Recording
Get a single recording.get
Get the list of all recordings of the user.get
Get the list of all recordings of this camera.get
Sequence
delete sequence for the account.delete
update sequence for the accountpatch
Add sequence for the accountpost
Get sequences for the accountget
Camera
Deletes a specific camera.delete
Modify the details of a specific camera.patch
Get info of a specific camera.get
Adds a camera.post
Get the list of all cameras the user has access to.get
Camera Addition Status
Get the addition status of all cameras of the account.get
Wait for camera status to change to a terminal state (success or failure).get
Camera Streams
Get the streams of the camera.get
Camera Device Info
Get device info of cameraget
Camera Video Stream Settings
Reset the video stream settings of a camera back to defaults.delete
Update the video settings of the camerapatch
Get the video settings of the cameraget
Camera Footage Settings
Get the footage capabilities of the cameraget
Update the footage settings of the camerapatch
Get the footage settings of the cameraget
Camera Location
Update location a specific camera.patch
Get location of a specific camera.get
Get location of all the cameras in the account.get
Camera Firmware
Get the list of firmware statuses for all cameras the user has access to.get
Start firmware upgrade for the given camera.post
Get the firmware status for the given camera.get
Camera Snapshot
Get the snapshot of the camera.get
Camera Microphone
Get the camera microphoneEnable attributes for all cameras.get
Set microphoneEnabled camera attribute.put
Get microphoneEnable camera attribute.get
Camera PTZ
Sets a camera PTZ.post
Subscription Rights
Get the subscriptions rights for all camerasget
Get the subscription rights for this camera.get
Camera Jobs
Get the details of a single camera related job.get
Get the list of currently active or previously finished camera related jobs.get
Schedule
save week-long push notification scheduleput
Get week-long push notification scheduleget
save week-long mail notification scheduleput
Get week-long mail notification scheduleget
save week-long camera recording scheduleput
Get week-long camera reocording scheduleget
Video Summary
Retrieve video summary mp4 file by job id.get
Triggers the generation of a video summary.post
Camera Capabilities
Get the fine-grained capabilities for a specific digital input of the cameraget
Get the fine-grained capabilities for a specific relay output of the cameraget
Get the fine-grained capabilities for device inputs and outputsget
Get the fine-grained Edge Storage capabilitiesget
Get the fine-grained Wi-Fi capabilitiesget
Get the fine-grained ptz capabilitiesget
Get the system capabilitiesget
Get image modification capabilitiesget
Get the device capabilitiesget
Edge Storage
Get edge recording status for specific storage location on a given camera.get
Starts a recording sync jobpost
Format the edge storage locationpost
Update edge storage recording configurationpatch
Get edge storage recording configurationget
Get edge storage info of the cameraget
Camera Wifi
Remove a network from the set of saved networks on the camera.delete
Connect to an already saved networkput
Save the given network to the camera and for most cameras request the camera to connect to the given network.post
Get a list of Wi-Fi networks saved to the camera.get
Get a list of Wi-Fi networks currently visible to the 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 the Wi-Fi connection status for the given camera.get

GeneRic API
Account Timezone
Update the account timezone of the requesting user.patch
Get account timezone of the user.get
Time Zone
Get list of supported time zonesget
Language
Get a list of supported languagesget
Video Export
Retrieve generated video footage mov file by job id.get
Triggers the generation of a video to be startedpost
Schedule
save week-long push notification scheduleput
Get week-long push notification scheduleget
save week-long mail notification scheduleput
Get week-long mail notification scheduleget
save week-long camera recording scheduleput
Get week-long camera reocording scheduleget
Video Analytics
Delete an area for the cameradelete
Partially update an area for the camerapatch
Update an area for the cameraput
Add a new area for the camerapost
Update video analytics settings of the camera.put
Get video analytics settings for the camera.get
Device Type
Get the list of all supported device types.get
Zone
Updates the zone of a specific camera.put
Move cameras into the zone.patch
Get cameras of a specific zone.get
Deletes a specific zone.delete
Updates all the info of a specific zone.put
Partially updates info of a specific zone.patch
Get info of a specific zone.get
Creates a new zone.post
Get the list of all zones the user has access to.get
GPS
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
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
Country
Get a list of supported countriesget
SequenceV24
delete sequence for the account.delete
update sequence for the accountpatch
Add sequence for the accountpost
Get sequences for the accountget
Detections
Video Motion Detection
Set video motion detection enabled camera attribute.put
Get video detection enabled camera attribute.get
PIR Detection
Set PIR detection enabled camera attribute.put
Get PIR detection enabled camera attribute.get
Audio Detection
Set audio detection enabled camera attribute.put
Get audio detection enabled camera attribute.get
Doorbell
Set doorbell detection enabled camera attribute.put
Get doorbell detection enabled camera attribute.get
Camera Detection Capabilities
Get whether the different detection capabilities of a camera are available.get

Events
Event Search
Searches for events.post
Event
Update an event.patch
Retrieve a specific event.get
Creates a new event.post
Get all eventsget
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
Update a face.patch
Get a faceget
Create a facepost
Get all facesget
Face Sample Images
Get a face sample imageget
Face Samples
Deletes a face sampledelete
Update a face samplepatch
Get a face sampleget
Upload a face samplepost
Get all face samplesget
Event Webhooks
Deletes a specific webhook.delete
Get information of a specific webhook event.get
Get all event webhooks.get
Create a new webhook.post

Users
User Notification Settings
Update user notification setting for a given notification type.patch
Get user notification setting for a given notification type.get
Get user notification settingsget
User Status
Updates the status of the current user.patch
Get the status of the current user.get
User Rights
Update permissions of a specified user.patch
Get permissions of a specified user.get
Get permissions of the current user.get
User Password Reset
Request a password reset for a given email address.post
User Base
Delete a specific user.delete
Update basic information about a specific user.patch
Get basic information about a specific user.get
Update basic information about the current user.patch
Get basic information about the current user.get
Create a new user.post
Get a list of all users the user has access to.get
User Details
Updates details information about the user.patch
Get details information about the user.get
User Credentials
Updates credentials for the user.patch
Get the status of user credentials.get
UserMfa
Updates the multi-factor authentication settings for the current user.patch
Get the multi-factor authentication settings for the current user.get

Devices
Device IO
Get the current settings for all relay outputs of the deviceget
Change the settings for the given relay outputpatch
Get the current settings for the given relay outputget
Get the status of all device outputs.get
Get the status of the device output.get
Set the status of the device output.put
Get the status of all device inputs.get
Get the status of the device input.get
Change the settings for the given digital inputpatch
Get the current settings for the given digital inputget
Get the current settings for all the existing digital inputs in the given deviceget
Device Channel Snapshot
Get the snapshot of the channel of the given device the user has access to.get
Add Device Status
Get the addition status of all devices of the account.get
Wait for device status to change to a terminal state (success or failure).get
Device Firmware
Get the list of firmware statuses for all devices the user has access to.get
Start firmware upgrade for the given device.post
Get the firmware status for the given device.get
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 details of a single device related job.get
Get the list of currently active or previously finished device related jobs.get
Device Channel
Get one of the channels of the given device the user has access to.get
Get the list of all channels of the given device the user has access to.get
Device Status
Retrieves the status of a specific deviceget
Device Connection Details
Update the device connection details and optionally run connection test.patch
Get the details needed to establish a connectionget
Device Connection Credentials
Update the device connection credentials in the backend.patch
Get the credentials needed to establish a connection with a device.get
DeviceType Credentials
Get the default credentials of the device, given the device's type ID.get

dEALER dASHBOARD
Account
Moves account to resellerput
Updates an account and/or the account owner's informationpatch
Retrieves a single account and details about the account ownerget
Adds an account.post
Get a list of accountsget
Account Camera Slots
Retrieves camera slots for accountget
Account User
Get all users from all accounts belonging to the logged in resellerget
Get all users from all accounts of all resellers belonging to the logged in distributorget
Updates a user credentialspatch
Get the status of user credentials.get
Delete a single user.delete
Updates a userpatch
Retrieves a single userget
Adds a user.post
Get a list of usersget
Account Subscriptions
Modify an existing subscriptionpatch
Delete a subscriptiondelete
Get a specific subscriptionget
Create a new subscriptionpost
Get the list of subscriptionsget
Camera Summary
Get single camera summary for the accountget
Get all cameras for accountget
Current User
Get base info about current userget
Distributors
Retrieves counts of objects related the distributorget
Partly updates a single distributor's detailspatch
Retrieves a single distributor's more in depth detailsget
Updates one or more of the distributors core informationpatch
Retrieves a single distributorget
Adds a Distributor.post
Get a list of distributorsget
Helpdesk
Get JNLP file to open helpdeskget
Mobile Helpdesk
Get URL for mobile client to open helpdeskget
Profiles
Updates a set of permissionspatch
Deletes a single profiledelete
Updates a single profilepatch
Get profile by IDget
Adds a profile.post
Get profiles of an accountget
Resellers
Retrieves counts of objects related to the resellerget
(Partly) updates a single reseller's detailspatch
Retrieves a single reseller's more in depth detailsget
Moves reseller to distributorput
(Partly) updates a single reseller's core informationpatch
Retrieves a single resellerget
Adds a reseller.post
Get a list of resellersget
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

Shared
Authentication
Deletes the token of the logged in user.delete
Create a new session for the authenticated userpost
Get authorization codepost
Get access tokenpost

Cameras
CameraSim
Set SIM card detailsput
Wait till camera is in given state.put
Get currently used SIM card.get
Camera Status
Get the status of all cameras.get
Get the status of the camera.get
Camera Mode
Get the camera mode for all camerasget
Get the camera mode per camera Idget
Update the camera modepatch
Cameras Recording
Get a single recording.get
Get the list of all recordings of the user.get
Get the list of all recordings of this camera.get
Sequence
delete sequence for the account.delete
update sequence for the accountpatch
Add sequence for the accountpost
Get sequences for the accountget
Camera
Deletes a specific camera.delete
Modify the details of a specific camera.patch
Get info of a specific camera.get
Adds a camera.post
Get the list of all cameras the user has access to.get
Camera Addition Status
Get the addition status of all cameras of the account.get
Wait for camera status to change to a terminal state (success or failure).get
Camera Streams
Get the streams of the camera.get
Camera Device Info
Get device info of cameraget
Camera Video Stream Settings
Reset the video stream settings of a camera back to defaults.delete
Update the video settings of the camerapatch
Get the video settings of the cameraget
Camera Footage Settings
Get the footage capabilities of the cameraget
Update the footage settings of the camerapatch
Get the footage settings of the cameraget
Camera Location
Update location a specific camera.patch
Get location of a specific camera.get
Get location of all the cameras in the account.get
Camera Firmware
Get the list of firmware statuses for all cameras the user has access to.get
Start firmware upgrade for the given camera.post
Get the firmware status for the given camera.get
Camera Snapshot
Get the snapshot of the camera.get
Camera Microphone
Get the camera microphoneEnable attributes for all cameras.get
Set microphoneEnabled camera attribute.put
Get microphoneEnable camera attribute.get
Camera PTZ
Sets a camera PTZ.post
Subscription Rights
Get the subscriptions rights for all camerasget
Get the subscription rights for this camera.get
Camera Jobs
Get the details of a single camera related job.get
Get the list of currently active or previously finished camera related jobs.get
Schedule
save week-long push notification scheduleput
Get week-long push notification scheduleget
save week-long mail notification scheduleput
Get week-long mail notification scheduleget
save week-long camera recording scheduleput
Get week-long camera reocording scheduleget
Video Summary
Retrieve video summary mp4 file by job id.get
Triggers the generation of a video summary.post
Camera Capabilities
Get the fine-grained capabilities for a specific digital input of the cameraget
Get the fine-grained capabilities for a specific relay output of the cameraget
Get the fine-grained capabilities for device inputs and outputsget
Get the fine-grained Edge Storage capabilitiesget
Get the fine-grained Wi-Fi capabilitiesget
Get the fine-grained ptz capabilitiesget
Get the system capabilitiesget
Get image modification capabilitiesget
Get the device capabilitiesget
Edge Storage
Get edge recording status for specific storage location on a given camera.get
Starts a recording sync jobpost
Format the edge storage locationpost
Update edge storage recording configurationpatch
Get edge storage recording configurationget
Get edge storage info of the cameraget
Camera Wifi
Remove a network from the set of saved networks on the camera.delete
Connect to an already saved networkput
Save the given network to the camera and for most cameras request the camera to connect to the given network.post
Get a list of Wi-Fi networks saved to the camera.get
Get a list of Wi-Fi networks currently visible to the 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 the Wi-Fi connection status for the given camera.get

GeneRic API
Account Timezone
Update the account timezone of the requesting user.patch
Get account timezone of the user.get
Time Zone
Get list of supported time zonesget
Language
Get a list of supported languagesget
Video Export
Retrieve generated video footage mov file by job id.get
Triggers the generation of a video to be startedpost
Schedule
save week-long push notification scheduleput
Get week-long push notification scheduleget
save week-long mail notification scheduleput
Get week-long mail notification scheduleget
save week-long camera recording scheduleput
Get week-long camera reocording scheduleget
Video Analytics
Delete an area for the cameradelete
Partially update an area for the camerapatch
Update an area for the cameraput
Add a new area for the camerapost
Update video analytics settings of the camera.put
Get video analytics settings for the camera.get
Device Type
Get the list of all supported device types.get
Zone
Updates the zone of a specific camera.put
Move cameras into the zone.patch
Get cameras of a specific zone.get
Deletes a specific zone.delete
Updates all the info of a specific zone.put
Partially updates info of a specific zone.patch
Get info of a specific zone.get
Creates a new zone.post
Get the list of all zones the user has access to.get
GPS
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
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
Country
Get a list of supported countriesget
SequenceV24
delete sequence for the account.delete
update sequence for the accountpatch
Add sequence for the accountpost
Get sequences for the accountget
Detections
Video Motion Detection
Set video motion detection enabled camera attribute.put
Get video detection enabled camera attribute.get
PIR Detection
Set PIR detection enabled camera attribute.put
Get PIR detection enabled camera attribute.get
Audio Detection
Set audio detection enabled camera attribute.put
Get audio detection enabled camera attribute.get
Doorbell
Set doorbell detection enabled camera attribute.put
Get doorbell detection enabled camera attribute.get
Camera Detection Capabilities
Get whether the different detection capabilities of a camera are available.get

Events
Event Search
Searches for events.post
Event
Update an event.patch
Retrieve a specific event.get
Creates a new event.post
Get all eventsget
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
Update a face.patch
Get a faceget
Create a facepost
Get all facesget
Face Sample Images
Get a face sample imageget
Face Samples
Deletes a face sampledelete
Update a face samplepatch
Get a face sampleget
Upload a face samplepost
Get all face samplesget
Event Webhooks
Deletes a specific webhook.delete
Get information of a specific webhook event.get
Get all event webhooks.get
Create a new webhook.post

Users
User Notification Settings
Update user notification setting for a given notification type.patch
Get user notification setting for a given notification type.get
Get user notification settingsget
User Status
Updates the status of the current user.patch
Get the status of the current user.get
User Rights
Update permissions of a specified user.patch
Get permissions of a specified user.get
Get permissions of the current user.get
User Password Reset
Request a password reset for a given email address.post
User Base
Delete a specific user.delete
Update basic information about a specific user.patch
Get basic information about a specific user.get
Update basic information about the current user.patch
Get basic information about the current user.get
Create a new user.post
Get a list of all users the user has access to.get
User Details
Updates details information about the user.patch
Get details information about the user.get
User Credentials
Updates credentials for the user.patch
Get the status of user credentials.get
UserMfa
Updates the multi-factor authentication settings for the current user.patch
Get the multi-factor authentication settings for the current user.get

Devices
Device IO
Get the current settings for all relay outputs of the deviceget
Change the settings for the given relay outputpatch
Get the current settings for the given relay outputget
Get the status of all device outputs.get
Get the status of the device output.get
Set the status of the device output.put
Get the status of all device inputs.get
Get the status of the device input.get
Change the settings for the given digital inputpatch
Get the current settings for the given digital inputget
Get the current settings for all the existing digital inputs in the given deviceget
Device Channel Snapshot
Get the snapshot of the channel of the given device the user has access to.get
Add Device Status
Get the addition status of all devices of the account.get
Wait for device status to change to a terminal state (success or failure).get
Device Firmware
Get the list of firmware statuses for all devices the user has access to.get
Start firmware upgrade for the given device.post
Get the firmware status for the given device.get
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 details of a single device related job.get
Get the list of currently active or previously finished device related jobs.get
Device Channel
Get one of the channels of the given device the user has access to.get
Get the list of all channels of the given device the user has access to.get
Device Status
Retrieves the status of a specific deviceget
Device Connection Details
Update the device connection details and optionally run connection test.patch
Get the details needed to establish a connectionget
Device Connection Credentials
Update the device connection credentials in the backend.patch
Get the credentials needed to establish a connection with a device.get
DeviceType Credentials
Get the default credentials of the device, given the device's type ID.get

dEALER dASHBOARD
Account
Moves account to resellerput
Updates an account and/or the account owner's informationpatch
Retrieves a single account and details about the account ownerget
Adds an account.post
Get a list of accountsget
Account Camera Slots
Retrieves camera slots for accountget
Account User
Get all users from all accounts belonging to the logged in resellerget
Get all users from all accounts of all resellers belonging to the logged in distributorget
Updates a user credentialspatch
Get the status of user credentials.get
Delete a single user.delete
Updates a userpatch
Retrieves a single userget
Adds a user.post
Get a list of usersget
Account Subscriptions
Modify an existing subscriptionpatch
Delete a subscriptiondelete
Get a specific subscriptionget
Create a new subscriptionpost
Get the list of subscriptionsget
Camera Summary
Get single camera summary for the accountget
Get all cameras for accountget
Current User
Get base info about current userget
Distributors
Retrieves counts of objects related the distributorget
Partly updates a single distributor's detailspatch
Retrieves a single distributor's more in depth detailsget
Updates one or more of the distributors core informationpatch
Retrieves a single distributorget
Adds a Distributor.post
Get a list of distributorsget
Helpdesk
Get JNLP file to open helpdeskget
Mobile Helpdesk
Get URL for mobile client to open helpdeskget
Profiles
Updates a set of permissionspatch
Deletes a single profiledelete
Updates a single profilepatch
Get profile by IDget
Adds a profile.post
Get profiles of an accountget
Resellers
Retrieves counts of objects related to the resellerget
(Partly) updates a single reseller's detailspatch
Retrieves a single reseller's more in depth detailsget
Moves reseller to distributorput
(Partly) updates a single reseller's core informationpatch
Retrieves a single resellerget
Adds a reseller.post
Get a list of resellersget
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

200OK

400The supplied object is invalid. Error detail will contain the validation error.

401You are not authenticated. Please authenticate and try again.

403You have no permission to access the specified resource.

404Referenced resource could not be found.

406The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request.

500Something went wrong in the server. Please try again.