Documentation > Index Management

API - Get Available Regions

Index Management
API Endpoint

Get Available Regions

Get a list of all server regions where you can create new Opensolr indexes. Use this to find the region identifier needed for the Create Index endpoint.

Endpoint

GET https://opensolr.com/solr_manager/api/regions
Alias: server_country is accepted as an alternative name for this endpoint and behaves identically to regions.
Vector-capable regions only: use vector_regions when the index will hold embeddings.

Parameters

ParameterStatusDescription
emailrequiredYour Opensolr registration email address
api_keyrequiredYour Opensolr API key

Code Examples

$_ cURL

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

PHP PHP

$params = http_build_query([
    'email'   => 'YOUR_EMAIL',
    'api_key' => 'YOUR_API_KEY',
]);
$response = json_decode(file_get_contents(
    'https://opensolr.com/solr_manager/api/regions?' . $params
), true);
print_r($response);

Py Python

import requests

response = requests.get(
    "https://opensolr.com/solr_manager/api/regions",
    params={
        "email": "YOUR_EMAIL",
        "api_key": "YOUR_API_KEY",
    }
)
data = response.json()
print(data)

Related Documentation

Create Index

Create a new Solr index via the API.

List Indexes

Get a list of all your Opensolr indexes.

Index Info & Stats

Get detailed information and statistics for an index.

Platform Guide

Complete guide to the Opensolr platform and control panel.

Need help managing your Solr indexes? We are here to help.

Contact Support