FluentCRM Developers

Appearance

View as Markdown

GET Database Index Health​

GET
/setting/db-index-health

Report whether each index FluentCRM considers critical is present on the database.

Missing indexes do not break correctness, but they turn the sending queue and segmentation queries into table scans, so this is the first thing to check when a large site reports slow sending.

By default the answer comes from a cached snapshot. Pass fresh=1 to run SHOW INDEX against the live database instead — slower, but authoritative. The cache is also bypassed automatically when it predates a newly introduced critical index.

Anything reporting status: "no" can be fixed with POST /setting/db-index-health/repair.

Required capability: fcrm_manage_settings

Enforced by SettingsPolicy::verifyRequest(), the policy default for this route group.

Authorizations​

ApplicationPasswords

WordPress Application Passwords — use Basic auth with your WordPress username and an application password in the format: username:application_password

Type
API Key (header: Authorization)

Parameters​

Query Parameters

fresh

Send 1 to bypass the cached snapshot and query the live database.

Type
string
Valid values
"1"

Responses​

Index health for every critical index.

application/json
JSON
{
"indexes": [
{
"name": "string",
"title": "string",
"table": "string",
"type": "string",
"columns": [
{
"name": "string",
"sub_part": 0
}
],
"cleanup": "string",
"status": "string"
}
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI