Inheritance diagram for homeassistant.components.api.APICoreStateView:

Collaboration diagram for homeassistant.components.api.APICoreStateView:

Public Member Functions
web.Response	get (self, web.Request request)

Static Public Attributes
string	name = "api:core:state"

	url = URL_API_CORE_STATE

Detailed Description

View to handle core state requests.

Definition at line 107 of file __init__.py.

Member Function Documentation

◆ get()

web.Response homeassistant.components.api.APICoreStateView.get	(		self,
		web.Request	request
	)

Retrieve the current core state.

This API is intended to be a fast and lightweight way to check if the
Home Assistant core is running. Its primary use case is for supervisor
to check if Home Assistant is running.

Definition at line 114 of file __init__.py.

Member Data Documentation

◆ name

string homeassistant.components.api.APICoreStateView.name = "api:core:state"

static

Definition at line 111 of file __init__.py.

◆ url

homeassistant.components.api.APICoreStateView.url = URL_API_CORE_STATE

static

Definition at line 110 of file __init__.py.

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

core/homeassistant/components/api/__init__.py

Home Assistant Unofficial Reference 2024.12.1