Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.http Namespace Reference

Namespaces

 auth
 
 ban
 
 const
 
 cors
 
 data_validator
 
 decorators
 
 forwarded
 
 headers
 
 request_context
 
 security_filter
 
 static
 
 view
 
 web_runner
 

Classes

class  ApiConfig
 
class  ConfData
 
class  HomeAssistantApplication
 
class  HomeAssistantHTTP
 
class  HomeAssistantRequest
 
class  StaticPathConfig
 

Functions

web.FileResponse _serve_file (str path, web.Request request)
 
web.FileResponse _serve_file_with_cache_headers (str path, web.Request request)
 
dict[str, Any]|None async_get_last_config (HomeAssistant hass)
 
bool async_setup (HomeAssistant hass, ConfigType config)
 
None start_http_server_and_save_config (HomeAssistant hass, dict conf, HomeAssistantHTTP server)
 

Variables

 _DEFAULT_BIND
 
 _HAS_IPV6
 
 _STATIC_CLASSES
 
 extra
 
 Final
 

Detailed Description

Support to serve the Home Assistant API as WSGI application.

Function Documentation

◆ _serve_file()

web.FileResponse homeassistant.components.http._serve_file ( str  path,
web.Request  request 
)
private

Definition at line 341 of file __init__.py.

◆ _serve_file_with_cache_headers()

web.FileResponse homeassistant.components.http._serve_file_with_cache_headers ( str  path,
web.Request   request 
)
private

Definition at line 335 of file __init__.py.

◆ async_get_last_config()

dict[str, Any] | None homeassistant.components.http.async_get_last_config ( HomeAssistant  hass)
Return the last known working config.

Definition at line 177 of file __init__.py.

◆ async_setup()

bool homeassistant.components.http.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up the HTTP API and debug interface.

Definition at line 200 of file __init__.py.

◆ start_http_server_and_save_config()

None homeassistant.components.http.start_http_server_and_save_config ( HomeAssistant  hass,
dict  conf,
HomeAssistantHTTP   server 
)
Startup the http server and save the config.

Definition at line 652 of file __init__.py.

Variable Documentation

◆ _DEFAULT_BIND

homeassistant.components.http._DEFAULT_BIND
private

Definition at line 107 of file __init__.py.

◆ _HAS_IPV6

homeassistant.components.http._HAS_IPV6
private

Definition at line 106 of file __init__.py.

◆ _STATIC_CLASSES

homeassistant.components.http._STATIC_CLASSES
private

Definition at line 152 of file __init__.py.

◆ extra

homeassistant.components.http.extra

Definition at line 140 of file __init__.py.

◆ Final

homeassistant.components.http.Final

Definition at line 74 of file __init__.py.