SEO Tools API
SEO Tools adds Google and Bing verification tags to client area pages and submits the sitemap’s addresses to search engines through IndexNow (cron does it when the sitemap changes). See Search verification and IndexNow for the settings page.
Admin calls need Module access on the Seo card of the staff group’s Permissions tab, plus each call’s own permission below (Super Administrators have all). See Authentication.
Admin calls
Section titled “Admin calls”POST /api/admin/seo/info
Returns the sitemap address, the IndexNow key, the result of the last submit and the verification codes.
Permission: View SEO information (seo.view)
No parameters.
Returns: An object: sitemap_url, key (the IndexNow key, null until settings are saved once), key_url (the key file’s address), last_submit (null or an object: at, ok, status (the HTTP status IndexNow answered), count (addresses sent), error and hash (of the sitemap)), google_verification and bing_verification.
Example
Request parameters:
{}result:
{ "sitemap_url": "https://billing.example.com/sitemap.xml", "key": "4f1c2b3a5d6e7f8091a2b3c4d5e6f708", "key_url": "https://billing.example.com/4f1c2b3a5d6e7f8091a2b3c4d5e6f708.txt", "last_submit": { "at": "2026-11-17 06:00:04", "ok": true, "status": 200, "count": 42, "error": "", "hash": "9b2e0c…" }, "google_verification": "abcDEF123", "bing_verification": ""}submit
Section titled “submit”POST /api/admin/seo/submit
Submits every address in the sitemap (up to 10,000) to IndexNow now, even when the sitemap did not change.
Permission: Manage SEO (seo.manage)
No parameters.
Returns: The submit’s result: at, ok (true when IndexNow answered 200 or 202), status, count, error (empty, The sitemap lists no pages. or the connection error) and hash. A failed submit is returned too, not thrown.
Errors:
- Save the settings first to create the IndexNow key.
save_settings
Section titled “save_settings”POST /api/admin/seo/save_settings
Saves the Google and Bing verification codes. Both are replaced, so send both. The first save also creates the IndexNow key.
Permission: Manage settings (seo.manage_settings)
| Parameter | Type | Description |
|---|---|---|
google_verification |
string | Only the content value of Google’s meta tag: letters, digits, - and _, up to 100. Empty: no tag. |
bing_verification |
string | Only the content value of Bing’s meta tag, with the same rules. |
Returns: true
Errors:
- Enter only the code: letters, digits, - and _.
Example
Request parameters:
{ "google_verification": "abcDEF123", "bing_verification": ""}result:
trueGuest calls
Section titled “Guest calls”verification (guest)
Section titled “verification (guest)”POST /api/guest/seo/verification
Returns the verification codes the client area puts in its page head.
No parameters.
Returns: An object: google and bing (each empty when not set).
Example
Request parameters:
{}result:
{ "google": "abcDEF123", "bing": ""}
