Summary
Get status.
Description
Get status of current IAP.
Route
GET /health/status
Roles
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| options |
object |
yes |
Query options for this method |
Copied to Clipboard
{
"options": {
"exclude-services": false
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"options": {
"title": "options",
"properties": {
"exclude-services": {
"title": "exclude-services",
"description": "When set to true, this method will skip its liveness check against downstream services",
"type": "boolean"
}
}
}
},
"required": [
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| status |
object |
status of the current IAP. |
Copied to Clipboard
{
"host": "incididunt",
"serverId": "laboris",
"serverName": "aliquip sed",
"services": [
{
"service": "Ut Excepteur dolore",
"status": "running"
}
],
"timestamp": -80843885,
"apps": "running",
"adapters": "running"
}
Copied to Clipboard
{
"title": "status",
"type": "object",
"properties": {
"host": {
"type": "string"
},
"serverId": {
"type": "string"
},
"serverName": {
"type": "string"
},
"services": {
"type": "array",
"items": {
"type": "object",
"properties": {
"service": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"running",
"failed"
]
}
}
}
},
"timestamp": {
"type": "integer"
},
"apps": {
"type": "string",
"enum": [
"running",
"degraded"
]
},
"adapters": {
"type": "string",
"enum": [
"running",
"degraded"
]
}
}
}
