API - Get Settings Dashboard (Combined Account, Crawl & Environment Data)

Index Management

Everything a settings page needs about one index in one call: plan and usage, crawl stats and schedule, your indexes, the regions with site search, and your API rate limits. The Opensolr Drupal module and WordPress plugin call it.

Endpointhttps://opensolr.com/solr_manager/api/get_settings_dashboard
MethodGET or POST
Authemail and api_key of your account, as GET or POST parameters: Authentication. Plus a signature: see below.

01 · Parameters

core_nameRequired

The name of your index.

signatureRequired

Hex HMAC-SHA256 of core_name followed by email, keyed with your API key.

02 · Example

SIG=$(printf '%s' "my_indexYOUR_EMAIL" | openssl dgst -sha256 -hmac "YOUR_API_KEY" | sed 's/^.* //')
curl -s "https://opensolr.com/solr_manager/api/get_settings_dashboard?email=YOUR_EMAIL&api_key=YOUR_API_KEY&core_name=my_index&signature=$SIG"

03 · Answer

account_summary

The answer of get_account_summary, or null.

crawl_stats

The answer of get_crawl_stats, or null before the first crawl.

crawl_schedule_active

true while a crawl schedule exists for the index.

crawl_schedule_transitioning

starting or stopping while a start or stop is still on its way, else null.

index_list

Your indexes, as get_index_list gives them.

environments

The regions with site search you can use, as one list.

api_rate_limit

max_per_minute, max_per_hour, and your calls in the last_min and last_hour.

04 · Errors

ERROR_MISSING_PARAMSHTTP 200

No core_name or no signature.

ERROR_INVALID_SIGNATUREHTTP 200

The signature does not match.

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

How to sign: Authentication. The same data, call by call: Control the crawl.

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