API - Create New Solr Index

Index Management

Creates a new Opensolr Index in the region you choose. It is ready to use when the call returns.

Endpointhttps://opensolr.com/solr_manager/api/create_index (create_core is the same call)
MethodGET
Authemail and api_key of your account, as GET or POST parameters: Authentication.
In the panelCreate an index

01 · Parameters

core_nameRequired

The name of the new index (index_name works too). Letters, digits and underscores, up to 50 characters: other characters are removed. Rules: Index names.

regionRequired

Where the index lives: an identifier from regions (server_country works too). For site search, Data Ingestion and hybrid search pick one from vector_regions.

02 · Example

curl -s "https://opensolr.com/solr_manager/api/create_index?email=YOUR_EMAIL&api_key=YOUR_API_KEY&core_name=my_index&region=DE-SOLR-9"

03 · Answer

{
    "status": true,
    "msg": "CORE_CREATED_OK",
    "core_hostname": "HOSTNAME_OF_THE_SERVER",
    "solr_version": "9.00"
}

The new index answers at https://core_hostname/solr/my_index. It starts with the username opensolr, your master API key as its password, and one IP rule, all on /: HTTP Basic Auth, IP restriction.

04 · Errors

ERROR_INVALID_CORE_NAMEHTTP 200

No name.

ERROR_INVALID_SERVER_COUNTRYHTTP 200

No region.

SERVER_COUNTRY_DOES_NOT_EXISTHTTP 200

The region is not one you can use.

ERROR_CORE_NAME_TAKEN_CHOOSE_ANOTHER_CORE_NAMEHTTP 200

Another index already has this name. Index names are unique on the whole platform.

ERROR_CANNOT_ADD_MORE_THAN_N_CORESHTTP 200

You have as many indexes as your plan allows. N is the number of your plan. get_account_summary tells how many are left.

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

Delete an index: delete_index. List your indexes: get_index_list.

What a site search index needs: What your index needs.

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