API - Get list of available environments and servers

Index Management

Lists the environments you can create indexes in: the shared regions, your own dedicated servers and your cluster environments.

Endpointhttps://opensolr.com/solr_manager/api/get_env
MethodGET or POST
Authemail and api_key of your account, as GET or POST parameters: Authentication.
In the panelRegions

01 · Parameters

web_crawlerOptional

true keeps only the environments with site search (crawl, Data Ingestion, hybrid search).

02 · Example

curl -s "https://opensolr.com/solr_manager/api/get_env?email=YOUR_EMAIL&api_key=YOUR_API_KEY&web_crawler=true"

03 · Answer

{
    "status": true,
    "msg": {
        "cluster_owned_environments": [],
        "simple_shared_environments": [
            {
                "server_identifier": "DE-SOLR-9",
                "solr_version": "9.00",
                "region": "...",
                "provider": "...",
                "country": "Germany",
                "flag": "..."
            }
        ],
        "simple_owned_environments": []
    }
}
simple_shared_environments

The shared regions every account can use.

simple_owned_environments

Your dedicated servers.

cluster_owned_environments

Your Resilient Cluster environments, for create_cluster.

Use server_identifier as the region of create_index.

04 · Errors

ERROR_AUTHENTICATION_FAILEDHTTP 403

The email and API key do not match.

ERROR_RATE_LIMIT_PER_MINUTEHTTP 429

Too many calls. Wait for the Retry-After seconds: Rate limits.

05 · Related

Only the identifiers: regions. Regions with site search, with their coordinates: vector_regions.

Every error code and HTTP status of the API: API errors. Calls per minute and per hour: Rate limits.