Skip to content

Opensearch dashboards.servicestatus

Home > opensearch-dashboards > ServiceStatus

ServiceStatus interface

The current status of a service at a point in time.

Signature:

export interface ServiceStatus<Meta extends Record<string, any> | unknown = unknown> 

Properties

Property Type Description
detail? string (Optional) A more detailed description of the service status.
documentationUrl? string (Optional) A URL to open in a new tab about how to resolve or troubleshoot the problem.
level ServiceStatusLevel The current availability level of the service.
meta? Meta (Optional) Any JSON-serializable data to be included in the HTTP API response. Useful for providing more fine-grained, machine-readable information about the service status. May include status information for underlying features.
summary string A high-level summary of the service status.