Get the status of the services

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-docs.kitsu.cloud/mcp

Standard setup for AI tools providing an mcp.json file

{
  "Kitsu API MCP server": {
    "url": "https://api-docs.kitsu.cloud/mcp"
  }
}

GET /status

Get the status of the services of the API: the database, the key value store, the event stream, the job queue and the indexer. A service is up if the API can connect to it. The job queue is up if one worker or more is available. You do not need a token for this route.

Responses

200 application/json

The name, the version and the status of each service
Hide response attributes Show response attributes object
- name string
- version string
- database-up boolean
- key-value-store-up boolean
- event-stream-up boolean
- job-queue-up boolean
- indexer-up boolean

GET /status

curl -X GET "http://api.example.com/status" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

import requests

url = "http://api.example.com/status"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json"
}
params = {}
payload = None

response = requests.get(
    url,
    headers=headers,
    params=params,
    json=payload
)

response.raise_for_status()

if response.content:
    print(response.json())

Response examples (200)

{
  "name": "string",
  "version": "string",
  "database-up": true,
  "key-value-store-up": true,
  "event-stream-up": true,
  "job-queue-up": true,
  "indexer-up": true
}