lakeFS

lakeFS healthCheck API

The healthCheck API from lakeFS — 1 operation(s) for healthcheck.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.lakefs.io/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/lakefs/refs/heads/main/openapi/lakefs-healthcheck-api-openapi.yml

OpenAPI Specification

lakefs-healthcheck-api-openapi.yml Raw ↑ 
openapi: 3.0.0
info:
  description: lakeFS HTTP API
  title: lakeFS actions healthCheck API
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.0
servers:
- url: /api/v1
  description: lakeFS server endpoint
security:
- jwt_token: []
- basic_auth: []
- cookie_auth: []
- oidc_auth: []
- saml_auth: []
tags:
- name: healthCheck
paths:
  /healthcheck:
    get:
      operationId: healthCheck
      security: []
      tags:
      - healthCheck
      description: check that the API server is up and running
      responses:
        204:
          description: NoContent
components:
  securitySchemes:
    basic_auth:
      type: http
      scheme: basic
    jwt_token:
      type: http
      scheme: bearer
      bearerFormat: JWT
    cookie_auth:
      type: apiKey
      in: cookie
      name: internal_auth_session
    oidc_auth:
      type: apiKey
      in: cookie
      name: oidc_auth_session
    saml_auth:
      type: apiKey
      in: cookie
      name: saml_auth_session