Index Management | Opensolr

API - Get a list of your Opensolr Indexes

Lists the Opensolr Indexes of your account.

Endpointhttps://opensolr.com/solr_manager/api/get_index_list

MethodGET

Authemail and api_key of your account, as GET or POST parameters: Authentication.

01 · Parameters

None besides email and api_key.

02 · Example

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

03 · Answer

[
    {
        "index_name": "my_index",
        "index_type": "-1"
    },
    {
        "index_name": "prodsearch",
        "index_type": "0"
    }
]

A plain list, without status. index_type is -1 for a standalone index, 0 for a cluster master, and the id of its master index for a replica. A scoped key limited to some indexes gets only those.

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

The details of one index: get_core_info.

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

Read Full Answer

API - Get list of available environments and servers

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.

Read Full Answer

API - Get Index Details, Info and Stats

Gives you the details of your Opensolr Index in one answer: how to connect to it, how much disk and traffic it uses, and its limits.

Endpointhttps://opensolr.com/solr_manager/api/get_core_info

MethodGET

Authemail and api_key of your account, as GET or POST parameters: Authentication.

In the panelIndex dashboard

01 · Parameters

core_nameRequired

The name of your index.

02 · Example

curl -s "https://opensolr.com/solr_manager/api/get_core_info?email=YOUR_EMAIL&api_key=YOUR_API_KEY&core_name=my_index"

03 · Answer

info

connection_url, port, type, solr_version, environment_identifier (the region), auth_username, auth_password.

core_data

This index: core_size_mb, core_badnwidth_mb (traffic this month), max_core_size_mb, max_badnwdith_mb. The two misspelled keys are spelled like this in the answer.

all_cores

Your indexes together: total_number_of_cores, total_cores_disk_mb, total_cores_bandwidth_mb and their averages.

A scoped key limited to some indexes counts only those in all_cores.

04 · Errors

NOT_OWNER_ERRORHTTP 200

The index is not yours.

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

Plan, usage and AI allowance of an index: get_account_summary.

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

Read Full Answer