API - Ping Solr Environment

Index Management

Asks one Opensolr server whether its Solr answers, and gives you the Solr ping answer.

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

01 · Parameters

hostnameRequired

The hostname of the server, as in the connection URL of your index: Connection URL.

emailRequired

Your account email, plain letters, digits and . _ % + - @ only.

02 · Example

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

03 · Answer

The body is the answer of Solr itself, a JSON with "status": "OK" when it is up.

04 · Errors

ERROR_INVALID_HOSTNAMEHTTP 200

The hostname is not a server of the Opensolr platform.

ERROR_INVALID_EMAILHTTP 200

The email has characters other than the ones above.

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 state of one index: get_core_status.

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