Run the plugin's health check across connected WordPress sites
Run the plugin's health check across connected WordPress sites and summarize the results. Checks every connected site by default; pass ?site= for one. Each site reports ok/warning/critical with its failing checks, WordPress and PHP versions, pending…
Request
- x-api-key: <your-api-key>
- Content-Type: application/json
This operation is read-only. Change the path values above and send.
Response
{
"sites": [
{}
],
"status": "success",
"summary": {
"critical": 1,
"ok": 37,
"total": 3,
"unreachable": 26,
"updatesPending": 7,
"warning": 19
},
"tokensDeducted": 1
}What it does
Run the plugin's health check across connected WordPress sites and summarize the results. Checks every connected site by default; pass ?site= for one. Each site reports ok/warning/critical with its failing checks, WordPress and PHP versions, pending updates and content counts. A site that cannot be reached is reported as "unreachable" with the reason rather than failing the whole call.ite checked.
Request
Parameters
| Field | In | Type | Required | Description |
|---|---|---|---|---|
site | query | string | no | Check only this connected site |
Response
| Field | Type | Description |
|---|---|---|
sites | array<object> | |
status | string | |
summary | object | |
↳ critical | integer | |
↳ ok | integer | |
↳ total | integer | |
↳ unreachable | integer | |
↳ updatesPending | integer | |
↳ warning | integer | |
tokensDeducted | integer |
Example response
{
"sites": [
{}
],
"status": "success",
"summary": {
"critical": 1,
"ok": 37,
"total": 3,
"unreachable": 26,
"updatesPending": 7,
"warning": 19
},
"tokensDeducted": 1
}Errors
Every error answers with the same envelope: an HTTP status, a machine code and a sentence.
400 | The body or a parameter failed validation. The details array names the field. |
401 | No key, a revoked key or a wrong header. Send x-api-key. |
402 | The wallet cannot cover this call. Top up or wait for the monthly grant. |
404 | The resource does not exist, or it is not yours. Both answer identically and cost nothing. |
429 | Over the per-minute quota of your tier. Back off and retry. |
5xx | Upstream refused or timed out. The call is not billed. |
Code
curl -X GET 'https://app.castomapi.com/v1/wordpress/health' \ -H 'x-api-key: <your-api-key>'
const res = await fetch('https://app.castomapi.com/v1/wordpress/health', {
method: 'GET',
headers: { 'x-api-key': '<your-api-key>' }
});
const data = await res.json();
console.log(data);import { request } from 'node:https';
// Node 18+ has fetch built in
const res = await fetch('https://app.castomapi.com/v1/wordpress/health', {
method: 'GET',
headers: { 'x-api-key': '<your-api-key>' }
});
const data = await res.json();
console.log(data);import requests
res = requests.get(
'https://app.castomapi.com/v1/wordpress/health',
headers={'x-api-key': '<your-api-key>'},
timeout=30,
)
print(res.json())<?php
$ch = curl_init('https://app.castomapi.com/v1/wordpress/health');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['x-api-key: <your-api-key>', 'Content-Type: application/json'],
]);
$data = json_decode(curl_exec($ch), true);
print_r($data);Cost and limits
This operation costs from 1 token. A call that fails is never billed. Every account gets 1000 free tokens a month; paid balances never expire. 1 token per site checked.
Rate limits per minute
| No key | 10 |
| Free | 60 |
| Pro | 300 |
| Enterprise | 1200 |
Questions
What does Run the plugin's health check across connected WordPress sites cost?
from 1 token per successful call, debited from your wallet after the response. Failed calls are free. Every account receives 1000 free tokens a month. 1 token per site checked.
How do I authenticate?
Send your key in the x-api-key header. One key covers every metered endpoint; there is nothing to enable per endpoint.
Can I send an Authorization: Bearer token instead?
Not for a metered endpoint — those take the x-api-key header and nothing else. Bearer tokens belong to the account side: the dashboard and account APIs accept a JWT session, and castomapi-auth issues those through a standard OAuth2 handshake, with authorization code, client credentials and refresh grants. The auth service page covers it.
What are the limits?
10 requests a minute per IP with no key at all, 60 a minute on the free tier, 300 on Pro, 1200 on Enterprise. Above the no-key tier the quota is per account, across every endpoint.
OpenAPI: https://app.castomapi.com/docs/json