# Eagle Eye Video API Platform Documentation ## Guides - [Logging in](https://developer.eagleeyenetworks.com/docs/login-confidential-client.md) - [Logging out](https://developer.eagleeyenetworks.com/docs/logout.md): Logout via OAuth - [Reseller account switching](https://developer.eagleeyenetworks.com/docs/reseller-account-switching.md) - [Single Sign On (SSO) Management](https://developer.eagleeyenetworks.com/docs/single-sign-on-sso-management.md) - [Automations](https://developer.eagleeyenetworks.com/docs/automations.md) - [Speakers](https://developer.eagleeyenetworks.com/docs/speakers.md): Managing speakers in an account - [Accounts and Authentication](https://developer.eagleeyenetworks.com/docs/auth.md): Authentication, Accounts, and User Management - [Devices](https://developer.eagleeyenetworks.com/docs/devices.md): Managing bridges, cameras, switches, and more - [Events and Analytics](https://developer.eagleeyenetworks.com/docs/events-and-analytics.md): Vehicle Surveillance, License Plate Recognition, and Point of Sale Events - [Google Integration](https://developer.eagleeyenetworks.com/docs/google-integration.md): Connect with Google Docs to export data - [Introduction](https://developer.eagleeyenetworks.com/docs/introduction.md) - [Recorded Media](https://developer.eagleeyenetworks.com/docs/recorded-media.md): Video archives and recordings - [Data Schemas](https://developer.eagleeyenetworks.com/docs/data-schemas.md) - [Event Types](https://developer.eagleeyenetworks.com/docs/event-type.md) - [Event Insertion](https://developer.eagleeyenetworks.com/docs/event-insertion.md) - [Event Subscriptions](https://developer.eagleeyenetworks.com/docs/event-subscriptions.md) - [Events, Alerts, and Notifications](https://developer.eagleeyenetworks.com/docs/events-alerts-notifications-introduction.md) - [Applications](https://developer.eagleeyenetworks.com/docs/applications.md) - [Client Credentials](https://developer.eagleeyenetworks.com/docs/client-credentials.md) - [Developer Accounts](https://developer.eagleeyenetworks.com/docs/developer-accounts.md): Managing your developer account. - [FAQ](https://developer.eagleeyenetworks.com/docs/faq.md) - [Getting started](https://developer.eagleeyenetworks.com/docs/getting-started.md) - [Glossary](https://developer.eagleeyenetworks.com/docs/glossary.md) - [Legacy APIs](https://developer.eagleeyenetworks.com/docs/legacy-apis.md) - [Archiving a Video](https://developer.eagleeyenetworks.com/docs/archiving-video.md) - [Archiving and Downloads](https://developer.eagleeyenetworks.com/docs/archiving-and-downloads.md) - [Managing Archives](https://developer.eagleeyenetworks.com/docs/managing-archives.md) - [Transferring Archived Files](https://developer.eagleeyenetworks.com/docs/transferring-archived-files.md) - [Deep Linking](https://developer.eagleeyenetworks.com/docs/deep-linking.md) - [iFrames](https://developer.eagleeyenetworks.com/docs/iframes.md) - [Deep Linking and iFrames](https://developer.eagleeyenetworks.com/docs/deep-linking-and-iframes.md) - [Overview](https://developer.eagleeyenetworks.com/docs/overview.md) - [Viewing Recorded Video and Audio](https://developer.eagleeyenetworks.com/docs/recorded-video.md) - [Streaming Live Video and Audio](https://developer.eagleeyenetworks.com/docs/streaming-live-video-and-audio.md) - [Playing LocalRTSP](https://developer.eagleeyenetworks.com/docs/playing-localrtsp.md) - [RTSP video](https://developer.eagleeyenetworks.com/docs/rtsp-video.md) - [Testing with FFmpeg](https://developer.eagleeyenetworks.com/docs/testing-ffmpeg.md) - [Live Video on Web](https://developer.eagleeyenetworks.com/docs/watch-live-video.md) - [Video SDK for Android](https://developer.eagleeyenetworks.com/docs/een-video-android-sdk.md) - [Live Video SDK for Web](https://developer.eagleeyenetworks.com/docs/live-video-web-sdk.md) - [2-Way Audio (No SDK)](https://developer.eagleeyenetworks.com/docs/implementing-talk-down-without-sdk.md) - [2-Way Audio SDK for Android](https://developer.eagleeyenetworks.com/docs/talkdown-sdk-for-android.md) - [2-Way Audio SDK for Web](https://developer.eagleeyenetworks.com/docs/two-way-audio-web-sdk.md) - [User Roles](https://developer.eagleeyenetworks.com/docs/user-roles.md) - [Vehicle Surveillance Package](https://developer.eagleeyenetworks.com/docs/vehicle-surveillance-package.md) - [VSP Events](https://developer.eagleeyenetworks.com/docs/vsp-events.md) - [VSP Rules & Configuration](https://developer.eagleeyenetworks.com/docs/vsp-rules-configuration.md) - [Video Search](https://developer.eagleeyenetworks.com/docs/video-search.md) ## API Reference - [/clientSettings](https://developer.eagleeyenetworks.com/reference/getclientsettings.md): Retrieves settings required to let the client successfully use the API. - [/accounts/self/ssoAuthSettings](https://developer.eagleeyenetworks.com/reference/getauthsettings.md): Returns Single Sign On Authentication Settings for the given account. - [/accounts/self/ssoAuthSettings](https://developer.eagleeyenetworks.com/reference/updateauthsettings.md): Updates Single Sign On Authentication Settings with the given values. - [/alertActionRules](https://developer.eagleeyenetworks.com/reference/addalertactionrule.md): Registers a new alert action rule with the account. These rules allow users to link alert action rules to alert condition rule. - [/alertActionRules/{actionRuleId}](https://developer.eagleeyenetworks.com/reference/deletealertactionrule.md): Removes alert action rule. - [/alertActionRules/{actionRuleId}](https://developer.eagleeyenetworks.com/reference/getalertactionrule.md): Retrieve a single alert action rule. - [/alertActionRules](https://developer.eagleeyenetworks.com/reference/listalertactionrules.md): List the configured action rules. - [/alertActionRules/{actionRuleId}](https://developer.eagleeyenetworks.com/reference/updatealertactionrule.md): Update single alert action rule. - [/alertActions](https://developer.eagleeyenetworks.com/reference/addalertaction.md): Registers a new alert action with the account. These alert actions can be used as responses to alerts generated by alert action rules. - [/alertActions/{actionId}](https://developer.eagleeyenetworks.com/reference/deletealertaction.md): Removes alert action. - [/alertActions/{actionId}](https://developer.eagleeyenetworks.com/reference/getalertaction.md): Retrieve a single alert action. - [/alertActions](https://developer.eagleeyenetworks.com/reference/listalertactions.md): List the configured alert actions. - [/alertActions/{actionId}](https://developer.eagleeyenetworks.com/reference/updatealertaction.md): Update single alert action. This is a partial update operation - all fields in the request body are optional, allowing you to update only the specific fields you want to change. Fields marked as required in the schema apply only to POST (create) operations. - [/eventAlertConditionRules](https://developer.eagleeyenetworks.com/reference/addeventalertconditionrule.md): Create a new rule that produces alerts based on certain conditions. Specifically, the user specifies alert conditions that indicate when the alert is produced based on following: * Which resources can produce the alert * What is the schedule for the alert. * What event types can produce the alert. - [/eventAlertConditionRules/{id}](https://developer.eagleeyenetworks.com/reference/deleteeventalertconditionrule.md): Deletes the rule corresponding to the rule ID - [/eventAlertConditionRules/{id}](https://developer.eagleeyenetworks.com/reference/geteventalertconditionrule.md): Get details of a specific rule by id - [/eventAlertConditionRules:listFieldValues](https://developer.eagleeyenetworks.com/reference/geteventalertconditionrulesfieldvalues.md): Fetches the list of field values across all the attributes of alertConditionRules stored for this account. These values can be used to filter the results of the [GET `/eventAlertConditionRules`](ref:listeventalertconditionrules) endpoint. - [/eventAlertConditionRules](https://developer.eagleeyenetworks.com/reference/listeventalertconditionrules.md): List the configured event alert condition rules in the account. Parameters can be used to filter the rules based on the actor, name, and enabled status. A list of the availible field values for each field can be fetched using the [`listFieldValues`](ref:geteventalertconditionrulesfieldvalues) endpoint. - [/eventAlertConditionRules/{id}](https://developer.eagleeyenetworks.com/reference/updateeventalertconditionrule.md): Updates the properties of a specific rule. Only the user defined fields can be updated by this method. - [/contracts/{id}](https://developer.eagleeyenetworks.com/reference/getcontractvaultrecord.md): Retrieves a contract record by its ID. - [/contracts](https://developer.eagleeyenetworks.com/reference/listcontractvaultrecords.md): Retrieves contract vault records based on provided criteria. - [/availableDevices](https://developer.eagleeyenetworks.com/reference/listavailabledevices.md): This endpoint returns a list of all devices found by the bridges in the account that have not yet been added. Devices of a certain type will not be reported in the response if the user does not have permission to add them. Since adding specific device types requires calling a device-type-specific API, it is recommended to filter on the devices supported by the cameras, rather than retrieving "all" types. It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available devices, not the number of devices resulting from the query string. - [/bridges](https://developer.eagleeyenetworks.com/reference/createbridge.md): Create the bridge for the account with given connect id - [/bridges/{bridgeId}](https://developer.eagleeyenetworks.com/reference/deletebridge.md): Removes the given bridge from the account, resetting it in the process and removing all cameras that were connected to it. - [/bridges/{bridgeId}](https://developer.eagleeyenetworks.com/reference/getbridge.md): Retrieves the given bridge. - [/bridges/{bridgeId}/metrics](https://developer.eagleeyenetworks.com/reference/getbridgemetrics.md): Returns metrics data. - [/bridges/{id}/settings/](https://developer.eagleeyenetworks.com/reference/getbridgesettings.md): Get all the configurable operational settings related to a bridge - [/bridges](https://developer.eagleeyenetworks.com/reference/listbridges.md): A list of bridges can be retrieved using this endpoint. It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available bridges, not the number of bridges resulting from the query string. - [/bridges/{bridgeId}:swap](https://developer.eagleeyenetworks.com/reference/swapbridge.md): Swap bridge with a new one. The original bridge must be offline and disconnected, if not API is going to throw 400 error. If the GUID is not added to the account or GUID has already been attached to another account API is going to throw 404 error. If the provided GUID is in wrong format, API is going to throw 400 error. - [/bridges/{bridgeId}](https://developer.eagleeyenetworks.com/reference/updatebridge.md): Update the bridge for the account with given bridge id - [/bridges/{id}/settings/](https://developer.eagleeyenetworks.com/reference/updatebridgesettings.md): Updates the settings of a bridge. - [/bridges:bulkUpdate](https://developer.eagleeyenetworks.com/reference/updatebulkbridges.md): This endpoints updates multiple bridges with provided updateField. - [/bridges/{bridgeId}/actions](https://developer.eagleeyenetworks.com/reference/updateport1.md): This endpoint is used to perform actions on a bridge. Currently, the only action available is rebooting the bridge. - [/cameras](https://developer.eagleeyenetworks.com/reference/addcamera.md): Associates a camera with the account. This can only be called with an end-user account, and will result in an error if tried with any other type of account. - [/cameras/{cameraId}](https://developer.eagleeyenetworks.com/reference/deletecamera.md): This endpoint disassociates the camera from the account, removing all references, recordings, and events, and in some cases resetting the camera to factory default settings. This request will be blocked until the camera has been fully removed. - [/cameras/{cameraId}/tunnel](https://developer.eagleeyenetworks.com/reference/deletecameratunnel.md): Deletes a camera tunnel. - [/cameras/{cameraId}](https://developer.eagleeyenetworks.com/reference/getcamera.md): Retrieves the given camera. - [/cameras/{cameraId}/metrics](https://developer.eagleeyenetworks.com/reference/getcamerametrics.md): Returns metrics data. - [/cameras/{cameraId}/settings](https://developer.eagleeyenetworks.com/reference/getcamerasettings.md): Retrieves the current settings for the given camera. Since cameras, the bridge they are connected to and the accounts they are part of can have different capabilities, not all settings given in this specification will be applicable to all cameras. If a setting is applicable, it will be returned by the API, if not, the field(s) will be skipped. - [/cameras/{cameraId}/io/ports/{portId}](https://developer.eagleeyenetworks.com/reference/getport.md): Retrieves the device port. - [/cameras/{cameraId}/io/ports](https://developer.eagleeyenetworks.com/reference/getports.md): Retrieves list of device IO ports. - [/cameras](https://developer.eagleeyenetworks.com/reference/listcameras.md): This endpoint allows you to retrieve a list of cameras associated with the account, with the ability to filter by account ID, location ID, bridge ID, multi-camera ID, and tags. It also supports pagination and the ability to include additional information about cameras. It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available cameras, not the number of cameras resulting from the query string. - [/cameras/{cameraId}/tunnel](https://developer.eagleeyenetworks.com/reference/putcameratunnel.md): Opens a camera tunnel. As this API is intended for incidental access to the cameras UI, it should not be used for general API integration. - [/cameras/{cameraId}:swap](https://developer.eagleeyenetworks.com/reference/swapcamera.md): Swap any camera with a new one. If the device is not visible by the bridge, API is going to throw a 404 error. If the GUID has already been attached to the account, API is going to throw a 409 error. If the provided GUID is in wrong format, API is going to throw 400 error. - [/cameras:bulkUpdate](https://developer.eagleeyenetworks.com/reference/updatebulkcameras.md): This endpoint allows the developer to update multiple cameras at once by providing update fields. - [/cameras/{cameraId}](https://developer.eagleeyenetworks.com/reference/updatecamera.md): This endpoint allows the developers to update a specific camera by providing update fields. - [/cameras/{cameraId}/settings](https://developer.eagleeyenetworks.com/reference/updatecamerasettings.md): Updates the settings of a camera. It will throw an error if the setting in the payload is not supported by a camera type. It won't apply any settings in case of error. - [/cameras/{cameraId}/io/ports/{portId}](https://developer.eagleeyenetworks.com/reference/updateport.md): Update the port configuration. Allowed properties depends on the port type. - [/devices/{deviceId}/io/ports/{portId}](https://developer.eagleeyenetworks.com/reference/getport1.md): Retrieves the device port. - [/devices/{deviceId}/io/ports/{portId}/recordingActions/{cameraId}](https://developer.eagleeyenetworks.com/reference/getportrecorder.md): Retrieves the recording action information for the camera and IO Port - [/devices/{deviceId}/io/ports/{portId}/recordingActions](https://developer.eagleeyenetworks.com/reference/getportrecorders.md): Retrieves the list of all cameras that can be activated to record video, including those that are currently enabled for recording actions on this port. - [/devices/{deviceId}/io/ports](https://developer.eagleeyenetworks.com/reference/getports1.md): Retrieves list of device IO ports. - [/devices/{deviceId}/io/ports/{portId}](https://developer.eagleeyenetworks.com/reference/updateport2.md): Update the port configuration. Allowed properties depends on the port type. - [/devices/{deviceId}/io/ports/{portId}/recordingActions/{cameraId}](https://developer.eagleeyenetworks.com/reference/updateportrecorder.md): Update the recording action configuration for the given camera and port. - [/multiCameras](https://developer.eagleeyenetworks.com/reference/addmulticamera.md): This endpoint allows a multi camera to be associated with an account. It can only be called with an end-user account and will fail if called with another type of account. - [/multiCameras/{multiCameraId}](https://developer.eagleeyenetworks.com/reference/deletemulticamera.md): This endpoint allows you to dis-associate a multi camera from the account, removing all references, recordings, and events. This request will be blocked until the multi camera has been fully removed. - [/multiCameras/{multiCameraId}](https://developer.eagleeyenetworks.com/reference/getmulticamera.md): This endpoint allows you to retrieve information about a multi camera based on its ID. - [/multiCameras/{multiCameraId}/channels](https://developer.eagleeyenetworks.com/reference/getmulticamerachannels.md): This endpoint allows you to retrieve the channel info of a multi camera. This information can be used to add a camera connected to the channel to the account using the /cameras endpoint. The channel details are read-only. To manipulate a new camera use the /cameras endpoint. If the cameraId is not empty then it means that the camera is already added to the account. It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available channels, not the number of channels resulting from the query string. - [/multiCameras](https://developer.eagleeyenetworks.com/reference/listmulticameras.md): This endpoint allows you to retrieve a list of multi cameras for a given account and location. Multi cameras are devices such as DVRs that have multiple cameras connected. It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available multi cameras, not the number of multi cameras resulting from the query string. - [/multiCameras/{multiCameraId}](https://developer.eagleeyenetworks.com/reference/updatemulticamera.md): This endpoint allows you to update a multi camera's data based on its ID. - [/cameras/{cameraId}/ptz/position](https://developer.eagleeyenetworks.com/reference/getcurrentposition.md): This endpoint returns the current position of the camera. The response includes the pan, tilt, and zoom values of the camera. If the camera does not support pan or tilt or zoom, the corresponding value will not be present in the response. - [/cameras/{cameraId}/ptz/settings](https://developer.eagleeyenetworks.com/reference/getptzsettings.md): Retrieves the PTZ settings for the given camera. - [/cameras/{cameraId}/ptz/position](https://developer.eagleeyenetworks.com/reference/moveto.md): This endpoint moves the camera to a specific position, in a specific direction, or to a specific center point on the screen. The endpoint accepts a move object that can be either a position move, a direction move or a center move. - [/cameras/{cameraId}/ptz/settings](https://developer.eagleeyenetworks.com/reference/updateptzsettings.md): Updates the PTZ settings for the given camera. - [/speakers](https://developer.eagleeyenetworks.com/reference/addspeaker.md): By using this endpoint you can create a speaker. - [/speakers/{speakerId}](https://developer.eagleeyenetworks.com/reference/deletespeaker.md): This endpoint allows you to dis-associate a speaker from the account, removing all references, recordings, and events. This request will be blocked until the speaker has been fully removed. - [/speakers/{speakerId}](https://developer.eagleeyenetworks.com/reference/getspeaker.md): This endpoint allows you to retrieve a specific speaker. - [/speakers/{speakerId}/settings](https://developer.eagleeyenetworks.com/reference/getspeakersettings.md): Retrieves the current settings for the given speaker. - [/speakers](https://developer.eagleeyenetworks.com/reference/listspeakers.md): Retrieving a list of speakers is possible with this endpoint. It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available speakers, not the number of speakers resulting from the query string. - [/speakers/{speakerId}](https://developer.eagleeyenetworks.com/reference/updatespeaker.md): This endpoint allows you to update a specific speaker. - [/speakers/{speakerId}/settings](https://developer.eagleeyenetworks.com/reference/updatespeakersettings.md): Updates the settings of a speaker. - [/switches/{switchId}](https://developer.eagleeyenetworks.com/reference/getswitch.md): This endpoint allows users to retrieve a specific switch based on its id. - [/switches](https://developer.eagleeyenetworks.com/reference/listswitches.md): This endpoint allows users to retrieve a paginated list of switches within a given account. It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available switches, not the number of switches resulting from the query string. - [/switches/{switchId}/actions](https://developer.eagleeyenetworks.com/reference/switchaction.md): Switch action endpoint. This endpoint allows users to perform actions on a specific switch. Currently only reboot is supported. - [/switches/{switchId}/ports/all/actions](https://developer.eagleeyenetworks.com/reference/updateallports.md): All ports can be turned On, Off or power cycled with this endpoint. - [/switches/{switchId}/ports/{portId}/actions](https://developer.eagleeyenetworks.com/reference/updateport3.md): A specific port can be turned On/Off with this endpoint. A port can also be power cycled. - [/switches/{switchId}](https://developer.eagleeyenetworks.com/reference/updateswitch.md): This endpoint allows users to update a given switch. - [/alerts/{id}](https://developer.eagleeyenetworks.com/reference/getalert.md): Get an alert - [/alerts](https://developer.eagleeyenetworks.com/reference/listalerts.md): Search and sort alerts by creatorId, alertType, actorId, actorType, actorAccountId, ruleId, eventId, locationId, and priority. Optional information can be requested with include. - [/alertTypes](https://developer.eagleeyenetworks.com/reference/listalerttypes.md): Fetches all the alert types that are currently supported. - [/eventMetrics](https://developer.eagleeyenetworks.com/reference/geteventmetrics.md): Returns metrics data indicating the number of occurrences of a given event over time. - [/eventSubscriptions](https://developer.eagleeyenetworks.com/reference/createeventsubscription.md): Creates a new event subscription. You have the option to create a temporary subscription using server-sent events or a persistent subscription using webhooks. If you choose a temporary subscription, it will be automatically deleted if it no clients are subscribed to it for the duration specified in `timeToLiveSeconds`. If you opt for a persistent subscription, it will remain active as long as you respond to the webhook messages sent to your provided URL with a `200 OK` status. If we are unable to deliver events to your webhook continuously for 90 days, the subscription will be disabled. - [/eventSubscriptions/{eventSubscriptionId}/filters](https://developer.eagleeyenetworks.com/reference/createeventsubscriptionfilter.md): Creates an event subscription filter for a given event subscription. - [/eventSubscriptions/{eventSubscriptionId}](https://developer.eagleeyenetworks.com/reference/deleteeventsubscription.md): Deletes a specific event subscription. - [/eventSubscriptions/{eventSubscriptionId}/filters/{filterId}](https://developer.eagleeyenetworks.com/reference/deleteeventsubscriptionfilter.md): Deletes a filter based on the given ID. - [/eventSubscriptions/{eventSubscriptionId}](https://developer.eagleeyenetworks.com/reference/geteventsubscription.md): This endpoint allows you to retrieve a specific event subscription. - [/eventSubscriptions/{eventSubscriptionId}/filters/{filterId}](https://developer.eagleeyenetworks.com/reference/geteventsubscriptionfilter.md): Gets info about a specific filter of a given event subscription ID. - [/eventSubscriptions/{eventSubscriptionId}/filters](https://developer.eagleeyenetworks.com/reference/listeventsubscriptionfilters.md): Gets all event subscription filters defined for the given event subscription. - [/eventSubscriptions](https://developer.eagleeyenetworks.com/reference/listeventsubscriptions.md): Gets all visible event subscriptions defined for the current account. - [/eventTypes](https://developer.eagleeyenetworks.com/reference/listeventtypes.md): Fetches all the event types that are currently supported. - [/events](https://developer.eagleeyenetworks.com/reference/createevent.md): Creates a new event and adds it to the history of the selected actor. The event must be from the list of [supported event types](https://developer.eagleeyenetworks.com/docs/event-type). For more information, please review the [Event Insertion Guide](doc:event-insertion). - [/events/{id}](https://developer.eagleeyenetworks.com/reference/geteventbyid.md): Get a specific event by its ID. - [/events](https://developer.eagleeyenetworks.com/reference/listevents.md): Gets all events of a specified type attributed to a specific actor such as a device, user, etc. By default, the API will return only the general event information. To include additional data specific to the requested event type, use the include parameter. The possible values for the include parameter are returned in the dataSchemas field of the event object. ## Data Filtering Data filters allow filtering events based on fields within specific event data schemas. These filters follow the naming pattern `data.{schemaName}.{fieldName}` and apply to all event types. Events that do not contain the specified schema will be excluded from results. For example, when searching for both motion and device status events with a connectionStatus filter, motion events will not be returned (since they don't have connectionStatus), and only device status events that match the connectionStatus criteria will be returned. - [/events:listFieldValues](https://developer.eagleeyenetworks.com/reference/listeventsfieldvalues.md): Retrieves the available values for each field. It is useful to know which filters to use when searching for events. - [/events:listRecentByType](https://developer.eagleeyenetworks.com/reference/listrecenteventsbytype.md): Gets the most recent event for each specified event type attributed to a specific actor such as a device, user, etc. This endpoint returns one event per type, with the most recent event based on startTimestamp. By default, the API will return only the general event information. To include additional data specific to the requested event type, use the include parameter. The possible values for the include parameter are returned in the dataSchemas field of the event object. ## Data Filtering Data filters allow filtering events based on fields within specific event data schemas. These filters follow the naming pattern `data.{schemaName}.{fieldName}` and apply to all event types. Events that do not contain the specified schema will be excluded from results. For example, when searching for both motion and device status events with a connectionStatus filter, motion events will not be returned (since they don't have connectionStatus), and only device status events that match the connectionStatus criteria will be returned. - [/notifications/{id}](https://developer.eagleeyenetworks.com/reference/getnotification.md): Get a notification - [/notifications](https://developer.eagleeyenetworks.com/reference/listnotifications.md): Search and sort notifications by alertId, alertType, actorId, actorType, actorAccountId, category, and read. V1 notifications can be requested with includeV1Notifications. - [/notifications/{id}](https://developer.eagleeyenetworks.com/reference/updatenotification.md): Update if a notification is read - [Accessing the API](https://developer.eagleeyenetworks.com/reference/using-the-api.md) - [/locations/{locationId}/floors/{id}/plans/{planId}](https://developer.eagleeyenetworks.com/reference/deletefloorplan.md): This endpoint allows you to delete a floor plan and its corresponding SVG or PNG file. Support for Location-based camera grouping is only available in the professional and enterprise editions. - [/locations/{locationId}/floors/{id}/plans](https://developer.eagleeyenetworks.com/reference/getfloorplans.md): This endpoint allows you to retrieve plans of a specific floor at a specific location. Support for Location-based camera grouping is only available in the professional and enterprise editions. - [/locations/{locationId}/floors/{id}/plans](https://developer.eagleeyenetworks.com/reference/setfloorplan.md): This endpoint allows you to create a floor plan for a specific floor at a specific location. Currently only one floor plan file is supported per floor, which means that uploading a new file will overwrite any existing file, even if it has a different format (svg vs png). Support for Location-based camera grouping is only available in the professional and enterprise editions. - [/locations/{locationId}/floors](https://developer.eagleeyenetworks.com/reference/createfloor.md): This endpoint allows you to create a floor. Support for Location-based camera grouping is only available in the professional and enterprise editions. - [/locations/{locationId}/floors/{id}](https://developer.eagleeyenetworks.com/reference/deletefloor.md): This endpoint allows you to delete a specific floor of a specific location. Support for Location-based camera grouping is only available in the professional and enterprise editions. - [/locations/{locationId}/floors/{id}](https://developer.eagleeyenetworks.com/reference/getfloor.md): This endpoint allows you to retrieve a specific floor at a specific location. Support for Location-based camera grouping is only available in the professional and enterprise editions. - [/locations/{locationId}/floors/{id}.{type}](https://developer.eagleeyenetworks.com/reference/getfloorimage.md): This endpoint allows you to retrieve the floor image of a specific floor. Please first check the floorPlans field in GET /locations/{locationId}/floors or GET /locations/{locationId}/floors/{id} to see if a file with this format exists. Support for Location-based camera grouping is only available in the professional and enterprise editions. - [/locations/{locationId}/floors](https://developer.eagleeyenetworks.com/reference/getlocationfloors.md): This endpoint allows you to retrieve the floors at the given location. Support for Location-based camera grouping is only available in the professional and enterprise editions. It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available floors, not the number of floors resulting from the query string. - [/locations/{locationId}/floors/{id}](https://developer.eagleeyenetworks.com/reference/updatefloor.md): Updates one or more fields of the given floor. This has no effect on the cameras on that floor. Support for Location-based camera grouping is only available in the professional and enterprise editions. - [/layouts](https://developer.eagleeyenetworks.com/reference/createlayout.md): This endpoint allows you to create a layout. - [/layouts/{layoutId}](https://developer.eagleeyenetworks.com/reference/deletelayout.md): This endpoint allows you to delete an existing layout. - [/layouts/{layoutId}](https://developer.eagleeyenetworks.com/reference/getlayout.md): This endpoint allows you to retrieve info of a specific layout. - [/layouts](https://developer.eagleeyenetworks.com/reference/getlayouts.md): This endpoint allows you to retrieve all the layouts associated with the account. It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available layouts, not the number of layouts resulting from the query string. - [/layouts/{layoutId}](https://developer.eagleeyenetworks.com/reference/updatelayout.md): This endpoint allows you to update a specific layout. - [/locations](https://developer.eagleeyenetworks.com/reference/createlocation.md): This endpoint allows you to create a new location. Support for Location-based camera grouping is only available in the professional and enterprise editions. - [/locations/{id}](https://developer.eagleeyenetworks.com/reference/deletelocation.md): This endpoint allows you to delete the location with the given ID. Support for Location-based camera grouping is only available in the professional and enterprise editions. - [/locations/{id}](https://developer.eagleeyenetworks.com/reference/getlocation.md): This endpoint allows retrieval of the location with a specific ID. Support for Location-based camera grouping is only available in the professional and enterprise editions. - [/locations/{id}/locations](https://developer.eagleeyenetworks.com/reference/getlocationdescendants.md): This endpoint allows you to retrieve the (grand) children of the location with the given ID. Support for Location-based camera grouping is only available in the professional and enterprise editions. - [/locations](https://developer.eagleeyenetworks.com/reference/getlocations.md): This endpoint is used to retrieve a list of locations. Support for Location-based camera grouping is only available in the professional and enterprise editions. It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available locations, not the number of locations resulting from the query string. - [/locations/{id}](https://developer.eagleeyenetworks.com/reference/updatelocation.md): This endpoint allows you to update the location with the given ID. Support for Location-based camera grouping is only available in the professional and enterprise editions. - [/tags](https://developer.eagleeyenetworks.com/reference/gettags.md): Retrieves a list of all tags visible to the current user. You can filter the result by name__contains and sort the result by sort field. Additionally, you can paginate the results by pageToken and pageSize. - [/measurementThresholds](https://developer.eagleeyenetworks.com/reference/createmeasurementthreshold.md): Create a new measurement threshold. - [/measurementThresholds/{measurementThresholdId}](https://developer.eagleeyenetworks.com/reference/deletemeasurementthreshold.md): Removes the given measurement threshold from the account, resetting it in all the attached measurements - [/measurementThresholds/{measurementThresholdId}](https://developer.eagleeyenetworks.com/reference/getmeasurementthreshold.md): Retrieves the given measurement threshold. - [/measurementThresholds](https://developer.eagleeyenetworks.com/reference/listmeasurementthresholds.md): Retrieves a list of all measurement thresholds visible to the current user. - [/measurementThresholds/{measurementThresholdId}](https://developer.eagleeyenetworks.com/reference/updatemeasurementthreshold.md): Update one or more fields of the given measurement threshold. - [/measurements/{measurementId}](https://developer.eagleeyenetworks.com/reference/getmeasurement.md): Retrieves the given measurement. - [/measurements](https://developer.eagleeyenetworks.com/reference/listmeasurements.md): Retrieves a list of all measurements visible to the current user. - [/measurements:listFieldValues](https://developer.eagleeyenetworks.com/reference/listmeasurementsfieldvalues.md): Fetches the list of field values across all the attributes of measurement stored for this account. - [/measurements/{measurementId}](https://developer.eagleeyenetworks.com/reference/updatemeasurement.md): Update one or more fields of the given measurement. Non-editable measurements (measurements that have a property type of `vape`, `health`, or `comfort`, OR have `editable` set to `false`) only allow updates to the `preferred` and `primaryCameraId` fields. - [/sensorEvents](https://developer.eagleeyenetworks.com/reference/eventallsensorthresholdupdates.md): This internal endpoint is used for posting the events for attached measurement/sensorGateway/sensorDevice. - [/downloads/{id}:download](https://developer.eagleeyenetworks.com/reference/downloaddownload.md): Save a download by ID. - [/downloads/{id}](https://developer.eagleeyenetworks.com/reference/getdownload.md): Gets details of a download based on its ID. - [/downloads](https://developer.eagleeyenetworks.com/reference/getdownloads.md): Returns a list of downloaded items. - [/downloads/{id}](https://developer.eagleeyenetworks.com/reference/updatedownload.md): Modifies the details of a download. - [/exports](https://developer.eagleeyenetworks.com/reference/createexportjob.md): Creates and starts a new video export job - [/exports/{jobId}:copy](https://developer.eagleeyenetworks.com/reference/retryexport.md): Start the export again with minor changes of some of the original parameters, which are specified in the body of the api. Fields that are not given will be kept the same as the original job. Failed intervals are tried again, adding a suffix to the names of the generated mp4's to indicate they are created by a retry. - [/feeds](https://developer.eagleeyenetworks.com/reference/listfeeds.md): This endpoint allows developers to list and retrieve information about the feeds that are generated by a device. It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available feeds, not the number of feeds resulting from the query string. - [/files](https://developer.eagleeyenetworks.com/reference/addfile.md): Add a new file to the archive. If the directory specified does not exist, it will automatically be created. To create a new empty directory, specify the desired name, parent directory and a mimeType of `application/directory`. - [/deletedFiles/all](https://developer.eagleeyenetworks.com/reference/deletealltrashfiles.md): Permanently delete all files in the recycle bin. - [/files/{id}](https://developer.eagleeyenetworks.com/reference/deletefile.md): Recycles an item by ID. - [/deletedFiles/{id}](https://developer.eagleeyenetworks.com/reference/deletetrashfile.md): Permanently delete an item by ID. - [/files/{id}:download](https://developer.eagleeyenetworks.com/reference/downloadfile.md): Download file or folder by ID. - [/files/{id}](https://developer.eagleeyenetworks.com/reference/getfile.md): Gets details of a file based on its ID. - [/files](https://developer.eagleeyenetworks.com/reference/getfiles.md): Returns a list of archived items. - [/deletedFiles](https://developer.eagleeyenetworks.com/reference/gettrash.md): Returns a list of deleted files. - [/deletedFiles/{id}](https://developer.eagleeyenetworks.com/reference/gettrashfile.md): Get details of a recycled item. - [/deletedFiles/{id}:restore](https://developer.eagleeyenetworks.com/reference/restoretrashfile.md): Restore a recycled item by ID. - [/files/{id}](https://developer.eagleeyenetworks.com/reference/updatefile.md): Modifies the details of an item. - [/jobs/{jobId}](https://developer.eagleeyenetworks.com/reference/deletejob.md): Deletes a Job regardless of state. - [/jobs/{jobId}](https://developer.eagleeyenetworks.com/reference/getjob.md): Get a single Job - [/jobs](https://developer.eagleeyenetworks.com/reference/listjobs.md): List Jobs. Filtering by userId, type, state namespace, createTimestamp, updateTimestamp, expireTimestamp. - [/media/liveImage.jpeg](https://developer.eagleeyenetworks.com/reference/getliveimage.md): This endpoint allows users to get a new image from the device. This call will wait until the image is available. - [/media/session](https://developer.eagleeyenetworks.com/reference/getmediasession.md): Api to list the url to call to set the media session cookie. The call will also redirect to the same url. The media session cookie can be used to replace the bearer authentication for mp4 playback in web browsers. - [/media/recordedImage.jpeg](https://developer.eagleeyenetworks.com/reference/getrecordedimage.md): This endpoint retrieves an image based on a specified timestamp. You can indicate whether the image must be captured exactly at that timestamp or allow a nearest match before or after. The timestamp must be submitted in ISO 8601 format. Each request must include one timestamp parameter and specify the desired image type — either `main` or `preview`. Alternatively, by submitting a `pageToken`, the next/previous image from the last image is returned. In this case, none of the other parameters are used. Be aware that the image type `main` is rate-limited, and should not be used in quick succession. Additionally, it requires that a recording is available at the given timestamp param. If no recording is available at the given timestamp param a 404 NOT FOUND will be returned. If an overlay is requested in the `include` parameter, then at least one overlayId must be provided as part of the `overlayId__in` parameter. The list of available overlay ids can be retrieved using the GET [/media/recordedImage.jpeg:listFieldValues](ref:listrecordedimagefieldvalues) API. - [/media](https://developer.eagleeyenetworks.com/reference/listmedia.md): This endpoint requests a list of intervals for which there are recordings for the given type and mediaType. If no endTimestamp__lte (formatted according to ISO 8601) is given, then the results until now are returned. Note: The ISO 8601 timestamp format is a standardized format for representing date and time information. It uses the format 'YYYY-MM-DDTHH:MM:SS.sss±hh:mm' where "T" is the separator between the date and time portions. - [/authorizationTokens](https://developer.eagleeyenetworks.com/reference/createtoken.md): Resellers can retrieve access tokens for a given end-user account, assuming that the end-user account falls under the reseller's account. - [/sensorDevices](https://developer.eagleeyenetworks.com/reference/addsensordevice.md): Associates a sensor device with the account. This can only be called with an end-user account, and will result in an error if tried with any other type of account. - [/sensorDevices/{sensorDeviceId}](https://developer.eagleeyenetworks.com/reference/deletesensordevice.md): Dis-associates the sensor device from the account, removing all references, recording, events and in some cases resetting the sensor device to factory default settings. This request will block until the sensor device has been fully removed. - [/sensorDevices/{sensorDeviceId}](https://developer.eagleeyenetworks.com/reference/getsensordevice.md): Retrieves the given sensor device. - [/sensorDevices](https://developer.eagleeyenetworks.com/reference/listsensordevices.md): Retrieves a list of all sensor devices visible to the current user. - [/sensorDevices/{sensorDeviceId}](https://developer.eagleeyenetworks.com/reference/updatesensordevice.md): Update one or more fields of the given sensor device. - [/sensorTimeSeries/{sensorId}](https://developer.eagleeyenetworks.com/reference/gettimeseries.md): Retrieves the timeSeries data for a given sensor Id. - [/sensorTimeSeries](https://developer.eagleeyenetworks.com/reference/listtimeseries.md): Retrieves a list of all time series data visible to the current user. - [/applications/{applicationId}/oauthClients](https://developer.eagleeyenetworks.com/reference/addoauthclient.md): This endpoint allows you to create a new OAuth client for the given application. A maximum of 250 oauth client credentials can be created under the application. - [/applications/{applicationId}/oauthClients/{clientId}](https://developer.eagleeyenetworks.com/reference/deleteoauthclient.md): This endpoint allows you to delete a specific OAuth client of a given application. - [/applications/{applicationId}/oauthClients/{clientId}](https://developer.eagleeyenetworks.com/reference/getoauthclient.md): This endpoint allows you to retrieve a specific OAuth client. - [/applications/{applicationId}/oauthClients](https://developer.eagleeyenetworks.com/reference/getoauthclients.md): This endpoint allows retrieval of all OAuth credentials for the given application. It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available OAuth credentials, not the number of OAuth credentials resulting from the query string. - [/applications/{applicationId}/oauthClients/{clientId}](https://developer.eagleeyenetworks.com/reference/updateclient.md): This endpoint allows you to update a specific Oauth client. - [/applications](https://developer.eagleeyenetworks.com/reference/createapplication.md): This endpoint allows you to create a new application under the requesting user's account. A maximum of 100 applications can be created under the account. - [/applications/{applicationId}](https://developer.eagleeyenetworks.com/reference/deleteapplication.md): This endpoint allows you to delete a single application. - [/applications/{applicationId}](https://developer.eagleeyenetworks.com/reference/getapplication.md): This endpoint allows you to retrieve a single application. - [/applications](https://developer.eagleeyenetworks.com/reference/listapplications.md): This endpoint allows retrieval of all applications accessible by the requesting user. It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available applications, not the number of applications resulting from the query string. - [/languages](https://developer.eagleeyenetworks.com/reference/listlanguages.md): This endpoint allows you to retrieve a list of languages supported by the service. It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available languages, not the number of languages resulting from the query string. - [/timeZones](https://developer.eagleeyenetworks.com/reference/listtimezones.md): This endpoint allows you to retrieve a list of the supported time zones. It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available time zones, not the number of time zones resulting from the query string. - [/applications/{applicationId}](https://developer.eagleeyenetworks.com/reference/updateapplication.md): This endpoint allows you to update a single application. - [/accounts/{id}/credentials/{credentialId}](https://developer.eagleeyenetworks.com/reference/deletecredential.md): Deletes the credential from the account. - [/accounts](https://developer.eagleeyenetworks.com/reference/listaccounts.md): Retrieves a list of accounts the user has access to. This will include the user's own account, but can contain others such as when the user is a reseller. - [/auditLogs](https://developer.eagleeyenetworks.com/reference/listauditlogs.md): This endpoint filters audit events by userId, targetId, targetType, auditType - [/editions/{id}](https://developer.eagleeyenetworks.com/reference/getedition.md): This endpoint allows you to retrieve a specific edition by its ID. - [/editions](https://developer.eagleeyenetworks.com/reference/geteditions.md): This endpoint allows you to retrieve a list of the editions that are available for your account. It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available editions, not the number of editions resulting from the query string. - [/resourceGrants:bulkCreate](https://developer.eagleeyenetworks.com/reference/createresourcegrants.md): This endpoint allows you to create multiple resource grants in one request. - [/resourceGrants:bulkDelete](https://developer.eagleeyenetworks.com/reference/deleteresourcegrants.md): This endpoint allows you to delete multiple resource grants in one request. - [/resourceGrants](https://developer.eagleeyenetworks.com/reference/getresourcegrants.md): This endpoint allows you to Retrieve a list of resource grants with pagination and filter parameters. It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available resource grants, not the number of resource grants resulting from the query string. - [/roles](https://developer.eagleeyenetworks.com/reference/createrole.md): This endpoint creates a new role under the current user's account. Admins can create roles and define which permissions are part of which roles. Non-admin users with 'Role' permission can only create a role with the permission that they already have themselves. - [/roleAssignments:bulkcreate](https://developer.eagleeyenetworks.com/reference/createroleassignments.md): This endpoint allows you to create multiple role assignments in one request. - [/roles/{roleId}](https://developer.eagleeyenetworks.com/reference/deleterole.md): This endpoint deletes a role from current user's account. A role can only be deleted if it is not assigned to any user. Admin users and non-admin users with 'Role' permission can delete roles. - [/roleAssignments:bulkdelete](https://developer.eagleeyenetworks.com/reference/deleteroleassignments.md): This endpoint allows you to delete multiple role assignments in one request. - [/roles/{roleId}](https://developer.eagleeyenetworks.com/reference/getrole.md): This endpoint returns a role by its ID. - [/roleAssignments](https://developer.eagleeyenetworks.com/reference/getroleassignments.md): This endpoint returns a list of all role assignments in current user's account. - [/roles](https://developer.eagleeyenetworks.com/reference/getroles.md): This endpoint returns a list of all roles in current user's account. - [/roles/{roleId}](https://developer.eagleeyenetworks.com/reference/updaterole.md): This endpoint updates a role. Admin users and non-admin users with 'Role' permission can update roles. - [/users](https://developer.eagleeyenetworks.com/reference/createuser.md): This endpoint allows users to create a user in the account. The created user will be in pending state and a verification email will be sent to the user. Once approved, the newly created user will be in active state and will be able to be used. - [/users/self/trustedClients/{trustedClientId}](https://developer.eagleeyenetworks.com/reference/deletetrustedclient.md): This endpoint allows you to delete a trusted client. - [/users/{userId}](https://developer.eagleeyenetworks.com/reference/deleteuser.md): This endpoint allows the users to delete a user from the account, removing all references related to that user. - [/users/self](https://developer.eagleeyenetworks.com/reference/getcurrentuser.md): This endpoint allows the users to retrieve info about the current user. - [/users/self/trustedClients](https://developer.eagleeyenetworks.com/reference/gettrustedclients.md): This endpoint allows you to retrieve a list of trusted clients. It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available trusted clients, not the number of trusted clients resulting from the query string. - [/users/{userId}](https://developer.eagleeyenetworks.com/reference/getuser.md): This endpoint allows the users to retrieve info about a specific user based on the user ID. - [/users](https://developer.eagleeyenetworks.com/reference/getusers.md): This endpoint allows the users to retrieve a list of users within the account. This endpoint supports filtering, pagination, and sorting, as well as including additional information with the response. It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available users, not the number of users resulting from the query string. - [/users/self](https://developer.eagleeyenetworks.com/reference/updatecurrentuser.md): This endpoint allows the users to update current user's data. - [/users/{userId}](https://developer.eagleeyenetworks.com/reference/updateuser.md): Updates a specific user's data. Note that not all fields may be editable in all contexts. To determine which fields are editable, request the schema using the include parameter. If the user's permissions are managed via the Roles API, the `schema.permissions` fields will be marked as `readOnly`. In such cases, `effectivePermissions.roleAssignments` will be `true`, indicating that role-based assignment is in effect. - [/lprEvents/{id}](https://developer.eagleeyenetworks.com/reference/getlprevent.md): Fetches lpr event based on `id` provided. This returns the event as an extension of event base envelope with LPR specific information - [/lprEvents:summary](https://developer.eagleeyenetworks.com/reference/getlpreventssummary.md): Fetches summary of lpr event counts. Query fields can control the parameters that are returned in the response body. There are 7 key attributes as follows: * `lastHour` : event count in last one hour. * `last24h` : event count in last 24 hours. * `today`: event count in current day from 00:00 user local time to present * `yesterday` : events for previous day (in user's local time zone) * `last7Days` : event count in last 7 days. * `last30Days` : event count in last 30 days * `latestEventTimestamp` : timestamp of the latest event. At least one of these attributes must be specified for the query to return results. The attributes given apply on each camera and to a single aggregated total. - [/lprEvents:listFieldValues](https://developer.eagleeyenetworks.com/reference/listlpreventfieldvalues.md): Fetches all of the possible values for each of the fields that can be used to filter LPR events. - [/lprEvents](https://developer.eagleeyenetworks.com/reference/listlprevents.md): Fetches license plate recognition events. Filters can be applied to search for specific events based on the make and model of the vehicle, the color of the vehicle, the direction of the vehicle, the access type, the actor, and the user data. For a list of possible values for each field, refer to the [`/lprEvents:listFieldValues`](ref:listlpreventfieldvalues) endpoint. The `include` parameter can be used to specify which data schemas should be included in the response. If no `include` parameter is provided, the response will include only the base event envelope. - [/lprAlertConditionRules](https://developer.eagleeyenetworks.com/reference/addlpralertconditionrule.md): Create a new rule that produces alerts based on certain conditions. Specifically, the user specifies alert conditions that indicate when the alert is produced based on following: * Which resources (cameras, account or location) can produce the alert * What is the schedule for the alert. * What event types, or which vehicles (specific plates, or belonging to a vehicleList) can produce the alert. - [/lprAlertConditionRules/{id}](https://developer.eagleeyenetworks.com/reference/deletelpralertconditionrule.md): Deletes the rule corresponding to the rule ID - [/lprAlertConditionRules/{id}](https://developer.eagleeyenetworks.com/reference/getlpralertconditionrule.md): Get details of a specific rule id - [/lprAlertConditionRules:listFieldValues](https://developer.eagleeyenetworks.com/reference/getlpralertconditionrulefieldvalues.md): Fetches the list of field values across all the attributes of alertConditionRules stored for this account. - [/lprAlertConditionRules](https://developer.eagleeyenetworks.com/reference/listlpralertconditionrules.md): Fetches lpr rules based on a filter - [/lprAlertConditionRules/{id}](https://developer.eagleeyenetworks.com/reference/updatelpralertconditionrule.md): Updates the properties of a specific rule. Only the user defined fields can be updated by this method. - [/lprVehicleLists/{id}/vehicles](https://developer.eagleeyenetworks.com/reference/addvehicle.md): Adds a new vehicle record to the list. This method enforces strictness about the uniqueness of vehicle license plate, so the same plate/vehicle cannot be added more than once, and would result in error if attempted. - [/lprVehicleLists](https://developer.eagleeyenetworks.com/reference/addvehiclelist.md): Add a new vehicleList to the user account - [/lprVehicleLists/{id}/vehicles:bulkCreate](https://developer.eagleeyenetworks.com/reference/addvehicles.md): Adds multiple vehicle records to the list in a single operation. This method enforces strictness about the uniqueness of vehicle license plates. Each plate/vehicle must be unique within the list, and duplicate entries in either the request or with existing records will result in an error. - [/lprVehicleLists/{id}/vehicles/{recordId}](https://developer.eagleeyenetworks.com/reference/deletevehicle.md): Delete given vehicle record in given list. - [/lprVehicleLists/{id}](https://developer.eagleeyenetworks.com/reference/deletevehiclelist.md): Delete the vehicle list along with the entries - [/lprVehicleLists/{id}/vehicles/{recordId}](https://developer.eagleeyenetworks.com/reference/getvehicle.md): Fetches information about a specific vehicle from a specific list - [/lprVehicleLists/{id}](https://developer.eagleeyenetworks.com/reference/getvehiclelist.md): Fetches the information about the specific vehicleList but not each vehicle record - [/lprVehicleLists:listFields](https://developer.eagleeyenetworks.com/reference/getvehiclelistfields.md): Fetches all available fields in vehicle Lists for this account. Specifically, using this API, the user may: * Obtain the list of fields for ordered display of vehicle records, wherein each field is a column. * Obtain the possible values for some or all of the fields for search queries. * Understand user defined fields in the records of vehicle Lists, which is a dynamic set. - [/lprVehicleLists:listFieldValues](https://developer.eagleeyenetworks.com/reference/getvehiclelistfieldvalues.md): Fetches the list of field values including possible values for each key in userData. - [/lprVehicleLists](https://developer.eagleeyenetworks.com/reference/listvehiclelists.md): Fetches the available vehicleLists based on the filter - [/lprVehicleLists/{id}/vehicles](https://developer.eagleeyenetworks.com/reference/listvehicles.md): Fetches information about all the vehicle records in the given list, including the user data. - [/lprVehicleLists:search](https://developer.eagleeyenetworks.com/reference/searchvehiclelists.md): Fetches the vehicle records that match search criteria, across all the lists that match the search criteria - [/lprVehicleLists/{id}/vehicles/{recordId}](https://developer.eagleeyenetworks.com/reference/updatevehicle.md): Update given vehicle record in the given list. Specifically for the given record, create-only properties like `plate` cannot be edited. To edit those, the record would have to be deleted and a new one added. - [/lprVehicleLists/{id}](https://developer.eagleeyenetworks.com/reference/updatevehiclelist.md): Update the meta configuration properties about the specific vehicle List - [/videoAnalyticEvents/{id}](https://developer.eagleeyenetworks.com/reference/getvideoanalyticsevent.md): Fetches video analytics event based on `id` provided. The event is returned as the base event envelope with the data objects requested using the `include` parameter. - [/videoAnalyticEvents:deepSearch](https://developer.eagleeyenetworks.com/reference/listvideoanalyticsevents.md): Fetches video analytic events matching the filters defined for the deep search. The events are returned as the base event envelope with the data objects requested using the `include` parameter. - [/videoAnalyticEvents:deepSearchGroupByResource](https://developer.eagleeyenetworks.com/reference/listvideoanalyticseventsdeepsearchgroupbyresource.md): Fetches matching video analytic event frequencies grouped as requested. The response is a list of groups, each with a count of matching events, and optionally a sample event. - [/videoAnalyticEvents:deepSearchGroupByTime](https://developer.eagleeyenetworks.com/reference/listvideoanalyticseventsdeepsearchgroupbytime.md): Fetches matching video analytic event frequencies grouped in time periods. The set of periods are defined by defining either their length using `timeInterval`, or their count with `groupCount`. The response is a list of time periods, each with a count of matching events, and optionally a sample event. - [/videoAnalyticEvents:listFieldValues](https://developer.eagleeyenetworks.com/reference/listvideoanalyticsfieldvalues.md): Fetches available deep search query parameters based on events matching the input filters and other query parameter inputs. Query parameters can be requested using the `parameter` param. It has to be noted that the values in the filter will be a subset for those fields which are mentioned in the `parameter` param. Eg. If the filter specifies a set of actors (such as cameras), and `parameter=actor` is given, the search for matching is done with the given actor filters and therefore the response will always be a subset of the given list of actors. - [/videoAnalyticEvents:listObjectValues](https://developer.eagleeyenetworks.com/reference/listvideoanalyticsobjectvalues.md): Fetches available deep search filter attribute values for a given filter based on events matching the input filters. The `include` parameter is used to indicate what filter the attribute values should be returned for. - [/videoAnalyticEvents:parse](https://developer.eagleeyenetworks.com/reference/parsevideoanalytics.md): Map a natural language query to a set of object filters to use in the deep search endpoints. The deep search can identify a variety of objects, including people, vehicles, and some common handheld objects such as backpacks and suitcases. The deep search can also identify the attributes of these objects, such as the color of a person's clothing or the make of a vehicle. ## Recipes - [Custom Object Detection](https://developer.eagleeyenetworks.com/recipes/custom-object-detection.md) - [Exportng Video](https://developer.eagleeyenetworks.com/recipes/exportng-video.md) - [Media Request Staggering](https://developer.eagleeyenetworks.com/recipes/media-request-staggering.md) - [OAuth Authentication](https://developer.eagleeyenetworks.com/recipes/oauth-authentication.md) - [Reseller Account Switching](https://developer.eagleeyenetworks.com/recipes/reseller-account-switching.md) ## Pages - [API V1 / V2 API Reference](https://developer.eagleeyenetworks.com/api-v1-v2-api-reference.md) - [Camera renaming in bulk](https://developer.eagleeyenetworks.com/camera-renaming-in-bulk.md) - [Code Samples](https://developer.eagleeyenetworks.com/code-samples.md) - [Easy live video viewing via SDK, HLS or RTSP](https://developer.eagleeyenetworks.com/eagle-eye-sdk-rtsp-and-hls.md) - [Node.js Local Proxy Server](https://developer.eagleeyenetworks.com/live-playing.md) - [Migration via password grant type](https://developer.eagleeyenetworks.com/migration-via-password-grant-type.md) - [Easy recorded video playback via MP4 & RTSP](https://developer.eagleeyenetworks.com/mp4-progressive-download.md) - [My Application New Tab](https://developer.eagleeyenetworks.com/my-application-html.md) - [OAuth 2.0 Authentication](https://developer.eagleeyenetworks.com/oauth-20-authentication.md) - [Onboarding process](https://developer.eagleeyenetworks.com/onboarding-process.md) - [Pricing](https://developer.eagleeyenetworks.com/pricing.md) - [test embed](https://developer.eagleeyenetworks.com/test-embed.md) - [Two-way-audio via WebRTC](https://developer.eagleeyenetworks.com/two-way-audio-via-webrtc.md) - [Use Cases](https://developer.eagleeyenetworks.com/use-cases.md) - [Video API Platform FAQ](https://developer.eagleeyenetworks.com/video-api-platform-faq.md) ## Changelog - [2.5.2026 - API Updates](https://developer.eagleeyenetworks.com/changelog/20260205-api-updates.md) - [HLS Streaming Support](https://developer.eagleeyenetworks.com/changelog/20251218-hls-streaming.md) - [10.09.2025 - Event Types Update](https://developer.eagleeyenetworks.com/changelog/20251009-events-update.md) - [9.18.2025 - API Updates](https://developer.eagleeyenetworks.com/changelog/20250918-api-updates.md) - [Incorrect Format - Event Webhook Timestamps](https://developer.eagleeyenetworks.com/changelog/incorrect-format-event-webhook-timestamps.md)