Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/xcoder-es/media-cleaner-pro/llms.txt

Use this file to discover all available pages before exploring further.

The /health endpoint is a lightweight liveness probe that confirms the MediaCleaner Pro server is up and accepting requests. It requires no authentication and carries no side effects, making it safe to poll from container orchestrators, load balancers, or monitoring scripts.
GET /health

Response fields

status
string
required
Always "ok". Any non-"ok" value (or a non-200 HTTP status) indicates a problem with the service.
service
string
required
Always "mediacleaner-pro". Useful for confirming you are talking to the correct service when multiple APIs share a host.
version
string
required
Semantic version string read from CARGO_PKG_VERSION at compile time, for example "0.1.4-alpha". Use this to assert that the running binary matches a known-good release.

Example

curl http://127.0.0.1:8080/health
{
  "status": "ok",
  "service": "mediacleaner-pro",
  "version": "0.1.4-alpha"
}

Build docs developers (and LLMs) love