brackets-curlyReference

Get all events

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
limitinteger · min: 1 · max: 100Optional

Maximum number of events to return.

Default: 10Example: 20
camerasstring[]Optional

Comma-separated list of camera entity_ids.

Example: ["camera.front_door","camera.driveway"]
categoriesstring[]Optional

Comma-separated list of categories.

Example: ["person","package"]
daysintegerOptional

Time window [now - days, now].

Example: 2
Responses
chevron-right
200

Successful response

application/json
get
/events
Example request
200

Successful response

Get a single event

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
event_idstring · uuidRequired
Responses
chevron-right
200

Event found

application/json
get
/event/{event_id}

Update an existing event

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
event_idstring · uuidRequired
Body
Responses
chevron-right
200

Event updated

application/json
Responseone of
or
post
/event/{event_id}

Delete an event

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
event_idstring · uuidRequired
Responses
chevron-right
200

Event deleted

application/json
delete
/event/{event_id}

Create a new event

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
titlestringOptional
descriptionstringOptional
key_framestringOptional
camera_namestringOptional
labelstringOptional
startstringOptional

ISO 8601 string or Unix timestamp

endstringOptional

ISO 8601 string or Unix timestamp

Responses
chevron-right
200

Event created

application/json
post
/events/new

Last updated