The Whole REST API Documented: 14 New Endpoint Articles, a Rewritten Reference, Host Split and Three Fixes
The REST API is now documented end to end. Fourteen new endpoint articles cover the last undocumented calls, the API Reference was rewritten to describe what the API actually returns, and the split between the two hosts is now explicit and enforced. Three endpoint bugs were fixed along the way.
01 Fourteen new endpoint articles
Every user-facing endpoint now has its own page with parameters, real responses and cURL, PHP and Python examples:
- AI. Hybrid Search (embed_and_search).
- Index management. vector_regions, get_account_summary, elevation_toggle.
- Web crawler. add_crawl_url_signed, delete_crawler_url, crawl_schedule_status, move_done_to_todo, tail_crawl_log.
- Logs and analytics. log tails and live streams.
- Backups, security, clusters. restore_backup, remove_http_auth and delete_environment.
The Data Ingestion Queue page now lists every queue endpoint, and the endpoint aliases create_core, delete_index, reset_core and server_country are noted on their respective articles.
02 The API Reference now tells the truth
The API Reference page was rewritten. It explains which endpoints live on opensolr.com (management) and which on api.opensolr.com (AI and Data Ingestion), lists the four HMAC-signed endpoints, and documents the real error responses rather than an idealised version of them.
| Response | Meaning |
|---|---|
200 with "status": false | Application error |
403 | Authentication failure |
429 with Retry-After | Rate limited |
Two commands that referenced non-existent endpoints were removed from the Solr Migration guide.
03 One host per job
api.opensolr.com now serves only the AI and Data Ingestion endpoints. Embeddings, hybrid search, ai_summary and the ingestion queue answer there. Every management endpoint — indexes, configuration, crawler, backups, security — is served exclusively by opensolr.com and answers 403 on the AI host.
04 Three fixes
remove_http_authworks again. The endpoint that removes HTTP Basic Auth from an index had been failing on every call. It now removes the credentials on the index and on every cluster replica, exactly like update_http_auth sets them.- The short alias no longer 404s.
https://api.opensolr.com/api/METHODanswered 404 and now resolves. api_query_suggestions. It returned an error when called on opensolr.com; that is fixed.