MechaMental
Api reference

Health

Health Check

GET
/health

Response Body

application/json

curl -X GET "https://loading/health"
{
  "status": "string"
}

Health Check Full

GET
/health/full

Header Parameters

authorization?string|null

Response Body

application/json

application/json

curl -X GET "https://loading/health/full"
{
  "status": "string",
  "service": "string",
  "instance_id": "string",
  "environment": "string",
  "version": "string",
  "timestamp": "string",
  "uptime_seconds": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Detailed Health Check

GET
/health/detailed

Header Parameters

authorization?string|null

Response Body

application/json

application/json

curl -X GET "https://loading/health/detailed"
{
  "status": "string",
  "service": "string",
  "instance_id": "string",
  "environment": "string",
  "version": "string",
  "timestamp": "string",
  "uptime_seconds": 0,
  "components": {
    "property1": {
      "status": "string",
      "latency_ms": 0,
      "message": "string"
    },
    "property2": {
      "status": "string",
      "latency_ms": 0,
      "message": "string"
    }
  },
  "system": {}
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Cluster Health Check

GET
/health/cluster

Header Parameters

authorization?string|null

Response Body

application/json

application/json

curl -X GET "https://loading/health/cluster"
{
  "status": "string",
  "service": "string",
  "environment": "string",
  "total_instances": 0,
  "healthy_instances": 0,
  "degraded_instances": 0,
  "unhealthy_instances": 0,
  "instances": [
    {
      "instance_id": "string",
      "status": "string",
      "uptime_seconds": 0,
      "last_check_at": "string",
      "cpu_percent": 0,
      "memory_mb": 0
    }
  ],
  "timestamp": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

System Metrics

GET
/health/metrics

Header Parameters

authorization?string|null

Response Body

application/json

application/json

curl -X GET "https://loading/health/metrics"
null
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Deregister Instance

DELETE
/health/instance

Header Parameters

authorization?string|null

Response Body

application/json

application/json

curl -X DELETE "https://loading/health/instance"
null
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}