Home Assistant Home Assistant
  • Getting started
  • Documentation
    • Installation
    • Configuration
    • Automation
    • Scripting
    • Dashboards
    • Voice control
  • Integrations
  • Examples
  • Blog
  • Need help?

Home Assistant API


The api integration exposes a RESTful API and allows one to interact with a Home Assistant instance that is running headless. This integration depends on the HTTP integration.

# Example configuration.yaml entry
api:

For details to use the API, please refer to the REST API in the “Developer” section.

Help us to improve our documentation

Suggest an edit to this page, or provide/view feedback for this page.
Edit Provide feedback View pending feedback
The Home Assistant API system was introduced in Home Assistant 0.7, and it's used by 38.2% of the active installations. It scores internal on our quality scale.
View source on GitHub
View known issues

Categories

  • Other

On this page

Home Assistant Home Assistant
  • Home Assistant Alerts
  • Developers
  • Data Science
  • Community Forum
  • Contact (no support!)
  • Security Vulnerabilities
  • Privacy
  • System Status
Website powered by Jekyll and the Oscailte theme.

Deploys by Netlify Badge