Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.hassio.http.HassIOView Class Reference
Inheritance diagram for homeassistant.components.hassio.http.HassIOView:
[legend]
Collaboration diagram for homeassistant.components.hassio.http.HassIOView:
[legend]

Public Member Functions

None __init__ (self, str host, aiohttp.ClientSession websession)
 

Static Public Attributes

web.StreamResponse get = _handle
 
string name = "api:hassio"
 
web.StreamResponse post = _handle
 
bool requires_auth = False
 
string url = "/api/hassio/{path:.+}"
 

Private Member Functions

web.StreamResponse _handle (self, web.Request request, str path)
 

Private Attributes

 _host
 
 _websession
 

Detailed Description

Hass.io view to handle base part.

Definition at line 137 of file http.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.hassio.http.HassIOView.__init__ (   self,
str  host,
aiohttp.ClientSession  websession 
)
Initialize a Hass.io base view.

Definition at line 144 of file http.py.

Member Function Documentation

◆ _handle()

web.StreamResponse homeassistant.components.hassio.http.HassIOView._handle (   self,
web.Request  request,
str  path 
)
private
Return a client request with proxy origin for Hass.io supervisor.

Use cases:
- Onboarding allows restoring backups
- Load Supervisor panel and add-on logo unauthenticated
- User upload/restore backups

Definition at line 149 of file http.py.

Member Data Documentation

◆ _host

homeassistant.components.hassio.http.HassIOView._host
private

Definition at line 146 of file http.py.

◆ _websession

homeassistant.components.hassio.http.HassIOView._websession
private

Definition at line 147 of file http.py.

◆ get

web.StreamResponse homeassistant.components.hassio.http.HassIOView.get = _handle
static

Definition at line 242 of file http.py.

◆ name

string homeassistant.components.hassio.http.HassIOView.name = "api:hassio"
static

Definition at line 140 of file http.py.

◆ post

web.StreamResponse homeassistant.components.hassio.http.HassIOView.post = _handle
static

Definition at line 243 of file http.py.

◆ requires_auth

bool homeassistant.components.hassio.http.HassIOView.requires_auth = False
static

Definition at line 142 of file http.py.

◆ url

string homeassistant.components.hassio.http.HassIOView.url = "/api/hassio/{path:.+}"
static

Definition at line 141 of file http.py.


The documentation for this class was generated from the following file: