kibana-plugin-core-server.kibanarequest.md

Home > kibana-plugin-core-server > KibanaRequest

KibanaRequest class

Kibana specific abstraction for an incoming request.

Signature:

export declare class KibanaRequest<Params = unknown, Query = unknown, Body = unknown, Method extends RouteMethod = any> 

Constructors

Constructor	Modifiers	Description
(constructor)(request, params, query, body, withoutSecretHeaders)		Constructs a new instance of the KibanaRequest class

Properties

Property	Modifiers	Type	Description
auth		{ isAuthenticated: boolean; }
body		Body
events		KibanaRequestEvents	Request events KibanaRequestEvents
headers		Headers	Readonly copy of incoming request headers.
id		string	A identifier to identify this request.
isSystemRequest		boolean	Whether or not the request is a "system request" rather than an application-level request. Can be set on the client using the HttpFetchOptions#asSystemRequest option.
params		Params
query		Query
route		RecursiveReadonly<KibanaRequestRoute<Method>>	matched route details
socket		IKibanaSocket	IKibanaSocket
url		Url	a WHATWG URL standard object.
uuid		string	A UUID to identify this request.