Skip to content

Get full settings page status

GET
/api/settings/status

Aggregate endpoint that returns health checks, job queue status, failed jobs, app settings, and all credential statuses in a single request. Non-admin users receive only their credential connection status; admin users receive the full diagnostics payload.

Responses

Aggregated settings status

application/json
JSON
{
  
"health": {
  
  
"status": "string",
  
  
"checks": {
  
  
  
"database": {
  
  
  
  
"status": "string",
  
  
  
  
"latencyMs": 0,
  
  
  
  
"error": "string"
  
  
  
},
  
  
  
"redis": {
  
  
  
  
"status": "string",
  
  
  
  
"latencyMs": 0,
  
  
  
  
"error": "string"
  
  
  
},
  
  
  
"eventBus": {
  
  
  
  
"status": "string",
  
  
  
  
"latencyMs": 0,
  
  
  
  
"error": "string"
  
  
  
}
  
  
}
  
},
  
"queues": {
  
  
"additionalProperties": {
  
  
  
"waiting": 0,
  
  
  
"active": 0,
  
  
  
"completed": 0,
  
  
  
"failed": 0,
  
  
  
"delayed": 0,
  
  
  
"paused": 0
  
  
}
  
},
  
"failedJobs": {
  
  
"jobs": [
  
  
  
{
  
  
  
  
"id": "string",
  
  
  
  
"queueName": "string",
  
  
  
  
"name": "string",
  
  
  
  
"data": {
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
},
  
  
  
  
"error": "string",
  
  
  
  
"failedAt": 0,
  
  
  
  
"attemptsMade": 0,
  
  
  
  
"maxAttempts": 0
  
  
  
}
  
  
],
  
  
"total": 0
  
},
  
"settings": {
  
  
"libraryPath": "string",
  
  
"inboxPath": "string",
  
  
"kosyncConfigured": true,
  
  
"hardcoverMetadataEnabled": true,
  
  
"hardcoverSyncEnabled": true
  
},
  
"credentials": {
  
  
"opds": {
  
  
  
"configured": true,
  
  
  
"service": "string",
  
  
  
"username": "string",
  
  
  
"createdAt": "string",
  
  
  
"updatedAt": "string"
  
  
},
  
  
"kosync": {
  
  
  
"configured": true,
  
  
  
"service": "string",
  
  
  
"username": "string",
  
  
  
"createdAt": "string",
  
  
  
"updatedAt": "string"
  
  
},
  
  
"hardcover": {
  
  
  
"configured": true,
  
  
  
"service": "string",
  
  
  
"username": "string",
  
  
  
"createdAt": "string",
  
  
  
"updatedAt": "string"
  
  
}
  
}
}

Samples