Check API status ✅

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://api-doc.ppe-analytics.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
"Deck API MCP server": {
  "url": "https://api-doc.ppe-analytics.com/mcp"
}
Close
GET /status

Checks the status of the API, with a basic request to the database behind the scenes to ensure that the API is really available.

Responses

  • 200 application/json

    API is up and running

    Hide response attributes Show response attributes object
    • status string
    • message string
  • 503 application/json

    API is temporarily unavailable

    Hide response attributes Show response attributes object
    • status string
    • message string
GET /status 
curl \
 --request GET 'https://api.ppe-analytics.com/api/v1/status'
Response examples (200) 
{
  "status": "OK",
  "message": "Welcome to Deck API! Check out the API doc at https://api-doc.ppe-analytics.com"
}
Response examples (503) 
{
  "status": "ERROR",
  "message": "Deck API is temporarily unavailable. We're working on it to bring it back as soon as possible."
}