Get Kibana's current status

GET /api/status

Query parameters

  • v7format boolean

    Set to "true" to get the response in v7 format.

  • v8format boolean

    Set to "true" to get the response in v8 format.

Responses

  • 200 application/json

    Overall status is OK and Kibana should be functioning normally.

    Kibana's operational status. A minimal response is sent for unauthorized users.

    Any of:
    Kibana_HTTP_APIs_core_status_response object Kibana_HTTP_APIs_core_status_redactedResponse object

    Kibana's operational status as well as a detailed breakdown of plugin statuses indication of various loads (like event loop utilization and network traffic) at time of request.

    Hide attributes Show attributes
    • metrics object Required

      Metric groups collected by Kibana.

      Additional properties are NOT allowed.

      Hide metrics attributes Show metrics attributes object
    • name string Required

      Kibana instance name.

    • status object Required

      Additional properties are NOT allowed.

      Hide status attributes Show status attributes object
      • core object Required

        Statuses of core Kibana services.

        Additional properties are NOT allowed.

        Hide core attributes Show core attributes object
        • elasticsearch object Required

          Additional properties are NOT allowed.

          Hide elasticsearch attributes Show elasticsearch attributes object
          • detail string

            Human readable detail of the service status.

          • documentationUrl string

            A URL to further documentation regarding this service.

          • level string Required

            Service status levels as human and machine readable values.

            Values are available, degraded, unavailable, or critical.

          • meta object Required

            An unstructured set of extra metadata about this service.

            Additional properties are allowed.

          • summary string Required

            A human readable summary of the service status.

        • savedObjects object Required

          Additional properties are NOT allowed.

          Hide savedObjects attributes Show savedObjects attributes object
          • detail string

            Human readable detail of the service status.

          • documentationUrl string

            A URL to further documentation regarding this service.

          • level string Required

            Service status levels as human and machine readable values.

            Values are available, degraded, unavailable, or critical.

          • meta object Required

            An unstructured set of extra metadata about this service.

            Additional properties are allowed.

          • summary string Required

            A human readable summary of the service status.

      • overall object Required

        Additional properties are NOT allowed.

        Hide overall attributes Show overall attributes object
        • detail string

          Human readable detail of the service status.

        • documentationUrl string

          A URL to further documentation regarding this service.

        • level string Required

          Service status levels as human and machine readable values.

          Values are available, degraded, unavailable, or critical.

        • meta object Required

          An unstructured set of extra metadata about this service.

          Additional properties are allowed.

        • summary string Required

          A human readable summary of the service status.

      • plugins object Required

        A dynamic mapping of plugin ID to plugin status.

        Hide plugins attribute Show plugins attribute object
        • * object Additional properties

          Additional properties are NOT allowed.

          Hide * attributes Show * attributes object
          • detail string

            Human readable detail of the service status.

          • documentationUrl string

            A URL to further documentation regarding this service.

          • level string Required

            Service status levels as human and machine readable values.

            Values are available, degraded, unavailable, or critical.

          • meta object Required

            An unstructured set of extra metadata about this service.

            Additional properties are allowed.

          • summary string Required

            A human readable summary of the service status.

    • uuid string Required

      Unique, generated Kibana instance UUID. This UUID should persist even if the Kibana process restarts.

    • version object Required

      Additional properties are NOT allowed.

      Hide version attributes Show version attributes object
      • build_date string Required

        The date and time of this build.

      • build_flavor string Required

        The build flavour determines configuration and behavior of Kibana. On premise users will almost always run the "traditional" flavour, while other flavours are reserved for Elastic-specific use cases.

        Values are serverless or traditional.

      • build_hash string Required

        A unique hash value representing the git commit of this Kibana build.

      • build_number number Required

        A monotonically increasing number, each subsequent build will have a higher number.

      • build_snapshot boolean Required

        Whether this build is a snapshot build.

      • number string Required

        A semantic version number.
  • 503 application/json

    Kibana or some of it's essential services are unavailable. Kibana may be degraded or unavailable.

    Kibana's operational status. A minimal response is sent for unauthorized users.

    Any of:
    Kibana_HTTP_APIs_core_status_response object Kibana_HTTP_APIs_core_status_redactedResponse object

    Kibana's operational status as well as a detailed breakdown of plugin statuses indication of various loads (like event loop utilization and network traffic) at time of request.

    Hide attributes Show attributes
    • metrics object Required

      Metric groups collected by Kibana.

      Additional properties are NOT allowed.

      Hide metrics attributes Show metrics attributes object
    • name string Required

      Kibana instance name.

    • status object Required

      Additional properties are NOT allowed.

      Hide status attributes Show status attributes object
      • core object Required

        Statuses of core Kibana services.

        Additional properties are NOT allowed.

        Hide core attributes Show core attributes object
        • elasticsearch object Required

          Additional properties are NOT allowed.

          Hide elasticsearch attributes Show elasticsearch attributes object
          • detail string

            Human readable detail of the service status.

          • documentationUrl string

            A URL to further documentation regarding this service.

          • level string Required

            Service status levels as human and machine readable values.

            Values are available, degraded, unavailable, or critical.

          • meta object Required

            An unstructured set of extra metadata about this service.

            Additional properties are allowed.

          • summary string Required

            A human readable summary of the service status.

        • savedObjects object Required

          Additional properties are NOT allowed.

          Hide savedObjects attributes Show savedObjects attributes object
          • detail string

            Human readable detail of the service status.

          • documentationUrl string

            A URL to further documentation regarding this service.

          • level string Required

            Service status levels as human and machine readable values.

            Values are available, degraded, unavailable, or critical.

          • meta object Required

            An unstructured set of extra metadata about this service.

            Additional properties are allowed.

          • summary string Required

            A human readable summary of the service status.

      • overall object Required

        Additional properties are NOT allowed.

        Hide overall attributes Show overall attributes object
        • detail string

          Human readable detail of the service status.

        • documentationUrl string

          A URL to further documentation regarding this service.

        • level string Required

          Service status levels as human and machine readable values.

          Values are available, degraded, unavailable, or critical.

        • meta object Required

          An unstructured set of extra metadata about this service.

          Additional properties are allowed.

        • summary string Required

          A human readable summary of the service status.

      • plugins object Required

        A dynamic mapping of plugin ID to plugin status.

        Hide plugins attribute Show plugins attribute object
        • * object Additional properties

          Additional properties are NOT allowed.

          Hide * attributes Show * attributes object
          • detail string

            Human readable detail of the service status.

          • documentationUrl string

            A URL to further documentation regarding this service.

          • level string Required

            Service status levels as human and machine readable values.

            Values are available, degraded, unavailable, or critical.

          • meta object Required

            An unstructured set of extra metadata about this service.

            Additional properties are allowed.

          • summary string Required

            A human readable summary of the service status.

    • uuid string Required

      Unique, generated Kibana instance UUID. This UUID should persist even if the Kibana process restarts.

    • version object Required

      Additional properties are NOT allowed.

      Hide version attributes Show version attributes object
      • build_date string Required

        The date and time of this build.

      • build_flavor string Required

        The build flavour determines configuration and behavior of Kibana. On premise users will almost always run the "traditional" flavour, while other flavours are reserved for Elastic-specific use cases.

        Values are serverless or traditional.

      • build_hash string Required

        A unique hash value representing the git commit of this Kibana build.

      • build_number number Required

        A monotonically increasing number, each subsequent build will have a higher number.

      • build_snapshot boolean Required

        Whether this build is a snapshot build.

      • number string Required

        A semantic version number.
GET /api/status 
curl \
 --request GET https://localhost:5601/api/status
Response examples (200) 
{
  "metrics": {
    "collection_interval_in_millis": 42.0,
    "elasticsearch_client": {
      "totalActiveSockets": 42.0,
      "totalIdleSockets": 42.0,
      "totalQueuedRequests": 42.0
    },
    "last_updated": "string"
  },
  "name": "string",
  "status": {
    "core": {
      "elasticsearch": {
        "detail": "string",
        "documentationUrl": "string",
        "level": "available",
        "meta": {},
        "summary": "string"
      },
      "savedObjects": {
        "detail": "string",
        "documentationUrl": "string",
        "level": "available",
        "meta": {},
        "summary": "string"
      }
    },
    "overall": {
      "detail": "string",
      "documentationUrl": "string",
      "level": "available",
      "meta": {},
      "summary": "string"
    },
    "plugins": {
      "additionalProperty1": {
        "detail": "string",
        "documentationUrl": "string",
        "level": "available",
        "meta": {},
        "summary": "string"
      },
      "additionalProperty2": {
        "detail": "string",
        "documentationUrl": "string",
        "level": "available",
        "meta": {},
        "summary": "string"
      }
    }
  },
  "uuid": "string",
  "version": {
    "build_date": "string",
    "build_flavor": "serverless",
    "build_hash": "string",
    "build_number": 42.0,
    "build_snapshot": true,
    "number": "string"
  }
}
{
  "status": {
    "overall": {
      "level": "available"
    }
  }
}
Response examples (503) 
{
  "metrics": {
    "collection_interval_in_millis": 42.0,
    "elasticsearch_client": {
      "totalActiveSockets": 42.0,
      "totalIdleSockets": 42.0,
      "totalQueuedRequests": 42.0
    },
    "last_updated": "string"
  },
  "name": "string",
  "status": {
    "core": {
      "elasticsearch": {
        "detail": "string",
        "documentationUrl": "string",
        "level": "available",
        "meta": {},
        "summary": "string"
      },
      "savedObjects": {
        "detail": "string",
        "documentationUrl": "string",
        "level": "available",
        "meta": {},
        "summary": "string"
      }
    },
    "overall": {
      "detail": "string",
      "documentationUrl": "string",
      "level": "available",
      "meta": {},
      "summary": "string"
    },
    "plugins": {
      "additionalProperty1": {
        "detail": "string",
        "documentationUrl": "string",
        "level": "available",
        "meta": {},
        "summary": "string"
      },
      "additionalProperty2": {
        "detail": "string",
        "documentationUrl": "string",
        "level": "available",
        "meta": {},
        "summary": "string"
      }
    }
  },
  "uuid": "string",
  "version": {
    "build_date": "string",
    "build_flavor": "serverless",
    "build_hash": "string",
    "build_number": 42.0,
    "build_snapshot": true,
    "number": "string"
  }
}
{
  "status": {
    "overall": {
      "level": "available"
    }
  }
}