Skip to main content

REST

The REST API is a basic configurable fetch wrapper, tuned for some useful REST API endpoints in Home Assistant.

This list doesn't change much, Home Assistant prefers utilizing the websocket api for most interactions.

🛠 Methods

Exported Function NameDescription
calendarSearchSearches for calendar events within a specified date range and returns them sorted by start date.
callServiceCalls a Home Assistant service with the specified parameters and returns the entity state changes.
checkConfigChecks the Home Assistant configuration for errors and returns the result.
checkCredentialsVerifies if the current credentialastamps.
getRawLogsRetrieves the raw Home Assistant server logs as a string.
listServicesLists all available services in Home Assistant.
updateEntityUpdates the state and/or attributes of a specified entity.
webhookSends a request to a specified webhook in Home Assistant with optional data.