Skip to content

Opensearch dashboards.legacycallapioptions

Home > opensearch-dashboards > LegacyCallAPIOptions

LegacyCallAPIOptions interface

Warning: This API is now obsolete.

The set of options that defines how API call should be made and result be processed.

Signature:

export interface LegacyCallAPIOptions 

Properties

Property Type Description
signal? AbortSignal (Optional) A signal object that allows you to abort the request via an AbortController object.
wrap401Errors? boolean (Optional) Indicates whether 401 Unauthorized errors returned from the OpenSearch API should be wrapped into Boom error instances with properly set WWW-Authenticate header that could have been returned by the API itself. If API didn't specify that then Basic realm="Authorization Required" is used as WWW-Authenticate.