mirror of
https://github.com/btcpayserver/btcpayserver.git
synced 2025-02-23 14:40:36 +01:00
57 lines
1.8 KiB
JSON
57 lines
1.8 KiB
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"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "Unexpected error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"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",
|
|
"description": "Health operations"
|
|
}
|
|
]
|
|
}
|