mirror of
https://github.com/shlinkio/shlink.git
synced 2024-11-30 12:34:12 -06:00
63 lines
2.0 KiB
JSON
63 lines
2.0 KiB
JSON
|
{
|
||
|
|
"get": {
|
||
|
|
"operationId": "health",
|
||
|
|
"tags": [
|
||
|
|
"Monitoring"
|
||
|
|
],
|
||
|
|
"summary": "Check healthiness",
|
||
|
|
"description": "Checks the healthiness of the service, making sure it can access required resources.",
|
||
|
|
"responses": {
|
||
|
|
"200": {
|
||
|
|
"description": "The passing health status",
|
||
|
|
"content": {
|
||
|
|
"application/json": {
|
||
|
|
"schema": {
|
||
|
|
"$ref": "../definitions/Health.json"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"examples": {
|
||
|
|
"application/json": {
|
||
|
|
"status": "pass",
|
||
|
|
"version": "1.16.0",
|
||
|
|
"links": {
|
||
|
|
"about": "https://shlink.io",
|
||
|
|
"project": "https://github.com/shlinkio/shlink"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"503": {
|
||
|
|
"description": "The failing health status",
|
||
|
|
"content": {
|
||
|
|
"application/json": {
|
||
|
|
"schema": {
|
||
|
|
"$ref": "../definitions/Health.json"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"examples": {
|
||
|
|
"application/json": {
|
||
|
|
"status": "fail",
|
||
|
|
"version": "1.16.0",
|
||
|
|
"links": {
|
||
|
|
"about": "https://shlink.io",
|
||
|
|
"project": "https://github.com/shlinkio/shlink"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"500": {
|
||
|
|
"description": "Unexpected error.",
|
||
|
|
"content": {
|
||
|
|
"application/json": {
|
||
|
|
"schema": {
|
||
|
|
"$ref": "../definitions/Error.json"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|