---
updatedAt: 2026-04-21T11:22:20.000Z
agentTools:
  projectIndex: https://docs.lmnl.app/v2/llms.txt
---

# Check Liminal server status

This API is a request to check whether the Liminal server is up and running, capable of receiving requests, and responding correctly. <br> <br> If the server is not running, you receive a 502 bad gateway response.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "API REFERENCES",
    "contact": {},
    "version": "8"
  },
  "servers": [
    {
      "url": "https://api-sdk.lmnl.dev",
      "variables": {}
    }
  ],
  "tags": [
    {
      "name": "Health"
    }
  ],
  "paths": {
    "/ping": {
      "get": {
        "tags": [
          "Health"
        ],
        "summary": "Check Liminal server status",
        "description": "This API is a request to check whether the Liminal server is up and running, capable of receiving requests, and responding correctly. <br> <br> If the server is not running, you receive a 502 bad gateway response.",
        "operationId": "Ping-Pong",
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json; charset=utf-8": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Ping-Pong-OK-Response"
                    },
                    {
                      "example": {
                        "status": true,
                        "Message": "Docker is Running... Let's Play with Liminal Express..."
                      }
                    }
                  ]
                },
                "example": {
                  "status": true,
                  "Message": "Docker is Running... Let's Play with Liminal Express..."
                }
              }
            }
          }
        },
        "deprecated": false,
        "security": []
      }
    }
  },
  "components": {
    "schemas": {
      "Ping-Pong-OK-Response": {
        "title": "Ping-Pong-OK-Response",
        "required": [
          "status",
          "Message"
        ],
        "type": "object",
        "properties": {
          "status": {
            "type": "boolean",
            "description": "This indicates whether the server is running or not."
          },
          "Message": {
            "type": "string",
            "description": "A short description of server's operational status."
          }
        },
        "example": {
          "status": true,
          "Message": "Docker is Running... Let's Play with Liminal Express..."
        }
      }
    }
  },
  "security": []
}
```