{ "id": "core.http", "client": { "classes": [], "functions": [], "interfaces": [ { "parentPluginId": "core", "id": "def-public.HttpFetchOptions", "type": "Interface", "tags": [], "label": "HttpFetchOptions", "description": [ "\nAll options that may be used with a {@link HttpHandler}." ], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpFetchOptions", "text": "HttpFetchOptions" }, " extends ", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpRequestInit", "text": "HttpRequestInit" } ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 245 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-public.HttpFetchOptions.query", "type": "Object", "tags": [], "label": "query", "description": [ "\nThe query string for an HTTP request. See {@link HttpFetchQuery}." ], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpFetchQuery", "text": "HttpFetchQuery" }, " | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 249 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpFetchOptions.prependBasePath", "type": "CompoundType", "tags": [], "label": "prependBasePath", "description": [ "\nWhether or not the request should automatically prepend the basePath. Defaults to `true`." ], "signature": [ "boolean | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 254 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpFetchOptions.headers", "type": "Object", "tags": [], "label": "headers", "description": [ "\nHeaders to send with the request. See {@link HttpHeadersInit}." ], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpHeadersInit", "text": "HttpHeadersInit" }, " | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 259 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpFetchOptions.asSystemRequest", "type": "CompoundType", "tags": [], "label": "asSystemRequest", "description": [ "\nWhether or not the request should include the \"system request\" header to differentiate an end user request from\nKibana internal request.\nCan be read on the server-side using KibanaRequest#isSystemRequest. Defaults to `false`." ], "signature": [ "boolean | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 266 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpFetchOptions.asResponse", "type": "CompoundType", "tags": [], "label": "asResponse", "description": [ "\nWhen `true` the return type of {@link HttpHandler} will be an {@link HttpResponse} with detailed request and\nresponse information. When `false`, the return type will just be the parsed response body. Defaults to `false`." ], "signature": [ "boolean | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 272 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-public.HttpFetchOptionsWithPath", "type": "Interface", "tags": [], "label": "HttpFetchOptionsWithPath", "description": [ "\nSimilar to {@link HttpFetchOptions} but with the URL path included." ], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpFetchOptionsWithPath", "text": "HttpFetchOptionsWithPath" }, " extends ", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpFetchOptions", "text": "HttpFetchOptions" } ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 279 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-public.HttpFetchOptionsWithPath.path", "type": "string", "tags": [], "label": "path", "description": [], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 283 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-public.HttpFetchQuery", "type": "Interface", "tags": [], "label": "HttpFetchQuery", "description": [], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 225 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-public.HttpFetchQuery.Unnamed", "type": "Any", "tags": [], "label": "Unnamed", "description": [ "\nTypeScript note: Technically we should use this interface instead, but @types/node uses the below stricter\ndefinition, so to avoid TypeScript errors, we'll restrict our version.\n\n[key: string]:\n | string\n | number\n | boolean\n | Array\n | undefined\n | null;" ], "signature": [ "any" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 238 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-public.HttpHandler", "type": "Interface", "tags": [], "label": "HttpHandler", "description": [ "\nA function for making an HTTP requests to Kibana's backend. See {@link HttpFetchOptions} for options and\n{@link HttpResponse} for the response.\n" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 295 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-public.HttpHandler.Unnamed", "type": "Any", "tags": [], "label": "Unnamed", "description": [], "signature": [ "any" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 296 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpHandler.Unnamed", "type": "Any", "tags": [], "label": "Unnamed", "description": [], "signature": [ "any" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 299 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpHandler.Unnamed", "type": "Any", "tags": [], "label": "Unnamed", "description": [], "signature": [ "any" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 302 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpHandler.Unnamed", "type": "Any", "tags": [], "label": "Unnamed", "description": [], "signature": [ "any" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 303 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-public.HttpHeadersInit", "type": "Interface", "tags": [], "label": "HttpHeadersInit", "description": [ "\nHeaders to append to the request. Any headers that begin with `kbn-` are considered private to Core and will cause\n{@link HttpHandler} to throw an error." ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 144 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-public.HttpHeadersInit.Unnamed", "type": "Any", "tags": [], "label": "Unnamed", "description": [], "signature": [ "any" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 145 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-public.HttpInterceptor", "type": "Interface", "tags": [], "label": "HttpInterceptor", "description": [ "\nAn object that may define global interceptor functions for different parts of the request and response lifecycle.\nSee {@link IHttpInterceptController}.\n" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 362 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-public.HttpInterceptor.request", "type": "Function", "tags": [], "label": "request", "description": [ "\nDefine an interceptor to be executed before a request is sent." ], "signature": [ "((fetchOptions: Readonly<", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpFetchOptionsWithPath", "text": "HttpFetchOptionsWithPath" }, ">, controller: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.IHttpInterceptController", "text": "IHttpInterceptController" }, ") => void | Partial<", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpFetchOptionsWithPath", "text": "HttpFetchOptionsWithPath" }, "> | Promise>) | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 368 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-public.HttpInterceptor.request.$1", "type": "Object", "tags": [], "label": "fetchOptions", "description": [], "signature": [ "Readonly<", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpFetchOptionsWithPath", "text": "HttpFetchOptionsWithPath" }, ">" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 369 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "core", "id": "def-public.HttpInterceptor.request.$2", "type": "Object", "tags": [], "label": "controller", "description": [], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.IHttpInterceptController", "text": "IHttpInterceptController" } ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 370 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", "id": "def-public.HttpInterceptor.requestError", "type": "Function", "tags": [], "label": "requestError", "description": [ "\nDefine an interceptor to be executed if a request interceptor throws an error or returns a rejected Promise." ], "signature": [ "((httpErrorRequest: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpInterceptorRequestError", "text": "HttpInterceptorRequestError" }, ", controller: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.IHttpInterceptController", "text": "IHttpInterceptController" }, ") => void | Partial<", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpFetchOptionsWithPath", "text": "HttpFetchOptionsWithPath" }, "> | Promise>) | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 378 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-public.HttpInterceptor.requestError.$1", "type": "Object", "tags": [], "label": "httpErrorRequest", "description": [], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpInterceptorRequestError", "text": "HttpInterceptorRequestError" } ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 379 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "core", "id": "def-public.HttpInterceptor.requestError.$2", "type": "Object", "tags": [], "label": "controller", "description": [], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.IHttpInterceptController", "text": "IHttpInterceptController" } ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 380 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", "id": "def-public.HttpInterceptor.response", "type": "Function", "tags": [], "label": "response", "description": [ "\nDefine an interceptor to be executed after a response is received." ], "signature": [ "((httpResponse: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpResponse", "text": "HttpResponse" }, ", controller: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.IHttpInterceptController", "text": "IHttpInterceptController" }, ") => void | ", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.IHttpResponseInterceptorOverrides", "text": "IHttpResponseInterceptorOverrides" }, " | Promise<", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.IHttpResponseInterceptorOverrides", "text": "IHttpResponseInterceptorOverrides" }, ">) | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 388 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-public.HttpInterceptor.response.$1", "type": "Object", "tags": [], "label": "httpResponse", "description": [], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpResponse", "text": "HttpResponse" }, "" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 389 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "core", "id": "def-public.HttpInterceptor.response.$2", "type": "Object", "tags": [], "label": "controller", "description": [], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.IHttpInterceptController", "text": "IHttpInterceptController" } ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 390 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", "id": "def-public.HttpInterceptor.responseError", "type": "Function", "tags": [], "label": "responseError", "description": [ "\nDefine an interceptor to be executed if a response interceptor throws an error or returns a rejected Promise." ], "signature": [ "((httpErrorResponse: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpInterceptorResponseError", "text": "HttpInterceptorResponseError" }, ", controller: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.IHttpInterceptController", "text": "IHttpInterceptController" }, ") => void | ", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.IHttpResponseInterceptorOverrides", "text": "IHttpResponseInterceptorOverrides" }, " | Promise<", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.IHttpResponseInterceptorOverrides", "text": "IHttpResponseInterceptorOverrides" }, ">) | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 398 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-public.HttpInterceptor.responseError.$1", "type": "Object", "tags": [], "label": "httpErrorResponse", "description": [], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpInterceptorResponseError", "text": "HttpInterceptorResponseError" } ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 399 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "core", "id": "def-public.HttpInterceptor.responseError.$2", "type": "Object", "tags": [], "label": "controller", "description": [], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.IHttpInterceptController", "text": "IHttpInterceptController" } ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 400 }, "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-public.HttpInterceptorRequestError", "type": "Interface", "tags": [], "label": "HttpInterceptorRequestError", "description": [], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 351 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-public.HttpInterceptorRequestError.fetchOptions", "type": "Object", "tags": [], "label": "fetchOptions", "description": [], "signature": [ "{ readonly path: string; readonly query?: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpFetchQuery", "text": "HttpFetchQuery" }, " | undefined; readonly prependBasePath?: boolean | undefined; readonly headers?: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpHeadersInit", "text": "HttpHeadersInit" }, " | undefined; readonly asSystemRequest?: boolean | undefined; readonly asResponse?: boolean | undefined; readonly body?: string | Blob | ArrayBufferView | ArrayBuffer | FormData | URLSearchParams | ReadableStream | null | undefined; readonly cache?: \"default\" | \"reload\" | \"force-cache\" | \"no-cache\" | \"no-store\" | \"only-if-cached\" | undefined; readonly credentials?: \"include\" | \"omit\" | \"same-origin\" | undefined; readonly integrity?: string | undefined; readonly keepalive?: boolean | undefined; readonly method?: string | undefined; readonly mode?: \"same-origin\" | \"cors\" | \"navigate\" | \"no-cors\" | undefined; readonly redirect?: \"error\" | \"follow\" | \"manual\" | undefined; readonly referrer?: string | undefined; readonly referrerPolicy?: \"\" | \"origin\" | \"no-referrer\" | \"unsafe-url\" | \"same-origin\" | \"no-referrer-when-downgrade\" | \"origin-when-cross-origin\" | \"strict-origin\" | \"strict-origin-when-cross-origin\" | undefined; readonly signal?: AbortSignal | null | undefined; readonly window?: null | undefined; }" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 352 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpInterceptorRequestError.error", "type": "Object", "tags": [], "label": "error", "description": [], "signature": [ "Error" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 353 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-public.HttpInterceptorResponseError", "type": "Interface", "tags": [], "label": "HttpInterceptorResponseError", "description": [], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpInterceptorResponseError", "text": "HttpInterceptorResponseError" }, " extends ", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpResponse", "text": "HttpResponse" }, "" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 346 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-public.HttpInterceptorResponseError.request", "type": "Object", "tags": [], "label": "request", "description": [], "signature": [ "{ readonly cache: RequestCache; readonly credentials: RequestCredentials; readonly destination: RequestDestination; readonly headers: Headers; readonly integrity: string; readonly isHistoryNavigation: boolean; readonly isReloadNavigation: boolean; readonly keepalive: boolean; readonly method: string; readonly mode: RequestMode; readonly redirect: RequestRedirect; readonly referrer: string; readonly referrerPolicy: ReferrerPolicy; readonly signal: AbortSignal; readonly url: string; readonly clone: () => Request; readonly body: ReadableStream | null; readonly bodyUsed: boolean; readonly arrayBuffer: () => Promise; readonly blob: () => Promise; readonly formData: () => Promise; readonly json: () => Promise; readonly text: () => Promise; }" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 347 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpInterceptorResponseError.error", "type": "CompoundType", "tags": [], "label": "error", "description": [], "signature": [ "Error | ", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.IHttpFetchError", "text": "IHttpFetchError" } ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 348 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-public.HttpRequestInit", "type": "Interface", "tags": [], "label": "HttpRequestInit", "description": [ "\nFetch API options available to {@link HttpHandler}s.\n" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 154 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-public.HttpRequestInit.body", "type": "CompoundType", "tags": [], "label": "body", "description": [ "\nA BodyInit object or null to set request's body." ], "signature": [ "string | Blob | ArrayBufferView | ArrayBuffer | FormData | URLSearchParams | ReadableStream | null | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 158 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpRequestInit.cache", "type": "CompoundType", "tags": [], "label": "cache", "description": [ "\nThe cache mode associated with request, which is a string indicating how the request will interact with the\nbrowser's cache when fetching." ], "signature": [ "\"default\" | \"reload\" | \"force-cache\" | \"no-cache\" | \"no-store\" | \"only-if-cached\" | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 164 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpRequestInit.credentials", "type": "CompoundType", "tags": [], "label": "credentials", "description": [ "\nThe credentials mode associated with request, which is a string indicating whether credentials will be sent with\nthe request always, never, or only when sent to a same-origin URL." ], "signature": [ "\"include\" | \"omit\" | \"same-origin\" | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 170 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpRequestInit.headers", "type": "Object", "tags": [], "label": "headers", "description": [ "{@link HttpHeadersInit}" ], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpHeadersInit", "text": "HttpHeadersInit" }, " | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 173 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpRequestInit.integrity", "type": "string", "tags": [], "label": "integrity", "description": [ "\nSubresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of\nmultiple hashes separated by whitespace." ], "signature": [ "string | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 179 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpRequestInit.keepalive", "type": "CompoundType", "tags": [], "label": "keepalive", "description": [ "Whether or not request can outlive the global in which it was created." ], "signature": [ "boolean | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 182 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpRequestInit.method", "type": "string", "tags": [], "label": "method", "description": [ "HTTP method, which is \"GET\" by default." ], "signature": [ "string | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 185 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpRequestInit.mode", "type": "CompoundType", "tags": [], "label": "mode", "description": [ "\nThe mode associated with request, which is a string indicating whether the request will use CORS, or will be\nrestricted to same-origin URLs." ], "signature": [ "\"same-origin\" | \"cors\" | \"navigate\" | \"no-cors\" | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 191 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpRequestInit.redirect", "type": "CompoundType", "tags": [], "label": "redirect", "description": [ "\nThe redirect mode associated with request, which is a string indicating how redirects for the request will be\nhandled during fetching. A request will follow redirects by default." ], "signature": [ "\"error\" | \"follow\" | \"manual\" | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 197 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpRequestInit.referrer", "type": "string", "tags": [], "label": "referrer", "description": [ "\nThe referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to\nindicate no referrer, and \"about:client\" when defaulting to the global's default. This is used during fetching to\ndetermine the value of the `Referer` header of the request being made." ], "signature": [ "string | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 204 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpRequestInit.referrerPolicy", "type": "CompoundType", "tags": [], "label": "referrerPolicy", "description": [ "\nThe referrer policy associated with request. This is used during fetching to compute the value of the request's\nreferrer." ], "signature": [ "\"\" | \"origin\" | \"no-referrer\" | \"unsafe-url\" | \"same-origin\" | \"no-referrer-when-downgrade\" | \"origin-when-cross-origin\" | \"strict-origin\" | \"strict-origin-when-cross-origin\" | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 210 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpRequestInit.signal", "type": "CompoundType", "tags": [], "label": "signal", "description": [ "\nReturns the signal associated with request, which is an AbortSignal object indicating whether or not request has\nbeen aborted, and its abort event handler." ], "signature": [ "AbortSignal | null | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 216 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpRequestInit.window", "type": "Uncategorized", "tags": [], "label": "window", "description": [ "\nCan only be null. Used to disassociate request from any Window." ], "signature": [ "null | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 221 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-public.HttpResponse", "type": "Interface", "tags": [], "label": "HttpResponse", "description": [], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpResponse", "text": "HttpResponse" }, "" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 307 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-public.HttpResponse.fetchOptions", "type": "Object", "tags": [], "label": "fetchOptions", "description": [ "The original {@link HttpFetchOptionsWithPath} used to send this request." ], "signature": [ "{ readonly path: string; readonly query?: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpFetchQuery", "text": "HttpFetchQuery" }, " | undefined; readonly prependBasePath?: boolean | undefined; readonly headers?: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpHeadersInit", "text": "HttpHeadersInit" }, " | undefined; readonly asSystemRequest?: boolean | undefined; readonly asResponse?: boolean | undefined; readonly body?: string | Blob | ArrayBufferView | ArrayBuffer | FormData | URLSearchParams | ReadableStream | null | undefined; readonly cache?: \"default\" | \"reload\" | \"force-cache\" | \"no-cache\" | \"no-store\" | \"only-if-cached\" | undefined; readonly credentials?: \"include\" | \"omit\" | \"same-origin\" | undefined; readonly integrity?: string | undefined; readonly keepalive?: boolean | undefined; readonly method?: string | undefined; readonly mode?: \"same-origin\" | \"cors\" | \"navigate\" | \"no-cors\" | undefined; readonly redirect?: \"error\" | \"follow\" | \"manual\" | undefined; readonly referrer?: string | undefined; readonly referrerPolicy?: \"\" | \"origin\" | \"no-referrer\" | \"unsafe-url\" | \"same-origin\" | \"no-referrer-when-downgrade\" | \"origin-when-cross-origin\" | \"strict-origin\" | \"strict-origin-when-cross-origin\" | undefined; readonly signal?: AbortSignal | null | undefined; readonly window?: null | undefined; }" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 309 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpResponse.request", "type": "Object", "tags": [], "label": "request", "description": [ "Raw request sent to Kibana server." ], "signature": [ "{ readonly cache: RequestCache; readonly credentials: RequestCredentials; readonly destination: RequestDestination; readonly headers: Headers; readonly integrity: string; readonly isHistoryNavigation: boolean; readonly isReloadNavigation: boolean; readonly keepalive: boolean; readonly method: string; readonly mode: RequestMode; readonly redirect: RequestRedirect; readonly referrer: string; readonly referrerPolicy: ReferrerPolicy; readonly signal: AbortSignal; readonly url: string; readonly clone: () => Request; readonly body: ReadableStream | null; readonly bodyUsed: boolean; readonly arrayBuffer: () => Promise; readonly blob: () => Promise; readonly formData: () => Promise; readonly json: () => Promise; readonly text: () => Promise; }" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 311 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpResponse.response", "type": "Object", "tags": [], "label": "response", "description": [ "Raw response received, may be undefined if there was an error." ], "signature": [ "Readonly | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 313 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpResponse.body", "type": "Uncategorized", "tags": [], "label": "body", "description": [ "Parsed body received, may be undefined if there was an error." ], "signature": [ "TResponseBody | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 315 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-public.HttpSetup", "type": "Interface", "tags": [], "label": "HttpSetup", "description": [], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 13 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-public.HttpSetup.basePath", "type": "Object", "tags": [], "label": "basePath", "description": [ "\nAPIs for manipulating the basePath on URL segments.\nSee {@link IBasePath}" ], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.IBasePath", "text": "IBasePath" } ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 18 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpSetup.anonymousPaths", "type": "Object", "tags": [], "label": "anonymousPaths", "description": [ "\nAPIs for denoting certain paths for not requiring authentication" ], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.IAnonymousPaths", "text": "IAnonymousPaths" } ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 23 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpSetup.externalUrl", "type": "Object", "tags": [], "label": "externalUrl", "description": [], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.IExternalUrl", "text": "IExternalUrl" } ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 25 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpSetup.intercept", "type": "Function", "tags": [], "label": "intercept", "description": [ "\nAdds a new {@link HttpInterceptor} to the global HTTP client." ], "signature": [ "(interceptor: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpInterceptor", "text": "HttpInterceptor" }, ") => () => void" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 32 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-public.HttpSetup.intercept.$1", "type": "Object", "tags": [], "label": "interceptor", "description": [ "a {@link HttpInterceptor}" ], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpInterceptor", "text": "HttpInterceptor" } ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 32 }, "deprecated": false, "isRequired": true } ], "returnComment": [ "a function for removing the attached interceptor." ] }, { "parentPluginId": "core", "id": "def-public.HttpSetup.fetch", "type": "Function", "tags": [], "label": "fetch", "description": [ "Makes an HTTP request. Defaults to a GET request unless overriden. See {@link HttpHandler} for options." ], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpHandler", "text": "HttpHandler" } ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 35 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpSetup.delete", "type": "Function", "tags": [], "label": "delete", "description": [ "Makes an HTTP request with the DELETE method. See {@link HttpHandler} for options." ], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpHandler", "text": "HttpHandler" } ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 37 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpSetup.get", "type": "Function", "tags": [], "label": "get", "description": [ "Makes an HTTP request with the GET method. See {@link HttpHandler} for options." ], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpHandler", "text": "HttpHandler" } ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 39 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpSetup.head", "type": "Function", "tags": [], "label": "head", "description": [ "Makes an HTTP request with the HEAD method. See {@link HttpHandler} for options." ], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpHandler", "text": "HttpHandler" } ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 41 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpSetup.options", "type": "Function", "tags": [], "label": "options", "description": [ "Makes an HTTP request with the OPTIONS method. See {@link HttpHandler} for options." ], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpHandler", "text": "HttpHandler" } ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 43 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpSetup.patch", "type": "Function", "tags": [], "label": "patch", "description": [ "Makes an HTTP request with the PATCH method. See {@link HttpHandler} for options." ], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpHandler", "text": "HttpHandler" } ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 45 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpSetup.post", "type": "Function", "tags": [], "label": "post", "description": [ "Makes an HTTP request with the POST method. See {@link HttpHandler} for options." ], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpHandler", "text": "HttpHandler" } ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 47 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpSetup.put", "type": "Function", "tags": [], "label": "put", "description": [ "Makes an HTTP request with the PUT method. See {@link HttpHandler} for options." ], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpHandler", "text": "HttpHandler" } ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 49 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.HttpSetup.addLoadingCountSource", "type": "Function", "tags": [], "label": "addLoadingCountSource", "description": [ "\nAdds a new source of loading counts. Used to show the global loading indicator when sum of all observed counts are\nmore than 0." ], "signature": [ "(countSource$: ", "Observable", ") => void" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 56 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-public.HttpSetup.addLoadingCountSource.$1", "type": "Object", "tags": [], "label": "countSource$", "description": [ "an Observable to subscribe to for loading count updates." ], "signature": [ "Observable", "" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 56 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", "id": "def-public.HttpSetup.getLoadingCount$", "type": "Function", "tags": [], "label": "getLoadingCount$", "description": [ "\nGet the sum of all loading count sources as a single Observable." ], "signature": [ "() => ", "Observable", "" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 61 }, "deprecated": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-public.IAnonymousPaths", "type": "Interface", "tags": [], "label": "IAnonymousPaths", "description": [ "\nAPIs for denoting paths as not requiring authentication" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 127 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-public.IAnonymousPaths.isAnonymous", "type": "Function", "tags": [], "label": "isAnonymous", "description": [ "\nDetermines whether the provided path doesn't require authentication. `path` should include the current basePath." ], "signature": [ "(path: string) => boolean" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 131 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-public.IAnonymousPaths.isAnonymous.$1", "type": "string", "tags": [], "label": "path", "description": [], "signature": [ "string" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 131 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", "id": "def-public.IAnonymousPaths.register", "type": "Function", "tags": [], "label": "register", "description": [ "\nRegister `path` as not requiring authentication. `path` should not include the current basePath." ], "signature": [ "(path: string) => void" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 136 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-public.IAnonymousPaths.register.$1", "type": "string", "tags": [], "label": "path", "description": [], "signature": [ "string" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 136 }, "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-public.IBasePath", "type": "Interface", "tags": [], "label": "IBasePath", "description": [ "\nAPIs for manipulating the basePath on URL segments." ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 74 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-public.IBasePath.get", "type": "Function", "tags": [], "label": "get", "description": [ "\nGets the `basePath` string." ], "signature": [ "() => string" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 78 }, "deprecated": false, "returnComment": [], "children": [] }, { "parentPluginId": "core", "id": "def-public.IBasePath.prepend", "type": "Function", "tags": [], "label": "prepend", "description": [ "\nPrepends `path` with the basePath." ], "signature": [ "(url: string) => string" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 83 }, "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", "id": "def-public.url", "type": "string", "tags": [], "label": "url", "description": [], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 83 }, "deprecated": false } ] }, { "parentPluginId": "core", "id": "def-public.IBasePath.remove", "type": "Function", "tags": [], "label": "remove", "description": [ "\nRemoves the prepended basePath from the `path`." ], "signature": [ "(url: string) => string" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 88 }, "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", "id": "def-public.url", "type": "string", "tags": [], "label": "url", "description": [], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 88 }, "deprecated": false } ] }, { "parentPluginId": "core", "id": "def-public.IBasePath.serverBasePath", "type": "string", "tags": [], "label": "serverBasePath", "description": [ "\nReturns the server's root basePath as configured, without any namespace prefix.\n\nSee {@link BasePath.get} for getting the basePath value for a specific request" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 95 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.IBasePath.publicBaseUrl", "type": "string", "tags": [], "label": "publicBaseUrl", "description": [ "\nThe server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the\n{@link IBasePath.serverBasePath}.\n" ], "signature": [ "string | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 104 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-public.IExternalUrl", "type": "Interface", "tags": [], "label": "IExternalUrl", "description": [ "\nAPIs for working with external URLs.\n" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 111 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-public.IExternalUrl.validateUrl", "type": "Function", "tags": [], "label": "validateUrl", "description": [ "\nDetermines if the provided URL is a valid location to send users.\nValidation is based on the configured allow list in kibana.yml.\n\nIf the URL is valid, then a URL will be returned.\nOtherwise, this will return null.\n" ], "signature": [ "(relativeOrAbsoluteUrl: string) => URL | null" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 121 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-public.IExternalUrl.validateUrl.$1", "type": "string", "tags": [], "label": "relativeOrAbsoluteUrl", "description": [], "signature": [ "string" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 121 }, "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-public.IHttpFetchError", "type": "Interface", "tags": [], "label": "IHttpFetchError", "description": [], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.IHttpFetchError", "text": "IHttpFetchError" }, " extends Error" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 330 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-public.IHttpFetchError.name", "type": "string", "tags": [], "label": "name", "description": [], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 331 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.IHttpFetchError.request", "type": "Object", "tags": [], "label": "request", "description": [], "signature": [ "Request" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 332 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.IHttpFetchError.response", "type": "Object", "tags": [], "label": "response", "description": [], "signature": [ "Response | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 333 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.IHttpFetchError.req", "type": "Object", "tags": [ "deprecated" ], "label": "req", "description": [], "signature": [ "Request" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 337 }, "deprecated": true, "references": [ { "plugin": "ml", "link": { "path": "x-pack/plugins/ml/common/util/errors/errors.test.ts", "lineNumber": 44 } }, { "plugin": "ml", "link": { "path": "x-pack/plugins/ml/common/util/errors/errors.test.ts", "lineNumber": 58 } } ] }, { "parentPluginId": "core", "id": "def-public.IHttpFetchError.res", "type": "Object", "tags": [ "deprecated" ], "label": "res", "description": [], "signature": [ "Response | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 341 }, "deprecated": true, "references": [] }, { "parentPluginId": "core", "id": "def-public.IHttpFetchError.body", "type": "Any", "tags": [], "label": "body", "description": [], "signature": [ "any" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 342 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-public.IHttpInterceptController", "type": "Interface", "tags": [], "label": "IHttpInterceptController", "description": [ "\nUsed to halt a request Promise chain in a {@link HttpInterceptor}." ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 408 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-public.IHttpInterceptController.halted", "type": "boolean", "tags": [], "label": "halted", "description": [ "Whether or not this chain has been halted." ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 410 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.IHttpInterceptController.halt", "type": "Function", "tags": [], "label": "halt", "description": [ "Halt the request Promise chain and do not process further interceptors or response handlers." ], "signature": [ "() => void" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 412 }, "deprecated": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-public.IHttpResponseInterceptorOverrides", "type": "Interface", "tags": [], "label": "IHttpResponseInterceptorOverrides", "description": [ "\nProperties that can be returned by HttpInterceptor.request to override the response." ], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.IHttpResponseInterceptorOverrides", "text": "IHttpResponseInterceptorOverrides" }, "" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 322 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-public.IHttpResponseInterceptorOverrides.response", "type": "Object", "tags": [], "label": "response", "description": [ "Raw response received, may be undefined if there was an error." ], "signature": [ "Readonly | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 324 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-public.IHttpResponseInterceptorOverrides.body", "type": "Uncategorized", "tags": [], "label": "body", "description": [ "Parsed body received, may be undefined if there was an error." ], "signature": [ "TResponseBody | undefined" ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 326 }, "deprecated": false } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "core", "id": "def-public.HttpStart", "type": "Type", "tags": [], "label": "HttpStart", "description": [ "\nSee {@link HttpSetup}" ], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreHttpPluginApi", "section": "def-public.HttpSetup", "text": "HttpSetup" } ], "source": { "path": "src/core/public/http/types.ts", "lineNumber": 68 }, "deprecated": false, "initialIsOpen": false } ], "objects": [] }, "server": { "classes": [ { "parentPluginId": "core", "id": "def-server.BasePath", "type": "Class", "tags": [], "label": "BasePath", "description": [ "\nAccess or manipulate the Kibana base path\n" ], "source": { "path": "src/core/server/http/base_path_service.ts", "lineNumber": 18 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.BasePath.serverBasePath", "type": "string", "tags": [], "label": "serverBasePath", "description": [ "\nreturns the server's basePath\n\nSee {@link BasePath.get} for getting the basePath value for a specific request" ], "source": { "path": "src/core/server/http/base_path_service.ts", "lineNumber": 26 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.BasePath.publicBaseUrl", "type": "string", "tags": [], "label": "publicBaseUrl", "description": [ "\nThe server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the\n{@link BasePath.serverBasePath}.\n" ], "signature": [ "string | undefined" ], "source": { "path": "src/core/server/http/base_path_service.ts", "lineNumber": 34 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.BasePath.get", "type": "Function", "tags": [], "label": "get", "description": [ "\nreturns `basePath` value, specific for an incoming request." ], "signature": [ "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.LegacyRequest", "text": "LegacyRequest" }, ") => string" ], "source": { "path": "src/core/server/http/base_path_service.ts", "lineNumber": 45 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.BasePath.get.$1", "type": "CompoundType", "tags": [], "label": "request", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.LegacyRequest", "text": "LegacyRequest" } ], "source": { "path": "src/core/server/http/base_path_service.ts", "lineNumber": 45 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", "id": "def-server.BasePath.set", "type": "Function", "tags": [ "privateRemarks" ], "label": "set", "description": [ "\nsets `basePath` value, specific for an incoming request.\n" ], "signature": [ "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.LegacyRequest", "text": "LegacyRequest" }, ", requestSpecificBasePath: string) => void" ], "source": { "path": "src/core/server/http/base_path_service.ts", "lineNumber": 55 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.BasePath.set.$1", "type": "CompoundType", "tags": [], "label": "request", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.LegacyRequest", "text": "LegacyRequest" } ], "source": { "path": "src/core/server/http/base_path_service.ts", "lineNumber": 55 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "core", "id": "def-server.BasePath.set.$2", "type": "string", "tags": [], "label": "requestSpecificBasePath", "description": [], "signature": [ "string" ], "source": { "path": "src/core/server/http/base_path_service.ts", "lineNumber": 55 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", "id": "def-server.BasePath.prepend", "type": "Function", "tags": [], "label": "prepend", "description": [ "\nPrepends `path` with the basePath." ], "signature": [ "(path: string) => string" ], "source": { "path": "src/core/server/http/base_path_service.ts", "lineNumber": 69 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.BasePath.prepend.$1", "type": "string", "tags": [], "label": "path", "description": [], "signature": [ "string" ], "source": { "path": "src/core/server/http/base_path_service.ts", "lineNumber": 69 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", "id": "def-server.BasePath.remove", "type": "Function", "tags": [], "label": "remove", "description": [ "\nRemoves the prepended basePath from the `path`." ], "signature": [ "(path: string) => string" ], "source": { "path": "src/core/server/http/base_path_service.ts", "lineNumber": 81 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.BasePath.remove.$1", "type": "string", "tags": [], "label": "path", "description": [], "signature": [ "string" ], "source": { "path": "src/core/server/http/base_path_service.ts", "lineNumber": 81 }, "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.KibanaRequest", "type": "Class", "tags": [], "label": "KibanaRequest", "description": [ "\nKibana specific abstraction for an incoming request." ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, "" ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 90 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.KibanaRequest.id", "type": "string", "tags": [], "label": "id", "description": [ "\nA identifier to identify this request.\n" ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 144 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.KibanaRequest.uuid", "type": "string", "tags": [], "label": "uuid", "description": [ "\nA UUID to identify this request.\n" ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 152 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.KibanaRequest.url", "type": "Object", "tags": [], "label": "url", "description": [ "a WHATWG URL standard object." ], "signature": [ "URL" ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 154 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.KibanaRequest.route", "type": "Object", "tags": [], "label": "route", "description": [ "matched route details" ], "signature": [ "{ readonly path: string; readonly method: ", "RecursiveReadonly", "; readonly options: ", "RecursiveReadonly", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequestRouteOptions", "text": "KibanaRequestRouteOptions" }, ">; }" ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 156 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.KibanaRequest.headers", "type": "CompoundType", "tags": [], "label": "headers", "description": [ "\nReadonly copy of incoming request headers." ], "signature": [ "{ accept?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; allow?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; date?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; from?: string | string[] | undefined; host?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; location?: string | string[] | undefined; origin?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; range?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; warning?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 162 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.KibanaRequest.isSystemRequest", "type": "boolean", "tags": [], "label": "isSystemRequest", "description": [ "\nWhether or not the request is a \"system request\" rather than an application-level request.\nCan be set on the client using the `HttpFetchOptions#asSystemRequest` option." ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 167 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.KibanaRequest.socket", "type": "Object", "tags": [], "label": "socket", "description": [ "{@link IKibanaSocket}" ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.IKibanaSocket", "text": "IKibanaSocket" } ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 170 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.KibanaRequest.events", "type": "Object", "tags": [], "label": "events", "description": [ "Request events {@link KibanaRequestEvents}" ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequestEvents", "text": "KibanaRequestEvents" } ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 172 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.KibanaRequest.auth", "type": "Object", "tags": [], "label": "auth", "description": [], "signature": [ "{ isAuthenticated: boolean; }" ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 173 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.KibanaRequest.rewrittenUrl", "type": "Object", "tags": [], "label": "rewrittenUrl", "description": [ "\nURL rewritten in onPreRouting request interceptor." ], "signature": [ "URL", " | undefined" ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 181 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.KibanaRequest.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 186 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.KibanaRequest.Unnamed.$1", "type": "Object", "tags": [], "label": "request", "description": [], "signature": [ "Request" ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 187 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "core", "id": "def-server.KibanaRequest.Unnamed.$2", "type": "Uncategorized", "tags": [], "label": "params", "description": [], "signature": [ "Params" ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 188 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "core", "id": "def-server.KibanaRequest.Unnamed.$3", "type": "Uncategorized", "tags": [], "label": "query", "description": [], "signature": [ "Query" ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 189 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "core", "id": "def-server.KibanaRequest.Unnamed.$4", "type": "Uncategorized", "tags": [], "label": "body", "description": [], "signature": [ "Body" ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 190 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "core", "id": "def-server.KibanaRequest.Unnamed.$5", "type": "boolean", "tags": [], "label": "withoutSecretHeaders", "description": [], "signature": [ "boolean" ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 193 }, "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.RouteValidationError", "type": "Class", "tags": [], "label": "RouteValidationError", "description": [ "\nError to return when the validation is not successful." ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteValidationError", "text": "RouteValidationError" }, " extends ", "SchemaTypeError" ], "source": { "path": "src/core/server/http/router/validator/validator_error.ts", "lineNumber": 15 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.RouteValidationError.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "source": { "path": "src/core/server/http/router/validator/validator_error.ts", "lineNumber": 16 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.RouteValidationError.Unnamed.$1", "type": "CompoundType", "tags": [], "label": "error", "description": [], "signature": [ "string | Error" ], "source": { "path": "src/core/server/http/router/validator/validator_error.ts", "lineNumber": 16 }, "deprecated": false, "isRequired": true }, { "parentPluginId": "core", "id": "def-server.RouteValidationError.Unnamed.$2", "type": "Array", "tags": [], "label": "path", "description": [], "signature": [ "string[]" ], "source": { "path": "src/core/server/http/router/validator/validator_error.ts", "lineNumber": 16 }, "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false } ], "functions": [], "interfaces": [ { "parentPluginId": "core", "id": "def-server.Authenticated", "type": "Interface", "tags": [], "label": "Authenticated", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.Authenticated", "text": "Authenticated" }, " extends ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.AuthResultParams", "text": "AuthResultParams" } ], "source": { "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 29 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.Authenticated.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.AuthResultType", "text": "AuthResultType" }, ".authenticated" ], "source": { "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 30 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.AuthNotHandled", "type": "Interface", "tags": [], "label": "AuthNotHandled", "description": [], "source": { "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 34 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.AuthNotHandled.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.AuthResultType", "text": "AuthResultType" }, ".notHandled" ], "source": { "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 35 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.AuthRedirected", "type": "Interface", "tags": [], "label": "AuthRedirected", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.AuthRedirected", "text": "AuthRedirected" }, " extends ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.AuthRedirectedParams", "text": "AuthRedirectedParams" } ], "source": { "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 39 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.AuthRedirected.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.AuthResultType", "text": "AuthResultType" }, ".redirected" ], "source": { "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 40 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.AuthRedirectedParams", "type": "Interface", "tags": [], "label": "AuthRedirectedParams", "description": [ "\nResult of auth redirection." ], "source": { "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 109 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.AuthRedirectedParams.headers", "type": "CompoundType", "tags": [], "label": "headers", "description": [ "\nHeaders to attach for auth redirect.\nMust include \"location\" header" ], "signature": [ "({ location: string; } & Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]>) | ({ location: string; } & Record)" ], "source": { "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 114 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.AuthResultParams", "type": "Interface", "tags": [], "label": "AuthResultParams", "description": [ "\nResult of successful authentication." ], "source": { "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 88 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.AuthResultParams.state", "type": "Object", "tags": [], "label": "state", "description": [ "\nData to associate with an incoming request. Any downstream plugin may get access to the data." ], "signature": [ "Record | undefined" ], "source": { "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 92 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.AuthResultParams.requestHeaders", "type": "Object", "tags": [], "label": "requestHeaders", "description": [ "\nAuth specific headers to attach to a request object.\nUsed to perform a request to Elasticsearch on behalf of an authenticated user." ], "signature": [ "Record | undefined" ], "source": { "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 97 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.AuthResultParams.responseHeaders", "type": "Object", "tags": [], "label": "responseHeaders", "description": [ "\nAuth specific headers to attach to a response object.\nUsed to send back authentication mechanism related headers to a client when needed." ], "signature": [ "Record | undefined" ], "source": { "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 102 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.AuthToolkit", "type": "Interface", "tags": [], "label": "AuthToolkit", "description": [], "source": { "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 121 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.AuthToolkit.authenticated", "type": "Function", "tags": [], "label": "authenticated", "description": [ "Authentication is successful with given credentials, allow request to pass through" ], "signature": [ "(data?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.AuthResultParams", "text": "AuthResultParams" }, " | undefined) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.AuthResult", "text": "AuthResult" } ], "source": { "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 123 }, "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", "id": "def-server.data", "type": "Object", "tags": [], "label": "data", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.AuthResultParams", "text": "AuthResultParams" }, " | undefined" ], "source": { "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 123 }, "deprecated": false } ] }, { "parentPluginId": "core", "id": "def-server.AuthToolkit.notHandled", "type": "Function", "tags": [], "label": "notHandled", "description": [ "\nUser has no credentials.\nAllows user to access a resource when authRequired is 'optional'\nRejects a request when authRequired: true" ], "signature": [ "() => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.AuthResult", "text": "AuthResult" } ], "source": { "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 129 }, "deprecated": false, "returnComment": [], "children": [] }, { "parentPluginId": "core", "id": "def-server.AuthToolkit.redirected", "type": "Function", "tags": [], "label": "redirected", "description": [ "\nRedirects user to another location to complete authentication when authRequired: true\nAllows user to access a resource without redirection when authRequired: 'optional'" ], "signature": [ "(headers: ({ location: string; } & Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]>) | ({ location: string; } & Record)) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.AuthResult", "text": "AuthResult" } ], "source": { "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 134 }, "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", "id": "def-server.headers", "type": "CompoundType", "tags": [], "label": "headers", "description": [], "signature": [ "({ location: string; } & Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]>) | ({ location: string; } & Record)" ], "source": { "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 134 }, "deprecated": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.CustomHttpResponseOptions", "type": "Interface", "tags": [], "label": "CustomHttpResponseOptions", "description": [ "\nHTTP response parameters for a response with adjustable status code." ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "" ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 79 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.CustomHttpResponseOptions.body", "type": "Uncategorized", "tags": [], "label": "body", "description": [ "HTTP message to send to the client" ], "signature": [ "T | undefined" ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 81 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.CustomHttpResponseOptions.headers", "type": "CompoundType", "tags": [], "label": "headers", "description": [ "HTTP Headers with additional information about response" ], "signature": [ "Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record | undefined" ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 83 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.CustomHttpResponseOptions.bypassErrorFormat", "type": "CompoundType", "tags": [], "label": "bypassErrorFormat", "description": [ "Bypass the default error formatting" ], "signature": [ "boolean | undefined" ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 85 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.CustomHttpResponseOptions.statusCode", "type": "number", "tags": [], "label": "statusCode", "description": [], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 86 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.ErrorHttpResponseOptions", "type": "Interface", "tags": [], "label": "ErrorHttpResponseOptions", "description": [ "\nHTTP response parameters" ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 103 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.ErrorHttpResponseOptions.body", "type": "CompoundType", "tags": [], "label": "body", "description": [ "HTTP message to send to the client" ], "signature": [ "string | Error | { message: string | Error; attributes?: Record | undefined; } | undefined" ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 105 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.ErrorHttpResponseOptions.headers", "type": "CompoundType", "tags": [], "label": "headers", "description": [ "HTTP Headers with additional information about response" ], "signature": [ "Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record | undefined" ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 107 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.HttpAuth", "type": "Interface", "tags": [], "label": "HttpAuth", "description": [], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 46 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.HttpAuth.get", "type": "Function", "tags": [], "label": "get", "description": [ "\nGets authentication state for a request. Returned by `auth` interceptor.\n{@link GetAuthState}" ], "signature": [ "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.LegacyRequest", "text": "LegacyRequest" }, ") => { status: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.AuthStatus", "text": "AuthStatus" }, "; state: T; }" ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 51 }, "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", "id": "def-server.request", "type": "CompoundType", "tags": [], "label": "request", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.LegacyRequest", "text": "LegacyRequest" } ], "source": { "path": "src/core/server/http/auth_state_storage.ts", "lineNumber": 36 }, "deprecated": false } ] }, { "parentPluginId": "core", "id": "def-server.HttpAuth.isAuthenticated", "type": "Function", "tags": [], "label": "isAuthenticated", "description": [ "\nReturns authentication status for a request.\n{@link IsAuthenticated}" ], "signature": [ "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.LegacyRequest", "text": "LegacyRequest" }, ") => boolean" ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 56 }, "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", "id": "def-server.request", "type": "CompoundType", "tags": [], "label": "request", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.LegacyRequest", "text": "LegacyRequest" } ], "source": { "path": "src/core/server/http/auth_state_storage.ts", "lineNumber": 44 }, "deprecated": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.HttpResponseOptions", "type": "Interface", "tags": [], "label": "HttpResponseOptions", "description": [ "\nHTTP response parameters" ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 60 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.HttpResponseOptions.body", "type": "CompoundType", "tags": [], "label": "body", "description": [ "HTTP message to send to the client" ], "signature": [ "string | Record | Buffer | ", "Stream", " | undefined" ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 62 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.HttpResponseOptions.headers", "type": "CompoundType", "tags": [], "label": "headers", "description": [ "HTTP Headers with additional information about response" ], "signature": [ "Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record | undefined" ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 64 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.HttpResponseOptions.bypassErrorFormat", "type": "CompoundType", "tags": [], "label": "bypassErrorFormat", "description": [ "Bypass the default error formatting" ], "signature": [ "boolean | undefined" ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 66 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.HttpServerInfo", "type": "Interface", "tags": [], "label": "HttpServerInfo", "description": [ "\nInformation about what hostname, port, and protocol the server process is\nrunning on. Note that this may not match the URL that end-users access\nKibana at. For the public URL, see {@link BasePath.publicBaseUrl}." ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 341 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.HttpServerInfo.name", "type": "string", "tags": [], "label": "name", "description": [ "The name of the Kibana server" ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 343 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.HttpServerInfo.hostname", "type": "string", "tags": [], "label": "hostname", "description": [ "The hostname of the server" ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 345 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.HttpServerInfo.port", "type": "number", "tags": [], "label": "port", "description": [ "The port the server is listening on" ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 347 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.HttpServerInfo.protocol", "type": "CompoundType", "tags": [], "label": "protocol", "description": [ "The protocol used by the server" ], "signature": [ "\"http\" | \"https\" | \"socket\"" ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 349 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.HttpServiceSetup", "type": "Interface", "tags": [], "label": "HttpServiceSetup", "description": [ "\nKibana HTTP Service provides own abstraction for work with HTTP stack.\nPlugins don't have direct access to `hapi` server and its primitives anymore. Moreover,\nplugins shouldn't rely on the fact that HTTP Service uses one or another library under the hood.\nThis gives the platform flexibility to upgrade or changing our internal HTTP stack without breaking plugins.\nIf the HTTP Service lacks functionality you need, we are happy to discuss and support your needs.\n" ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 131 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.HttpServiceSetup.createCookieSessionStorageFactory", "type": "Function", "tags": [], "label": "createCookieSessionStorageFactory", "description": [ "\nCreates cookie based session storage factory {@link SessionStorageFactory}" ], "signature": [ "(cookieOptions: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.SessionStorageCookieOptions", "text": "SessionStorageCookieOptions" }, ") => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.SessionStorageFactory", "text": "SessionStorageFactory" }, ">" ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 136 }, "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", "id": "def-server.cookieOptions", "type": "Object", "tags": [], "label": "cookieOptions", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.SessionStorageCookieOptions", "text": "SessionStorageCookieOptions" }, "" ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 137 }, "deprecated": false } ] }, { "parentPluginId": "core", "id": "def-server.HttpServiceSetup.registerOnPreRouting", "type": "Function", "tags": [], "label": "registerOnPreRouting", "description": [ "\nTo define custom logic to perform for incoming requests before server performs a route lookup.\n" ], "signature": [ "(handler: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.OnPreRoutingHandler", "text": "OnPreRoutingHandler" }, ") => void" ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 150 }, "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", "id": "def-server.handler", "type": "Function", "tags": [], "label": "handler", "description": [], "signature": [ "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ", response: { badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; }, toolkit: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.OnPreRoutingToolkit", "text": "OnPreRoutingToolkit" }, ") => Next | RewriteUrl | ", "KibanaResponse", " | Promise>" ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 150 }, "deprecated": false } ] }, { "parentPluginId": "core", "id": "def-server.HttpServiceSetup.registerOnPreAuth", "type": "Function", "tags": [], "label": "registerOnPreAuth", "description": [ "\nTo define custom logic to perform for incoming requests before\nthe Auth interceptor performs a check that user has access to requested resources.\n" ], "signature": [ "(handler: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.OnPreAuthHandler", "text": "OnPreAuthHandler" }, ") => void" ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 162 }, "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", "id": "def-server.handler", "type": "Function", "tags": [], "label": "handler", "description": [], "signature": [ "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ", response: { badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; }, toolkit: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.OnPreAuthToolkit", "text": "OnPreAuthToolkit" }, ") => ", "KibanaResponse", " | Next | Promise<", "KibanaResponse", " | Next>" ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 162 }, "deprecated": false } ] }, { "parentPluginId": "core", "id": "def-server.HttpServiceSetup.registerAuth", "type": "Function", "tags": [], "label": "registerAuth", "description": [ "\nTo define custom authentication and/or authorization mechanism for incoming requests.\n" ], "signature": [ "(handler: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.AuthenticationHandler", "text": "AuthenticationHandler" }, ") => void" ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 174 }, "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", "id": "def-server.handler", "type": "Function", "tags": [], "label": "handler", "description": [], "signature": [ "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ", response: { badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; }, toolkit: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.AuthToolkit", "text": "AuthToolkit" }, ") => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.IKibanaResponse", "text": "IKibanaResponse" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.Authenticated", "text": "Authenticated" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.AuthNotHandled", "text": "AuthNotHandled" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.AuthRedirected", "text": "AuthRedirected" }, " | Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.IKibanaResponse", "text": "IKibanaResponse" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.Authenticated", "text": "Authenticated" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.AuthNotHandled", "text": "AuthNotHandled" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.AuthRedirected", "text": "AuthRedirected" }, ">" ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 174 }, "deprecated": false } ] }, { "parentPluginId": "core", "id": "def-server.HttpServiceSetup.registerOnPostAuth", "type": "Function", "tags": [], "label": "registerOnPostAuth", "description": [ "\nTo define custom logic after Auth interceptor did make sure a user has access to the requested resource.\n" ], "signature": [ "(handler: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.OnPostAuthHandler", "text": "OnPostAuthHandler" }, ") => void" ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 186 }, "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", "id": "def-server.handler", "type": "Function", "tags": [], "label": "handler", "description": [], "signature": [ "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ", response: { badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; }, toolkit: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.OnPostAuthToolkit", "text": "OnPostAuthToolkit" }, ") => ", "KibanaResponse", " | Next | Promise<", "KibanaResponse", " | Next>" ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 186 }, "deprecated": false } ] }, { "parentPluginId": "core", "id": "def-server.HttpServiceSetup.registerOnPreResponse", "type": "Function", "tags": [], "label": "registerOnPreResponse", "description": [ "\nTo define custom logic to perform for the server response.\n" ], "signature": [ "(handler: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.OnPreResponseHandler", "text": "OnPreResponseHandler" }, ") => void" ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 198 }, "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", "id": "def-server.handler", "type": "Function", "tags": [], "label": "handler", "description": [], "signature": [ "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ", preResponse: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.OnPreResponseInfo", "text": "OnPreResponseInfo" }, ", toolkit: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.OnPreResponseToolkit", "text": "OnPreResponseToolkit" }, ") => Render | Next | Promise" ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 198 }, "deprecated": false } ] }, { "parentPluginId": "core", "id": "def-server.HttpServiceSetup.basePath", "type": "Object", "tags": [], "label": "basePath", "description": [ "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." ], "signature": [ "{ remove: (path: string) => string; get: (request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.LegacyRequest", "text": "LegacyRequest" }, ") => string; set: (request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.LegacyRequest", "text": "LegacyRequest" }, ", requestSpecificBasePath: string) => void; prepend: (path: string) => string; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }" ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 204 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.HttpServiceSetup.auth", "type": "Object", "tags": [ "deprecated" ], "label": "auth", "description": [ "\nAuth status.\nSee {@link HttpAuth}\n" ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpAuth", "text": "HttpAuth" } ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 212 }, "deprecated": true, "references": [] }, { "parentPluginId": "core", "id": "def-server.HttpServiceSetup.csp", "type": "Object", "tags": [], "label": "csp", "description": [ "\nThe CSP config used for Kibana." ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.ICspConfig", "text": "ICspConfig" } ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 217 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.HttpServiceSetup.createRouter", "type": "Function", "tags": [], "label": "createRouter", "description": [ "\nProvides ability to declare a handler function for a particular path and HTTP request method.\n" ], "signature": [ "() => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.IRouter", "text": "IRouter" }, "" ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 234 }, "deprecated": false, "returnComment": [], "children": [] }, { "parentPluginId": "core", "id": "def-server.HttpServiceSetup.registerRouteHandlerContext", "type": "Function", "tags": [], "label": "registerRouteHandlerContext", "description": [ "\nRegister a context provider for a route handler." ], "signature": [ "(contextName: ContextName, provider: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.IContextProvider", "text": "IContextProvider" }, ") => ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.IContextContainer", "text": "IContextContainer" } ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 266 }, "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", "id": "def-server.contextName", "type": "Uncategorized", "tags": [], "label": "contextName", "description": [], "signature": [ "ContextName" ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 270 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.provider", "type": "Function", "tags": [], "label": "provider", "description": [], "signature": [ "(context: Pick>, request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ", response: { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", "Stream", " | undefined>(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, ") => ", "KibanaResponse", "; badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; ok: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; accepted: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; noContent: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", "; }) => Context[ContextName] | Promise" ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 271 }, "deprecated": false } ] }, { "parentPluginId": "core", "id": "def-server.HttpServiceSetup.getServerInfo", "type": "Function", "tags": [], "label": "getServerInfo", "description": [ "\nProvides common {@link HttpServerInfo | information} about the running http server." ], "signature": [ "() => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpServerInfo", "text": "HttpServerInfo" } ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 277 }, "deprecated": false, "returnComment": [], "children": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.HttpServiceStart", "type": "Interface", "tags": [], "label": "HttpServiceStart", "description": [], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 310 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.HttpServiceStart.basePath", "type": "Object", "tags": [], "label": "basePath", "description": [ "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." ], "signature": [ "{ remove: (path: string) => string; get: (request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.LegacyRequest", "text": "LegacyRequest" }, ") => string; set: (request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.LegacyRequest", "text": "LegacyRequest" }, ", requestSpecificBasePath: string) => void; prepend: (path: string) => string; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }" ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 315 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.HttpServiceStart.auth", "type": "Object", "tags": [], "label": "auth", "description": [ "\nAuth status.\nSee {@link HttpAuth}" ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpAuth", "text": "HttpAuth" } ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 321 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.HttpServiceStart.getServerInfo", "type": "Function", "tags": [], "label": "getServerInfo", "description": [ "\nProvides common {@link HttpServerInfo | information} about the running http server." ], "signature": [ "() => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpServerInfo", "text": "HttpServerInfo" } ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 326 }, "deprecated": false, "returnComment": [], "children": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.IKibanaResponse", "type": "Interface", "tags": [], "label": "IKibanaResponse", "description": [ "\nA response data object, expected to returned as a result of {@link RequestHandler} execution" ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.IKibanaResponse", "text": "IKibanaResponse" }, "" ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 33 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.IKibanaResponse.status", "type": "number", "tags": [], "label": "status", "description": [], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 34 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.IKibanaResponse.payload", "type": "Uncategorized", "tags": [], "label": "payload", "description": [], "signature": [ "T | undefined" ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 35 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.IKibanaResponse.options", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" } ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 36 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.IKibanaSocket", "type": "Interface", "tags": [], "label": "IKibanaSocket", "description": [ "\nA tiny abstraction for TCP socket." ], "source": { "path": "src/core/server/http/router/socket.ts", "lineNumber": 17 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.IKibanaSocket.getPeerCertificate", "type": "Function", "tags": [], "label": "getPeerCertificate", "description": [], "signature": [ "{ (detailed: true): ", "DetailedPeerCertificate", " | null; (detailed: false): ", "PeerCertificate", " | null; (detailed?: boolean | undefined): ", "DetailedPeerCertificate", " | ", "PeerCertificate", " | null; }" ], "source": { "path": "src/core/server/http/router/socket.ts", "lineNumber": 18 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.IKibanaSocket.getPeerCertificate.$1", "type": "boolean", "tags": [], "label": "detailed", "description": [], "signature": [ "true" ], "source": { "path": "src/core/server/http/router/socket.ts", "lineNumber": 18 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", "id": "def-server.IKibanaSocket.getPeerCertificate", "type": "Function", "tags": [], "label": "getPeerCertificate", "description": [], "signature": [ "{ (detailed: true): ", "DetailedPeerCertificate", " | null; (detailed: false): ", "PeerCertificate", " | null; (detailed?: boolean | undefined): ", "DetailedPeerCertificate", " | ", "PeerCertificate", " | null; }" ], "source": { "path": "src/core/server/http/router/socket.ts", "lineNumber": 19 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.IKibanaSocket.getPeerCertificate.$1", "type": "boolean", "tags": [], "label": "detailed", "description": [], "signature": [ "false" ], "source": { "path": "src/core/server/http/router/socket.ts", "lineNumber": 19 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", "id": "def-server.IKibanaSocket.getPeerCertificate", "type": "Function", "tags": [], "label": "getPeerCertificate", "description": [ "\nReturns an object representing the peer's certificate.\nThe returned object has some properties corresponding to the field of the certificate.\nIf detailed argument is true the full chain with issuer property will be returned,\nif false only the top certificate without issuer property.\nIf the peer does not provide a certificate, it returns null." ], "signature": [ "{ (detailed: true): ", "DetailedPeerCertificate", " | null; (detailed: false): ", "PeerCertificate", " | null; (detailed?: boolean | undefined): ", "DetailedPeerCertificate", " | ", "PeerCertificate", " | null; }" ], "source": { "path": "src/core/server/http/router/socket.ts", "lineNumber": 29 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.IKibanaSocket.getPeerCertificate.$1", "type": "CompoundType", "tags": [], "label": "detailed", "description": [ "- If true; the full chain with issuer property will be returned." ], "signature": [ "boolean | undefined" ], "source": { "path": "src/core/server/http/router/socket.ts", "lineNumber": 29 }, "deprecated": false, "isRequired": false } ], "returnComment": [ "An object representing the peer's certificate." ] }, { "parentPluginId": "core", "id": "def-server.IKibanaSocket.getProtocol", "type": "Function", "tags": [], "label": "getProtocol", "description": [ "\nReturns a string containing the negotiated SSL/TLS protocol version of the current connection. The value 'unknown' will be returned for\nconnected sockets that have not completed the handshaking process. The value null will be returned for server sockets or disconnected\nclient sockets. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_get_version.html for more information." ], "signature": [ "() => string | null" ], "source": { "path": "src/core/server/http/router/socket.ts", "lineNumber": 36 }, "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "core", "id": "def-server.IKibanaSocket.renegotiate", "type": "Function", "tags": [], "label": "renegotiate", "description": [ "\nRenegotiates a connection to obtain the peer's certificate. This cannot be used when the protocol version is TLSv1.3." ], "signature": [ "(options: { rejectUnauthorized?: boolean | undefined; requestCert?: boolean | undefined; }) => Promise" ], "source": { "path": "src/core/server/http/router/socket.ts", "lineNumber": 43 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.IKibanaSocket.renegotiate.$1.options", "type": "Object", "tags": [], "label": "options", "description": [], "source": { "path": "src/core/server/http/router/socket.ts", "lineNumber": 43 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.IKibanaSocket.renegotiate.$1.options.rejectUnauthorized", "type": "CompoundType", "tags": [], "label": "rejectUnauthorized", "description": [], "signature": [ "boolean | undefined" ], "source": { "path": "src/core/server/http/router/socket.ts", "lineNumber": 43 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.IKibanaSocket.renegotiate.$1.options.requestCert", "type": "CompoundType", "tags": [], "label": "requestCert", "description": [], "signature": [ "boolean | undefined" ], "source": { "path": "src/core/server/http/router/socket.ts", "lineNumber": 43 }, "deprecated": false } ] } ], "returnComment": [ "A Promise that will be resolved if renegotiation succeeded, or will be rejected if renegotiation failed." ] }, { "parentPluginId": "core", "id": "def-server.IKibanaSocket.authorized", "type": "CompoundType", "tags": [], "label": "authorized", "description": [ "\nIndicates whether or not the peer certificate was signed by one of the specified CAs. When TLS\nisn't used the value is `undefined`." ], "signature": [ "boolean | undefined" ], "source": { "path": "src/core/server/http/router/socket.ts", "lineNumber": 49 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.IKibanaSocket.authorizationError", "type": "Object", "tags": [], "label": "authorizationError", "description": [ "\nThe reason why the peer's certificate has not been verified. This property becomes available\nonly when `authorized` is `false`." ], "signature": [ "Error | undefined" ], "source": { "path": "src/core/server/http/router/socket.ts", "lineNumber": 55 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.IRouter", "type": "Interface", "tags": [], "label": "IRouter", "description": [ "\nRegisters route handlers for specified resource path and method.\nSee {@link RouteConfig} and {@link RequestHandler} for more information about arguments to route registrations.\n" ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.IRouter", "text": "IRouter" }, "" ], "source": { "path": "src/core/server/http/router/router.ts", "lineNumber": 62 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.IRouter.routerPath", "type": "string", "tags": [], "label": "routerPath", "description": [ "\nResulted path" ], "source": { "path": "src/core/server/http/router/router.ts", "lineNumber": 66 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.IRouter.get", "type": "Function", "tags": [], "label": "get", "description": [ "\nRegister a route handler for `GET` request." ], "signature": [ "(route: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteConfig", "text": "RouteConfig" }, ", handler: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RequestHandler", "text": "RequestHandler" }, " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", "Stream", " | undefined>(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, ") => ", "KibanaResponse", "; badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; ok: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; accepted: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; noContent: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", "; }>) => void" ], "source": { "path": "src/core/server/http/router/router.ts", "lineNumber": 73 }, "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", "id": "def-server.route", "type": "Object", "tags": [], "label": "route", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteConfig", "text": "RouteConfig" }, "" ], "source": { "path": "src/core/server/http/router/router.ts", "lineNumber": 52 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.handler", "type": "Function", "tags": [], "label": "handler", "description": [], "signature": [ "(context: Context, request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ", response: { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", "Stream", " | undefined>(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, ") => ", "KibanaResponse", "; badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; ok: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; accepted: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; noContent: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", "; }) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.IKibanaResponse", "text": "IKibanaResponse" }, " | Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.IKibanaResponse", "text": "IKibanaResponse" }, ">" ], "source": { "path": "src/core/server/http/router/router.ts", "lineNumber": 53 }, "deprecated": false } ] }, { "parentPluginId": "core", "id": "def-server.IRouter.post", "type": "Function", "tags": [], "label": "post", "description": [ "\nRegister a route handler for `POST` request." ], "signature": [ "(route: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteConfig", "text": "RouteConfig" }, ", handler: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RequestHandler", "text": "RequestHandler" }, " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", "Stream", " | undefined>(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, ") => ", "KibanaResponse", "; badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; ok: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; accepted: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; noContent: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", "; }>) => void" ], "source": { "path": "src/core/server/http/router/router.ts", "lineNumber": 80 }, "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", "id": "def-server.route", "type": "Object", "tags": [], "label": "route", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteConfig", "text": "RouteConfig" }, "" ], "source": { "path": "src/core/server/http/router/router.ts", "lineNumber": 52 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.handler", "type": "Function", "tags": [], "label": "handler", "description": [], "signature": [ "(context: Context, request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ", response: { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", "Stream", " | undefined>(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, ") => ", "KibanaResponse", "; badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; ok: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; accepted: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; noContent: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", "; }) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.IKibanaResponse", "text": "IKibanaResponse" }, " | Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.IKibanaResponse", "text": "IKibanaResponse" }, ">" ], "source": { "path": "src/core/server/http/router/router.ts", "lineNumber": 53 }, "deprecated": false } ] }, { "parentPluginId": "core", "id": "def-server.IRouter.put", "type": "Function", "tags": [], "label": "put", "description": [ "\nRegister a route handler for `PUT` request." ], "signature": [ "(route: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteConfig", "text": "RouteConfig" }, ", handler: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RequestHandler", "text": "RequestHandler" }, " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", "Stream", " | undefined>(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, ") => ", "KibanaResponse", "; badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; ok: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; accepted: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; noContent: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", "; }>) => void" ], "source": { "path": "src/core/server/http/router/router.ts", "lineNumber": 87 }, "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", "id": "def-server.route", "type": "Object", "tags": [], "label": "route", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteConfig", "text": "RouteConfig" }, "" ], "source": { "path": "src/core/server/http/router/router.ts", "lineNumber": 52 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.handler", "type": "Function", "tags": [], "label": "handler", "description": [], "signature": [ "(context: Context, request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ", response: { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", "Stream", " | undefined>(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, ") => ", "KibanaResponse", "; badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; ok: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; accepted: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; noContent: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", "; }) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.IKibanaResponse", "text": "IKibanaResponse" }, " | Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.IKibanaResponse", "text": "IKibanaResponse" }, ">" ], "source": { "path": "src/core/server/http/router/router.ts", "lineNumber": 53 }, "deprecated": false } ] }, { "parentPluginId": "core", "id": "def-server.IRouter.patch", "type": "Function", "tags": [], "label": "patch", "description": [ "\nRegister a route handler for `PATCH` request." ], "signature": [ "(route: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteConfig", "text": "RouteConfig" }, ", handler: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RequestHandler", "text": "RequestHandler" }, " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", "Stream", " | undefined>(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, ") => ", "KibanaResponse", "; badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; ok: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; accepted: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; noContent: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", "; }>) => void" ], "source": { "path": "src/core/server/http/router/router.ts", "lineNumber": 94 }, "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", "id": "def-server.route", "type": "Object", "tags": [], "label": "route", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteConfig", "text": "RouteConfig" }, "" ], "source": { "path": "src/core/server/http/router/router.ts", "lineNumber": 52 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.handler", "type": "Function", "tags": [], "label": "handler", "description": [], "signature": [ "(context: Context, request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ", response: { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", "Stream", " | undefined>(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, ") => ", "KibanaResponse", "; badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; ok: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; accepted: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; noContent: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", "; }) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.IKibanaResponse", "text": "IKibanaResponse" }, " | Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.IKibanaResponse", "text": "IKibanaResponse" }, ">" ], "source": { "path": "src/core/server/http/router/router.ts", "lineNumber": 53 }, "deprecated": false } ] }, { "parentPluginId": "core", "id": "def-server.IRouter.delete", "type": "Function", "tags": [], "label": "delete", "description": [ "\nRegister a route handler for `DELETE` request." ], "signature": [ "(route: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteConfig", "text": "RouteConfig" }, ", handler: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RequestHandler", "text": "RequestHandler" }, " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", "Stream", " | undefined>(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, ") => ", "KibanaResponse", "; badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; ok: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; accepted: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; noContent: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", "; }>) => void" ], "source": { "path": "src/core/server/http/router/router.ts", "lineNumber": 101 }, "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", "id": "def-server.route", "type": "Object", "tags": [], "label": "route", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteConfig", "text": "RouteConfig" }, "" ], "source": { "path": "src/core/server/http/router/router.ts", "lineNumber": 52 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.handler", "type": "Function", "tags": [], "label": "handler", "description": [], "signature": [ "(context: Context, request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ", response: { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", "Stream", " | undefined>(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, ") => ", "KibanaResponse", "; badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; ok: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; accepted: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; noContent: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", "; }) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.IKibanaResponse", "text": "IKibanaResponse" }, " | Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.IKibanaResponse", "text": "IKibanaResponse" }, ">" ], "source": { "path": "src/core/server/http/router/router.ts", "lineNumber": 53 }, "deprecated": false } ] }, { "parentPluginId": "core", "id": "def-server.IRouter.handleLegacyErrors", "type": "Function", "tags": [], "label": "handleLegacyErrors", "description": [ "\nWrap a router handler to catch and converts legacy boom errors to proper custom errors." ], "signature": [ " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", "Stream", " | undefined>(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, ") => ", "KibanaResponse", "; badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; ok: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; accepted: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; noContent: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", "; } = { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", "Stream", " | undefined>(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, ") => ", "KibanaResponse", "; badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; ok: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; accepted: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; noContent: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", "; }>(handler: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RequestHandler", "text": "RequestHandler" }, ") => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RequestHandler", "text": "RequestHandler" }, "" ], "source": { "path": "src/core/server/http/router/router.ts", "lineNumber": 107 }, "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", "id": "def-server.handler", "type": "Function", "tags": [], "label": "handler", "description": [], "signature": [ "(context: Context, request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ", response: ResponseFactory) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.IKibanaResponse", "text": "IKibanaResponse" }, " | Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.IKibanaResponse", "text": "IKibanaResponse" }, ">" ], "source": { "path": "src/core/server/http/router/router.ts", "lineNumber": 385 }, "deprecated": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.KibanaRequestEvents", "type": "Interface", "tags": [], "label": "KibanaRequestEvents", "description": [ "\nRequest events." ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 62 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.KibanaRequestEvents.aborted$", "type": "Object", "tags": [], "label": "aborted$", "description": [ "\nObservable that emits once if and when the request has been aborted." ], "signature": [ "Observable", "" ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 66 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.KibanaRequestEvents.completed$", "type": "Object", "tags": [], "label": "completed$", "description": [ "\nObservable that emits once if and when the request has been completely handled.\n" ], "signature": [ "Observable", "" ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 76 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.KibanaRequestRoute", "type": "Interface", "tags": [], "label": "KibanaRequestRoute", "description": [ "\nRequest specific route information exposed to a handler." ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequestRoute", "text": "KibanaRequestRoute" }, "" ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 52 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.KibanaRequestRoute.path", "type": "string", "tags": [], "label": "path", "description": [], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 53 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.KibanaRequestRoute.method", "type": "Uncategorized", "tags": [], "label": "method", "description": [], "signature": [ "Method" ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 54 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.KibanaRequestRoute.options", "type": "Uncategorized", "tags": [], "label": "options", "description": [], "signature": [ "Method extends ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.SafeRouteMethod", "text": "SafeRouteMethod" }, " ? Required, \"timeout\" | \"tags\" | \"authRequired\" | \"xsrfRequired\">> : Required<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteConfigOptions", "text": "RouteConfigOptions" }, ">" ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 55 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.LegacyRequest", "type": "Interface", "tags": [ "deprecated" ], "label": "LegacyRequest", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.LegacyRequest", "text": "LegacyRequest" }, " extends ", "Request" ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 84 }, "deprecated": true, "references": [ { "plugin": "security", "link": { "path": "x-pack/plugins/security/server/saved_objects/index.ts", "lineNumber": 8 } }, { "plugin": "security", "link": { "path": "x-pack/plugins/security/server/saved_objects/index.ts", "lineNumber": 34 } } ], "children": [], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.OnPostAuthToolkit", "type": "Interface", "tags": [], "label": "OnPostAuthToolkit", "description": [], "source": { "path": "src/core/server/http/lifecycle/on_post_auth.ts", "lineNumber": 42 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.OnPostAuthToolkit.next", "type": "Function", "tags": [], "label": "next", "description": [ "To pass request to the next handler" ], "signature": [ "() => Next" ], "source": { "path": "src/core/server/http/lifecycle/on_post_auth.ts", "lineNumber": 44 }, "deprecated": false, "returnComment": [], "children": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.OnPreAuthToolkit", "type": "Interface", "tags": [], "label": "OnPreAuthToolkit", "description": [], "source": { "path": "src/core/server/http/lifecycle/on_pre_auth.ts", "lineNumber": 42 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.OnPreAuthToolkit.next", "type": "Function", "tags": [], "label": "next", "description": [ "To pass request to the next handler" ], "signature": [ "() => Next" ], "source": { "path": "src/core/server/http/lifecycle/on_pre_auth.ts", "lineNumber": 44 }, "deprecated": false, "returnComment": [], "children": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.OnPreResponseExtensions", "type": "Interface", "tags": [], "label": "OnPreResponseExtensions", "description": [ "\nAdditional data to extend a response." ], "source": { "path": "src/core/server/http/lifecycle/on_pre_response.ts", "lineNumber": 56 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.OnPreResponseExtensions.headers", "type": "CompoundType", "tags": [], "label": "headers", "description": [ "additional headers to attach to the response" ], "signature": [ "Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record | undefined" ], "source": { "path": "src/core/server/http/lifecycle/on_pre_response.ts", "lineNumber": 58 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.OnPreResponseInfo", "type": "Interface", "tags": [], "label": "OnPreResponseInfo", "description": [ "\nResponse status code." ], "source": { "path": "src/core/server/http/lifecycle/on_pre_response.ts", "lineNumber": 65 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.OnPreResponseInfo.statusCode", "type": "number", "tags": [], "label": "statusCode", "description": [], "source": { "path": "src/core/server/http/lifecycle/on_pre_response.ts", "lineNumber": 66 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.OnPreResponseRender", "type": "Interface", "tags": [], "label": "OnPreResponseRender", "description": [ "\nAdditional data to extend a response when rendering a new body" ], "source": { "path": "src/core/server/http/lifecycle/on_pre_response.ts", "lineNumber": 45 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.OnPreResponseRender.headers", "type": "CompoundType", "tags": [], "label": "headers", "description": [ "additional headers to attach to the response" ], "signature": [ "Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record | undefined" ], "source": { "path": "src/core/server/http/lifecycle/on_pre_response.ts", "lineNumber": 47 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.OnPreResponseRender.body", "type": "string", "tags": [], "label": "body", "description": [ "the body to use in the response" ], "source": { "path": "src/core/server/http/lifecycle/on_pre_response.ts", "lineNumber": 49 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.OnPreResponseToolkit", "type": "Interface", "tags": [], "label": "OnPreResponseToolkit", "description": [ "\nA tool set defining an outcome of OnPreResponse interceptor for incoming request." ], "source": { "path": "src/core/server/http/lifecycle/on_pre_response.ts", "lineNumber": 88 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.OnPreResponseToolkit.render", "type": "Function", "tags": [], "label": "render", "description": [ "To override the response with a different body" ], "signature": [ "(responseRender: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.OnPreResponseRender", "text": "OnPreResponseRender" }, ") => OnPreResponseResult" ], "source": { "path": "src/core/server/http/lifecycle/on_pre_response.ts", "lineNumber": 90 }, "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", "id": "def-server.responseRender", "type": "Object", "tags": [], "label": "responseRender", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.OnPreResponseRender", "text": "OnPreResponseRender" } ], "source": { "path": "src/core/server/http/lifecycle/on_pre_response.ts", "lineNumber": 90 }, "deprecated": false } ] }, { "parentPluginId": "core", "id": "def-server.OnPreResponseToolkit.next", "type": "Function", "tags": [], "label": "next", "description": [ "To pass request to the next handler" ], "signature": [ "(responseExtensions?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.OnPreResponseExtensions", "text": "OnPreResponseExtensions" }, " | undefined) => OnPreResponseResult" ], "source": { "path": "src/core/server/http/lifecycle/on_pre_response.ts", "lineNumber": 92 }, "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", "id": "def-server.responseExtensions", "type": "Object", "tags": [], "label": "responseExtensions", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.OnPreResponseExtensions", "text": "OnPreResponseExtensions" }, " | undefined" ], "source": { "path": "src/core/server/http/lifecycle/on_pre_response.ts", "lineNumber": 92 }, "deprecated": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.OnPreRoutingToolkit", "type": "Interface", "tags": [], "label": "OnPreRoutingToolkit", "description": [], "source": { "path": "src/core/server/http/lifecycle/on_pre_routing.ts", "lineNumber": 55 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.OnPreRoutingToolkit.next", "type": "Function", "tags": [], "label": "next", "description": [ "To pass request to the next handler" ], "signature": [ "() => OnPreRoutingResult" ], "source": { "path": "src/core/server/http/lifecycle/on_pre_routing.ts", "lineNumber": 57 }, "deprecated": false, "returnComment": [], "children": [] }, { "parentPluginId": "core", "id": "def-server.OnPreRoutingToolkit.rewriteUrl", "type": "Function", "tags": [], "label": "rewriteUrl", "description": [ "Rewrite requested resources url before is was authenticated and routed to a handler" ], "signature": [ "(url: string) => OnPreRoutingResult" ], "source": { "path": "src/core/server/http/lifecycle/on_pre_routing.ts", "lineNumber": 59 }, "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", "id": "def-server.url", "type": "string", "tags": [], "label": "url", "description": [], "source": { "path": "src/core/server/http/lifecycle/on_pre_routing.ts", "lineNumber": 59 }, "deprecated": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.RouteConfig", "type": "Interface", "tags": [], "label": "RouteConfig", "description": [ "\nRoute specific configuration." ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteConfig", "text": "RouteConfig" }, "" ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 157 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.RouteConfig.path", "type": "string", "tags": [], "label": "path", "description": [ "\nThe endpoint _within_ the router path to register the route.\n" ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 171 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.RouteConfig.validate", "type": "CompoundType", "tags": [], "label": "validate", "description": [ "\nA schema created with `@kbn/config-schema` that every request will be validated against.\n" ], "signature": [ "false | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteValidatorFullConfig", "text": "RouteValidatorFullConfig" }, "" ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 229 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.RouteConfig.options", "type": "Object", "tags": [], "label": "options", "description": [ "\nAdditional route options {@link RouteConfigOptions}." ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteConfigOptions", "text": "RouteConfigOptions" }, " | undefined" ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 234 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.RouteConfigOptions", "type": "Interface", "tags": [], "label": "RouteConfigOptions", "description": [ "\nAdditional route options." ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteConfigOptions", "text": "RouteConfigOptions" }, "" ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 106 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.RouteConfigOptions.authRequired", "type": "CompoundType", "tags": [], "label": "authRequired", "description": [ "\nDefines authentication mode for a route:\n- true. A user has to have valid credentials to access a resource\n- false. A user can access a resource without any credentials.\n- 'optional'. A user can access a resource, and will be authenticated if provided credentials are valid.\n Can be useful when we grant access to a resource but want to identify a user if possible.\n\nDefaults to `true` if an auth mechanism is registered." ], "signature": [ "boolean | \"optional\" | undefined" ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 116 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.RouteConfigOptions.xsrfRequired", "type": "Uncategorized", "tags": [], "label": "xsrfRequired", "description": [ "\nDefines xsrf protection requirements for a route:\n- true. Requires an incoming POST/PUT/DELETE request to contain `kbn-xsrf` header.\n- false. Disables xsrf protection.\n\nSet to true by default" ], "signature": [ "(Method extends \"get\" ? never : boolean) | undefined" ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 125 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.RouteConfigOptions.tags", "type": "Object", "tags": [], "label": "tags", "description": [ "\nAdditional metadata tag strings to attach to the route." ], "signature": [ "readonly string[] | undefined" ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 130 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.RouteConfigOptions.body", "type": "Uncategorized", "tags": [], "label": "body", "description": [ "\nAdditional body options {@link RouteConfigOptionsBody}." ], "signature": [ "(Method extends ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.SafeRouteMethod", "text": "SafeRouteMethod" }, " ? undefined : ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteConfigOptionsBody", "text": "RouteConfigOptionsBody" }, ") | undefined" ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 135 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.RouteConfigOptions.timeout", "type": "Object", "tags": [], "label": "timeout", "description": [ "\nDefines per-route timeouts." ], "signature": [ "{ payload?: (Method extends ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.SafeRouteMethod", "text": "SafeRouteMethod" }, " ? undefined : number) | undefined; idleSocket?: number | undefined; } | undefined" ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 140 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.RouteConfigOptionsBody", "type": "Interface", "tags": [], "label": "RouteConfigOptionsBody", "description": [ "\nAdditional body options for a route" ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 55 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.RouteConfigOptionsBody.accepts", "type": "CompoundType", "tags": [], "label": "accepts", "description": [ "\nA string or an array of strings with the allowed mime types for the endpoint. Use this settings to limit the set of allowed mime types. Note that allowing additional mime types not listed\nabove will not enable them to be parsed, and if parse is true, the request will result in an error response.\n\nDefault value: allows parsing of the following mime types:\n* application/json\n* application/*+json\n* application/octet-stream\n* application/x-www-form-urlencoded\n* multipart/form-data\n* text/*" ], "signature": [ "string | string[] | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteContentType", "text": "RouteContentType" }, "[] | undefined" ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 68 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.RouteConfigOptionsBody.maxBytes", "type": "number", "tags": [], "label": "maxBytes", "description": [ "\nLimits the size of incoming payloads to the specified byte count. Allowing very large payloads may cause the server to run out of memory.\n\nDefault value: The one set in the kibana.yml config file under the parameter `server.maxPayload`." ], "signature": [ "number | undefined" ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 75 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.RouteConfigOptionsBody.output", "type": "CompoundType", "tags": [], "label": "output", "description": [ "\nThe processed payload format. The value must be one of:\n* 'data' - the incoming payload is read fully into memory. If parse is true, the payload is parsed (JSON, form-decoded, multipart) based on the 'Content-Type' header. If parse is false, a raw\nBuffer is returned.\n* 'stream' - the incoming payload is made available via a Stream.Readable interface. If the payload is 'multipart/form-data' and parse is true, field values are presented as text while files\nare provided as streams. File streams from a 'multipart/form-data' upload will also have a hapi property containing the filename and headers properties. Note that payload streams for multipart\npayloads are a synthetic interface created on top of the entire multipart content loaded into memory. To avoid loading large multipart payloads into memory, set parse to false and handle the\nmultipart payload in the handler using a streaming parser (e.g. pez).\n\nDefault value: 'data', unless no validation.body is provided in the route definition. In that case the default is 'stream' to alleviate memory pressure." ], "signature": [ "\"data\" | \"stream\" | undefined" ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 88 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.RouteConfigOptionsBody.parse", "type": "CompoundType", "tags": [], "label": "parse", "description": [ "\nDetermines if the incoming payload is processed or presented raw. Available values:\n* true - if the request 'Content-Type' matches the allowed mime types set by allow (for the whole payload as well as parts), the payload is converted into an object when possible. If the\nformat is unknown, a Bad Request (400) error response is sent. Any known content encoding is decoded.\n* false - the raw payload is returned unmodified.\n* 'gunzip' - the raw payload is returned unmodified after any known content encoding is decoded.\n\nDefault value: true, unless no validation.body is provided in the route definition. In that case the default is false to alleviate memory pressure." ], "signature": [ "boolean | \"gunzip\" | undefined" ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 99 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.RouteValidationResultFactory", "type": "Interface", "tags": [], "label": "RouteValidationResultFactory", "description": [ "\nValidation result factory to be used in the custom validation function to return the valid data or validation errors\n\nSee {@link RouteValidationFunction}.\n" ], "source": { "path": "src/core/server/http/router/validator/validator.ts", "lineNumber": 20 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.RouteValidationResultFactory.ok", "type": "Function", "tags": [], "label": "ok", "description": [], "signature": [ "(value: T) => { value: T; }" ], "source": { "path": "src/core/server/http/router/validator/validator.ts", "lineNumber": 21 }, "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", "id": "def-server.value", "type": "Uncategorized", "tags": [], "label": "value", "description": [], "signature": [ "T" ], "source": { "path": "src/core/server/http/router/validator/validator.ts", "lineNumber": 21 }, "deprecated": false } ] }, { "parentPluginId": "core", "id": "def-server.RouteValidationResultFactory.badRequest", "type": "Function", "tags": [], "label": "badRequest", "description": [], "signature": [ "(error: string | Error, path?: string[] | undefined) => { error: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteValidationError", "text": "RouteValidationError" }, "; }" ], "source": { "path": "src/core/server/http/router/validator/validator.ts", "lineNumber": 22 }, "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", "id": "def-server.error", "type": "CompoundType", "tags": [], "label": "error", "description": [], "signature": [ "string | Error" ], "source": { "path": "src/core/server/http/router/validator/validator.ts", "lineNumber": 22 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.path", "type": "Array", "tags": [], "label": "path", "description": [], "signature": [ "string[] | undefined" ], "source": { "path": "src/core/server/http/router/validator/validator.ts", "lineNumber": 22 }, "deprecated": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.RouteValidatorConfig", "type": "Interface", "tags": [], "label": "RouteValidatorConfig", "description": [ "\nThe configuration object to the RouteValidator class.\nSet `params`, `query` and/or `body` to specify the validation logic to follow for that property.\n" ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteValidatorConfig", "text": "RouteValidatorConfig" }, "" ], "source": { "path": "src/core/server/http/router/validator/validator.ts", "lineNumber": 87 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.RouteValidatorConfig.params", "type": "CompoundType", "tags": [], "label": "params", "description": [ "\nValidation logic for the URL params" ], "signature": [ "ObjectType", " | ", "Type", "

| ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteValidationFunction", "text": "RouteValidationFunction" }, "

| undefined" ], "source": { "path": "src/core/server/http/router/validator/validator.ts", "lineNumber": 92 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.RouteValidatorConfig.query", "type": "CompoundType", "tags": [], "label": "query", "description": [ "\nValidation logic for the Query params" ], "signature": [ "ObjectType", " | ", "Type", " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteValidationFunction", "text": "RouteValidationFunction" }, " | undefined" ], "source": { "path": "src/core/server/http/router/validator/validator.ts", "lineNumber": 97 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.RouteValidatorConfig.body", "type": "CompoundType", "tags": [], "label": "body", "description": [ "\nValidation logic for the body payload" ], "signature": [ "ObjectType", " | ", "Type", " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteValidationFunction", "text": "RouteValidationFunction" }, " | undefined" ], "source": { "path": "src/core/server/http/router/validator/validator.ts", "lineNumber": 102 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.RouteValidatorOptions", "type": "Interface", "tags": [], "label": "RouteValidatorOptions", "description": [ "\nAdditional options for the RouteValidator class to modify its default behaviour.\n" ], "source": { "path": "src/core/server/http/router/validator/validator.ts", "lineNumber": 110 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.RouteValidatorOptions.unsafe", "type": "Object", "tags": [], "label": "unsafe", "description": [ "\nSet the `unsafe` config to avoid running some additional internal *safe* validations on top of your custom validation" ], "signature": [ "{ params?: boolean | undefined; query?: boolean | undefined; body?: boolean | undefined; } | undefined" ], "source": { "path": "src/core/server/http/router/validator/validator.ts", "lineNumber": 115 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.SessionCookieValidationResult", "type": "Interface", "tags": [], "label": "SessionCookieValidationResult", "description": [ "\nReturn type from a function to validate cookie contents." ], "source": { "path": "src/core/server/http/cookie_session_storage.ts", "lineNumber": 48 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.SessionCookieValidationResult.isValid", "type": "boolean", "tags": [], "label": "isValid", "description": [ "\nWhether the cookie is valid or not." ], "source": { "path": "src/core/server/http/cookie_session_storage.ts", "lineNumber": 52 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.SessionCookieValidationResult.path", "type": "string", "tags": [], "label": "path", "description": [ "\nThe \"Path\" attribute of the cookie; if the cookie is invalid, this is used to clear it." ], "signature": [ "string | undefined" ], "source": { "path": "src/core/server/http/cookie_session_storage.ts", "lineNumber": 56 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.SessionStorage", "type": "Interface", "tags": [], "label": "SessionStorage", "description": [ "\nProvides an interface to store and retrieve data across requests." ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.SessionStorage", "text": "SessionStorage" }, "" ], "source": { "path": "src/core/server/http/session_storage.ts", "lineNumber": 14 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.SessionStorage.get", "type": "Function", "tags": [], "label": "get", "description": [ "\nRetrieves session value from the session storage." ], "signature": [ "() => Promise" ], "source": { "path": "src/core/server/http/session_storage.ts", "lineNumber": 18 }, "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "core", "id": "def-server.SessionStorage.set", "type": "Function", "tags": [], "label": "set", "description": [ "\nPuts current session value into the session storage." ], "signature": [ "(sessionValue: T) => void" ], "source": { "path": "src/core/server/http/session_storage.ts", "lineNumber": 23 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.SessionStorage.set.$1", "type": "Uncategorized", "tags": [], "label": "sessionValue", "description": [ "- value to put" ], "signature": [ "T" ], "source": { "path": "src/core/server/http/session_storage.ts", "lineNumber": 23 }, "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", "id": "def-server.SessionStorage.clear", "type": "Function", "tags": [], "label": "clear", "description": [ "\nClears current session." ], "signature": [ "() => void" ], "source": { "path": "src/core/server/http/session_storage.ts", "lineNumber": 27 }, "deprecated": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.SessionStorageCookieOptions", "type": "Interface", "tags": [], "label": "SessionStorageCookieOptions", "description": [ "\nConfiguration used to create HTTP session storage based on top of cookie mechanism." ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.SessionStorageCookieOptions", "text": "SessionStorageCookieOptions" }, "" ], "source": { "path": "src/core/server/http/cookie_session_storage.ts", "lineNumber": 20 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.SessionStorageCookieOptions.name", "type": "string", "tags": [], "label": "name", "description": [ "\nName of the session cookie." ], "source": { "path": "src/core/server/http/cookie_session_storage.ts", "lineNumber": 24 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.SessionStorageCookieOptions.encryptionKey", "type": "string", "tags": [], "label": "encryptionKey", "description": [ "\nA key used to encrypt a cookie's value. Should be at least 32 characters long." ], "source": { "path": "src/core/server/http/cookie_session_storage.ts", "lineNumber": 28 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.SessionStorageCookieOptions.validate", "type": "Function", "tags": [], "label": "validate", "description": [ "\nFunction called to validate a cookie's decrypted value." ], "signature": [ "(sessionValue: T | T[]) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.SessionCookieValidationResult", "text": "SessionCookieValidationResult" } ], "source": { "path": "src/core/server/http/cookie_session_storage.ts", "lineNumber": 32 }, "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", "id": "def-server.sessionValue", "type": "CompoundType", "tags": [], "label": "sessionValue", "description": [], "signature": [ "T | T[]" ], "source": { "path": "src/core/server/http/cookie_session_storage.ts", "lineNumber": 32 }, "deprecated": false } ] }, { "parentPluginId": "core", "id": "def-server.SessionStorageCookieOptions.isSecure", "type": "boolean", "tags": [], "label": "isSecure", "description": [ "\nFlag indicating whether the cookie should be sent only via a secure connection." ], "source": { "path": "src/core/server/http/cookie_session_storage.ts", "lineNumber": 36 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.SessionStorageCookieOptions.sameSite", "type": "CompoundType", "tags": [], "label": "sameSite", "description": [ "\nDefines SameSite attribute of the Set-Cookie Header.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite" ], "signature": [ "\"None\" | \"Strict\" | \"Lax\" | undefined" ], "source": { "path": "src/core/server/http/cookie_session_storage.ts", "lineNumber": 41 }, "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.SessionStorageFactory", "type": "Interface", "tags": [], "label": "SessionStorageFactory", "description": [ "\nSessionStorage factory to bind one to an incoming request" ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.SessionStorageFactory", "text": "SessionStorageFactory" }, "" ], "source": { "path": "src/core/server/http/session_storage.ts", "lineNumber": 33 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.SessionStorageFactory.asScoped", "type": "Function", "tags": [], "label": "asScoped", "description": [], "signature": [ "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ") => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.SessionStorage", "text": "SessionStorage" }, "" ], "source": { "path": "src/core/server/http/session_storage.ts", "lineNumber": 34 }, "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", "id": "def-server.request", "type": "Object", "tags": [], "label": "request", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, "" ], "source": { "path": "src/core/server/http/session_storage.ts", "lineNumber": 34 }, "deprecated": false } ] } ], "initialIsOpen": false } ], "enums": [ { "parentPluginId": "core", "id": "def-server.AuthResultType", "type": "Enum", "tags": [], "label": "AuthResultType", "description": [], "source": { "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 22 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.AuthStatus", "type": "Enum", "tags": [], "label": "AuthStatus", "description": [ "\nStatus indicating an outcome of the authentication." ], "source": { "path": "src/core/server/http/auth_state_storage.ts", "lineNumber": 15 }, "deprecated": false, "initialIsOpen": false } ], "misc": [ { "parentPluginId": "core", "id": "def-server.AuthenticationHandler", "type": "Type", "tags": [], "label": "AuthenticationHandler", "description": [ "\nSee {@link AuthToolkit}." ], "signature": [ "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ", response: { badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; }, toolkit: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.AuthToolkit", "text": "AuthToolkit" }, ") => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.IKibanaResponse", "text": "IKibanaResponse" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.Authenticated", "text": "Authenticated" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.AuthNotHandled", "text": "AuthNotHandled" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.AuthRedirected", "text": "AuthRedirected" }, " | Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.IKibanaResponse", "text": "IKibanaResponse" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.Authenticated", "text": "Authenticated" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.AuthNotHandled", "text": "AuthNotHandled" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.AuthRedirected", "text": "AuthRedirected" }, ">" ], "source": { "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 147 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.AuthHeaders", "type": "Type", "tags": [], "label": "AuthHeaders", "description": [ "\nAuth Headers map" ], "signature": [ "{ [x: string]: string | string[]; }" ], "source": { "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 82 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.AuthResult", "type": "Type", "tags": [], "label": "AuthResult", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.Authenticated", "text": "Authenticated" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.AuthNotHandled", "text": "AuthNotHandled" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.AuthRedirected", "text": "AuthRedirected" } ], "source": { "path": "src/core/server/http/lifecycle/auth.ts", "lineNumber": 44 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.DestructiveRouteMethod", "type": "Type", "tags": [], "label": "DestructiveRouteMethod", "description": [ "\nSet of HTTP methods changing the state of the server." ], "signature": [ "\"post\" | \"put\" | \"delete\" | \"patch\"" ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 19 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.GetAuthHeaders", "type": "Type", "tags": [ "return" ], "label": "GetAuthHeaders", "description": [ "\nGet headers to authenticate a user against Elasticsearch." ], "signature": [ "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.LegacyRequest", "text": "LegacyRequest" }, ") => Record | undefined" ], "source": { "path": "src/core/server/http/auth_headers_storage.ts", "lineNumber": 18 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.GetAuthState", "type": "Type", "tags": [], "label": "GetAuthState", "description": [ "\nGets authentication state for a request. Returned by `auth` interceptor." ], "signature": [ "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.LegacyRequest", "text": "LegacyRequest" }, ") => { status: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.AuthStatus", "text": "AuthStatus" }, "; state: T; }" ], "source": { "path": "src/core/server/http/auth_state_storage.ts", "lineNumber": 35 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.Headers", "type": "Type", "tags": [], "label": "Headers", "description": [ "\nHttp request headers to read." ], "signature": [ "{ accept?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; allow?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; date?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; from?: string | string[] | undefined; host?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; location?: string | string[] | undefined; origin?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; range?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; warning?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" ], "source": { "path": "src/core/server/http/router/headers.ts", "lineNumber": 40 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.HttpResponsePayload", "type": "Type", "tags": [], "label": "HttpResponsePayload", "description": [ "\nData send to the client as a response payload." ], "signature": [ "string | Record | Buffer | ", "Stream", " | undefined" ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 73 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.IBasePath", "type": "Type", "tags": [], "label": "IBasePath", "description": [ "\nAccess or manipulate the Kibana base path\n\n{@link BasePath}" ], "signature": [ "{ remove: (path: string) => string; get: (request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.LegacyRequest", "text": "LegacyRequest" }, ") => string; set: (request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.LegacyRequest", "text": "LegacyRequest" }, ", requestSpecificBasePath: string) => void; prepend: (path: string) => string; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }" ], "source": { "path": "src/core/server/http/base_path_service.ts", "lineNumber": 104 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.IsAuthenticated", "type": "Type", "tags": [], "label": "IsAuthenticated", "description": [ "\nReturns authentication status for a request." ], "signature": [ "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.LegacyRequest", "text": "LegacyRequest" }, ") => boolean" ], "source": { "path": "src/core/server/http/auth_state_storage.ts", "lineNumber": 44 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.KibanaRequestRouteOptions", "type": "Type", "tags": [], "label": "KibanaRequestRouteOptions", "description": [ "\nRoute options: If 'GET' or 'OPTIONS' method, body options won't be returned." ], "signature": [ "Method extends ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.SafeRouteMethod", "text": "SafeRouteMethod" }, " ? Required, \"timeout\" | \"tags\" | \"authRequired\" | \"xsrfRequired\">> : Required<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteConfigOptions", "text": "RouteConfigOptions" }, ">" ], "source": { "path": "src/core/server/http/router/request.ts", "lineNumber": 44 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.KibanaResponseFactory", "type": "Type", "tags": [], "label": "KibanaResponseFactory", "description": [ "\nCreates an object containing request response payload, HTTP headers, error details, and other data transmitted to the client." ], "signature": [ "{ custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", "Stream", " | undefined>(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, ") => ", "KibanaResponse", "; badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; ok: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; accepted: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; noContent: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", "; }" ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 323 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.KnownHeaders", "type": "Type", "tags": [], "label": "KnownHeaders", "description": [ "\nSet of well-known HTTP headers." ], "signature": [ "\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\"" ], "source": { "path": "src/core/server/http/router/headers.ts", "lineNumber": 34 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.LifecycleResponseFactory", "type": "Type", "tags": [], "label": "LifecycleResponseFactory", "description": [ "\nCreates an object containing redirection or error response with error details, HTTP headers, and other data transmitted to the client." ], "signature": [ "{ badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; }" ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 329 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.OnPostAuthHandler", "type": "Type", "tags": [], "label": "OnPostAuthHandler", "description": [ "\nSee {@link OnPostAuthToolkit}." ], "signature": [ "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ", response: { badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; }, toolkit: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.OnPostAuthToolkit", "text": "OnPostAuthToolkit" }, ") => ", "KibanaResponse", " | Next | Promise<", "KibanaResponse", " | Next>" ], "source": { "path": "src/core/server/http/lifecycle/on_post_auth.ts", "lineNumber": 51 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.OnPreAuthHandler", "type": "Type", "tags": [], "label": "OnPreAuthHandler", "description": [ "\nSee {@link OnPreAuthToolkit}." ], "signature": [ "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ", response: { badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; }, toolkit: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.OnPreAuthToolkit", "text": "OnPreAuthToolkit" }, ") => ", "KibanaResponse", " | Next | Promise<", "KibanaResponse", " | Next>" ], "source": { "path": "src/core/server/http/lifecycle/on_pre_auth.ts", "lineNumber": 55 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.OnPreResponseHandler", "type": "Type", "tags": [], "label": "OnPreResponseHandler", "description": [ "\nSee {@link OnPreRoutingToolkit}." ], "signature": [ "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ", preResponse: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.OnPreResponseInfo", "text": "OnPreResponseInfo" }, ", toolkit: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.OnPreResponseToolkit", "text": "OnPreResponseToolkit" }, ") => Render | Next | Promise" ], "source": { "path": "src/core/server/http/lifecycle/on_pre_response.ts", "lineNumber": 104 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.OnPreRoutingHandler", "type": "Type", "tags": [], "label": "OnPreRoutingHandler", "description": [ "\nSee {@link OnPreRoutingToolkit}." ], "signature": [ "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ", response: { badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; }, toolkit: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.OnPreRoutingToolkit", "text": "OnPreRoutingToolkit" }, ") => Next | RewriteUrl | ", "KibanaResponse", " | Promise>" ], "source": { "path": "src/core/server/http/lifecycle/on_pre_routing.ts", "lineNumber": 71 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.RedirectResponseOptions", "type": "Type", "tags": [], "label": "RedirectResponseOptions", "description": [ "\nHTTP response parameters for redirection response" ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, " & { headers: { location: string; }; }" ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 93 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.RequestHandler", "type": "Type", "tags": [], "label": "RequestHandler", "description": [ "\nA function executed when route path matched requested resource path.\nRequest handler is expected to return a result of one of {@link KibanaResponseFactory} functions.\nIf anything else is returned, or an error is thrown, the HTTP service will automatically log the error\nand respond `500 - Internal Server Error`." ], "signature": [ "(context: Context, request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ", response: ResponseFactory) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.IKibanaResponse", "text": "IKibanaResponse" }, " | Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.IKibanaResponse", "text": "IKibanaResponse" }, ">" ], "source": { "path": "src/core/server/http/router/router.ts", "lineNumber": 351 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.RequestHandlerContextContainer", "type": "Type", "tags": [], "label": "RequestHandlerContextContainer", "description": [ "\nAn object that handles registration of http request context providers." ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", "section": "def-server.IContextContainer", "text": "IContextContainer" } ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 30 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.RequestHandlerContextProvider", "type": "Type", "tags": [], "label": "RequestHandlerContextProvider", "description": [ "\nContext provider for request handler.\nExtends request context object with provided functionality or data.\n" ], "signature": [ "(context: Pick>, request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ", response: { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", "Stream", " | undefined>(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, ") => ", "KibanaResponse", "; badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; ok: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; accepted: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; noContent: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", "; }) => Context[ContextName] | Promise" ], "source": { "path": "src/core/server/http/types.ts", "lineNumber": 38 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.RequestHandlerWrapper", "type": "Type", "tags": [], "label": "RequestHandlerWrapper", "description": [ "\nType-safe wrapper for {@link RequestHandler} function." ], "signature": [ " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", "Stream", " | undefined>(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, ") => ", "KibanaResponse", "; badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; ok: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; accepted: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; noContent: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", "; } = { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", "Stream", " | undefined>(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, ") => ", "KibanaResponse", "; badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; ok: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; accepted: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; noContent: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", "; }>(handler: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RequestHandler", "text": "RequestHandler" }, ") => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RequestHandler", "text": "RequestHandler" }, "" ], "source": { "path": "src/core/server/http/router/router.ts", "lineNumber": 377 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.ResponseError", "type": "Type", "tags": [], "label": "ResponseError", "description": [ "\nError message and optional data send to the client in case of error." ], "signature": [ "string | Error | { message: string | Error; attributes?: Record | undefined; }" ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 21 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.ResponseErrorAttributes", "type": "Type", "tags": [], "label": "ResponseErrorAttributes", "description": [ "\nAdditional data to provide error details." ], "signature": [ "{ [x: string]: any; }" ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 16 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.ResponseHeaders", "type": "Type", "tags": [], "label": "ResponseHeaders", "description": [ "\nHttp response headers to set." ], "signature": [ "Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record" ], "source": { "path": "src/core/server/http/router/headers.ts", "lineNumber": 48 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.RouteContentType", "type": "Type", "tags": [], "label": "RouteContentType", "description": [ "\nThe set of supported parseable Content-Types" ], "signature": [ "\"application/json\" | \"application/*+json\" | \"application/octet-stream\" | \"application/x-www-form-urlencoded\" | \"multipart/form-data\" | \"text/*\"" ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 43 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.RouteMethod", "type": "Type", "tags": [], "label": "RouteMethod", "description": [ "\nThe set of common HTTP methods supported by Kibana routing." ], "signature": [ "\"get\" | \"options\" | \"post\" | \"put\" | \"delete\" | \"patch\"" ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 31 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.RouteRegistrar", "type": "Type", "tags": [], "label": "RouteRegistrar", "description": [ "\nRoute handler common definition\n" ], "signature": [ "(route: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteConfig", "text": "RouteConfig" }, ", handler: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RequestHandler", "text": "RequestHandler" }, " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", "Stream", " | undefined>(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, ") => ", "KibanaResponse", "; badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; ok: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; accepted: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; noContent: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", "; }>) => void" ], "source": { "path": "src/core/server/http/router/router.ts", "lineNumber": 48 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.RouteValidationFunction", "type": "Type", "tags": [], "label": "RouteValidationFunction", "description": [ "\nThe custom validation function if @kbn/config-schema is not a valid solution for your specific plugin requirements.\n" ], "signature": [ "(data: any, validationResult: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteValidationResultFactory", "text": "RouteValidationResultFactory" }, ") => { value: T; error?: undefined; } | { value?: undefined; error: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteValidationError", "text": "RouteValidationError" }, "; }" ], "source": { "path": "src/core/server/http/router/validator/validator.ts", "lineNumber": 50 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.RouteValidationSpec", "type": "Type", "tags": [], "label": "RouteValidationSpec", "description": [ "\nAllowed property validation options: either @kbn/config-schema validations or custom validation functions\n\nSee {@link RouteValidationFunction} for custom validation.\n" ], "signature": [ "ObjectType", " | ", "Type", " | ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteValidationFunction", "text": "RouteValidationFunction" }, "" ], "source": { "path": "src/core/server/http/router/validator/validator.ts", "lineNumber": 70 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.RouteValidatorFullConfig", "type": "Type", "tags": [], "label": "RouteValidatorFullConfig", "description": [ "\nRoute validations config and options merged into one object" ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteValidatorConfig", "text": "RouteValidatorConfig" }, " & ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RouteValidatorOptions", "text": "RouteValidatorOptions" } ], "source": { "path": "src/core/server/http/router/validator/validator.ts", "lineNumber": 126 }, "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.SafeRouteMethod", "type": "Type", "tags": [], "label": "SafeRouteMethod", "description": [ "\nSet of HTTP methods not changing the state of the server." ], "signature": [ "\"get\" | \"options\"" ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 25 }, "deprecated": false, "initialIsOpen": false } ], "objects": [ { "parentPluginId": "core", "id": "def-server.kibanaResponseFactory", "type": "Object", "tags": [], "label": "kibanaResponseFactory", "description": [ "\nSet of helpers used to create `KibanaResponse` to form HTTP response on an incoming request.\nShould be returned as a result of {@link RequestHandler} execution.\n" ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 293 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.kibanaResponseFactory.Unnamed", "type": "Any", "tags": [], "label": "Unnamed", "description": [], "signature": [ "any" ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 294 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.kibanaResponseFactory.Unnamed", "type": "Any", "tags": [], "label": "Unnamed", "description": [], "signature": [ "any" ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 295 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.kibanaResponseFactory.Unnamed", "type": "Any", "tags": [], "label": "Unnamed", "description": [], "signature": [ "any" ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 296 }, "deprecated": false }, { "parentPluginId": "core", "id": "def-server.kibanaResponseFactory.custom", "type": "Function", "tags": [], "label": "custom", "description": [ "/**\n * Creates a response with defined status code and payload.\n * @param options - {@link CustomHttpResponseOptions} configures HTTP response parameters.\n */" ], "signature": [ " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", "Stream", " | undefined>(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, ") => ", "KibanaResponse", "" ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 301 }, "deprecated": false, "children": [ { "parentPluginId": "core", "id": "def-server.kibanaResponseFactory.custom.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "" ], "source": { "path": "src/core/server/http/router/response.ts", "lineNumber": 302 }, "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", "id": "def-server.validBodyOutput", "type": "Object", "tags": [], "label": "validBodyOutput", "description": [ "\nThe set of valid body.output" ], "signature": [ "readonly [\"data\", \"stream\"]" ], "source": { "path": "src/core/server/http/router/route.ts", "lineNumber": 37 }, "deprecated": false, "initialIsOpen": false } ] }, "common": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] } }