Surfsight API endpoints

The Surfsight API provides REST APIs with multiple endpoints, parameters and methods, all of which are grouped together according to functionality. The primary data you will use in order to make these calls includes:

orgId - organization or identifier
Device imei- unique number of the device
partnerId - partner identifier

Use the endpoints shown in the table below to manage, configure, and capture data from the devices, as well as set user permissions.

Note

Surfsight API requests use a standard call structure, as described in Call structure.

Name	Description	Endpoints
Alarms	Retrieve alarm reports, manage report email recipients, and manage alarms.	/alarms
Audit logs	Retrieve your organization audit logs.	/audit-logs
Authentication	Generate an API token to access the Surfsight API	/authenticate
Device operations	Manage your device operations, such as formatting SD cards and receiving data usage.	/devices/{imei} /organizations/{orgId}/devices
Devices	Manage your devices and receive data about your devices, such as a device's settings or active cameras.	/devices/{imei} /organizations/{orgId}
Events	Configure event settings and receive data about your events, such as event settings or details.	/devices/{imei}
Geofences	Manage the geofences of a devices.	/devices/{imei}/geofences
Groups	Create and manage groups.	/organizations/{orgId}/groups
Health	Retrieve health reports and manage report email recipients.	/device-health /recipients/health
Organizations	Create and manage organizations.	/organizations
Partner operation statistics	Receive your operational statistics. Only partners can make these calls.	/partners/operational-statistics
Partners	Manage your partner contacts.	/partners/{partnerId}
Recordings	Retrieve data about a camera's recordings availability, and snapshots of a camera's current view.	/devices/{imei}
Streaming	Prepare live streaming from a device.	/devices/{imei}/connect-media
Telemetry	Retrieve telemetry data from a device or camera.	/devices/{imei}
Users	Create new users and manage user passwords.	/organizations/{orgId}/users
Virtual events	Generate third party events.	/devices/{imei}/virtual-event
Webhooks	Manage your webhook subscriptions.	/organizations/{orgId}/webhooks