btcpayserver/BTCPayServer/wwwroot/swagger/v1/swagger.template.health.json

{
    "paths": {
        "/api/v1/health": {
            "get": {
                "tags": [
                    "Health"
                ],
                "summary": "Get health status",
                "description": "Check the instance health status",
                "operationId": "Health_GetHealth",
                "responses": {
                    "200": {
                        "description": "Instance is up",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ApplicationHealthData"
                                }
                            }
                        }
                    }
                },
                "security": []
            }
        }
    },
    "components": {
        "schemas": {
            "ApplicationHealthData": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                    "synchronized": {
                        "type": "boolean",
                        "description": "True if the instance is fully synchronized, according to NBXplorer"
                    }
                }
            }
        }
    },
    "tags": [
        {
            "name": "Health"
        }
    ]
}