Get detailed API status
GET /status/current
Detailed status information about the API and its dependencies
Responses
| Status | Description |
|---|---|
200 OK | Detailed status information |
Content type application/json
Response fields (200)
| Field | Type | Required | Description |
|---|---|---|---|
status |
string | no | One of: |
timestamp |
integer | no | |
environment |
string | no | |
components |
object | no | |
components.api |
object | no | |
components.api.status |
string | no | |
components.api.version |
string | no | |
components.database |
object | no | |
components.database.status |
string | no | |
components.database.message |
string | no | |
maintenance_mode |
boolean | no |
Example 200 response
{
"status": "operational",
"timestamp": 0,
"environment": "string",
"components": {
"api": {
"status": "string",
"version": "string"
},
"database": {
"status": "string",
"message": "string"
}
},
"maintenance_mode": true
}Example request
curl --request GET \
--url https://api.sandbox.truevault.com.au/api/v1/status/current